QUINCE API. Інвентаризація

Список методів

Метод	Опис
`/api/v2/document/inventory/list`	Отримання списку документів
`/api/v2/document/inventory/add`	Додавання документа
`/api/v2/document/inventory/update`	Оновлення документа
`/api/v2/document/inventory/unpublish`	Зняття документа з проведення
`/api/v2/document/inventory/fill_balances`	Отримання залишків для заповнення інвентаризації

Отримання списку документів

Назва методу: /api/v2/document/inventory/list

Повертає список документів інвентаризації. Для навігації використовується номер сторінки page.

Якщо не передати filter.Id і обидва параметри filter.DateFrom та filter.DateTo, API автоматично підставляє поточний день.

Параметри запиту

Поле	Опис
`filter.Id`	Ідентифікатор документа.
`filter.DateFrom`	Початок періоду у форматі `YYYY-MM-DD` або `YYYY-MM-DD HH:mm:ss`.
`filter.DateTo`	Кінець періоду у форматі `YYYY-MM-DD` або `YYYY-MM-DD HH:mm:ss`.
`filter.Company`	Ідентифікатор організації.
`filter.Archive`	Ознака архівності.
`filter.MobileApp`	Якщо `true`, API повертає збільшений ліміт елементів для мобільного сценарію.
`page`	Номер сторінки. Необов’язковий.

Основні поля відповіді

Поле	Опис
`Id`	Ідентифікатор документа.
`Date`	Дата документа у часовому поясі користувача.
`Number`	Номер документа.
`Comment`	Коментар.
`Fixed`	Ознака проведення документа.
`Void`	Ознака архівності.
`Store`	Склад.
`Company`	Організація.
`Responsible`	Відповідальний.
`Rows`	Рядки товарів.

Основні поля рядка

Поле	Опис
`Id`	Ідентифікатор рядка.
`RowNo`	Номер рядка.
`Product`	Id товару.
`ProductName`	Назва товару.
`Article`	Артикул товару.
`UnitName`	Назва одиниці виміру.
`Kind`	Вид позиції.
`Qty`	Різниця між фактичною та обліковою кількістю.
`QtyAccount`	Кількість за обліком.
`QtyFact`	Фактична кількість.
`Price`	Ціна.
`Sum`	Сума рядка.

Приклад запиту

{
  "filter": {
    "DateFrom": "2026-06-01",
    "DateTo": "2026-06-30",
    "Company": 126
  },
  "page": 1
}

Додавання документа

Назва методу: /api/v2/document/inventory/add

Метод додає один документ за запит. Якщо передати Fixed: true, API проведе документ після створення.

Поле	Опис
`array`	Масив з одним документом.
`array[].Date`	Дата документа. Обов’язкова, якщо не задана в шаблоні документа.
`array[].Company`	Id організації. Обов’язковий, якщо не заданий у шаблоні документа.
`array[].Store`	Id складу. Обов’язковий, якщо не заданий у шаблоні документа.
`array[].Responsible`	Id відповідального. Обов’язковий, якщо не заданий у шаблоні документа.
`array[].Comment`	Коментар.
`array[].Fixed`	Провести документ після створення.
`array[].MainSum`	Основна сума документа. Якщо не передати, береться сума рядків.
`array[].Rows` або `array[].RowsGoods`	Масив рядків товарів. Обов’язковий.

Поля рядка

Поле	Опис
`Product`	Id товару. Обов’язковий.
`QtyFact`	Фактична кількість. Якщо не передати, береться `Qty` або `1`.
`QtyAccount`	Кількість за обліком. За замовчуванням `0`.
`Qty`	Різниця. Якщо передані `Qty` і `QtyFact`, використовується `Qty`; інакше рахується як `QtyFact - QtyAccount`.
`Price`	Ціна.
`Sum`	Сума. Якщо не передати, рахується як `Qty * Price`.
`Unit`	Id одиниці виміру. Якщо не передати, API підставить одиницю товару.
`RowNo`	Номер рядка.
`Store`	Id складу в рядку. Якщо не передати, береться склад документа.
`StoreCellFrom`	Id комірки відбору.
`StoreCellTo`	Id комірки розміщення.
`MemoRows` або `Comment`	Коментар рядка.
`Barcode`	Штрихкод.
`Vat`	Id ставки ПДВ.
`MainPrice`	Ціна в основній валюті.
`MainSum`	Сума в основній валюті.
`CashAccountSum`	Сума у валюті рахунку.
`PercentDiscount`	Відсоток знижки.
`UnitRate`	Коефіцієнт одиниці виміру.
`QtyRate`	Кількість з урахуванням коефіцієнта.
`SeriesCode`	Серія.
`SeriesDateManufacture`	Дата виробництва серії.
`SeriesDateShelfLife`	Термін придатності серії.
`SeriesBarcode`	Штрихкод серії.
`SeriesComment`	Коментар серії.
`PnlItem`	Id статті P&L.

Приклад створення

{
  "array": [
    {
      "Date": "2026-06-16",
      "Company": 126,
      "Store": 132,
      "Responsible": 57,
      "Comment": "Планова інвентаризація складу",
      "Fixed": true,
      "Rows": [
        {
          "Product": 5001,
          "QtyAccount": 12,
          "QtyFact": 11,
          "Price": 85,
          "Store": 132,
          "Barcode": "4820000000012",
          "MemoRows": "Розбіжність після перерахунку"
        },
        {
          "Product": 5002,
          "QtyAccount": 4,
          "QtyFact": 4,
          "Price": 120,
          "Store": 132
        }
      ]
    }
  ]
}

Оновлення документа

Назва методу: /api/v2/document/inventory/update

Метод оновлює один документ за запит. Поле Id обов’язкове. Якщо передати Rows або RowsGoods, API замінить рядки документа перед збереженням.

Приклад оновлення

{
  "array": [
    {
      "Id": 8027,
      "Comment": "Уточнення після повторного перерахунку",
      "Rows": [
        {
          "Id": 14501,
          "Product": 5001,
          "QtyAccount": 12,
          "QtyFact": 10,
          "Price": 85,
          "Store": 132
        }
      ]
    }
  ]
}

Зняття документа з проведення

Назва методу: /api/v2/document/inventory/unpublish

Метод знімає з проведення один документ за запит.

{
  "array": [
    {
      "Id": 8027
    }
  ]
}

Отримання залишків для заповнення інвентаризації

Назва методу: /api/v2/document/inventory/fill_balances

Повертає залишки товарів для організації та складу. Метод можна використовувати, щоб підготувати рядки інвентаризації.

Поле	Опис
`filter.Company` або `Company`	Id організації. Обов’язковий.
`filter.Store` або `Store`	Id складу. Обов’язковий.
`filter.Date` або `Date`	Дата залишків. Необов’язкова.
`filter.OnlyRemaining` або `OnlyRemaining`	Якщо `1`, повертає тільки товари із залишками. За замовчуванням `1`.
`filter.Folder` або `Folder`	Id папки товарів.
`filter.Complect` або `Complect`	Ознака комплектів. За замовчуванням `0`.

Приклад запиту

{
  "filter": {
    "Company": 126,
    "Store": 132,
    "Date": "2026-03-31",
    "OnlyRemaining": 1
  }
}