# Bimp API method reference

URL: https://bimpsoft.com/en/help/developers/api-reference/
Updated: 2026-11-06

> 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](https://bimpsoft.com/en/help/developers/api-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](https://bimpsoft.com/en/help/developers/api-getting-started/); request rate and page size limits are in [Limits, pagination and errors](https://bimpsoft.com/en/help/developers/api-limits/).

## 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.

> [!NOTE] Reference pages are generated automatically from the OpenAPI specification. If a field exists in the API but is missing here, check the interactive documentation at [app.bimpsoft.com/docs](https://app.bimpsoft.com/docs).

## All API resources

| Resource | Path | Methods |
|---|---|---|
| [Additional costs](/en/help/developers/api-reference/additional-spendings/) | `/org2/additionalSpendings/` | 4 |
| [Address types](/en/help/developers/api-reference/address-type/) | `/org2/addressType/` | 1 |
| [Assembly (production)](/en/help/developers/api-reference/production-assembly/) | `/org2/production-assembly/` | 4 |
| [Authorization](/en/help/developers/api-reference/auth/) | `/org2/auth/` | 4 |
| [Bank accounts](/en/help/developers/api-reference/bank-accounts/) | `/org2/bankAccounts/` | 3 |
| [Batches](/en/help/developers/api-reference/party/) | `/org2/party/` | 3 |
| [Business lines](/en/help/developers/api-reference/line-of-business/) | `/org2/lineOfBusiness/` | 1 |
| [Cash registers](/en/help/developers/api-reference/cash-registry/) | `/org2/cashRegistry/` | 2 |
| [Chart of accounts](/en/help/developers/api-reference/chart-of-account/) | `/org2/chartOfAccount/` | 1 |
| [Companies](/en/help/developers/api-reference/company/) | `/org2/company/` | 1 |
| [Contracts](/en/help/developers/api-reference/contract/) | `/org2/contract/` | 6 |
| [Counterparties](/en/help/developers/api-reference/counterparty/) | `/org2/counterparty/` | 14 |
| [Counterparty products](/en/help/developers/api-reference/counterparty-nomenclature/) | `/org2/counterpartyNomenclature/` | 4 |
| [Currencies](/en/help/developers/api-reference/currency/) | `/org2/currency/` | 2 |
| [Customer orders](/en/help/developers/api-reference/invoice-for-customer-payment/) | `/org2/invoiceForCustomerPayment/` | 14 |
| [Customer payments](/en/help/developers/api-reference/customer-payment/) | `/org2/customerPayment/` | 6 |
| [Customer returns](/en/help/developers/api-reference/customer-inventories-return/) | `/org2/customer-inventories-return/` | 5 |
| [Employees](/en/help/developers/api-reference/employee/) | `/org2/employee/` | 5 |
| [Equipment](/en/help/developers/api-reference/machinery/) | `/org2/machinery/` | 1 |
| [Expense items](/en/help/developers/api-reference/expense-items/) | `/org2/expenseItems/` | 1 |
| [Expense requests](/en/help/developers/api-reference/expense-request/) | `/org2/expenseRequest/` | 5 |
| [Financing balances](/en/help/developers/api-reference/financing-balance/) | `/org2/financing-balance/` | 1 |
| [Goods and services receipts](/en/help/developers/api-reference/purchase-invoice/) | `/org2/purchaseInvoice/` | 5 |
| [Images](/en/help/developers/api-reference/images/) | `/org2/images/` | 1 |
| [Income items](/en/help/developers/api-reference/income-items/) | `/org2/incomeItems/` | 1 |
| [Integration settings](/en/help/developers/api-reference/integration-settings/) | `/org2/integrationSettings/` | 7 |
| [Investment repayments](/en/help/developers/api-reference/investment-repayment/) | `/org2/investmentRepayment/` | 4 |
| [Investments received](/en/help/developers/api-reference/investment-obtainment/) | `/org2/investmentObtainment/` | 4 |
| [Loan repayments](/en/help/developers/api-reference/loan-repayment/) | `/org2/loanRepayment/` | 4 |
| [Loans received](/en/help/developers/api-reference/loan-obtainment/) | `/org2/loanObtainment/` | 4 |
| [Opening balances entry](/en/help/developers/api-reference/entering-opening-balances/) | `/org2/enteringOpeningBalances/` | 4 |
| [Organizations](/en/help/developers/api-reference/organization/) | `/org2/organization/` | 1 |
| [Other expenses](/en/help/developers/api-reference/other-expenses/) | `/org2/otherExpenses/` | 4 |
| [Other income](/en/help/developers/api-reference/other-income/) | `/org2/otherIncome/` | 4 |
| [Price lists](/en/help/developers/api-reference/price-list/) | `/org2/priceList/` | 7 |
| [Product groups](/en/help/developers/api-reference/nomenclature-group/) | `/org2/nomenclature-group/` | 4 |
| [Production orders](/en/help/developers/api-reference/production-order/) | `/org2/production-order/` | 6 |
| [Production tasks](/en/help/developers/api-reference/production-task/) | `/org2/production-task/` | 4 |
| [Products and services](/en/help/developers/api-reference/nomenclature/) | `/org2/nomenclature/` | 15 |
| [Projects](/en/help/developers/api-reference/project/) | `/org2/project/` | 1 |
| [Refunds from suppliers](/en/help/developers/api-reference/refund-from-supplier/) | `/org2/refundFromSupplier/` | 4 |
| [Refunds to customers](/en/help/developers/api-reference/refund-to-customer/) | `/org2/refundToCustomer/` | 4 |
| [Returns to suppliers](/en/help/developers/api-reference/refund-supplier/) | `/org2/refundSupplier/` | 5 |
| [Sales of goods and services](/en/help/developers/api-reference/sales-invoice/) | `/org2/salesInvoice/` | 11 |
| [Specifications](/en/help/developers/api-reference/specification/) | `/org2/specification/` | 4 |
| [Stock balances and kits](/en/help/developers/api-reference/inventory/) | `/org2/inventory/` | 6 |
| [Stock posting](/en/help/developers/api-reference/inventory-posting/) | `/org2/inventoryPosting/` | 1 |
| [Stock transfers](/en/help/developers/api-reference/movement-of-inventories/) | `/org2/movementOfInventories/` | 5 |
| [Stock write-offs](/en/help/developers/api-reference/write-off-of-inventories/) | `/org2/writeOffOfInventories/` | 5 |
| [Supplier orders](/en/help/developers/api-reference/invoice-for-supplier-payment/) | `/org2/invoiceForSupplierPayment/` | 6 |
| [Supplier payments](/en/help/developers/api-reference/payment-to-supplier/) | `/org2/paymentToSupplier/` | 5 |
| [Transfers between accounts](/en/help/developers/api-reference/interaccount-transfer/) | `/org2/interaccountTransfer/` | 4 |
| [Units of measure](/en/help/developers/api-reference/units-of-measurment/) | `/org2/unitsOfMeasurment/` | 1 |
| [Users](/en/help/developers/api-reference/user/) | `/org2/user/` | 1 |
| [VAT rates](/en/help/developers/api-reference/vat/) | `/org2/vat/` | 2 |
| [Warehouses](/en/help/developers/api-reference/warehouse/) | `/org2/warehouse/` | 1 |
| [Webhooks](/en/help/developers/api-reference/webhook/) | `/org2/webhook/` | 4 |
| [Webhooks (subscriptions)](/en/help/developers/api-reference/webhooks/) | `/org2/webhooks/` | 3 |
| [Zoho People integration](/en/help/developers/api-reference/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.