Bimp API method reference
The Bimp API directories all public API methods grouped by resource: one page per resource (for example, "Customer order" or "Products") with request parameters, response fields and a curl example. The pages are generated from the OpenAPI specification, so they match the current API version.
How Bimp API methods are organized
Bimp API methods are grouped by resource: the path looks like /org2/<resource>/<action>, for example /org2/invoiceForCustomerPayment/api-readList. The base address is https://app.bimpsoft.com, and the format is JSON.
Typical resource actions:
| Action | What it does |
|---|---|
api-readList | list of objects with pagination and filters |
api-read | one object by uuid |
api-create | creates an object |
api-update | updates an object by uuid |
api-saveExternalId | links an identifier from your system, see External IDs |
Every request except login passes the company token in the access-token header. How to get the token is described in Getting started with the API; request rate and page size limits are in Limits, pagination and errors.
How to read a resource page
A resource page starts with a table of methods, then each method is described separately: path, purpose, request body fields (required ones are marked), response fields in the data object and a curl request example. Nested fields are written with a dot: counterparty.uuid means the uuid field inside the counterparty object, and products[].count means the count field of each element of the products array.
All API resources
| Resource | Path | Methods |
|---|---|---|
| Additional costs | /org2/additionalSpendings/ | 4 |
| Address types | /org2/addressType/ | 1 |
| Assembly (production) | /org2/production-assembly/ | 4 |
| Authorization | /org2/auth/ | 4 |
| Bank accounts | /org2/bankAccounts/ | 3 |
| Batches | /org2/party/ | 3 |
| Business lines | /org2/lineOfBusiness/ | 1 |
| Cash registers | /org2/cashRegistry/ | 2 |
| Chart of accounts | /org2/chartOfAccount/ | 1 |
| Companies | /org2/company/ | 1 |
| Contracts | /org2/contract/ | 6 |
| Counterparties | /org2/counterparty/ | 14 |
| Counterparty products | /org2/counterpartyNomenclature/ | 4 |
| Currencies | /org2/currency/ | 2 |
| Customer orders | /org2/invoiceForCustomerPayment/ | 14 |
| Customer payments | /org2/customerPayment/ | 6 |
| Customer returns | /org2/customer-inventories-return/ | 5 |
| Employees | /org2/employee/ | 5 |
| Equipment | /org2/machinery/ | 1 |
| Expense items | /org2/expenseItems/ | 1 |
| Expense requests | /org2/expenseRequest/ | 5 |
| Financing balances | /org2/financing-balance/ | 1 |
| Goods and services receipts | /org2/purchaseInvoice/ | 5 |
| Images | /org2/images/ | 1 |
| Income items | /org2/incomeItems/ | 1 |
| Integration settings | /org2/integrationSettings/ | 7 |
| Investment repayments | /org2/investmentRepayment/ | 4 |
| Investments received | /org2/investmentObtainment/ | 4 |
| Loan repayments | /org2/loanRepayment/ | 4 |
| Loans received | /org2/loanObtainment/ | 4 |
| Opening balances entry | /org2/enteringOpeningBalances/ | 4 |
| Organizations | /org2/organization/ | 1 |
| Other expenses | /org2/otherExpenses/ | 4 |
| Other income | /org2/otherIncome/ | 4 |
| Price lists | /org2/priceList/ | 7 |
| Product groups | /org2/nomenclature-group/ | 4 |
| Production orders | /org2/production-order/ | 6 |
| Production tasks | /org2/production-task/ | 4 |
| Products and services | /org2/nomenclature/ | 15 |
| Projects | /org2/project/ | 1 |
| Refunds from suppliers | /org2/refundFromSupplier/ | 4 |
| Refunds to customers | /org2/refundToCustomer/ | 4 |
| Returns to suppliers | /org2/refundSupplier/ | 5 |
| Sales of goods and services | /org2/salesInvoice/ | 11 |
| Specifications | /org2/specification/ | 4 |
| Stock balances and kits | /org2/inventory/ | 6 |
| Stock posting | /org2/inventoryPosting/ | 1 |
| Stock transfers | /org2/movementOfInventories/ | 5 |
| Stock write-offs | /org2/writeOffOfInventories/ | 5 |
| Supplier orders | /org2/invoiceForSupplierPayment/ | 6 |
| Supplier payments | /org2/paymentToSupplier/ | 5 |
| Transfers between accounts | /org2/interaccountTransfer/ | 4 |
| Units of measure | /org2/unitsOfMeasurment/ | 1 |
| Users | /org2/user/ | 1 |
| VAT rates | /org2/vat/ | 2 |
| Warehouses | /org2/warehouse/ | 1 |
| Webhooks | /org2/webhook/ | 4 |
| Webhooks (subscriptions) | /org2/webhooks/ | 3 |
| Zoho People integration | /org2/integration/ | 1 |
FAQ
Where can I get the OpenAPI specification for the Bimp API?
Interactive documentation with the specification is available at https://app.bimpsoft.com/docs. You can view the schemas there and send a test request.
Why do most Bimp API methods use POST?
In Bimp, even reads (api-read, api-readList) are performed with a POST request with parameters in the JSON body. GET is used only by a few methods, for example kit stock balances.