id
stringlengths
53
86
api_name
stringlengths
2
76
api_description
stringlengths
1
500
βŒ€
api_score
float64
0
10
βŒ€
endpoint_name
stringlengths
1
190
endpoint_description
stringlengths
0
500
response_status_code
int64
100
505
response_summary
stringlengths
1
68
βŒ€
response_json
stringlengths
6
50k
response_json_schema
stringlengths
14
150k
6988cefe-3cc8-4c08-a77d-c2ee157cd571/930d209d-8e55-4680-9321-e8eb1fa3a022/1/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
deleteEntity
Deletes the Entity represented by the given Id.
400
null
{"status": "error", "errors": {"entity_id": ["Entity cannot be deleted because it has Transactions: (1), Balances: (1), Exchange Rates: (4), Reporting Periods: (2), Categories: (6), Accounts: (5), Closing Rates: (1), Closing Transactions: (1), Taxes: (1), Discounts: (1) depending on it "]}}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/ee64585f-a611-4d7a-a2ed-8d3312a67b4a/0/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
getBalances
Retrieves a paginated list of Balances associated with the logged-in user.
200
null
{"current_page": 1, "data": [{"uuid": "ef5edea0-29a6-4517-bd4a-a3580065f1b3", "id": 1, "entity_id": 1, "account_id": 1, "currency_id": 3, "exchange_rate_id": 2, "reporting_period_id": 1, "reference": "ipsa", "transaction_date": "2021-10-21 14:59:10", "transaction_no": "quis", "balance_type": "DEBIT", "balance": "243613.6048", "transaction_name": "Supplier Bill", "amount": 65508.66, "type": "Debit", "is_posted": true, "is_credited": false, "exchange_rate": {"uuid": "66e61424-c3c0-433c-9458-fb496f0c07a9", "id": 2, "entity_id": 1, "currency_id": 2, "valid_from": "2022-10-13T18:50:44.000000Z", "valid_to": "2022-10-21T14:59:10.000000Z", "rate": "3.7188"}}, {"uuid": "436b15e5-397f-4087-8dbf-3c367831f031", "id": 2, "entity_id": 1, "account_id": 2, "currency_id": 5, "exchange_rate_id": 3, "reporting_period_id": 1, "reference": "nihil", "transaction_date": "2021-10-21 14:59:10", "transaction_no": "fugit", "balance_type": "CREDIT", "balance": "158235.0532", "transaction_name": "Journal Entry", "amount": 50254.09, "type": "Credit", "is_posted": true, "is_credited": true, "exchange_rate": {"uuid": "cbe7809b-c8bb-4412-988d-95536912ff31", "id": 3, "entity_id": 1, "currency_id": 4, "valid_from": "2022-10-11T18:21:43.000000Z", "valid_to": "2022-10-21T14:59:10.000000Z", "rate": "3.1487"}}], "first_page_url": "http://api.microbooks.io/books/v1/balance?page=1", "from": 1, "last_page": 1, "last_page_url": "http://api.microbooks.io/books/v1/balance?page=1", "links": [{"url": null, "label": "pagination.previous", "active": false}, {"url": "http://api.microbooks.io/books/v1/balance?page=1", "label": "1", "active": true}, {"url": null, "label": "pagination.next", "active": false}], "next_page_url": null, "path": "http://api.microbooks.io/books/v1/balance", "per_page": 5, "prev_page_url": null, "to": 2, "total": 2}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/f3315204-f088-4c21-ad9b-dab971484445/0/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
datePeriod
Retrieves the Reporting Period to which the given date belongs.
400
null
{"status": "error", "errors": {"calendar_year": ["Entity 'Champlin-Doyle' has no reporting period defined for the year 2021 "]}}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/f3315204-f088-4c21-ad9b-dab971484445/1/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
datePeriod
Retrieves the Reporting Period to which the given date belongs.
200
null
{"status": "success", "period": {"uuid": "e400be70-c80d-49c3-abdb-fbc08de7f034", "id": 2, "entity_id": 1, "period_count": 6, "status": "OPEN", "calendar_year": 2020, "closing_date": null}}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/4c7baa8d-205f-489e-a4cb-6a7c6dc4b2b2/0/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
createDiscount
Creates a Discount. Parameters: | Parameters | Attributes | Notes | | --- | --- | --- | | name | required, string | | | code | required, string, minimum:1, maximum:5 | | | rate | required, numeric, minimum:1 | | | account_id | required, integer | Must exist | | entity_id | optional, integer | Must exist, in case the Discount is for an entity other than that of the logged in user |
200
null
{"status": "success", "message": "Discount: Trade Discount (SALE) at 10.00% created successfully", "resource": {"name": "Trade Discount", "code": "SALE", "rate": 10, "account_id": 1, "operations_discount": false, "entity_id": 1, "id": 2, "account": {"uuid": "9bf98392-556e-4f68-8e92-3fcfef689f25", "id": 1, "entity_id": 1, "category_id": null, "currency_id": 1, "code": 2, "name": "Rick Schinner II", "description": null, "type": "Direct Expense", "is_closed": false}}}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/4c7baa8d-205f-489e-a4cb-6a7c6dc4b2b2/1/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
createDiscount
Creates a Discount. Parameters: | Parameters | Attributes | Notes | | --- | --- | --- | | name | required, string | | | code | required, string, minimum:1, maximum:5 | | | rate | required, numeric, minimum:1 | | | account_id | required, integer | Must exist | | entity_id | optional, integer | Must exist, in case the Discount is for an entity other than that of the logged in user |
400
null
{"status": "error", "errors": {"account_id": ["Discount Account Type must be one of: Direct Expense, Operating Expense, Operating Revenue, Non Operating Revenue "]}}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/4c7baa8d-205f-489e-a4cb-6a7c6dc4b2b2/1/1
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
createDiscount
Creates a Discount. Parameters: | Parameters | Attributes | Notes | | --- | --- | --- | | name | required, string | | | code | required, string, minimum:1, maximum:5 | | | rate | required, numeric, minimum:1 | | | account_id | required, integer | Must exist | | entity_id | optional, integer | Must exist, in case the Discount is for an entity other than that of the logged in user |
400
null
{"status": "error", "errors": {"account_id": ["10% Discount requires a Discount Account "]}}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/4c7baa8d-205f-489e-a4cb-6a7c6dc4b2b2/1/2
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
createDiscount
Creates a Discount. Parameters: | Parameters | Attributes | Notes | | --- | --- | --- | | name | required, string | | | code | required, string, minimum:1, maximum:5 | | | rate | required, numeric, minimum:1 | | | account_id | required, integer | Must exist | | entity_id | optional, integer | Must exist, in case the Discount is for an entity other than that of the logged in user |
400
null
{"status": "error", "errors": {"rate": ["A Discount cannot have 0% rate "]}}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/f0832c94-0c9a-465d-9669-c69bbb0640ad/0/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
getDiscounts
Retrieves a paginated list of Discounts associated with the logged-in user.
200
null
{"current_page": 1, "data": [{"uuid": "e3e1863a-933f-4796-975f-ae5aa4f1ace4", "id": 1, "entity_id": 1, "account_id": 1, "code": "BCEDA", "name": "Prof. Riley White", "rate": "3.0000", "gross_discount": true, "operations_discount": false, "account": {"uuid": "9bf98392-556e-4f68-8e92-3fcfef689f25", "id": 1, "entity_id": 1, "category_id": null, "currency_id": 1, "code": 2, "name": "Rick Schinner II", "description": null, "type": "Direct Expense", "is_closed": false}}], "first_page_url": "http://api.microbooks.io/books/v1/discount?page=1", "from": 1, "last_page": 1, "last_page_url": "http://api.microbooks.io/books/v1/discount?page=1", "links": [{"url": null, "label": "pagination.previous", "active": false}, {"url": "http://api.microbooks.io/books/v1/discount?page=1", "label": "1", "active": true}, {"url": null, "label": "pagination.next", "active": false}], "next_page_url": null, "path": "http://api.microbooks.io/books/v1/discount", "per_page": 5, "prev_page_url": null, "to": 1, "total": 1}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/8f11639f-b0f6-472b-aba2-4f89b3d8ae2c/0/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
updateReportingPeriod
Updates the Reporting Period represented by the given Id. Parameters: | Parameters | Attributes | Notes | | --- | --- | --- | | calendar_year | required, integer | | | period_count | required, integer | The number of years the Entity has been in operation | | entity_id | optional, integer | If the Reporting Period is for an Entity other than that of the logged in user |
200
null
{"status": "success", "message": "ReportingPeriod: 2023 updated successfully", "resource": {"uuid": "5eca26c4-0012-479f-b369-9c51d3fb4954", "id": 1, "entity_id": 1, "period_count": 2, "status": "OPEN", "calendar_year": 2023, "closing_date": null}}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/784f327a-d20c-4936-a2be-26729f5c9201/0/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
closingRates
Retrieves a list of Closing Rates for the foreign Currencies used in transactions during the Reporting period.
200
null
{"status": "success", "closing_rates": [{"uuid": "6c2cd8bb-33ec-4721-b19d-f8c7049488d3", "id": 1, "entity_id": 1, "exchange_rate": {"uuid": "b3cb2a3b-308a-4bac-b8fa-762e747f4d7e", "id": 1, "entity_id": 1, "currency_id": 2, "valid_from": "2022-09-27T22:00:08.000000Z", "valid_to": "2022-10-21T13:02:21.000000Z", "rate": "100.0000"}}, {"uuid": "4bbd98dd-6de7-4a8c-8810-994a7b676c7b", "id": 2, "entity_id": 1, "exchange_rate": {"uuid": "e90bcf87-1e58-4fc7-bfa9-43e59cb888d1", "id": 2, "entity_id": 1, "currency_id": 4, "valid_from": "2022-10-01T14:25:38.000000Z", "valid_to": "2022-10-21T13:02:21.000000Z", "rate": "150.0000"}}, {"uuid": "8752093c-a072-4cac-8b4f-8626fc85eb2a", "id": 3, "entity_id": 1, "exchange_rate": {"uuid": "7b30f481-a7fe-46ca-a442-dbcc2300ac8f", "id": 3, "entity_id": 1, "currency_id": 6, "valid_from": "2022-09-24T19:01:53.000000Z", "valid_to": "2022-10-21T13:02:21.000000Z", "rate": "75.0000"}}]}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/2c8f5f97-b973-4a2e-83b6-c60d08680788/0/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
createExchangeRate
Creates an Exchange Rate. Parameters: | Parameters | Attributes | Notes | | --- | --- | --- | | currency_id | required, integer | Must exist | | rate | required, numeric | | | valid_from | required, date | | | valid_to | optional, date | |
200
null
{"status": "success", "message": "ExchangeRate: 100.00 for Ashly Bergstrom (AWG) from 2022-07-20 created successfully", "resource": {"valid_from": "2022-07-20T00:00:00.000000Z", "currency_id": 2, "rate": 100, "entity_id": 1, "id": 4, "currency": {"uuid": "7b87e7e9-0e23-44aa-9694-ba9ccfc0091b", "id": 2, "user_id": 1, "name": "Ashly Bergstrom", "currency_code": "AWG"}}}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/b8037e4c-55eb-4376-9708-1a56014aa9b2/0/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
getExchangeRates
Retrieves a paginated list of Exchange Rates associated with the logged-in user.
200
null
{"current_page": 1, "data": [{"uuid": "826a0ac1-39e3-4452-9291-49d99f332dcb", "id": 1, "entity_id": 1, "currency_id": 2, "valid_from": "2022-10-07T22:22:57.000000Z", "valid_to": "2022-10-20T05:33:28.000000Z", "rate": "1.7563"}, {"uuid": "8646689f-1e4e-47f5-9a1d-06d626e51f21", "id": 2, "entity_id": 1, "currency_id": 2, "valid_from": "2022-10-06T15:37:17.000000Z", "valid_to": "2022-10-20T05:33:28.000000Z", "rate": "3.5961"}, {"uuid": "9012ead0-09cd-4ef7-a210-94303a5e257d", "id": 3, "entity_id": 1, "currency_id": 2, "valid_from": "2022-09-22T09:59:10.000000Z", "valid_to": "2022-10-20T05:33:28.000000Z", "rate": "1.2323"}], "first_page_url": "http://api.microbooks.io/books/v1/exchange-rate?page=1", "from": 1, "last_page": 1, "last_page_url": "http://api.microbooks.io/books/v1/exchange-rate?page=1", "links": [{"url": null, "label": "pagination.previous", "active": false}, {"url": "http://api.microbooks.io/books/v1/exchange-rate?page=1", "label": "1", "active": true}, {"url": null, "label": "pagination.next", "active": false}], "next_page_url": null, "path": "http://api.microbooks.io/books/v1/exchange-rate", "per_page": 5, "prev_page_url": null, "to": 3, "total": 3}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/d51d90a8-d004-48db-b97d-339fc0c61fca/0/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
destroyRecycledResource
Deletes the Recycled Object permanently.
200
null
{"status": "success", "message": "Receivable: Verona Treutel destroyed successfully", "resource": {"uuid": "b40d6438-55f9-4f9d-839e-033da881a253", "id": 2, "entity_id": 1, "category_id": 2, "currency_id": 1, "code": 9, "name": "Verona Treutel", "description": null, "type": "Receivable", "is_closed": false, "category": {"uuid": "f2016651-d640-4a68-9af7-5f6bf1a37988", "id": 2, "entity_id": 1, "name": "et", "type": "Receivable"}}}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/afe68dc8-759e-4e69-b1f0-17ed07c41243/0/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
restoreRecycledResource
Restores the Recycled Object to its previous state.
200
null
{"status": "success", "message": "Non Current Asset: Ms. Elisabeth Murphy Sr. restored successfully", "resource": {"uuid": "d66fc8fc-c073-41c9-bb36-2ae70f0130da", "id": 1, "entity_id": 1, "category_id": 1, "currency_id": 1, "code": 9, "name": "Ms. Elisabeth Murphy Sr.", "description": null, "type": "Non Current Asset", "is_closed": false, "category": {"uuid": "6460d9b7-dbdc-4ce3-a9fe-f51c2fd94cd8", "id": 1, "entity_id": 1, "name": "voluptatum", "type": "Non Current Asset"}}}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/543c66fe-2974-4f42-a820-1c20cd62e000/0/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
getRecycledResource
Retrieves the Recycled Object with the passed in Id.
200
null
{"status": "success", "resource": {"uuid": "541ff53d-0848-43cc-856f-a5efe627ee86", "id": 1, "entity_id": 1, "user_id": 1, "object": "Account", "object_id": "1"}}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/c44c071f-f2a6-4a87-a33d-99a9611ca964/0/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
getRecycledResources
Retrieves a paginated list of Objects that have been deleted.
200
null
{"current_page": 1, "data": [{"uuid": "541ff53d-0848-43cc-856f-a5efe627ee86", "id": 1, "entity_id": 1, "user_id": 1, "resource": "Account", "resource_id": "1"}, {"uuid": "6193f616-908a-4f0a-8bea-ad4716148ea6", "id": 2, "entity_id": 1, "user_id": 1, "resource": "Account", "resource_id": "2"}], "first_page_url": "http://api.microbooks.io/books/v1/recycled-resource?page=1", "from": 1, "last_page": 1, "last_page_url": "http://api.microbooks.io/books/v1/recycled-resource?page=1", "links": [{"url": null, "label": "pagination.previous", "active": false}, {"url": "http://api.microbooks.io/books/v1/recycled-resource?page=1", "label": "1", "active": true}, {"url": null, "label": "pagination.next", "active": false}], "next_page_url": null, "path": "http://api.microbooks.io/books/v1/recycled-resource", "per_page": 5, "prev_page_url": null, "to": 2, "total": 2}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/5f15acde-347f-4939-bfb1-16ffb3068bb4/0/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
getDiscounts
Retrieves the Discounts associated with the Line Item with the passed in Id.
200
null
{"status": "success", "discounts": [{"applicable_id": 1, "amount": "1.0000", "name": "Edd Lueilwitz", "code": "BADCE", "type": "Discount"}, {"applicable_id": 2, "amount": "2.5000", "name": "Dr. Hans Marquardt DVM", "code": "CBEAD", "type": "Discount"}]}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/8040a75a-021d-4384-9fbf-9cc6aae65e39/0/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
postTransaction
Posts the Transaction with the given Id to the ledger.
400
null
{"status": "error", "errors": {"transaction": ["A Transaction must have at least one LineItem to be posted "]}}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/8040a75a-021d-4384-9fbf-9cc6aae65e39/0/1
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
postTransaction
Posts the Transaction with the given Id to the ledger.
400
null
{"status": "error", "errors": {"main_account_amount": ["Total Debit amounts do not match total Credit amounts "]}}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/8040a75a-021d-4384-9fbf-9cc6aae65e39/1/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
postTransaction
Posts the Transaction with the given Id to the ledger.
200
null
{"status": "success", "message": "Journal Entry: JN01/0001 for 100.00 posted successfully", "resource": {"uuid": "fc32e97d-094b-4752-876d-1d55f9f3dc08", "id": 1, "entity_id": 1, "account_id": 1, "currency_id": 3, "exchange_rate_id": 2, "transaction_date": "2022-10-24T17:58:18.000000Z", "reference": "veritatis", "transaction_no": "JN01/0001", "transaction_type": "JN", "narration": "Ut porro dicta aut laboriosam aperiam.", "credited": true, "compound": false, "main_account_amount": "0.0000", "transaction_name": "Journal Entry", "is_posted": true, "is_credited": true, "amount": 100, "tax": {"total": 0}, "assignable": true, "clearable": true, "has_integrity": true, "line_items": [{"uuid": "44947f70-6497-4a45-b14c-0215cc6ef156", "id": 1, "entity_id": 1, "account_id": 4, "transaction_id": 1, "narration": "Enim consequatur totam quasi explicabo dolorum.", "amount": "50.0000", "quantity": "2.0000", "tax_inclusive": false, "compound_tax": false, "entry_type": "DEBIT", "credited": false, "tax": {"total": 0}, "discount": {"total": 0}, "net_amount": 100, "has_withholding_tax": false, "has_gross_discount": false, "has_operations_discounts": false}], "exchange_rate": {"uuid": "f97adf30-5aba-46f2-99f9-95e2c8b11037", "id": 2, "entity_id": 1, "currency_id": 1, "valid_from": "2022-10-24T17:58:18.000000Z", "valid_to": null, "rate": "1.0000"}, "clearances": [], "assignments": []}}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/51bdd2fc-ee59-4fcc-a0ae-437b61fd1e96/0/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
addItems
Adds the line items with the Ids in the line_item array to the Transaction. Parameters: | Parameters | Attributes | Notes | | --- | --- | --- | | transaction_type | required | Must be one of: IN CS CN RC CP BL DN PY CE JN (See Create/Update Transaction) | | line_items | required, array[integer] | A list of ids of already existing Line Items to be added to the Transaction. |
400
null
{"status": "error", "errors": {"transaction": ["Transaction Currency must be the same as the Bank: Test Savings & Loan Account Currency "]}}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/51bdd2fc-ee59-4fcc-a0ae-437b61fd1e96/0/1
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
addItems
Adds the line items with the Ids in the line_item array to the Transaction. Parameters: | Parameters | Attributes | Notes | | --- | --- | --- | | transaction_type | required | Must be one of: IN CS CN RC CP BL DN PY CE JN (See Create/Update Transaction) | | line_items | required, array[integer] | A list of ids of already existing Line Items to be added to the Transaction. |
400
null
{"status": "error", "errors": {"transaction": ["Cannot add LineItem to a posted Transaction "]}}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/51bdd2fc-ee59-4fcc-a0ae-437b61fd1e96/0/2
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
addItems
Adds the line items with the Ids in the line_item array to the Transaction. Parameters: | Parameters | Attributes | Notes | | --- | --- | --- | | transaction_type | required | Must be one of: IN CS CN RC CP BL DN PY CE JN (See Create/Update Transaction) | | line_items | required, array[integer] | A list of ids of already existing Line Items to be added to the Transaction. |
400
null
{"status": "error", "errors": {"transaction": ["A Transaction Main Account cannot be one of the Line Item Accounts "]}}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/51bdd2fc-ee59-4fcc-a0ae-437b61fd1e96/0/3
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
addItems
Adds the line items with the Ids in the line_item array to the Transaction. Parameters: | Parameters | Attributes | Notes | | --- | --- | --- | | transaction_type | required | Must be one of: IN CS CN RC CP BL DN PY CE JN (See Create/Update Transaction) | | line_items | required, array[integer] | A list of ids of already existing Line Items to be added to the Transaction. |
400
null
{"status": "error", "errors": {"tax_id": ["Compound Journal Entries cannot have Tax"]}}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/51bdd2fc-ee59-4fcc-a0ae-437b61fd1e96/1/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
addItems
Adds the line items with the Ids in the line_item array to the Transaction. Parameters: | Parameters | Attributes | Notes | | --- | --- | --- | | transaction_type | required | Must be one of: IN CS CN RC CP BL DN PY CE JN (See Create/Update Transaction) | | line_items | required, array[integer] | A list of ids of already existing Line Items to be added to the Transaction. |
200
null
{"status": "success", "message": "Journal Entry: JN01/0001 for 50.00 LineItems added successfully", "resource": {"uuid": "30d79554-1c71-4262-918b-0b3466897baa", "id": 1, "entity_id": 1, "account_id": 1, "currency_id": 3, "exchange_rate_id": 2, "transaction_date": "2022-10-24T17:59:23.000000Z", "reference": "quibusdam", "transaction_no": "JN01/0001", "transaction_type": "JN", "narration": "Quo mollitia quis eos.", "credited": true, "compound": false, "main_account_amount": "0.0000", "transaction_name": "Journal Entry", "is_posted": false, "is_credited": true, "amount": 50, "tax": {"total": 0}, "assignable": true, "clearable": true, "has_integrity": true, "line_items": [{"uuid": "7097b010-b038-4f8d-8e5c-6ff383764f73", "id": 1, "entity_id": 1, "account_id": 4, "transaction_id": 1, "narration": "Est necessitatibus sed quia doloribus id minima sapiente.", "amount": "50.0000", "quantity": "1.0000", "tax_inclusive": false, "compound_tax": false, "entry_type": "DEBIT", "credited": false, "tax": {"total": 0}, "discount": {"total": 0}, "net_amount": 50, "has_withholding_tax": false, "has_gross_discount": false, "has_operations_discounts": false}], "clearances": [], "assignments": []}}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/08768f28-b82c-4580-861a-6cc7aa3d57c6/0/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
openingBalances
Retrieves the opening Balances for the Account with the passed in Id and the year given. Optional Query Parameters: | Parameter | Attributes | Notes | | --- | --- | --- | | year | optional, integer | The specific year whose Opening Balances to retrieve |
200
null
{"status": "success", "account_balances": [{"uuid": "339c1d88-9653-4e19-8bef-9ddc84cf936c", "id": 1, "entity_id": 1, "account_id": 1, "currency_id": 4, "exchange_rate_id": 1, "reporting_period_id": 1, "reference": "maxime", "transaction_date": "2021-10-21 16:17:55", "transaction_no": "esse", "balance_type": "DEBIT", "balance": "50.0000", "transaction_name": "Supplier Bill", "amount": 50, "type": "Debit", "is_posted": true, "is_credited": false, "exchange_rate": {"uuid": "ff8d29f0-b0cc-4650-a451-e862c28dbc32", "id": 1, "entity_id": 1, "currency_id": 2, "valid_from": "2022-10-20T06:02:50.000000Z", "valid_to": "2022-10-21T16:17:55.000000Z", "rate": "1.0000"}}, {"uuid": "d08c2d44-cb33-4c80-b8af-1adf5493744d", "id": 2, "entity_id": 1, "account_id": 1, "currency_id": 6, "exchange_rate_id": 1, "reporting_period_id": 1, "reference": "repellendus", "transaction_date": "2021-10-21 16:17:55", "transaction_no": "soluta", "balance_type": "DEBIT", "balance": "50.0000", "transaction_name": "Client Invoice", "amount": 50, "type": "Debit", "is_posted": true, "is_credited": false, "exchange_rate": {"uuid": "ff8d29f0-b0cc-4650-a451-e862c28dbc32", "id": 1, "entity_id": 1, "currency_id": 2, "valid_from": "2022-10-20T06:02:50.000000Z", "valid_to": "2022-10-21T16:17:55.000000Z", "rate": "1.0000"}}, {"uuid": "039cce94-9df6-4bbe-ae30-44eddc160281", "id": 3, "entity_id": 1, "account_id": 1, "currency_id": 8, "exchange_rate_id": 1, "reporting_period_id": 1, "reference": "iste", "transaction_date": "2021-10-21 16:17:55", "transaction_no": "odit", "balance_type": "DEBIT", "balance": "50.0000", "transaction_name": "Journal Entry", "amount": 50, "type": "Debit", "is_posted": true, "is_credited": false, "exchange_rate": {"uuid": "ff8d29f0-b0cc-4650-a451-e862c28dbc32", "id": 1, "entity_id": 1, "currency_id": 2, "valid_from": "2022-10-20T06:02:50.000000Z", "valid_to": "2022-10-21T16:17:55.000000Z", "rate": "1.0000"}}, {"uuid": "b50feee7-7d54-4918-bd19-15dd7d3cab90", "id": 4, "entity_id": 1, "account_id": 1, "currency_id": 11, "exchange_rate_id": 6, "reporting_period_id": 1, "reference": "deserunt", "transaction_date": "2021-10-21 16:17:56", "transaction_no": "quia", "balance_type": "CREDIT", "balance": "40.0000", "transaction_name": "Supplier Bill", "amount": 40, "type": "Credit", "is_posted": true, "is_credited": true, "exchange_rate": {"uuid": "137f2fa0-3ca5-4f4c-b2a1-2fa97da8c442", "id": 6, "entity_id": 1, "currency_id": 9, "valid_from": "2022-10-04T11:33:41.000000Z", "valid_to": "2022-10-21T16:17:56.000000Z", "rate": "1.0000"}}, {"uuid": "f2ce00ad-4298-4720-8ac6-493a2f385881", "id": 5, "entity_id": 1, "account_id": 1, "currency_id": 13, "exchange_rate_id": 6, "reporting_period_id": 1, "reference": "non", "transaction_date": "2021-10-21 16:17:56", "transaction_no": "aliquid", "balance_type": "CREDIT", "balance": "40.0000", "transaction_name": "Supplier Bill", "amount": 40, "type": "Credit", "is_posted": true, "is_credited": true, "exchange_rate": {"uuid": "137f2fa0-3ca5-4f4c-b2a1-2fa97da8c442", "id": 6, "entity_id": 1, "currency_id": 9, "valid_from": "2022-10-04T11:33:41.000000Z", "valid_to": "2022-10-21T16:17:56.000000Z", "rate": "1.0000"}}]}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/a0b58817-a6ef-40eb-92c5-6bf0ee658034/0/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
bulkAssignTransaction
Assigns the balance on the given Transaction to all curently outstanding Clearable Transactions belonging to the Transaction's main Account Parameters: | Parameters | Attributes | Notes | | --- | --- | --- | | transaction_id | required, integer | Transaction Type must be one of: * CN * RC * DN * PY * JN (See Transactions) | | forex_account_id | optional, integer | Account Type must be EQUITY (See Accounts). Required if transaction currencies are difference from the reporting currency |
200
null
{"status": "success", "message": "Journal Entry: JN01/0001 for 100.00 Transactions bulk assigned successfully", "assigned": [{"id": 4, "number": "JN01/0003", "amount": 75}, {"id": 6, "number": "JN01/0005", "amount": 25}]}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/5b5bbd5d-ebe4-4dcc-b53b-dd80ce6b37b2/0/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
agingSchedule
Retrieves a schedule of Payable and Receivable accounts and their outstanding balances categorized by how long they have been outstanding. Optional Query Parameters: | Parameter | Attributes | Notes | | --- | --- | --- | | end-date | optional, date | The latest date of the Balances to retrieve | | currency-id | optional, integer | Filter the Transactions in the balances by the Currency given |
200
null
{"status": "success", "schedule": {"accounts": [{"uuid": "56947640-81a0-45bb-ac70-45b621264ea1", "id": 1, "entity_id": 1, "category_id": null, "currency_id": 2, "code": 8, "name": "Magali Kohler III", "description": null, "agedBalances": {"current": 50, "31 - 90 days": 100, "91 - 180 days": 75, "181 - 270 days": 150, "271 - 365 days": 175, "365+ (bad debts)": 25}, "type": "Receivable", "is_closed": false}], "balances": {"current": 50, "31 - 90 days": 100, "91 - 180 days": 75, "181 - 270 days": 150, "271 - 365 days": 175, "365+ (bad debts)": 25}, "period": {"endDate": "2022-10-21T00:00:00.000000Z"}}}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/54e947e2-7276-4593-baf2-823a53613770/0/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
accountSchedule
Retrieves the outstanding (Clearable) Transactions of the Account as at the given end date. Optional Query Parameters: | Parameter | Attributes | Notes | | --- | --- | --- | | start-date | optional, date | The earliest date of the Transactions to retrieve | | end-date | optional, date | The latest date of the Transactions to retrieve | | currency-id | optional, integer | Filter the Transactions by the Currency given |
200
null
{"status": "success", "schedule": [{"uuid": "fe091120-11ab-4f8a-ad8b-aa47200daa3c", "id": 1, "entity_id": 1, "account_id": 1, "currency_id": 2, "exchange_rate_id": 1, "reporting_period_id": 1, "reference": "voluptatem", "transaction_date": "2021-10-21 16:00:54", "transaction_no": "molestiae", "balance_type": "DEBIT", "balance": "50.0000", "original_amount": 50, "amount_cleared": 15, "clearable_Type": "Balance", "age": 365, "date": "Oct 21, 2021", "uncleared_amount": 35, "transaction_name": "Journal Entry", "amount": 50, "type": "Debit", "is_posted": true, "is_credited": false, "exchange_rate": {"uuid": "d7ceb5ee-3077-44c9-bb44-bcdc4c6ff873", "id": 1, "entity_id": 1, "currency_id": 2, "valid_from": "2022-10-20T03:53:48.000000Z", "valid_to": "2022-10-21T16:00:54.000000Z", "rate": "1.0000"}, "clearances": [{"uuid": "e33f058a-e0e0-4aca-b999-c6b7547fdf2c", "id": 1, "entity_id": 1, "transaction_id": 2, "forex_account_id": null, "assignment_date": "2022-10-04 21:00:55", "cleared_id": 1, "amount": "15.0000", "type": "Balance"}]}, {"uuid": "35a18926-6597-4ab7-af25-0d1a518c3bcd", "id": 6, "entity_id": 1, "account_id": 1, "currency_id": 2, "exchange_rate_id": 4, "transaction_date": "2022-10-21T16:00:54.000000Z", "reference": null, "transaction_no": "IN01/0001", "transaction_type": "IN", "narration": "suscipit", "credited": false, "compound": false, "main_account_amount": "0.0000", "original_amount": 116, "amount_cleared": 50, "clearable_Type": "Transaction", "age": 0, "date": "Oct 21, 2022", "uncleared_amount": 66, "transaction_name": "Client Invoice", "is_posted": true, "is_credited": false, "amount": 116, "tax": {"total": 16, "BDCAE": "16.0000"}, "assignable": false, "clearable": true, "has_integrity": true, "clearances": [{"uuid": "417c6a4a-5caf-4b77-b1d9-297c1b639577", "id": 2, "entity_id": 1, "transaction_id": 8, "forex_account_id": null, "assignment_date": "2022-09-24 01:16:08", "cleared_id": 6, "amount": "50.0000", "type": "Transaction"}], "line_items": [{"uuid": "1a57efb8-d085-49be-a4be-81e1f1f3e48c", "id": 2, "entity_id": 1, "account_id": 8, "transaction_id": 6, "narration": "Porro excepturi laborum incidunt enim dicta quia nesciunt assumenda.", "amount": "100.0000", "quantity": "1.0000", "tax_inclusive": false, "compound_tax": false, "entry_type": "DEBIT", "credited": true, "tax": {"total": 16, "BDCAE": "16.0000"}, "discount": {"total": 0}, "net_amount": 100, "has_withholding_tax": false, "has_gross_discount": false, "has_operations_discounts": false}], "assignments": []}], "schedule_balances": {"original_amount": 166, "amount_cleared": 65, "uncleared_amount": 101, "total_age": 365, "average_age": 183}}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/bdb94483-4952-4243-8cb7-99683f7ad75b/0/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
accountStatement
Retrieves a chronological list of Transactions posted for the account during the given period. Optional Query Parameters: | Parameter | Attributes | Notes | | --- | --- | --- | | start-date | optional, date | The earliest date of the Transactions to retrieve | | end-date | optional, date | The latest date of the Transactions to retrieve | | currency-id | optional, integer | Filter the Transactions by the Currency given |
200
null
{"status": "success", "statement": [{"id": 1, "transaction_date": "2022-10-21 15:58:18", "transaction_no": "CS05/0001", "reference": null, "transaction_type": "CS", "credited": false, "narration": "perspiciatis", "rate": "1.0000", "amount": 116, "balance": 186, "credit": 0, "debit": 116, "contribution": 116, "type": "Cash Sale", "date": "Oct 21, 2022"}, {"id": 4, "transaction_date": "2022-10-21 15:58:18", "transaction_no": "CE05/0001", "reference": null, "transaction_type": "CE", "credited": false, "narration": "consequatur", "rate": "1.0000", "amount": 50, "balance": 136, "credit": 50, "debit": 0, "contribution": -50, "type": "Contra Entry", "date": "Oct 21, 2022"}], "statement_balances": {"opening": 70, "closing": 136}}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/73c909eb-8ec4-40dd-93a3-789beb3e1ed5/0/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
assignments
Retrieves Assignments (Transactions that have been cleared by) of the Transaction with the passed in Id.
200
null
{"status": "success", "assignments": [{"uuid": "1f3d4602-2728-4bd3-8a11-c1357e495958", "id": 1, "entity_id": 1, "transaction_id": 1, "forex_account_id": null, "assignment_date": "2022-10-24 18:36:17", "cleared_id": 2, "amount": "50.0000", "type": "Transaction"}, {"uuid": "a7bb8810-e5a1-4e56-8827-1d071dc3c15d", "id": 2, "entity_id": 1, "transaction_id": 1, "forex_account_id": null, "assignment_date": "2022-10-24 18:36:17", "cleared_id": 3, "amount": "15.0000", "type": "Transaction"}]}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/04195509-cfd8-4946-81b2-7f0026ee77a1/0/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
removeItems
Removes the line items with the Ids in the line_item array from the Transaction. Parameters: | Parameters | Attributes | Notes | | --- | --- | --- | | transaction_type | required | Must be one of: IN CS CN RC CP BL DN PY CE JN (See Create/Update Transaction) | | line_items | required, array[integer] | A list of ids of already existing Line Items to be removed from the Transaction. |
400
null
{"status": "error", "errors": {"transaction": ["Cannot remove LineItems from a posted Transaction "]}}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/04195509-cfd8-4946-81b2-7f0026ee77a1/1/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
removeItems
Removes the line items with the Ids in the line_item array from the Transaction. Parameters: | Parameters | Attributes | Notes | | --- | --- | --- | | transaction_type | required | Must be one of: IN CS CN RC CP BL DN PY CE JN (See Create/Update Transaction) | | line_items | required, array[integer] | A list of ids of already existing Line Items to be removed from the Transaction. |
200
null
{"status": "success", "message": "Journal Entry: JN01/0001 for 0.00 LineItems removed successfully", "resource": {"uuid": "b101e406-3df1-4bfd-9f12-86f831e6e136", "id": 1, "entity_id": 1, "account_id": 1, "currency_id": 3, "exchange_rate_id": 2, "transaction_date": "2022-10-24T18:00:26.000000Z", "reference": "enim", "transaction_no": "JN01/0001", "transaction_type": "JN", "narration": "Qui temporibus aut ratione aliquam et sed tenetur.", "credited": true, "compound": false, "main_account_amount": "0.0000", "transaction_name": "Journal Entry", "is_posted": false, "is_credited": true, "amount": 0, "tax": {"total": 0}, "assignable": true, "clearable": true, "has_integrity": true, "line_items": [], "clearances": [], "assignments": []}}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/d8ac56ab-a72b-410c-b497-71160ff5e8d2/0/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
getAccount
Retrieves the Account with the passed in Id.
200
null
{"status": "success", "resource": {"uuid": "f277275e-7a8c-40c5-b3df-57fef9b6dd5a", "id": 1, "entity_id": 1, "category_id": 1, "currency_id": 1, "code": 6, "name": "Bulah Mante", "description": null, "type": "Control", "is_closed": false}}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/1a23472f-5936-4cab-b7eb-d2ec57575640/0/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
deleteAccount
Deletes the Account represented by the given Id.
400
null
{"status": "error", "errors": {"account_id": ["Account cannot be deleted because it has Transactions: (1), Line Items: (1), Taxes: (1) depending on it "]}}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/1a23472f-5936-4cab-b7eb-d2ec57575640/1/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
deleteAccount
Deletes the Account represented by the given Id.
200
null
{"status": "success", "message": "Payable: New Test Account deleted successfully"}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/5a002648-c1f7-4b94-88a6-23575c1a54b6/0/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
clearances
Retrieves Clearances (Transactions that have been used to clear) the Transaction with the passed in Id.
200
null
{"status": "success", "clearances": [{"uuid": "01864875-d756-4b93-9484-7230f1d9157d", "id": 1, "entity_id": 1, "transaction_id": 2, "forex_account_id": null, "assignment_date": "2022-10-24 18:40:36", "cleared_id": 1, "amount": "50.0000", "type": "Transaction"}, {"uuid": "107f55f8-ca4f-4adf-9ccd-af816bd53ec6", "id": 2, "entity_id": 1, "transaction_id": 3, "forex_account_id": null, "assignment_date": "2022-10-24 18:40:36", "cleared_id": 1, "amount": "15.0000", "type": "Transaction"}]}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/52a3a5b9-5725-4cbf-acab-dc77f4acc9a9/0/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
deleteTransactions
Deletes the Transaction represented by the given Id.
400
null
{"status": "error", "errors": {"transaction_id": ["Transaction cannot be deleted because it has Line Items: (2), Closing Transaction: (1) depending on it "]}}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/52a3a5b9-5725-4cbf-acab-dc77f4acc9a9/0/1
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
deleteTransactions
Deletes the Transaction represented by the given Id.
400
null
{"status": "error", "errors": {"transaction": ["Transaction cannot be deleted because it has been used to to Clear other Transactions "]}}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/52a3a5b9-5725-4cbf-acab-dc77f4acc9a9/0/2
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
deleteTransactions
Deletes the Transaction represented by the given Id.
400
null
{"status": "error", "errors": {"transaction": ["Cannot delete a posted Transaction "]}}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/52a3a5b9-5725-4cbf-acab-dc77f4acc9a9/1/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
deleteTransactions
Deletes the Transaction represented by the given Id.
200
null
{"status": "success", "message": "Journal Entry: JN01/0002 for 0.00 deleted successfully"}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/95405c3e-7536-411d-94e2-6f644f79cc3b/0/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
getCategories
Retrieves a paginated list of Categories associated with the logged-in user.
200
null
{"current_page": 1, "data": [{"uuid": "fe4839d4-faf5-4053-8940-c8f3cc07c8d9", "id": 1, "entity_id": 1, "name": "minus", "type": "Non Operating Revenue"}, {"uuid": "3f371586-9eb4-4f78-b1ed-235a87065ff5", "id": 2, "entity_id": 1, "name": "possimus", "type": "Operating Revenue"}], "first_page_url": "http://api.microbooks.io/books/v1/category?page=1", "from": 1, "last_page": 1, "last_page_url": "http://api.microbooks.io/books/v1/category?page=1", "links": [{"url": null, "label": "pagination.previous", "active": false}, {"url": "http://api.microbooks.io/books/v1/category?page=1", "label": "1", "active": true}, {"url": null, "label": "pagination.next", "active": false}], "next_page_url": null, "path": "http://api.microbooks.io/books/v1/category", "per_page": 5, "prev_page_url": null, "to": 2, "total": 2}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/7cb401c6-afa6-4d24-bb52-d9f2c8f98e04/0/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
getAccounts
Retrieves a paginated list of Accounts associated with the logged-in user.
200
null
{"current_page": 1, "data": [{"uuid": "f277275e-7a8c-40c5-b3df-57fef9b6dd5a", "id": 1, "entity_id": 1, "category_id": 1, "currency_id": 1, "code": 6, "name": "Bulah Mante", "description": null, "type": "Control", "is_closed": false}, {"uuid": "4035db2d-6ed7-41ee-8ff5-9684fdb060d0", "id": 2, "entity_id": 1, "category_id": 2, "currency_id": 1, "code": 2, "name": "Mr. Clyde Mante", "description": null, "type": "Other Expense", "is_closed": false}], "first_page_url": "http://api.microbooks.io/books/v1/account?page=1", "from": 1, "last_page": 1, "last_page_url": "http://api.microbooks.io/books/v1/account?page=1", "links": [{"url": null, "label": "pagination.previous", "active": false}, {"url": "http://api.microbooks.io/books/v1/account?page=1", "label": "1", "active": true}, {"url": null, "label": "pagination.next", "active": false}], "next_page_url": null, "path": "http://api.microbooks.io/books/v1/account", "per_page": 5, "prev_page_url": null, "to": 2, "total": 2}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/41b86137-ae82-408a-97e2-783115af6583/0/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
deleteCategory
Deletes the Category represented by the given Id.
200
null
{"status": "success", "message": "Operating Revenue Category: possimus deleted successfully"}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/41b86137-ae82-408a-97e2-783115af6583/1/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
deleteCategory
Deletes the Category represented by the given Id.
400
null
{"status": "error", "errors": {"category_id": ["Category cannot be deleted because it has Accounts: (1) depending on it "]}}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/0062ff91-227a-4df4-ba94-8fc09b2c14ce/0/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
updateCategory
Updates the Category represented by the given Id. Parameters: | Parameters | Attributes | Notes | | --- | --- | --- | | name | required, string | | | category_type | required | Must be a valid Account Type |
200
null
{"status": "success", "message": "Inventory Category: New Test Category updated successfully", "resource": {"uuid": "fe4839d4-faf5-4053-8940-c8f3cc07c8d9", "id": 1, "entity_id": 1, "name": "New Test Category", "type": "Inventory"}}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/51750ebd-4961-4471-9a9d-4ee7b8c153cb/0/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
lineItems
Retrieves the Line Items assiciated with the Transaction with the passed in Id.
200
null
{"status": "success", "line_items": [{"uuid": "8427f78b-2bb3-48ef-aef1-41ab3ceeff54", "id": 1, "entity_id": 1, "account_id": 4, "transaction_id": 1, "narration": "Voluptas molestias alias pariatur.", "amount": "50.0000", "quantity": "1.0000", "tax_inclusive": false, "compound_tax": false, "entry_type": "DEBIT", "credited": false, "tax": {"total": 0}, "discount": {"total": 0}, "net_amount": 50, "has_withholding_tax": false, "has_gross_discount": false, "has_operations_discounts": false}, {"uuid": "fd45fcfe-0cfe-4b11-a29e-08a6b8c011da", "id": 2, "entity_id": 1, "account_id": 6, "transaction_id": 1, "narration": "Tempora velit illo molestiae distinctio officiis id minus.", "amount": "50.0000", "quantity": "1.0000", "tax_inclusive": false, "compound_tax": false, "entry_type": "DEBIT", "credited": false, "tax": {"total": 0}, "discount": {"total": 0}, "net_amount": 50, "has_withholding_tax": false, "has_gross_discount": false, "has_operations_discounts": false}]}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/49a5f5ba-ba61-4a05-b55a-26247c61df2d/0/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
getTransaction
Retrieves the Transaction with the passed in Id.
200
null
{"status": "success", "resource": {"uuid": "30ef49eb-8a07-433a-a123-3dd127a55dcc", "id": 1, "entity_id": 1, "account_id": 1, "currency_id": 1, "exchange_rate_id": 1, "transaction_date": "2022-10-24T17:49:39.000000Z", "reference": null, "transaction_no": "JN01/0001", "transaction_type": "JN", "narration": "harum", "credited": true, "compound": false, "main_account_amount": "0.0000", "transaction_name": "Journal Entry", "is_posted": false, "is_credited": true, "amount": 50, "tax": {"total": 0}, "assignable": true, "clearable": true, "has_integrity": true, "line_items": [{"uuid": "33b78219-68fa-4cf8-8e97-0ba9ca930156", "id": 1, "entity_id": 1, "account_id": 2, "transaction_id": 1, "narration": null, "amount": "50.0000", "quantity": "1.0000", "tax_inclusive": false, "compound_tax": false, "entry_type": "DEBIT", "credited": false, "tax": {"total": 0}, "discount": {"total": 0}, "net_amount": 50, "has_withholding_tax": false, "has_gross_discount": false, "has_operations_discounts": false}], "clearances": [], "assignments": []}}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/cf8cfd73-007a-45fc-a9b7-283fb96e7a6b/0/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
getCategory
Retrieves the Category with the passed in Id.
200
null
{"status": "success", "resource": {"uuid": "fe4839d4-faf5-4053-8940-c8f3cc07c8d9", "id": 1, "entity_id": 1, "name": "minus", "type": "Non Operating Revenue"}}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/8bef4019-d4d3-4138-b5ac-0128dbf7b88c/0/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
removeDiscounts
Removes the Discounts with the Ids in thediscounts array from the Line Item. Parameters: | Parameters | Attributes | Notes | | --- | --- | --- | | discounts | required, array[integer] | A list of ids of already existing Discounts to be removed from the Line Item |
400
null
{"status": "error", "errors": {"transaction_id": ["Cannot remove Discount from a posted Transaction "]}}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/8bef4019-d4d3-4138-b5ac-0128dbf7b88c/1/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
removeDiscounts
Removes the Discounts with the Ids in thediscounts array from the Line Item. Parameters: | Parameters | Attributes | Notes | | --- | --- | --- | | discounts | required, array[integer] | A list of ids of already existing Discounts to be removed from the Line Item |
200
null
{"status": "success", "message": "LineItem: Test Account for 50 Discounts removed successfully", "resource": {"uuid": "18d072ff-ba13-4350-8ce8-b8d0827f05b7", "id": 1, "entity_id": 1, "account_id": 1, "transaction_id": 1, "narration": "Et facere voluptate numquam iusto eaque et asperiores sint.", "amount": "50.0000", "quantity": "1.0000", "tax_inclusive": false, "compound_tax": false, "entry_type": "DEBIT", "credited": false, "tax": {"total": 0}, "discount": {"total": 0}, "net_amount": 50, "has_withholding_tax": false, "has_gross_discount": false, "has_operations_discounts": false, "account": {"uuid": "ac2b4a58-7b74-41a4-95bd-dc2967936662", "id": 1, "entity_id": 1, "category_id": 1, "currency_id": 1, "code": 5, "name": "Test Account", "description": null, "type": "Current Liability", "is_closed": false}}}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/0ea4a4f5-99e6-4679-8c6d-3ca0df5df34b/0/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
categoryAccounts
Retrieves the Balances of the Accounts belonging to the Category with the passed in Id. Optional Query Parameters: | Parameter | Attributes | Notes | | --- | --- | --- | | start-date | optional, date | The earliest date of the Transactions in the balances to retrieve | | end-date | optional, date | The latest date of the Transactions in the balances to retrieve |
200
null
{"status": "success", "balances": {"total": 70, "accounts": [{"uuid": "121b6be5-0e3d-43ae-9a25-e47b46bc856e", "id": 1, "entity_id": 1, "category_id": 1, "currency_id": 1, "code": 501, "name": "Terrell Abbott IV", "description": null, "closingBalance": 70, "type": "Receivable", "is_closed": false}]}, "category_name": "Category One", "account_type": "Receivable"}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/beca0028-69be-4ac1-a99a-aa3266802fba/0/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
sectionMovement
Shows the change in balances for Accounts of type SECTION during the given period. Optional Query Parameters: | Parameter | Attributes | Notes | | --- | --- | --- | | start-date | optional, date | The earliest date of the Transactions in the balances to retrieve | | end-date | optional, date | The latest date of the Transactions in the balances to retrieve |
200
null
{"status": "success", "balances": {"section_opening_balance": 70, "section_closing_balance": 186, "section_movement": -116, "section_categories": {"facere": {"accounts": [{"uuid": "2eadaeb2-944f-4a9d-bdca-076a18e2f445", "id": 1, "entity_id": 1, "category_id": 1, "currency_id": 1, "code": 501, "name": "Leola Ferry", "description": null, "account_type": "Receivable", "opening_balance": 70, "balance_movement": 0, "closing_balance": 70}], "total": 70, "category_id": 1}, "vel": {"accounts": [{"uuid": "5fb5f2f0-3497-433d-a996-cc5f0048e7a6", "id": 2, "entity_id": 1, "category_id": 2, "currency_id": 1, "code": 502, "name": "Nathan Huel MD", "description": null, "account_type": "Receivable", "opening_balance": 0, "balance_movement": -116, "closing_balance": 116}], "total": 116, "category_id": 2}}}}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/7d0bedae-c79e-4e48-8218-7ab52bae1bcd/0/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
removeTaxes
Removes the Taxes with the Ids in the taxes array from the Line Item. Parameters: | Parameters | Attributes | Notes | | --- | --- | --- | | taxes | required, array[integer] | A list of ids of already existing Taxes to be removed from the Line Item |
400
null
{"status": "error", "errors": {"transaction_id": ["Cannot remove Tax from a posted Transaction "]}}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/7d0bedae-c79e-4e48-8218-7ab52bae1bcd/1/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
removeTaxes
Removes the Taxes with the Ids in the taxes array from the Line Item. Parameters: | Parameters | Attributes | Notes | | --- | --- | --- | | taxes | required, array[integer] | A list of ids of already existing Taxes to be removed from the Line Item |
200
null
{"status": "success", "message": "LineItem: Test Account for 50 Taxes removed successfully", "resource": {"uuid": "3ad21bc5-21f7-42d8-8dc0-0028c51a3efd", "id": 1, "entity_id": 1, "account_id": 1, "transaction_id": 1, "narration": "Rem mollitia ut officiis blanditiis.", "amount": "50.0000", "quantity": "1.0000", "tax_inclusive": false, "compound_tax": false, "entry_type": "DEBIT", "credited": false, "tax": {"total": 0}, "discount": {"total": 0}, "net_amount": 50, "has_withholding_tax": false, "has_gross_discount": false, "has_operations_discounts": false, "account": {"uuid": "eaebd366-8ce2-4e38-919d-bcfc8efe5419", "id": 1, "entity_id": 1, "category_id": 1, "currency_id": 1, "code": 0, "name": "Test Account", "description": null, "type": "Non Current Liability", "is_closed": false}}}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/4c2ec69a-0884-45f6-9f98-38a219fe0b25/0/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
getTaxes
Retrieves the Taxes associated with the Line Item with the passed in Id.
200
null
{"status": "success", "taxes": [{"applicable_id": 1, "amount": "2.5000", "name": "Camille Wilkinson", "code": "BADCE", "type": "Tax"}, {"applicable_id": 2, "amount": "2.5000", "name": "Miss Tiara Langworth", "code": "DBCEA", "type": "Tax"}]}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/95f1af38-fddf-4f18-99de-443f94d763b5/0/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
getTransactions
Retrieves a paginated list of Transactions associated with the logged-in user.
200
null
{"current_page": 1, "data": [{"uuid": "30ef49eb-8a07-433a-a123-3dd127a55dcc", "id": 1, "entity_id": 1, "account_id": 1, "currency_id": 1, "exchange_rate_id": 1, "transaction_date": "2022-10-24T17:49:39.000000Z", "reference": null, "transaction_no": "JN01/0001", "transaction_type": "JN", "narration": "harum", "credited": true, "compound": false, "main_account_amount": "0.0000", "transaction_name": "Journal Entry", "is_posted": false, "is_credited": true, "amount": 50, "tax": {"total": 0}, "assignable": true, "clearable": true, "has_integrity": true, "line_items": [{"uuid": "33b78219-68fa-4cf8-8e97-0ba9ca930156", "id": 1, "entity_id": 1, "account_id": 2, "transaction_id": 1, "narration": null, "amount": "50.0000", "quantity": "1.0000", "tax_inclusive": false, "compound_tax": false, "entry_type": "DEBIT", "credited": false, "tax": {"total": 0}, "discount": {"total": 0}, "net_amount": 50, "has_withholding_tax": false, "has_gross_discount": false, "has_operations_discounts": false}], "clearances": [], "assignments": []}], "first_page_url": "http://api.microbooks.io/books/v1/transaction?page=1", "from": 1, "last_page": 1, "last_page_url": "http://api.microbooks.io/books/v1/transaction?page=1", "links": [{"url": null, "label": "pagination.previous", "active": false}, {"url": "http://api.microbooks.io/books/v1/transaction?page=1", "label": "1", "active": true}, {"url": null, "label": "pagination.next", "active": false}], "next_page_url": null, "path": "http://api.microbooks.io/books/v1/transaction", "per_page": 5, "prev_page_url": null, "to": 1, "total": 1}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/aaa8bfc9-b751-4964-87bb-edbacbfed3a2/0/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
createCategory
Creates a Category. Parameters: | Parameters | Attributes | Notes | | --- | --- | --- | | name | required, string | | | category_type | required | Must be a valid Account Type (See Accounts) |
200
null
{"status": "success", "message": "Bank Category: Test Category created successfully", "resource": {"name": "Test Category", "entity_id": 1, "id": 3, "type": "Bank"}}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/c74f2746-7206-41dd-bac0-2ed4bddced64/0/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
addTaxes
Adds the Taxes with the Ids in the taxes array to the Line Item. Parameters: | Parameters | Attributes | Notes | | --- | --- | --- | | taxes | required, array[integer] | A list of ids of already existing Taxes to be added to the Line Item |
400
null
{"status": "error", "errors": {"transaction_id": ["Cannot add Tax to a posted Transaction "]}}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/c74f2746-7206-41dd-bac0-2ed4bddced64/0/1
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
addTaxes
Adds the Taxes with the Ids in the taxes array to the Line Item. Parameters: | Parameters | Attributes | Notes | | --- | --- | --- | | taxes | required, array[integer] | A list of ids of already existing Taxes to be added to the Line Item |
400
null
{"status": "error", "errors": {"applicable_id": ["Zero rated taxes cannot be applied to a compound tax Line Item "]}}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/c74f2746-7206-41dd-bac0-2ed4bddced64/0/2
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
addTaxes
Adds the Taxes with the Ids in the taxes array to the Line Item. Parameters: | Parameters | Attributes | Notes | | --- | --- | --- | | taxes | required, array[integer] | A list of ids of already existing Taxes to be added to the Line Item |
400
null
{"status": "error", "errors": {"applicable_id": ["Tax inclusive Line Items cannot have compound Tax "]}}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/c74f2746-7206-41dd-bac0-2ed4bddced64/0/3
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
addTaxes
Adds the Taxes with the Ids in the taxes array to the Line Item. Parameters: | Parameters | Attributes | Notes | | --- | --- | --- | | taxes | required, array[integer] | A list of ids of already existing Taxes to be added to the Line Item |
400
null
{"status": "error", "errors": {"applicable_id": ["Tax inclusive Line Items cannot have more than one Tax "]}}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/c74f2746-7206-41dd-bac0-2ed4bddced64/0/4
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
addTaxes
Adds the Taxes with the Ids in the taxes array to the Line Item. Parameters: | Parameters | Attributes | Notes | | --- | --- | --- | | taxes | required, array[integer] | A list of ids of already existing Taxes to be added to the Line Item |
400
null
{"status": "error", "errors": {"applicable_id": ["Withholding Tax must but be the only Tax on a Line Item "]}}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/c74f2746-7206-41dd-bac0-2ed4bddced64/1/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
addTaxes
Adds the Taxes with the Ids in the taxes array to the Line Item. Parameters: | Parameters | Attributes | Notes | | --- | --- | --- | | taxes | required, array[integer] | A list of ids of already existing Taxes to be added to the Line Item |
200
null
{"status": "success", "message": "LineItem: Test Account for 50 Taxes added successfully", "resource": {"uuid": "3ad21bc5-21f7-42d8-8dc0-0028c51a3efd", "id": 1, "entity_id": 1, "account_id": 1, "transaction_id": 1, "narration": "Rem mollitia ut officiis blanditiis.", "amount": "50.0000", "quantity": "1.0000", "tax_inclusive": false, "compound_tax": false, "entry_type": "DEBIT", "credited": false, "tax": {"total": 13, "DABEC": "8.0000", "ABCED": "5.0000"}, "discount": {"total": 0}, "net_amount": 50, "has_withholding_tax": false, "has_gross_discount": false, "has_operations_discounts": false, "account": {"uuid": "eaebd366-8ce2-4e38-919d-bcfc8efe5419", "id": 1, "entity_id": 1, "category_id": 1, "currency_id": 1, "code": 0, "name": "Test Account", "description": null, "type": "Non Current Liability", "is_closed": false}}}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/29bc0d5a-295d-4706-a8ed-bc0f8d4734ac/0/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
addDiscounts
Adds the Discounts with the Ids in the tdiscounts array to the Line Item. Parameters: | Parameters | Attributes | Notes | | --- | --- | --- | | discounts | required, array[integer] | A list of ids of already existing Discounts to the Line Item |
200
null
{"status": "success", "message": "LineItem: Test Account for 50 Discounts added successfully", "resource": {"uuid": "18d072ff-ba13-4350-8ce8-b8d0827f05b7", "id": 1, "entity_id": 1, "account_id": 1, "transaction_id": 1, "narration": "Et facere voluptate numquam iusto eaque et asperiores sint.", "amount": "50.0000", "quantity": "1.0000", "tax_inclusive": false, "compound_tax": false, "entry_type": "DEBIT", "credited": false, "tax": {"total": 0}, "discount": {"total": 4, "CABED": "4.0000"}, "net_amount": 46, "has_withholding_tax": false, "has_gross_discount": true, "has_operations_discounts": true, "account": {"uuid": "ac2b4a58-7b74-41a4-95bd-dc2967936662", "id": 1, "entity_id": 1, "category_id": 1, "currency_id": 1, "code": 5, "name": "Test Account", "description": null, "type": "Current Liability", "is_closed": false}}}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/29bc0d5a-295d-4706-a8ed-bc0f8d4734ac/1/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
addDiscounts
Adds the Discounts with the Ids in the tdiscounts array to the Line Item. Parameters: | Parameters | Attributes | Notes | | --- | --- | --- | | discounts | required, array[integer] | A list of ids of already existing Discounts to the Line Item |
400
null
{"status": "error", "errors": {"transaction_id": ["Cannot add Discount to a posted Transaction "]}}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/29bc0d5a-295d-4706-a8ed-bc0f8d4734ac/1/1
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
addDiscounts
Adds the Discounts with the Ids in the tdiscounts array to the Line Item. Parameters: | Parameters | Attributes | Notes | | --- | --- | --- | | discounts | required, array[integer] | A list of ids of already existing Discounts to the Line Item |
400
null
{"status": "error", "errors": {"applicable_id": ["Operation and Non - Operations Discounts cannot combined on the same Line Item "]}}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/70b38903-775d-4fa3-a678-d1ace860907c/0/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
closingTransactions
Retrieves the Closing Transactions Posted for the Account for the given year. Optional Query Parameters: | Parameter | Attributes | Notes | | --- | --- | --- | | year | optional, integer | The specific year whose Transactions to retrieve |
200
null
{"status": "success", "closing_transactions": [{"id": 3, "account_id": 2, "currency_id": 1, "reporting_period_id": 1, "credited": true, "transaction_type": "JN", "transaction_date": "2022-12-31 00:00:00", "narration": "JOD 2022 Forex Balance Translation", "amount": 0, "balance": 0, "credit": 0, "debit": 0, "contribution": 0, "type": "Journal Entry", "date": "Dec 31, 2022"}, {"id": 4, "account_id": 2, "currency_id": 1, "reporting_period_id": 1, "credited": false, "transaction_type": "JN", "transaction_date": "2022-12-31 00:00:00", "narration": "KPW 2022 Forex Balance Translation", "amount": 0, "balance": 0, "credit": 0, "debit": 0, "contribution": 0, "type": "Journal Entry", "date": "Dec 31, 2022"}]}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/9ce4c8d5-ae17-42e0-aa97-345769ad3692/0/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
getLineItems
Retrieves a paginated list of Line Items associated with the logged in user.
200
null
{"current_page": 1, "data": [{"uuid": "30758323-dbe4-4739-9f10-1367d106ca04", "id": 1, "entity_id": 1, "account_id": 4, "transaction_id": 1, "narration": "Consequatur dignissimos et harum est dolor autem quam.", "amount": "171.3125", "quantity": "97.0000", "tax_inclusive": false, "compound_tax": false, "entry_type": "DEBIT", "credited": false, "tax": {"total": 664.6925, "DCABE": "664.6925"}, "discount": {"total": 1036.9203, "BDCEA": "1036.9203"}, "net_amount": 15580.3922, "has_withholding_tax": false, "has_gross_discount": true, "has_operations_discounts": true}], "first_page_url": "http://api.microbooks.io/books/v1/line-item?page=1", "from": 1, "last_page": 1, "last_page_url": "http://api.microbooks.io/books/v1/line-item?page=1", "links": [{"url": null, "label": "pagination.previous", "active": false}, {"url": "http://api.microbooks.io/books/v1/line-item?page=1", "label": "1", "active": true}, {"url": null, "label": "pagination.next", "active": false}], "next_page_url": null, "path": "http://api.microbooks.io/books/v1/line-item", "per_page": 5, "prev_page_url": null, "to": 1, "total": 1}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/070d69b1-cbb0-42f4-b83f-6514e0f10676/0/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
deleteLineItem
Deletes the Line Item represented by the given Id.
400
null
{"status": "error", "errors": {"transaction_id": ["LineItem cannot be deleted because it has Taxes and Discounts: (1) depending on it "]}}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/070d69b1-cbb0-42f4-b83f-6514e0f10676/1/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
deleteLineItem
Deletes the Line Item represented by the given Id.
200
null
{"status": "success", "message": "LineItem: Dr. Mandy Haley for 100 deleted successfully"}
{"type": "object"}
6988cefe-3cc8-4c08-a77d-c2ee157cd571/8fbb1d6c-61f8-4782-baa2-3da6342b07ae/0/0
Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
5.1
getLineItem
Retrieves the Line Item with the passed in Id.
200
null
{"status": "success", "resource": {"uuid": "fdfced1a-7a4a-4553-9c78-96a37d04513b", "id": 1, "entity_id": 1, "account_id": 1, "transaction_id": null, "narration": null, "amount": "100.0000", "quantity": "1.0000", "tax_inclusive": false, "compound_tax": false, "entry_type": "DEBIT", "credited": false, "tax": {"total": 16, "BADCE": "16.0000"}, "discount": {"total": 0}, "net_amount": 100, "has_withholding_tax": false, "has_gross_discount": false, "has_operations_discounts": false}}
{"type": "object"}
3a17114c-b0c6-427a-bd5f-c0a831a4152e/7d6e735d-4a7e-499f-bc4e-6deeaf1b2af1/0/0
APITemplateio
APITemplate.io is the newest API-based platform designed to give you two powerful APIs for your media content generation β€” Image and PDF
null
create-image
This endpoint creates a JPEG file(along with PNG) with JSON data and your template
200
null
{"status": "success", "download_url": "https://bucket.s3.amazonaws.com/91f62769-69e4-48bf.jpeg", "download_url_png": "https://bucket.s3.amazonaws.com/91f62769-69e4-48bf.png", "template_id": "cd890b2b199c5c42", "transaction_ref": "a0430897-2c94-40e1-a09b-57403d811ceb"}
{"type": "object", "properties": {"status": {"type": "string", "description": "Status"}, "download_url": {"type": "string", "description": "Download URL"}, "download_url_png": {"type": "string", "description": "Download URL PNG"}, "template_id": {"type": "string", "description": "Template ID"}, "transaction_ref": {"type": "string", "description": "Transaction reference"}}}
3a17114c-b0c6-427a-bd5f-c0a831a4152e/9708e3f8-05ad-44a7-b51f-d567ef153265/0/0
APITemplateio
APITemplate.io is the newest API-based platform designed to give you two powerful APIs for your media content generation β€” Image and PDF
null
list-objects
Retrieves all the generated PDFs and images
200
null
{"status": "success", "objects": []}
{"type": "object", "properties": {"status": {"type": "string"}, "objects": {"type": "array"}}}
3a17114c-b0c6-427a-bd5f-c0a831a4152e/4e62fc26-6493-4dea-85ba-6ede005b0b27/0/0
APITemplateio
APITemplate.io is the newest API-based platform designed to give you two powerful APIs for your media content generation β€” Image and PDF
null
delete-object
Delete a PDF or an image from CDN and mark the transaction as deleted
200
null
{"status": "success"}
{"type": "object", "properties": {"status": {"type": "string"}, "transaction_ref": {}}}
3a17114c-b0c6-427a-bd5f-c0a831a4152e/b41abf0c-ac07-4051-b7c4-763ee91306ec/0/0
APITemplateio
APITemplate.io is the newest API-based platform designed to give you two powerful APIs for your media content generation β€” Image and PDF
null
list-templates
Retrieves the information of templates
200
null
{"status": "success", "templates": []}
{"type": "object", "properties": {"status": {"type": "string"}, "templates": {"type": "array"}}}
3a17114c-b0c6-427a-bd5f-c0a831a4152e/e250201f-5aab-43fe-b84c-75d629d59872/0/0
APITemplateio
APITemplate.io is the newest API-based platform designed to give you two powerful APIs for your media content generation β€” Image and PDF
null
create-pdf
This endpoint creates a PDF file with JSON data and your template. We support synchoronus and asynchronous PDF generation.
200
null
{"status": "success", "download_url": "https://bucket.s3.amazonaws.com/91f62769-69e4-48bf.jpeg", "template_id": "cd890b2b199c5c42", "transaction_ref": "a0430897-2c94-40e1-a09b-57403d811ceb"}
{"type": "object", "properties": {"status": {"type": "string", "description": "Status"}, "download_url": {"type": "string", "description": "Download URL"}, "template_id": {"type": "string", "description": "Template ID"}, "transaction_ref": {"type": "string", "description": "Transaction reference"}}}
3a17114c-b0c6-427a-bd5f-c0a831a4152e/20b2430c-6887-40ca-91c9-998f0bad6669/0/0
APITemplateio
APITemplate.io is the newest API-based platform designed to give you two powerful APIs for your media content generation β€” Image and PDF
null
merge-pdfs
This endpoint merges multiple PDF URLs
200
null
{"status": "success", "primary_url": "https://craftmypdf.com/output.pdf", "transaction_ref": "a0430897-2c94-40e1-a09b-57403d811ceb"}
{"type": "object", "properties": {"status": {"type": "string", "description": "Status"}, "primary_url": {"type": "string", "description": "Generated PDF document"}, "transaction_ref": {"type": "string", "description": "Transaction reference"}}}
e4f0f0db-66a7-4a0c-bfa8-98dacb45ddc1/27fc9764-d915-484a-8d50-7972d9454ac3/0/0
test1
penhw
null
endpoint1
test
200
New Example
{"key1": "", "key2": ""}
{"type": "object", "properties": {"key1": {"type": "string"}, "key2": {"type": "string"}}}
17e99011-4123-48a3-bdff-6877c92e8d02/98f85144-7092-4777-b54b-602f9f486944/0/0
Simple Lead Scoring for your CRM
️‍πŸ”₯ Simple Lead Scoring for your CRM
null
Get Simple Lead Score
This will take in key activites and responds with a score.
200
New Example
{"name": "[email protected]", "totalEmailSent": 7, "totalOpens": 5, "totalClicks": 0, "summary": "[email protected]'s activity score is 26.31578947368421. His max activity points is 19 and he got 5. \n Time score is 1. and Rating is \ud83d\udd25,\ud83d\udd25,\ud83d\udd25,\ud83d\udd25,\ud83d\udd25. His forgiveness time is 56 \n", "lastInteraction": "Fri Sep 03 2021 00:00:00 GMT-0400 (Eastern Daylight Time)", "lastEmailSent": "Thu Oct 14 2021 00:00:00 GMT-0400 (Eastern Daylight Time)", "maxActivityPoints": 19, "activityPoints": 5, "sinceLastEmailSent": {"days": 3, "hours": 1, "minutes": 32, "sec": 52}, "sinceLastInteraction": {"days": 44, "hours": 1, "minutes": 32, "sec": 52}, "skipStreak": 2, "timeScore": 1, "activityScore": 0.5263157894736842, "avgDelay": 37.333333333333336, "inactiveForgivenessTime": 56, "inactiveDays": 44, "isActive": 1, "delays": [13, 61, 92, 16, 40, 2], "rating": 3.526315789473684, "fire": "\ud83d\udd25\ud83d\udd25\ud83d\udd25"}
{"type": "object", "properties": {"name": {"type": "string"}, "totalEmailSent": {"type": "integer"}, "totalOpens": {"type": "integer"}, "totalClicks": {"type": "integer"}, "summary": {"type": "string"}, "lastInteraction": {"type": "string"}, "lastEmailSent": {"type": "string"}, "maxActivityPoints": {"type": "integer"}, "activityPoints": {"type": "integer"}, "sinceLastEmailSent": {"type": "object", "properties": {"days": {"type": "integer"}, "hours": {"type": "integer"}, "minutes": {"type": "integer"}, "sec": {"type": "integer"}}}, "sinceLastInteraction": {"type": "object", "properties": {"days": {"type": "integer"}, "hours": {"type": "integer"}, "minutes": {"type": "integer"}, "sec": {"type": "integer"}}}, "skipStreak": {"type": "integer"}, "timeScore": {"type": "integer"}, "activityScore": {"type": "number"}, "avgDelay": {"type": "number"}, "inactiveForgivenessTime": {"type": "integer"}, "inactiveDays": {"type": "integer"}, "isActive": {"type": "integer"}, "delays": {"type": "array", "items": {"type": "integer"}}, "rating": {"type": "number"}, "fire": {"type": "string"}}}
520dac54-19b2-4a1e-a117-8afe3e8d3e37/e48461a2-9b56-4cb1-b199-853a48edbfd1/0/0
newAPI
Description
null
dat
a
502
Response
{"messages": "The API is unreachable, please contact the API provider", "info": "Your Client (working) ---> Gateway (working) ---> API (not working)"}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"messages": {"type": "string"}, "info": {"type": "string"}}, "required": ["info", "messages"]}
520dac54-19b2-4a1e-a117-8afe3e8d3e37/e48461a2-9b56-4cb1-b199-853a48edbfd1/1/0
newAPI
Description
null
dat
a
200
New Example
{"key1": "value", "key2": "1"}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"key1": {"type": "string"}, "key2": {"type": "string"}}, "required": ["key1", "key2"]}
262c31c6-dfca-42fb-94cb-7cf70a22c580/0869724c-7e11-44f4-8217-b119c026af41/0/0
ROAC
API ROAC
7
/api/Auditores/roac/{roac}Sociedad
asd
200
Example_1
{"documento": "33345107Y", "codigoROAC": "23072", "idTipoDocumento": "1", "nombre": "CARMEN", "apellidos": "VAZQUEZ PE\u00d1A", "razonSocial": null, "fechaAlta": "2014-09-10", "fechaBaja": null}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"documento": {"type": "string"}, "codigoROAC": {"type": "string"}, "idTipoDocumento": {"type": "string"}, "nombre": {"type": "string"}, "apellidos": {"type": "string"}, "razonSocial": {"type": "null"}, "fechaAlta": {"type": "string"}, "fechaBaja": {"type": "null"}}, "required": ["apellidos", "codigoROAC", "documento", "fechaAlta", "fechaBaja", "idTipoDocumento", "nombre", "razonSocial"]}
b89de5d5-c39b-477b-a60c-16a69287bca1/841ddf9f-6de7-4897-a19a-46f7d56cc3ed/0/0
New Cryptocurrencies Listings
API that shows new cryptocurrencies listings on exchanges
0.2
News
Returns latest news from all supported exchanges
200
Response
{"anounsments": [{"date": "2022-02-06 14:06", "news_url": "https://www.gate.io/article/25079", "source_name": "Gate.IO", "text": "About Gate.io Startup Free Airdrop Program In order to reward platform users, Gate.io launched the \"Startup Project Free Airdrop Program\", and free airdrops for blockchain excellent projects are launched in the Startup area from time to time. VIP and GT users can get a variety of tokens airdrop bene...", "title": "Gate.io Startup Free Offering: KingdomX(KT)and Announcement of Free Distribution Rules( 2,500,000KT free of charge)"}, {"date": "2022-01-29 13:12", "news_url": "https://www.binance.com/ru/support/announcement/457d640465bb4a74a5da8226a3e82788", "source_name": "Binance", "text": ".css-14vs3o1{box-sizing:border-box;margin:0;min-width:0;color:#0e101a;}28.01.2022 \u0432 15:00 (\u043c\u0441\u043a) \u043f\u043b\u0430\u0442\u0444\u043e\u0440\u043c\u0430 Binance Staking \u0437\u0430\u043f\u0443\u0441\u0442\u0438\u0442 \u0441\u0435\u0440\u0438\u044e \u043d\u043e\u0432\u044b\u0445 \u043f\u0440\u043e\u043c\u043e\u0430\u043a\u0446\u0438\u0439 \u0432\u044b\u0441\u043e\u043a\u043e\u0434\u043e\u0445\u043e\u0434\u043d\u043e\u0433\u043e \u0444\u0438\u043a\u0441\u0438\u0440\u043e\u0432\u0430\u043d\u043d\u043e\u0433\u043e \u0441\u0442\u0435\u0439\u043a\u0438\u043d\u0433\u0430 SAND \u0441 \u043c\u0430\u0441\u0441\u043e\u0439 \u0432\u043e\u0437\u043d\u0430\u0433\u0440\u0430\u0436\u0434\u0435\u043d\u0438\u0439. ", "title": "\u0421\u043f\u0435\u0446\u0438\u0430\u043b\u044c\u043d\u043e\u0435 \u043f\u0440\u0435\u0434\u043b\u043e\u0436\u0435\u043d\u0438\u0435 \u0434\u043b\u044f \u0441\u0442\u0435\u0439\u043a\u0438\u043d\u0433\u0430 SAND: \u0434\u043e\u0445\u043e\u0434\u043d\u043e\u0441\u0442\u044c \u0434\u043e 24,50% \u0433\u043e\u0434\u043e\u0432\u044b\u0445 \u0438 \u043f\u0440\u0438\u0437\u043e\u0432\u043e\u0439 \u0444\u043e\u043d\u0434 \u0432 18900SAND"}, {"date": "2022-01-30 15:04", "news_url": "https://www.binance.com/ru/support/announcement/d3fdcc3097b0477dbd982989c7d1b55c", "source_name": "Binance", "text": "\u0420\u0435\u0444\u0435\u0440\u0430\u043b\u044c\u043d\u0430\u044f \u043f\u0440\u043e\u0433\u0440\u0430\u043c\u043c\u0430 .css-li4l4s{box-sizing:border-box;margin:0;min-width:0;display:inline;color:#F0B90B;}.css-li4l4s:visited{color:#F0B90B;}.css-li4l4s:hover{color:#F0B90B;opacity:0.5;}.css-1f5vusx{box-sizing:border-box;margin:0;min-width:0;color:#1155cc;}\u0441\u0432\u043e\u043f-\u0444\u0430\u0440\u043c\u0438\u043d\u0433\u0430\u00a0\u2014 \u044d\u0442\u043e \u0432\u043e\u0437\u043c\u043e\u0436\u043d\u043e\u0441\u0442\u044c \u043f\u043e\u043b\u0443\u0447\u0438\u0442\u044c \u0431\u043e\u043d\u0443\u0441 \u0434\u043e 200\u00a0BUSD. \u041f\u0440\u0438 \u044d\u0442\u043e\u043c \u043a\u0430\u0436\u0434\u044b\u0439 \u0438\u0437 \u0432\u0430\u0448\u0438\u0445 \u0441\u043e\u043e\u0442\u0432\u0435\u0442\u0441\u0442\u0432\u0443\u044e\u0449\u0438\u0445 \u0442\u0440\u0435\u0431\u043e\u0432\u0430\u043d\u0438\u044f\u043c \u0440\u0435\u0444\u0435\u0440\u0430\u043b\u043e\u0432 \u043f\u043e\u043b\u0443\u0447\u0438\u0442 5\u00a0BUSD. \u041a\u043e\u043b\u0438\u0447\u0435\u0441\u0442\u0432\u043e \u0434\u0440\u0443\u0437\u0435\u0439, \u043a\u043e\u0442\u043e\u0440\u044b\u0445 \u043c\u043e\u0436\u043d\u043e \u043f\u0440\u0438\u0433\u043b\u0430\u0441\u0438\u0442\u044c, \u043d\u0435 \u043e\u0433\u0440\u0430\u043d\u0438\u0447\u0435\u043d\u043e. \u0410 \u0437\u043d\u0430\u0447\u0438\u0442, \u0447\u0435\u043c \u0431\u043e\u043b\u044c\u0448\u0435 \u0434\u0440\u0443\u0437\u0435\u0439, \u0442\u0435\u043c \u0431\u043e\u043b\u044c\u0448\u0435 \u0432\u0430\u0448 \u0431\u043e\u043d\u0443\u0441! \u042d\u0442\u0430 \u043f\u0440\u043e\u043c\u043e\u0430\u043a\u0446\u0438\u044f \u0434\u043e\u0441\u0442\u0443\u043f\u043d\u0430 \u0442\u043e\u043b\u044c\u043a\u043e \u0432 \u0442\u0435\u0447\u0435\u043d\u0438\u0435 \u043e\u0434\u043d\u043e\u0433\u043e \u043c\u0435\u0441\u044f\u0446\u0430.", "title": "\u0420\u0435\u0444\u0435\u0440\u0430\u043b\u044c\u043d\u0430\u044f \u043f\u0440\u043e\u0433\u0440\u0430\u043c\u043c\u0430 \u0441\u0432\u043e\u043f-\u0444\u0430\u0440\u043c\u0438\u043d\u0433\u0430 Binance: \u043f\u0440\u0438\u0433\u043b\u0430\u0441\u0438\u0442\u0435 \u0434\u0440\u0443\u0437\u0435\u0439 \u0438 \u043f\u043e\u043b\u0443\u0447\u0438\u0442\u0435 \u0434\u043e 200BUSD"}, {"date": "2021-03-09 06:18", "news_url": "https://www.huobi.com/support/ru-ru/detail/900004831346", "source_name": "Huobi", "text": "\u042d\u043a\u0441\u043a\u043b\u044e\u0437\u0438\u0432\u043d\u044b\u0439 \u0442\u043e\u0440\u0433\u043e\u0432\u044b\u0439 \u043a\u043e\u043d\u043a\u0443\u0440\u0441 \u0434\u043b\u044f \u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u0442\u0435\u043b\u0435\u0439 \u0438\u0437 \u0421\u041d\u0413 + \u0440\u043e\u0437\u044b\u0433\u0440\u044b\u0448 iPhone 12 Pro", "title": "\u042d\u043a\u0441\u043a\u043b\u044e\u0437\u0438\u0432\u043d\u044b\u0439 \u0442\u043e\u0440\u0433\u043e\u0432\u044b\u0439 \u043a\u043e\u043d\u043a\u0443\u0440\u0441 \u0434\u043b\u044f \u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u0442\u0435\u043b\u0435\u0439 \u0438\u0437 \u0421\u041d\u0413 + \u0440\u043e\u0437\u044b\u0433\u0440\u044b\u0448 iPhone 12 Pro"}, {"date": "2022-01-24 18:00:46", "news_url": "https://www.kucoin.com/news/kucoin-supports-on-site-sepa-deposit-eur-and-trade-to-share-over-400000-usdt", "source_name": "KuCoin", "text": "Dear KuCoin Users, We are happy to announce that the KuCoin Fiat Account will support the on-site SEPA payment method starting on January 24, 2022 (UTC) to offer European customers the Easiest Fiat-On-Ramp Service! KuCoin on-site SEPA currently supports deposits of EUR to buy USDT. In the near future, KuCoin will support SEPA withdrawal and more cryptocurrencies and services!", "title": "KuCoin Supports On-Site SEPA: Deposit EUR and Trade To Share Over 400,000 USDT! \nDear KuCoin Users, We are happy to announce that the KuCoin Fiat Account will support the on-site SEPA payment method starting on January 24, 2022 (UTC) to offer European customers the Easiest Fiat-On-Ramp Service! KuCoin on-site SEPA currently supports deposits of EUR to buy USDT. In the near future, KuCoin will support SEPA withdrawal and more cryptocurrencies and services!"}, {"date": "2022-01-25 00:00", "news_url": "https://blog.kraken.com/post/12671/mango-mngo-kin-kin-orca-orca-star-atlas-atlas-polis-bonfida-fida-step-finance-step-saber-sbr-trading-start-january-27-deposit-now/", "source_name": "Kraken", "text": "Mango (MNGO), Kin (KIN), Orca (ORCA), Star Atlas (ATLAS & POLIS), Bonfida (FIDA), Step Finance (STEP), Saber (SBR) Trading Start January 27 \u2013 Deposit Now", "title": "Mango (MNGO), Kin (KIN), Orca (ORCA), Star Atlas (ATLAS & POLIS), Bonfida (FIDA), Step Finance (STEP), Saber (SBR) Trading Start January 27 \u2013 Deposit Now"}, {"date": "2022-02-04 09:22", "news_url": "https://www.gate.io/article/25078", "source_name": "Gate.IO", "text": "Gate.io is currently holding a KNIGHT trading competition. It will start on Feb 5th 09:00 UTC to Feb 12th 09:00 UTC, 2022. We have a pool of $12,300 in rewards for users who trade KNIGHT . New users need to sign up Gate.io to participate.Click to Submit Your UID & Join Immediately Compet...", "title": "Gate.io Forest Knight(KNIGHT) Trading Competition & $12,300 Unmissable Rewards"}, {"date": "2022-02-03 12:42", "news_url": "https://www.gate.io/article/25077", "source_name": "Gate.IO", "text": "Gate.io HODL& Earn will launch its 54th shark fin structured product\u201cShark Fin BTC 6-Day No.54\u201d on Feb 5th, at 10:00 AM UTC, with an estimated return of 3%-16% P.A. The total lock-up amount is capped at 300 BTC, with a lock-up period of 6 days. The shark fin product is principal protected....", "title": "Gate.io HODL& Earn Launches \u201cSharkFin BTC 6-Day No.54\u201d, Estimated Reward of 3%-16% P.A."}, {"date": "2022-02-03 02:31", "news_url": "https://www.gate.io/article/25076", "source_name": "Gate.IO", "text": "[Monday's Delight Red Packet] is a special event that will be held in the chatroom every Monday starting from March 8, 2021.To celebrate the Chinese Lunar New Year next monday, Gate.io will launch a special Lunar New Year event in the Chat Room. Don\u2019t miss out as we will be releasing waves of...", "title": "Gate.io $25,000 Lunar New Year Red Packets Up For Grabs. Join Us !"}, {"date": "2022-02-02 04:57", "news_url": "https://www.gate.io/article/25075", "source_name": "Gate.IO", "text": "1 Perion (PERC)Token Sale Result The Gate.io Startup Perion (PERC)sale result is as follows: PERC Startup Sale Amount: 83,333 PERC Total value of orders (in USDT): 57,210,020 USDT Total value of qualified orders (in USDT): 56,688,120 USDT Number of orders:19,856 Number of Qualified...", "title": "Gate.io Startup:Perion (PERC) Initial Sale Result & Listing Schedule"}], "status": "ok"}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"anounsments": {"type": "array", "items": {"type": "object", "properties": {"date": {"type": "string"}, "news_url": {"type": "string"}, "source_name": {"type": "string"}, "text": {"type": "string"}, "title": {"type": "string"}}, "required": ["date", "news_url", "source_name", "text", "title"]}}, "status": {"type": "string"}}, "required": ["anounsments", "status"]}
b89de5d5-c39b-477b-a60c-16a69287bca1/5ab377b5-400e-4d3b-ba55-e15bb978af2d/0/0
New Cryptocurrencies Listings
API that shows new cryptocurrencies listings on exchanges
0.2
Asset Info
Accepts a coin ticker as an input, returns a list of exchanges where the coin is traded and prices for this coin Note: default value for limit is 10
200
New Example
{"exchanges": [{"exchange": "Binance", "priceUSD": "60952.8372094008475189", "volumePercent": "13.0852283887680387"}, {"exchange": "Crypto.com Exchange", "priceUSD": "60959.7559288755595625", "volumePercent": "10.2567954807001525"}, {"exchange": "Huobi", "priceUSD": "60946.2388937223594774", "volumePercent": "4.1159650015969988"}, {"exchange": "ZB", "priceUSD": "60964.1915189295355904", "volumePercent": "3.8310688437796778"}, {"exchange": "HitBTC", "priceUSD": "60941.9735181851274506", "volumePercent": "3.3794612471541566"}, {"exchange": "Okex", "priceUSD": "60978.1491093025436782", "volumePercent": "3.2534788069073084"}, {"exchange": "Bitrue", "priceUSD": "60999.9565926830398154", "volumePercent": "2.3753612832905142"}, {"exchange": "Kucoin", "priceUSD": "61061.4540963207842024", "volumePercent": "2.1971319384864013"}, {"exchange": "WhiteBIT", "priceUSD": "60919.9357445760953119", "volumePercent": "2.1768459717312195"}, {"exchange": "Coinbene", "priceUSD": "60987.4308067744077366", "volumePercent": "2.0897091711501554"}], "status": "ok"}
{"type": "object", "properties": {"exchanges": {"type": "array", "items": {"type": "object", "properties": {"exchange": {"type": "string"}, "priceUSD": {"type": "string"}, "volumePercent": {"type": "string"}}}}, "status": {"type": "string"}}}
b89de5d5-c39b-477b-a60c-16a69287bca1/d83c1e35-e7ce-491d-a145-1dbedcd3db74/0/0
New Cryptocurrencies Listings
API that shows new cryptocurrencies listings on exchanges
0.2
Set Alert
You can send your email address and for new listings, it will send notifications, if there are no errors it will return status: ok and send a test letter to the email address. Later you will receive an email if new coins start listing at supported exchanges
200
New Example
{"status": "ok"}
{"type": "object", "properties": {"status": {"type": "string"}}}
b89de5d5-c39b-477b-a60c-16a69287bca1/81b7f755-f9f5-463d-b008-204b9ae94237/0/0
New Cryptocurrencies Listings
API that shows new cryptocurrencies listings on exchanges
0.2
Supported Exchanges
Returns a list of exchanges from which we receive data
200
New Example
{"exchanges": ["Binance", "Huobi Global(will be supported from 31.10.2021)"], "status": "ok"}
{"type": "object", "properties": {"exchanges": {"type": "array", "items": {"type": "string"}}, "status": {"type": "string"}}}
b89de5d5-c39b-477b-a60c-16a69287bca1/da5a4264-8e58-4f7a-b9ea-6d29cf096107/0/0
New Cryptocurrencies Listings
API that shows new cryptocurrencies listings on exchanges
0.2
New Listings
Returns new listings on biggest exchanges(now just Binance, but I'll fix it later) - status: "ok" or "error" - anounsments: list of crypto announcements -- date: date of announcement at the exchange -- text: text of the announcement from the exchange -- title: title of the announcement from the exchange -- topic: - -- ticker: ticker of new currency -- news_url: URL of the announcement -- news_type: - -- sentiment: - -- source_name: name of the exchange Note: updates every 10 minutes
200
New Example
{"status": "ok", "anounsments": [{"date": "2021-11-24 01:59", "text": "Binance will list Tribe (TRIBE) and will open trading for TRIBE/BTC, TRIBE/BNB, TRIBE/BUSD and TRIBE/USDT trading pairs at 2021-11-24 06:00 (UTC).", "title": "Binance Will List Tribe (TRIBE)", "topic": "", "ticker": "TRIBE", "news_url": "https://www.binance.com/en/support/announcement/d22b03e28ba64f3cbde5e8a0aea55c66", "news_type": "", "sentiment": "", "source_name": "Binance"}]}
{"type": "object", "properties": {"status": {"type": "string"}, "anounsments": {"type": "array", "items": {"type": "object", "properties": {"date": {"type": "string"}, "text": {"type": "string"}, "title": {"type": "string"}, "topic": {"type": "string"}, "ticker": {"type": "string"}, "news_url": {"type": "string"}, "news_type": {"type": "string"}, "sentiment": {"type": "string"}, "source_name": {"type": "string"}}}}}}
face5204-464c-4a2d-a60d-15e0119b39d4/5f47ab08-0e14-426e-b0cd-b2eca01de839/1/0
AntTools
Some tools that I make in my free time! If something doesn't work just send me an email to: [email protected]
7.5
Convert PDF to ZPL
Receives a PDF file and returns the desired ZPL code.
200
Success
{"key1": "value", "key2": "value"}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"key1": {"type": "string"}, "key2": {"type": "string"}}, "required": ["key1", "key2"]}
87868806-7343-4ad2-a5ce-2afe45b7a065/6ec63c60-ba2c-447f-b999-e043ec0aaba0/0/0
XLSX Template
Template (xlsx) + Data (json) ➞ Document. You can create xlsx document or pdf file with template and json data. Home page: https://xlsx-template.kurukona.net/ Live demo: https://xlsx-template.kurukona.net/developer/ Docuemnts: https://xlsx-template.kurukona.net/docs/
8
Send mail (mailConfig and base64)
Send mail with generated XLSX or PDF files by mailConfigId and base64 template file mailConfigId with base64
200
Example_1
{"accepted": ["[email protected]"], "rejected": ["[email protected]"], "envelopeTime": 262, "messageTime": 1130, "messageSize": 85106, "response": "250 2.0.0 OK 1668905587 q13-20020aa7960d000000b0054ee4b632dasm5659558pfg.169 - gsmtp", "envelope": {"from": "[email protected]", "to": ["[email protected]"]}, "messageId": "<[email protected]>"}
{"type": "object", "properties": {"accepted": {"type": "array", "items": {"type": "string"}}, "rejected": {"type": "array", "items": {"type": "string"}}, "envelopeTime": {"type": "integer"}, "messageTime": {"type": "integer"}, "messageSize": {"type": "integer"}, "response": {"type": "string"}, "envelope": {"type": "object", "properties": {"from": {"type": "string"}, "to": {"type": "array", "items": {"type": "string"}}}}, "messageId": {"type": "string"}}, "description": "https://nodemailer.com/usage/#sending-mail"}
87868806-7343-4ad2-a5ce-2afe45b7a065/7941d583-6844-4096-81c0-e1c4f4465f20/0/0
XLSX Template
Template (xlsx) + Data (json) ➞ Document. You can create xlsx document or pdf file with template and json data. Home page: https://xlsx-template.kurukona.net/ Live demo: https://xlsx-template.kurukona.net/developer/ Docuemnts: https://xlsx-template.kurukona.net/docs/
8
Send mail (mailConfigId with base64)
Send mail with generated XLSX or PDF files by mailConfigId and base64 template file mailConfigId with base64
200
Example_1
{"accepted": ["[email protected]"], "rejected": ["[email protected]"], "envelopeTime": 262, "messageTime": 1130, "messageSize": 85106, "response": "250 2.0.0 OK 1668905587 q13-20020aa7960d000000b0054ee4b632dasm5659558pfg.169 - gsmtp", "envelope": {"from": "[email protected]", "to": ["[email protected]"]}, "messageId": "<[email protected]>"}
{"type": "object", "properties": {"accepted": {"type": "array", "items": {"type": "string"}}, "rejected": {"type": "array", "items": {"type": "string"}}, "envelopeTime": {"type": "integer"}, "messageTime": {"type": "integer"}, "messageSize": {"type": "integer"}, "response": {"type": "string"}, "envelope": {"type": "object", "properties": {"from": {"type": "string"}, "to": {"type": "array", "items": {"type": "string"}}}}, "messageId": {"type": "string"}}, "description": "https://nodemailer.com/usage/#sending-mail"}
87868806-7343-4ad2-a5ce-2afe45b7a065/3dd2e1dd-7de0-4125-8448-191fc33e5313/0/0
XLSX Template
Template (xlsx) + Data (json) ➞ Document. You can create xlsx document or pdf file with template and json data. Home page: https://xlsx-template.kurukona.net/ Live demo: https://xlsx-template.kurukona.net/developer/ Docuemnts: https://xlsx-template.kurukona.net/docs/
8
Send mail (mailConfigId)
Send mail with generated XLSX or PDF files by mailConfigId
200
Example_1
{"accepted": ["[email protected]"], "rejected": ["[email protected]"], "envelopeTime": 262, "messageTime": 1130, "messageSize": 85106, "response": "250 2.0.0 OK 1668905587 q13-20020aa7960d000000b0054ee4b632dasm5659558pfg.169 - gsmtp", "envelope": {"from": "[email protected]", "to": ["[email protected]"]}, "messageId": "<[email protected]>"}
{"type": "object", "properties": {"accepted": {"type": "array", "items": {"type": "string"}}, "rejected": {"type": "array", "items": {"type": "string"}}, "envelopeTime": {"type": "integer"}, "messageTime": {"type": "integer"}, "messageSize": {"type": "integer"}, "response": {"type": "string"}, "envelope": {"type": "object", "properties": {"from": {"type": "string"}, "to": {"type": "array", "items": {"type": "string"}}}}, "messageId": {"type": "string"}}, "description": "https://nodemailer.com/usage/#sending-mail"}
87868806-7343-4ad2-a5ce-2afe45b7a065/789e85f4-9eff-4d1b-806f-d33da10d35b2/0/0
XLSX Template
Template (xlsx) + Data (json) ➞ Document. You can create xlsx document or pdf file with template and json data. Home page: https://xlsx-template.kurukona.net/ Live demo: https://xlsx-template.kurukona.net/developer/ Docuemnts: https://xlsx-template.kurukona.net/docs/
8
Send mail (mailConfig)
Send mail with generated XLSX or PDF files by mailConfig mailConfig
200
Example_1
{"accepted": ["[email protected]"], "rejected": ["[email protected]"], "envelopeTime": 262, "messageTime": 1130, "messageSize": 85106, "response": "250 2.0.0 OK 1668905587 q13-20020aa7960d000000b0054ee4b632dasm5659558pfg.169 - gsmtp", "envelope": {"from": "[email protected]", "to": ["[email protected]"]}, "messageId": "<[email protected]>"}
{"type": "object", "properties": {"accepted": {"type": "array", "items": {"type": "string"}}, "rejected": {"type": "array", "items": {"type": "string"}}, "envelopeTime": {"type": "integer"}, "messageTime": {"type": "integer"}, "messageSize": {"type": "integer"}, "response": {"type": "string"}, "envelope": {"type": "object", "properties": {"from": {"type": "string"}, "to": {"type": "array", "items": {"type": "string"}}}}, "messageId": {"type": "string"}}, "description": "https://nodemailer.com/usage/#sending-mail"}
87868806-7343-4ad2-a5ce-2afe45b7a065/6b313419-4b34-4653-908d-5070f0880689/0/0
XLSX Template
Template (xlsx) + Data (json) ➞ Document. You can create xlsx document or pdf file with template and json data. Home page: https://xlsx-template.kurukona.net/ Live demo: https://xlsx-template.kurukona.net/developer/ Docuemnts: https://xlsx-template.kurukona.net/docs/
8
Mail config List
Get mail config list from cloud database
200
Example_1
[{"host": "smtp.example.com", "port": 587, "secure": true, "auth": {"user": "username", "pass": "pass"}, "generatedAt": "2022-11-21T00:38:43.478Z", "mailConfigId": "slB2bozM2fVk5KirxyMq"}]
{"type": "array", "items": {"allOf": [{"type": "object", "properties": {"host": {"type": "string"}, "port": {"type": "integer"}, "secure": {"type": "boolean"}, "auth": {"type": "object", "properties": {"user": {"type": "string"}, "pass": {"type": "string"}}}}, "description": "https://nodemailer.com/smtp/#examples"}, {"properties": {"generatedAt": {"type": "string"}, "mailConfigId": {"type": "string", "description": "Cloud stored mail config id"}}}]}}
87868806-7343-4ad2-a5ce-2afe45b7a065/03dcdc48-f59c-4e2c-baa7-111dd34e892a/0/0
XLSX Template
Template (xlsx) + Data (json) ➞ Document. You can create xlsx document or pdf file with template and json data. Home page: https://xlsx-template.kurukona.net/ Live demo: https://xlsx-template.kurukona.net/developer/ Docuemnts: https://xlsx-template.kurukona.net/docs/
8
Generate historys
Generated files history
200
Example_1
[{"generatedFiles": [{"filename": "downloadThisName.pdf", "pdf": {"size": 47183, "serverTimingMs": 1479}, "xlsx": {"size": 47183, "serverTimingMs": 1479}}], "remoteIp": "111.32.128.11", "serverTimingMs": 1978, "serverTimingSec": 2, "generatedAt": "2022-11-21T00:38:43.478Z"}]
{"type": "array", "items": {"type": "object", "properties": {"generatedFiles": {"type": "array", "items": {"type": "object", "properties": {"filename": {"type": "string"}, "pdf": {"type": "object", "properties": {"size": {"type": "integer", "description": "byte"}, "serverTimingMs": {"type": "integer", "description": "milliseconds"}}}, "xlsx": {"type": "object", "properties": {"size": {"type": "integer", "description": "byte"}, "serverTimingMs": {"type": "integer", "description": "milliseconds"}}}}}}, "remoteIp": {"type": "string", "description": "Api call remote ip"}, "serverTimingMs": {"type": "integer", "description": "milliseconds"}, "serverTimingSec": {"type": "integer", "description": "seconds"}, "generatedAt": {"type": "string"}}}}
87868806-7343-4ad2-a5ce-2afe45b7a065/c76a925e-101e-4acb-90a3-2804478acb48/0/0
XLSX Template
Template (xlsx) + Data (json) ➞ Document. You can create xlsx document or pdf file with template and json data. Home page: https://xlsx-template.kurukona.net/ Live demo: https://xlsx-template.kurukona.net/developer/ Docuemnts: https://xlsx-template.kurukona.net/docs/
8
Mail config delete
generated files history
200
null
{"deleted": "slB2bozM2fVk5KirxyMq"}
{"type": "object", "properties": {"deleted": {"type": "string"}}}
87868806-7343-4ad2-a5ce-2afe45b7a065/e9b36e4b-17dd-4a85-b21e-80df5dd9db86/0/0
XLSX Template
Template (xlsx) + Data (json) ➞ Document. You can create xlsx document or pdf file with template and json data. Home page: https://xlsx-template.kurukona.net/ Live demo: https://xlsx-template.kurukona.net/developer/ Docuemnts: https://xlsx-template.kurukona.net/docs/
8
Mail config get
Get a mail confing from cloud database
200
null
{"host": "smtp.example.com", "port": 587, "secure": true, "auth": {"user": "username", "pass": "pass"}, "generatedAt": "2022-11-21T00:38:43.478Z", "mailConfigId": "slB2bozM2fVk5KirxyMq"}
{"allOf": [{"type": "object", "properties": {"host": {"type": "string"}, "port": {"type": "integer"}, "secure": {"type": "boolean"}, "auth": {"type": "object", "properties": {"user": {"type": "string"}, "pass": {"type": "string"}}}}, "description": "https://nodemailer.com/smtp/#examples"}, {"properties": {"generatedAt": {"type": "string"}, "mailConfigId": {"type": "string", "description": "Cloud stored mail config id"}}}]}
87868806-7343-4ad2-a5ce-2afe45b7a065/22682733-48d5-4c2e-9f74-76e5c6029757/0/0
XLSX Template
Template (xlsx) + Data (json) ➞ Document. You can create xlsx document or pdf file with template and json data. Home page: https://xlsx-template.kurukona.net/ Live demo: https://xlsx-template.kurukona.net/developer/ Docuemnts: https://xlsx-template.kurukona.net/docs/
8
Template list
Cloud storage templates file list
200
null
{"totalSize": 158324, "templateFiles": [{"filename": "template.xlsx", "size": "35026", "updated": "2022-10-12T11:53:18.006Z"}]}
{"type": "object", "properties": {"totalSize": {"type": "integer"}, "templateFiles": {"type": "array", "items": {"type": "object", "properties": {"filename": {"type": "string"}, "size": {"type": "string"}, "updated": {"type": "string"}}}}}}
87868806-7343-4ad2-a5ce-2afe45b7a065/f01c8b82-16f7-4ae1-9e11-dc4dfeb8db88/0/0
XLSX Template
Template (xlsx) + Data (json) ➞ Document. You can create xlsx document or pdf file with template and json data. Home page: https://xlsx-template.kurukona.net/ Live demo: https://xlsx-template.kurukona.net/developer/ Docuemnts: https://xlsx-template.kurukona.net/docs/
8
Template download
Download template file from Cloud storage
400
null
{"error": "error message."}
{"type": "object", "properties": {"error": {"type": "string"}}}