QUINCE API. Продажі
Список методів
| Метод | Опис |
|---|---|
/api/v2/document/outgoing_invoice/list | Отримання списку документів продажу |
Отримання списку документів продажу
Назва методу: /api/v2/document/outgoing_invoice/list
Повертає список документів продажу. Для навігації використовується номер сторінки page. Розмір сторінки фіксований і дорівнює 100 елементам.
Параметри запиту
| Поле | Тип | Опис |
|---|---|---|
filter | object | Фільтр документів. Поля фільтра працюють з логікою AND. |
filter.Id | integer | Ідентифікатор документа. |
filter.DateFrom | string | Дата, починаючи з якої повертати документи. Формат: yyyy-mm-dd або yyyy-mm-dd HH:mm:ss. |
filter.DateTo | string | Дата, до якої повертати документи. Формат: yyyy-mm-dd або yyyy-mm-dd HH:mm:ss. |
filter.Company | integer | Ідентифікатор організації. |
filter.Status | array | Ідентифікатори статусів документа продажу. |
filter.Archive | boolean | Ознака повернення архівних або скасованих документів. |
filter.MobileApp | boolean | Якщо true, API використовує збільшений ліміт вибірки. |
page | integer | Номер сторінки. Якщо не передати, використовується перша сторінка. |
Якщо DateFrom і DateTo не передані та немає фільтра Id, API повертає документи за поточний день. Якщо передати тільки одну з дат, API поверне помилку DateFrom and DateTo are required. Поле Status має бути масивом.
Основні поля відповіді
| Поле | Опис |
|---|---|
Id | Ідентифікатор документа. |
Date | Дата документа. |
Number | Номер документа. |
NumberOrderSite | Зовнішній номер. |
Sum | Сума документа. |
StoresInRows | Ознака використання складів у рядках. |
VatInclude | Ознака, що суми включають ПДВ. |
SumVat | Сума ПДВ. |
SumWithoutVat | Сума без ПДВ. |
Comment | Коментар. |
DeliveryAddress | Адреса доставки. |
DateScheduleShipment | Запланована дата доставки. |
Fixed | Ознака публікації документа. |
Partner | Партнер. |
Store | Склад. |
Status | Статус документа. |
Company | Організація. |
Contract | Контракт. |
PriceType | Тип ціни. |
DiscountType | Тип знижки. |
Responsible | Відповідальний. |
Rows | Товарні позиції. |
Масив NovaPoshtaNotes
Якщо для продажу доступні накладні Нової Пошти, /api/v2/document/outgoing_invoice/list повертає їх у масиві NovaPoshtaNotes. Це read-only дані: метод не створює, не оновлює і не видаляє ТТН.
API не вибирає одну “головну” накладну. У масив потрапляють усі активні ТТН, прив’язані безпосередньо до продажу. Якщо продаж створено із замовлення покупця, у масив також потрапляють активні ТТН батьківського замовлення. Поле Source показує джерело: document або parent_order.
| Поле | Опис |
|---|---|
NovaPoshtaNotes | Масив накладних Нової Пошти, пов’язаних із продажем або його батьківським замовленням. |
NovaPoshtaNotes[].Id | Ідентифікатор накладної Нової Пошти в QUINCEFIN. |
NovaPoshtaNotes[].Date | Дата накладної. |
NovaPoshtaNotes[].Number | Внутрішній номер документа накладної в QUINCEFIN. |
NovaPoshtaNotes[].NumberNP | Номер експрес-накладної Нової Пошти. |
NovaPoshtaNotes[].ENId | Ідентифікатор експрес-накладної у Новій Пошті, якщо він доступний. |
NovaPoshtaNotes[].Status | Текст поточного статусу Нової Пошти. |
NovaPoshtaNotes[].StatusCode | Код поточного статусу Нової Пошти. |
NovaPoshtaNotes[].StatusAlias | Коротка назва статусу для компактного відображення. |
NovaPoshtaNotes[].StatusColor | Службова назва кольору статусу в QUINCEFIN. |
NovaPoshtaNotes[].RecipientName | Ім’я або назва отримувача. |
NovaPoshtaNotes[].RecipientPhone | Телефон отримувача. |
NovaPoshtaNotes[].Source | Джерело ТТН: document або parent_order. |
NovaPoshtaNotes[].ParentDoc | Документ, до якого фактично прив’язана ТТН. |
NovaPoshtaNotes[].Fixed | Ознака публікації накладної. |
NovaPoshtaNotes[].Void | Ознака архівної або скасованої накладної. |
NovaPoshtaNotes[].Comment | Коментар. |
Доступ до документа продажу визначається правами користувача, для якого видано API-ключ. Якщо користувач не має доступу до документа продажу або пов’язаної організації, документ не повертається в списку.
Поля рядків Rows
| Поле | Опис |
|---|---|
Id | Ідентифікатор рядка. |
RowNo | Номер рядка. |
Product | Ідентифікатор товару або послуги. |
Price | Ціна. |
Qty | Кількість. |
Sum | Сума. |
SumVat | Сума ПДВ. |
PriceWithoutDiscount | Ціна без знижки. |
PercentDiscount | Відсоток знижки. |
Kind | Вид позиції: P - товар, S - послуга. |
Store | Склад рядка, якщо склади ведуться в рядках. |
Приклад запиту
{
"filter": {
"DateFrom": "2026-03-01",
"DateTo": "2026-03-31",
"Status": [111, 192]
},
"page": 1
}
Приклад фрагмента відповіді з ТТН
{
"success": true,
"data": [
{
"Id": 494872,
"Date": "2026-03-14T11:20:00",
"Number": "РН-000145",
"NumberOrderSite": "SHOP-10045",
"Sum": 2450,
"NovaPoshtaNotes": [
{
"Id": 782411,
"Date": "2026-03-14T11:25:00",
"Number": "НП-000087",
"NumberNP": "20450000000001",
"ENId": "8f2a4c45-7b56-11ee-a60f-48df37b921da",
"Status": "Відправлення прямує до міста отримувача",
"StatusCode": 5,
"StatusAlias": "В дорозі",
"StatusColor": "info",
"RecipientName": "Іван Петренко",
"RecipientPhone": "+380671112233",
"Source": "document",
"ParentDoc": {
"Id": 494872,
"Type": "OUTGOING_INVOICE",
"Number": "РН-000145",
"DisplayName": "Продаж №РН-000145 від 14.03.2026"
},
"Fixed": true,
"Void": false,
"Comment": ""
}
]
}
]
}
Якщо інтеграції потрібен окремий список накладних Нової Пошти або пошук за номером ТТН, використовуйте метод /api/v2/document/nova_poshta/list.