# Довідник методів API Bimp

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

> Довідник API Bimp містить усі методи публічного API, згруповані за ресурсами: одна сторінка на ресурс (наприклад, «Замовлення покупця» або «Номенклатура») з параметрами запиту, полями відповіді і прикладом curl. Сторінки згенеровані зі специфікації OpenAPI, тож відповідають поточній версії API.

## Як влаштовані методи API Bimp

Методи API Bimp згруповані за ресурсами: шлях має вигляд `/org2/<ресурс>/<дія>`, наприклад `/org2/invoiceForCustomerPayment/api-readList`. Базова адреса — `https://app.bimpsoft.com`, формат — JSON.

Типові дії ресурсу:

| Дія | Що робить |
|---|---|
| `api-readList` | список об'єктів з пагінацією і фільтрами |
| `api-read` | один об'єкт за `uuid` |
| `api-create` | створення об'єкта |
| `api-update` | зміна об'єкта за `uuid` |
| `api-saveExternalId` | прив'язка ідентифікатора з вашої системи — див. [Зовнішні ID](https://bimpsoft.com/help/developers/api-external-ids/) |

Кожен запит, крім входу, передає токен компанії в заголовку `access-token`. Як отримати токен — у статті [Початок роботи з API](https://bimpsoft.com/help/developers/api-getting-started/); обмеження на кількість запитів і розмір сторінки — у статті [Ліміти, пагінація і помилки](https://bimpsoft.com/help/developers/api-limits/).

## Як читати сторінку ресурсу

Сторінка ресурсу починається з таблиці методів, далі кожен метод описано окремо: шлях, призначення, поля тіла запиту (з позначкою обов'язкових), поля відповіді в об'єкті `data` і приклад запиту curl. Вкладені поля записано через крапку: `counterparty.uuid` означає поле `uuid` всередині об'єкта `counterparty`, а `products[].count` — поле кожного елемента масиву `products`.

> [!NOTE] Сторінки довідника генеруються автоматично зі специфікації OpenAPI. Якщо поле є в API, але відсутнє тут, перевірте інтерактивну документацію [app.bimpsoft.com/docs](https://app.bimpsoft.com/docs).

## Усі ресурси API

| Ресурс | Шлях | Методів |
|---|---|---|
| [Авторизація](https://bimpsoft.com/help/developers/api-reference/auth/) | `/org2/auth/` | 4 |
| [Банківські рахунки](https://bimpsoft.com/help/developers/api-reference/bank-accounts/) | `/org2/bankAccounts/` | 3 |
| [Валюти](https://bimpsoft.com/help/developers/api-reference/currency/) | `/org2/currency/` | 2 |
| [Введення початкових залишків](https://bimpsoft.com/help/developers/api-reference/entering-opening-balances/) | `/org2/enteringOpeningBalances/` | 4 |
| [Вебхуки](https://bimpsoft.com/help/developers/api-reference/webhook/) | `/org2/webhook/` | 4 |
| [Вебхуки (підписки)](https://bimpsoft.com/help/developers/api-reference/webhooks/) | `/org2/webhooks/` | 3 |
| [Виробничі завдання](https://bimpsoft.com/help/developers/api-reference/production-task/) | `/org2/production-task/` | 4 |
| [Групи номенклатури](https://bimpsoft.com/help/developers/api-reference/nomenclature-group/) | `/org2/nomenclature-group/` | 4 |
| [Договори](https://bimpsoft.com/help/developers/api-reference/contract/) | `/org2/contract/` | 6 |
| [Додаткові витрати](https://bimpsoft.com/help/developers/api-reference/additional-spendings/) | `/org2/additionalSpendings/` | 4 |
| [Залишки за фінансуванням](https://bimpsoft.com/help/developers/api-reference/financing-balance/) | `/org2/financing-balance/` | 1 |
| [Залишки і комплекти](https://bimpsoft.com/help/developers/api-reference/inventory/) | `/org2/inventory/` | 6 |
| [Замовлення на виробництво](https://bimpsoft.com/help/developers/api-reference/production-order/) | `/org2/production-order/` | 6 |
| [Замовлення покупця](https://bimpsoft.com/help/developers/api-reference/invoice-for-customer-payment/) | `/org2/invoiceForCustomerPayment/` | 14 |
| [Замовлення постачальнику](https://bimpsoft.com/help/developers/api-reference/invoice-for-supplier-payment/) | `/org2/invoiceForSupplierPayment/` | 6 |
| [Заявки на витрату коштів](https://bimpsoft.com/help/developers/api-reference/expense-request/) | `/org2/expenseRequest/` | 5 |
| [Збірка (виробництво)](https://bimpsoft.com/help/developers/api-reference/production-assembly/) | `/org2/production-assembly/` | 4 |
| [Зображення](https://bimpsoft.com/help/developers/api-reference/images/) | `/org2/images/` | 1 |
| [Інтеграція Zoho People](https://bimpsoft.com/help/developers/api-reference/integration/) | `/org2/integration/` | 1 |
| [Інші витрати](https://bimpsoft.com/help/developers/api-reference/other-expenses/) | `/org2/otherExpenses/` | 4 |
| [Інші доходи](https://bimpsoft.com/help/developers/api-reference/other-income/) | `/org2/otherIncome/` | 4 |
| [Каси](https://bimpsoft.com/help/developers/api-reference/cash-registry/) | `/org2/cashRegistry/` | 2 |
| [Компанії](https://bimpsoft.com/help/developers/api-reference/company/) | `/org2/company/` | 1 |
| [Контрагенти](https://bimpsoft.com/help/developers/api-reference/counterparty/) | `/org2/counterparty/` | 14 |
| [Користувачі](https://bimpsoft.com/help/developers/api-reference/user/) | `/org2/user/` | 1 |
| [Надходження товарів, послуг](https://bimpsoft.com/help/developers/api-reference/purchase-invoice/) | `/org2/purchaseInvoice/` | 5 |
| [Налаштування інтеграцій](https://bimpsoft.com/help/developers/api-reference/integration-settings/) | `/org2/integrationSettings/` | 7 |
| [Напрями діяльності](https://bimpsoft.com/help/developers/api-reference/line-of-business/) | `/org2/lineOfBusiness/` | 1 |
| [Номенклатура (товари та послуги)](https://bimpsoft.com/help/developers/api-reference/nomenclature/) | `/org2/nomenclature/` | 15 |
| [Номенклатура контрагента](https://bimpsoft.com/help/developers/api-reference/counterparty-nomenclature/) | `/org2/counterpartyNomenclature/` | 4 |
| [Обладнання](https://bimpsoft.com/help/developers/api-reference/machinery/) | `/org2/machinery/` | 1 |
| [Одиниці виміру](https://bimpsoft.com/help/developers/api-reference/units-of-measurment/) | `/org2/unitsOfMeasurment/` | 1 |
| [Оплата від покупця](https://bimpsoft.com/help/developers/api-reference/customer-payment/) | `/org2/customerPayment/` | 6 |
| [Оплата постачальнику](https://bimpsoft.com/help/developers/api-reference/payment-to-supplier/) | `/org2/paymentToSupplier/` | 5 |
| [Оприбуткування запасів](https://bimpsoft.com/help/developers/api-reference/inventory-posting/) | `/org2/inventoryPosting/` | 1 |
| [Організації](https://bimpsoft.com/help/developers/api-reference/organization/) | `/org2/organization/` | 1 |
| [Отримання інвестицій](https://bimpsoft.com/help/developers/api-reference/investment-obtainment/) | `/org2/investmentObtainment/` | 4 |
| [Отримання кредитів](https://bimpsoft.com/help/developers/api-reference/loan-obtainment/) | `/org2/loanObtainment/` | 4 |
| [Партії](https://bimpsoft.com/help/developers/api-reference/party/) | `/org2/party/` | 3 |
| [Перекази між рахунками](https://bimpsoft.com/help/developers/api-reference/interaccount-transfer/) | `/org2/interaccountTransfer/` | 4 |
| [Переміщення запасів](https://bimpsoft.com/help/developers/api-reference/movement-of-inventories/) | `/org2/movementOfInventories/` | 5 |
| [План рахунків](https://bimpsoft.com/help/developers/api-reference/chart-of-account/) | `/org2/chartOfAccount/` | 1 |
| [Повернення інвестицій](https://bimpsoft.com/help/developers/api-reference/investment-repayment/) | `/org2/investmentRepayment/` | 4 |
| [Повернення коштів від постачальника](https://bimpsoft.com/help/developers/api-reference/refund-from-supplier/) | `/org2/refundFromSupplier/` | 4 |
| [Повернення коштів покупцю](https://bimpsoft.com/help/developers/api-reference/refund-to-customer/) | `/org2/refundToCustomer/` | 4 |
| [Повернення кредитів](https://bimpsoft.com/help/developers/api-reference/loan-repayment/) | `/org2/loanRepayment/` | 4 |
| [Повернення товару від покупця](https://bimpsoft.com/help/developers/api-reference/customer-inventories-return/) | `/org2/customer-inventories-return/` | 5 |
| [Повернення товару постачальнику](https://bimpsoft.com/help/developers/api-reference/refund-supplier/) | `/org2/refundSupplier/` | 5 |
| [Прайс-листи](https://bimpsoft.com/help/developers/api-reference/price-list/) | `/org2/priceList/` | 7 |
| [Продаж товарів, послуг](https://bimpsoft.com/help/developers/api-reference/sales-invoice/) | `/org2/salesInvoice/` | 11 |
| [Проєкти](https://bimpsoft.com/help/developers/api-reference/project/) | `/org2/project/` | 1 |
| [Склади](https://bimpsoft.com/help/developers/api-reference/warehouse/) | `/org2/warehouse/` | 1 |
| [Специфікації](https://bimpsoft.com/help/developers/api-reference/specification/) | `/org2/specification/` | 4 |
| [Списання запасів](https://bimpsoft.com/help/developers/api-reference/write-off-of-inventories/) | `/org2/writeOffOfInventories/` | 5 |
| [Співробітники](https://bimpsoft.com/help/developers/api-reference/employee/) | `/org2/employee/` | 5 |
| [Ставки ПДВ](https://bimpsoft.com/help/developers/api-reference/vat/) | `/org2/vat/` | 2 |
| [Статті витрат](https://bimpsoft.com/help/developers/api-reference/expense-items/) | `/org2/expenseItems/` | 1 |
| [Статті доходів](https://bimpsoft.com/help/developers/api-reference/income-items/) | `/org2/incomeItems/` | 1 |
| [Типи адрес](https://bimpsoft.com/help/developers/api-reference/address-type/) | `/org2/addressType/` | 1 |

## FAQ

**Де взяти специфікацію OpenAPI для API Bimp?**

Інтерактивна документація зі специфікацією доступна за адресою https://app.bimpsoft.com/docs. Там можна переглянути схеми і надіслати тестовий запит.

**Чому більшість методів API Bimp використовують POST?**

У Bimp навіть читання (api-read, api-readList) виконується POST-запитом з параметрами в JSON-тілі. GET використовують лише окремі методи, наприклад залишки комплектів.