API BIMP
Документація та інструменти для інтеграції з системою BIMP.ПРИМІТКИ
Загальні примітки
примітки до публічної документації
Авторизація
POST /org2/auth/api-verifyCompanyAccess
Перевірити company access token та повернути auth payload для використання мікросервісами.
POST /org2/auth/api-selectCompany
Створити новий access token з інформацією про вибрану компанію. Цей токен можна використовувати для доступу до даних компанії.
POST /org2/auth/api-refresh
Продовжити сесію користувача, оновивши токен без повторної авторизації.
POST /org2/auth/api-login
Дозволяє отримати базовий токен користувача для подальших запитів, які не залежать від конкретної компанії
Користувачі
POST /org2/user/api-readList
Отримати список користувачів.
Номенклатури(товари)
POST /org2/nomenclature/api-update
Оновити існуючу номенклатуру.
POST /org2/nomenclature/api-create
Створити нову номенклатуру.
POST /org2/nomenclature/api-readPrices
Отримати список номенклатури з цінами.
POST /org2/nomenclature/api-readList
Отримати список номенклатур.
POST /org2/nomenclature/api-read
Отримати детальну інформацію про конкретну номенклатуру.
POST /org2/nomenclature/api-saveExternalId
Зберегти або оновити прив`язку
POST /org2/nomenclature/api-readExternalId
Прочитати зовнішній ID за товаром і джерелом
POST /org2/nomenclature/api-readByExternalId
Знайти товар за зовнішнім ID
POST /org2/nomenclature/api-readExternalIdsList
Список усіх прив’язок
POST /org2/nomenclature/api-readWithoutExternalId
Товари без прив’язки для обраного source
Одиниці виміру
POST /org2/unitsOfMeasurment/api-readList
Отримати список одиниць виміру.
Залишки товарів
GET /org2/inventory/kits/api-readList/cursor
Отримати доступні кількості комплектів з використанням курсорної пагінації. Оптимізовано для великих наборів даних (2000+ комплектів).
GET /org2/inventory/kits/api-readList
Отримати доступні кількості комплектів, розраховані з залишків компонентів. Використовує offset пагінацію з максимальним лімітом 2000 комплектів.
GET /org2/inventory/api-read/:productHex/stock
Отримати поточні залишки та резерви для конкретного товару за його hex або guid ідентифікатором. Використовується для перевірки наявності товару перед розміщенням замовлення.
GET /org2/inventory/api-readList/cursor
Отримати залишки товарів з використанням курсорної пагінації (keyset pagination) для нескінченного скролу. Оптимізовано для великих наборів даних (5000+ елементів).
GET /org2/inventory/api-readList
Отримати залишки товарів з пагінацією та динамічним сортуванням.
Склади
POST /org2/warehouse/api-readList
Отримати список складів.
Замовлення постачальника
POST /org2/invoiceForSupplierPayment/api-update
Оновити існуюче замовлення постачальника.
POST /org2/invoiceForSupplierPayment/api-create
Створити нове замовлення постачальника.
POST /org2/invoiceForSupplierPayment/api-readStatuses
Отримати список статусів замовлень постачальника.
POST /org2/invoiceForSupplierPayment/api-readList
Отримати список замовлень постачальників.
POST /org2/invoiceForSupplierPayment/api-read
Отримати детальну інформацію про конкретне замовлення постачальника.
Надходження товарів
POST /org2/purchaseInvoice/api-update
Оновити існуюче надходження товарів
POST /org2/purchaseInvoice/api-create
Створити нове надходження товару
POST /org2/purchaseInvoice/api-readList
Отримати список надходжень товарів
POST /org2/purchaseInvoice/api-read
Отримати детальну інформацію про конкретне надходження товарів
Замовлення покупця
POST /org2/invoiceForCustomerPayment/api-update
Оновити існуюче замовлення покупця.
POST /org2/invoiceForCustomerPayment/api-create
Створити нове замовлення покупця.
POST /org2/invoiceForCustomerPayment/api-readStatuses
Отримати список статусів замовлень покупців.
POST /org2/invoiceForCustomerPayment/api-readList
Отримати список замовлень покупців.
POST /org2/invoiceForCustomerPayment/api-read
Отримати детальну інформацію про конкретне замовлення від покупця.
POST /org2/invoiceForCustomerPayment/api-saveExternalId
Створює або оновлює мапінг між замовленням BIMP і його ID у зовнішній системі
POST /org2/invoiceForCustomerPayment/api-readExternalId
Повертає externalId для конкретного замовлення BIMP і конкретного source
POST /org2/invoiceForCustomerPayment/api-readByExternalId
Знаходить замовлення BIMP по source + externalId
POST /org2/invoiceForCustomerPayment/api-readExternalIdsList
Повертає список існуючих мапінгів з пагінацією і фільтрами
POST /org2/invoiceForCustomerPayment/api-readWithoutExternalId
Повертає список замовлень, які не мають мапінгу для заданого source
Реалізація
POST /org2/salesInvoice/api-update
Оновити існуючий продаж
POST /org2/salesInvoice/api-create
Створити новий продаж
POST /org2/salesInvoice/api-read
Отримати детальну інформацію про конкретний продаж
POST /org2/salesInvoice/api-readList
Отримати список продажів
POST /org2/salesInvoice/api-saveExternalId
Створити або оновити прив’язку між документом продажу і його ідентифікатором у зовнішній системі
POST /org2/salesInvoice/api-readExternalId
отримати externalId для конкретного документа продажу BIMP і конкретного source
POST /org2/salesInvoice/api-readByExternalId
знайти документ продажу BIMP за парою source та externalId
POST /org2/salesInvoice/api-readExternalIdsList
Список існуючих
POST /org2/salesInvoice/api-readWithoutExternalId
Документи продажу, які ще не мають мапінгу для вказаного source
POST /org2/salesInvoice/api-deleteExternalId
Видалити мапінг зовнішнього ID для документа продажу
Повернення товарів від покупця
POST /org2/customer-inventories-return/api-update
Оновити існуюче повернення товарів від покупця.
POST /org2/customer-inventories-return/api-create
Створити нове повернення товарів від покупця.
POST /org2/customer-inventories-return/api-readList
Отримати список повернень товарів від покупців.
POST /org2/customer-inventories-return/api-read
Отримати детальну інформацію про конкретне повернення товарів від покупця.
Оплата від покупця
POST /org2/customerPayment/api-update
Оновити існуючий платіж від покупця.
POST /org2/customerPayment/api-create
Створити новий платіж від покупця.
POST /org2/customerPayment/api-readList
Отримати список платежів від покупців.
POST /org2/customerPayment/api-read
Отримати детальну інформацію про конкретний платіж від покупця.
Повернення коштів покупцю
POST /org2/refundToCustomer/api-update
Оновити існуюче повернення коштів покупцю.
POST /org2/refundToCustomer/api-create
Створити нове повернення коштів покупцю.
POST /org2/refundToCustomer/api-readList
Отримати список повернень коштів покупцям.
POST /org2/refundToCustomer/api-read
Отримати детальну інформацію про конкретне повернення коштів покупцю.
Заявка на витрату коштів
POST /org2/expenseRequest/api-update
Оновити існуючу заявку на витрату коштів.
POST /org2/expenseRequest/api-create
Створити нову заявку на витрату коштів.
POST /org2/expenseRequest/api-readStatuses
Отримати список статусів заявок на витрату коштів.
POST /org2/expenseRequest/api-readList
Отримати список заявок на витрату коштів.
POST /org2/expenseRequest/api-read
Отримати детальну інформацію про конкретну заявку на витрату коштів.
Інші витрати документ
POST /org2/otherExpenses/api-update
Оновити існуючу іншу витрату.
POST /org2/otherExpenses/api-create
Створити нову іншу витрату.
POST /org2/otherExpenses/api-readList
Отримати список інших витрат.
POST /org2/otherExpenses/api-read
Отримати детальну інформацію про конкретну іншу витрату.
Прайс листи
POST /org2/priceList/api-update
Оновити існуючий прайс-лист.
POST /org2/priceList/api-create
Створити новий прайс-лист.
POST /org2/priceList/api-readList
Отримати список прайс-листів.
POST /org2/priceList/api-read
Отримати детальну інформацію про конкретний прайс-лист.
Ставки ПДВ
POST /org2/vat/api-readList
Отримати список ставок ПДВ.
Специфікації
POST /org2/specification/api-update
Оновити існуючу специфікацію.
POST /org2/specification/api-create
Створити нову специфікацію.
POST /org2/specification/api-readList
Отримати список специфікацій.
POST /org2/specification/api-read
Отримати детальну інформацію про конкретну специфікацію.
Проект
POST /org2/project/api-readList
Отримати список проєктів.
Виробництво
POST /org2/production-order/api-create
Створити нове виробниче замовлення.
POST /org2/production-order/api-readStatuses
Отримати список статусів виробничих замовлень.
POST /org2/production-order/api-readList
Отримати список виробничих замовлень.
POST /org2/production-order/api-read
Отримати детальну інформацію про конкретне виробниче замовлення.
Компонування
POST /org2/production-assembly/api-create
Створити нову виробничу збірку.
POST /org2/production-assembly/api-readList
Отримати список виробничих збірок.
POST /org2/production-assembly/api-read
Отримати детальну інформацію про конкретну виробничу збірку.
Організації
POST /org2/organization/api-readList
Отримати список організацій.
Переміщення запасів
POST /org2/movementOfInventories/api-update
Оновити існуючий документ переміщення запасів.
POST /org2/movementOfInventories/api-create
Створити новий документ переміщення запасів.
POST /org2/movementOfInventories/api-readList
Отримати список документів переміщення запасів.
POST /org2/movementOfInventories/api-read
Отримати детальну інформацію про конкретний документ переміщення запасів.
Список обладнання
POST /org2/machinery/api-readList
Отримати список обладнання.
Напрямки діяльності
POST /org2/lineOfBusiness/api-readList
Отримати список напрямків діяльності.
Списання запасів
POST /org2/writeOffOfInventories/api-update
Оновити існуюче списання товарів.
POST /org2/writeOffOfInventories/api-create
Створити нове списання товарів.
POST /org2/writeOffOfInventories/api-readList
Отримати список списаних товарів.
POST /org2/writeOffOfInventories/api-read
Отримати детальну інформацію про конкретне списання товарів.
Групи номенклатур
POST /org2/nomenclature-group/api-readList
Отримати список груп номенклатури
Статті витрат
POST /org2/expenseItems/api-readList
Отримати список статей витрат.
Співробітники
POST /org2/employee/api-update
Оновити існуючого співробітника.
POST /org2/employee/api-create
Створити нового співробітника.
POST /org2/employee/api-readList
Отримати список співробітників.
POST /org2/employee/api-read
Отримати детальну інформацію про конкретного співробітника.
Валюти
POST /org2/currency/api-readList
Отримати список валют.
Контрагенти
POST /org2/counterparty/api-readStatuses
Отримати список статусів контрагентів.
POST /org2/counterparty/api-readList
Отримати список контрагентів.
POST /org2/counterparty/api-read
Отримати детальну інформацію про конкретного контрагента.
POST /org2/counterparty/api-saveExternalId
Створити або оновити прив’язку між контрагентом у BIMP і його ідентифікатором у зовнішній системі
POST /org2/counterparty/api-readExternalId
Отримати externalId для контрагента BIMP і source
POST /org2/counterparty/api-readByExternalId
Знайти контрагента BIMP за source та externalId
POST /org2/counterparty/api-readWithoutExternalId
Контрагенти для вказаного source
POST /org2/counterparty/api-deleteExternalId
Видалити мапінг для контрагента
Договори
POST /org2/contract/api-readList
Отримати список договорів.
POST /org2/contract/api-readStatuses
Отримати детальну інформацію про статуси договорів.
POST /org2/contract/api-readTypes
Отримати детальну інформацію про типи договорів.
POST /org2/contract/api-read
Отримати детальну інформацію про конкретний договір.
Компанії
POST /org2/company/api-readList
Отримати список компаній.
Плани рахунків
POST /org2/chartOfAccount/api-readList
Отримати список рахунків плану рахунків.
Касові реєстри
POST /org2/cashRegistry/api-readList
Отримати список касових реєстрів.
POST /org2/cashRegistry/api-read
Отримати детальну інформацію про конкретний касовий реєстр.
Банківські рахунки
POST /org2/bankAccounts/api-readList
Отримати список банківських рахунків.
POST /org2/bankAccounts/api-read
Отримати детальну інформацію про конкретний банківський рахунок.
POST /org2/bankAccounts/api-readTypes
Отримати детальну інформацію про типи банківських рахунків.
Типи адрес
POST /org2/addressType/api-readList
Отримати список типів адрес.