Microbooks
An IFRS compliant Accounting API that caters to all financial reporting needs.
18 subscribers
95 endpoints
The in-depth APIMemo review for this API hasn't been published yet —
the data below comes straight from the public marketplace listing.
Microbooks endpoints
| Method | Endpoint | Description |
|---|---|---|
| Entities | ||
| GET |
getEntities /books/v1/entity |
Retrieves a paginated list of Entities associated with the logged-in user. |
| POST |
createEntity /books/v1/entity |
Creates an Entity. ### Parameters: | **Parameters** | **Attributes** | **Notes** | | --- | --- | --- | | name | required, string | | | currency_code | required, string, length:3… |
| GET |
getEntity /books/v1/entity/{id} |
Retrieves the Entity with the passed in Id. |
| PUT |
updateEntity /books/v1/entity/{id} |
Updates the Entity represented by the given Id. ### Parameters: | **Parameters** | **Attributes** | **Notes** | | --- | --- | --- | | name | required, string | | | currency_code… |
| DELETE |
deleteEntity /books/v1/entity/{id} |
Deletes the Entity represented by the given Id. |
| Currencies | ||
| GET |
getCurrencies /books/v1/currency |
Retrieves a paginated list of Currencies associated with the logged-in user. |
| POST |
createCurrency /books/v1/currency |
Creates a currency. ### Parameters: | **Parameters** | **Attributes** | **Notes** | | --- | --- | --- | | currency_code | required, string, length:3, unique | | | name |… |
| GET |
getCurrency /books/v1/currency/{id} |
Retrieves the Currency with the passed in Id. |
| PUT |
updateCurrency /books/v1/currency/{id} |
Updates the Currency represented by the given Id. ### Parameters: | **Parameters** | **Attributes** | **Notes** | | --- | --- | --- | | currency_code | required, string,… |
| DELETE |
deleteCurrency /books/v1/currency/{id} |
Deletes the Currency represented by the given Id. |
| GET |
getClosingRates /books/v1/currency/{id}/closing-rates |
Retrieves the Closing Rates belonging to the Currency with the passed in Id. ### Query Parameters: | **Parameter** | **Attributes** | **Notes** | | --- | --- | --- | | year |… |
| GET |
getExchangeRates /books/v1/currency/{id}/exchange-rates |
Retrieves the Exchange Rates belonging to the Currency with the passed in Id. ### Optional Query Parameters: | **Parameter** | **Attributes** | **Notes** | | --- | --- | --- | |… |
| Exchange Rates | ||
| DELETE |
deleteExchangeRate /books/v1/exchange-rate/{id} |
Deletes the Exchange Rate represented by the given Id. |
| PUT |
updateExchangeRate /books/v1/exchange-rate/{id} |
Updates the Exchange Rate represented by the given Id. ### Parameters: | **Parameters** | **Attributes** | | --- | --- | | currency_id | required, integer | | rate | required,… |
| GET |
getExchangeRate /books/v1/exchange-rate/{id} |
Retrieves the Exchange Rate with the passed in Id. |
| POST |
createExchangeRate /books/v1/exchange-rate |
Creates an Exchange Rate. ### Parameters: | **Parameters** | **Attributes** | **Notes** | | --- | --- | --- | | currency_id | required, integer | Must exist | | rate | required,… |
| GET |
getExchangeRates /books/v1/exchange-rate |
Retrieves a paginated list of Exchange Rates associated with the logged-in user. |
| Reporting Periods | ||
| GET |
getReportingPeriods /books/v1/reporting-period |
Retrieves a paginated list of Reporting Periods associated with the logged in user. |
| POST |
createReportingPeriod /books/v1/reporting-period |
Creates a Reporting Period. (Note: creating an Entity also creates a default Reporting Period for it for the current calendar year). ### Parameters: | **Parameters** |… |
| GET |
getReportingPeriod /books/v1/reporting-period/{id} |
Retrieves the Reporting Period with the passed in Id. |
| PUT |
updateReportingPeriod /books/v1/reporting-period/{id} |
Updates the Reporting Period represented by the given Id. ### Parameters: | **Parameters** | **Attributes** | **Notes** | | --- | --- | --- | | calendar_year | required, integer… |
| DELETE |
deleteReportingPeriod /books/v1/reporting-period/{id} |
Deletes the Reporting Period represented by the given Id. |
| GET |
datePeriod /books/v1/reporting-period/date-period |
Retrieves the Reporting Period to which the given date belongs. |
| GET |
closingRates /books/v1/reporting-period/{id}/closing-rates |
Retrieves a list of Closing Rates for the foreign Currencies used in transactions during the Reporting period. |
| GET |
transactionCurrencies /books/v1/reporting-period/{id}/transaction-currencies |
Retrieves a list of foreign Currencies used in transactions during the Reporting period. ### Optional Query Parameters: | **Parameter** | **Attributes** | **Notes** | | --- | ---… |
| POST |
prepareClosingTransactions /books/v1/reporting-period/prepare-closing-transactions |
Prepares the Transactions for translating foreign Currency denominated Account balances to the reporting Currency saving them to the database (unposted). ### Parameters: |… |
| POST |
postClosingTransactions /books/v1/reporting-period/post-closing-transactions |
StartFragment Posts the Transactions for translating foreign Currency denominated Account balances to the reporting Currency to the ledger. EndFragment ### Parameters: |… |
| GET |
listClosingTransactions /books/v1/reporting-period/{id}/list-closing-transactions |
Lists the Closing Transactions for the given Reporting Period. ### Optional Query Parameters: | **Parameter** | **Attributes** | **Notes** | | --- | --- | --- | | acccount-id |… |
| Balances | ||
| GET |
getBalances /books/v1/balance |
Retrieves a paginated list of Balances associated with the logged-in user. |
| POST |
createBalance /books/v1/balance |
Creates a Balance. ### Parameters: | **Parameters** | **Attributes** | **Notes** | | --- | --- | --- | | account_id | required, integer | Must exist | | balance_type | required,… |
| GET |
getBalance /books/v1/balance/{id} |
Retrieves the Balance with the passed in Id. |
| PUT |
updateBalance /books/v1/balance/{id} |
Updates the Balance represented by the given Id. ### Parameters: | **Parameters** | **Attributes** | **Notes** | | --- | --- | --- | | account_id | required, integer | Must exist… |
| DELETE |
deleteBalance /books/v1/balance/{id} |
Deletes the Balance represented by the given Id. |
| GET |
openingBalances /books/v1/balance/opening-balances |
Retrieves the totals of the outstanding amounts in Balance Sheet Accounts from previous Reporting Periods. ### Query Parameters: | **Parameters** | **Attributes** | **Notes** | |… |
| Recycle Bin | ||
| POST |
destroyRecycledResource /books/v1/recycled-object/destroy/{id} |
Deletes the Recycled Object permanently. |
| POST |
restoreRecycledResource /books/v1/recycled-resource/restore/{id} |
Restores the Recycled Object to its previous state. |
| GET |
getRecycledResource /books/v1/recycled-resource/{id} |
Retrieves the Recycled Object with the passed in Id. |
| GET |
getRecycledResources /books/v1/recycled-resource |
Retrieves a paginated list of Objects that have been deleted. |
| Account | ||
| GET |
getAccounts /books/v1/account |
Retrieves a paginated list of Accounts associated with the logged-in user. |
| POST |
createAccoount /books/v1/account |
Creates an Account. ### Parameters: | **Parameters** | **Attributes** | **Notes** | | --- | --- | --- | | name | required, string | | | account_type | required | Must be one of:… |
| GET |
getAccount /books/v1/account/{id} |
Retrieves the Account with the passed in Id. |
| PUT |
updateAccount /books/v1/account/{id} |
Updates the Account represented by the given Id. ### Parameters: | **Parameters** | **Attributes** | **Notes** | | --- | --- | --- | | name | required, string | | | account_type… |
| DELETE |
deleteAccount /books/v1/account/{id} |
Deletes the Account represented by the given Id. |
| GET |
openingBalances /books/v1/account/{id}/balances |
Retrieves the opening Balances for the Account with the passed in Id and the year given. ### Optional Query Parameters: | **Parameter** | **Attributes** | **Notes** | | --- | ---… |
| GET |
closingTransactions /books/v1/account/{id}/closing-transactions |
Retrieves the Closing Transactions Posted for the Account for the given year. ### Optional Query Parameters: | **Parameter** | **Attributes** | **Notes** | | --- | --- | --- | |… |
| GET |
accountStatement /books/v1/account/{id}/statement |
Retrieves a chronological list of Transactions posted for the account during the given period. ### Optional Query Parameters: | **Parameter** | **Attributes** | **Notes** | | ---… |
| GET |
accountSchedule /books/v1/account/{id}/schedule |
Retrieves the outstanding (Clearable) Transactions of the Account as at the given end date. ### Optional Query Parameters: | **Parameter** | **Attributes** | **Notes** | | --- |… |
| GET |
agingSchedule /books/v1/account/aging |
Retrieves a schedule of Payable and Receivable accounts and their outstanding balances categorized by how long they have been outstanding. ### Optional Query Parameters: |… |
| GET |
sectionMovement /books/v1/account/movement |
Shows the change in balances for Accounts of type SECTION during the given period. ### Optional Query Parameters: | **Parameter** | **Attributes** | **Notes** | | --- | --- | ---… |
| Categories | ||
| GET |
getCategories /books/v1/category |
Retrieves a paginated list of Categories associated with the logged-in user. |
+ 45 more endpoints on the provider's documentation.
Microbooks pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | Free | — |
|
