QUINCE API. Надходження
Список методів
| Метод | Опис |
|---|---|
/api/v2/document/income_invoice/list | Отримання списку документів |
/api/v2/document/income_invoice/add | Додавання документа |
/api/v2/document/income_invoice/update | Оновлення документа |
/api/v2/document/income_invoice/unpublish | Зняття документа з проведення |
Отримання списку документів
Назва методу: /api/v2/document/income_invoice/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 | Номер документа. |
Sum | Сума документа. |
StoresInRows | Ознака, що склад вказується в рядках. |
VatInclude | Ознака включення ПДВ у суми. |
SumVat | Сума ПДВ. |
SumWithoutVat | Сума без ПДВ. |
Fixed | Ознака проведення документа. |
Void | Ознака архівності. |
Comment | Коментар. |
Partner | Постачальник. |
Store | Склад документа. |
Status | Статус документа. |
Company | Організація. |
Contract | Контракт. |
PriceType | Тип цін. |
DiscountType | Тип знижки. |
Responsible | Відповідальний. |
Rows | Рядки товарів або послуг. |
Поля рядка
| Поле | Опис |
|---|---|
Id | Ідентифікатор рядка. |
RowNo | Номер рядка. |
Product | Id товару або послуги. |
Kind | Вид позиції: товар або послуга. |
Price | Ціна. |
Qty | Кількість. |
Sum | Сума рядка. |
SumVat | Сума ПДВ по рядку. |
PriceWithoutDiscount | Ціна без знижки. |
PercentDiscount | Відсоток знижки. |
Store | Склад рядка, якщо використовується режим складів у рядках. |
Приклад запиту
{
"filter": {
"DateFrom": "2026-06-01",
"DateTo": "2026-06-30",
"Company": 126
},
"page": 1
}
Додавання документа
Назва методу: /api/v2/document/income_invoice/add
Метод додає один документ за запит. Якщо передати Fixed: true, API спробує провести документ після створення.
| Поле | Опис |
|---|---|
array | Масив з одним документом. |
array[].Date | Дата документа. |
array[].Company | Id організації. Обов’язковий, якщо не заданий у шаблоні документа. |
array[].Partner | Id постачальника. Обов’язковий. |
array[].Contract | Id контракту. |
array[].Store | Id складу документа. Необов’язковий, якщо склади задаються в рядках. |
array[].PriceType | Id типу цін. |
array[].DiscountType | Id типу знижки. |
array[].Responsible | Id відповідального. Обов’язковий. |
array[].Comment | Коментар. |
array[].ParentId або array[].Parent | Id пов’язаного документа-джерела. |
array[].Sum | Сума документа. Якщо не передати, береться сума рядків. |
array[].SumWithoutDiscount | Сума без знижки. |
array[].MainSum | Сума в основній валюті. |
array[].Fixed | Провести документ після створення. |
array[].Rows або array[].RowsGoods | Рядки товарів або послуг. Обов’язкові. |
Поля рядка
| Поле | Опис |
|---|---|
Product | Id товару або послуги. Обов’язковий. |
Qty | Кількість. Якщо не передати, API підставить 1. |
Price | Ціна. |
Sum | Сума. Якщо не передати, рахується як Qty * Price. |
Store | Id складу в рядку. Якщо не передати, API використовує Store документа. |
Unit | Id одиниці виміру. Якщо не передати, API підставить одиницю товару. |
RowNo | Номер рядка. |
PriceWithoutDiscount | Ціна без знижки. |
PriceByCashAccount | Ціна у валюті рахунку. |
PriceWithoutDiscountByCashAccount | Ціна без знижки у валюті рахунку. |
MainPrice | Ціна в основній валюті. |
MainSum | Сума в основній валюті. |
CashAccountSum | Сума у валюті рахунку. |
PercentDiscount | Відсоток знижки. |
StoreCellFrom | Id комірки відбору. |
StoreCellTo | Id комірки розміщення. |
MemoRows або Comment | Коментар рядка. |
Barcode | Штрихкод. |
Vat | Id ставки ПДВ. |
UnitRate | Коефіцієнт одиниці виміру. |
QtyRate | Кількість з урахуванням коефіцієнта. |
SeriesCode | Серія. |
SeriesDateManufacture | Дата виробництва серії. |
SeriesDateShelfLife | Термін придатності серії. |
SeriesBarcode | Штрихкод серії. |
SeriesComment | Коментар серії. |
PnlItem | Id статті P&L. |
OutgoingOrder | Id пов’язаного замовлення. |
ParentRow | Id батьківського рядка. |
Приклад створення
{
"array": [
{
"Date": "2026-06-16",
"Company": 126,
"Partner": 410,
"Contract": 905,
"Store": 132,
"Responsible": 57,
"Comment": "Надходження від постачальника",
"Fixed": true,
"Rows": [
{
"Product": 5001,
"Qty": 10,
"Price": 85,
"Store": 132,
"Barcode": "4820000000012"
},
{
"Product": 5002,
"Qty": 4,
"Price": 120,
"Store": 132
}
]
}
]
}
Оновлення документа
Назва методу: /api/v2/document/income_invoice/update
Метод оновлює один документ за запит. Поле Id обов’язкове. Якщо передати Rows або RowsGoods, API замінить рядки документа перед збереженням.
Приклад оновлення
{
"array": [
{
"Id": 6112,
"Comment": "Оновлене надходження після звірки",
"Rows": [
{
"Id": 15001,
"Product": 5001,
"Qty": 8,
"Price": 85,
"Store": 132
}
]
}
]
}
Зняття документа з проведення
Назва методу: /api/v2/document/income_invoice/unpublish
Метод знімає з проведення один документ за запит.
{
"array": [
{
"Id": 6112
}
]
}