QUINCEFINСпробувати
Відкрити меню

QUINCE API. Продажі

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

МетодОпис
/api/v2/document/outgoing_invoice/listОтримання списку документів продажу

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

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

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

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

ПолеТипОпис
filterobjectФільтр документів. Поля фільтра працюють з логікою AND.
filter.IdintegerІдентифікатор документа.
filter.DateFromstringДата, починаючи з якої повертати документи. Формат: yyyy-mm-dd або yyyy-mm-dd HH:mm:ss.
filter.DateTostringДата, до якої повертати документи. Формат: yyyy-mm-dd або yyyy-mm-dd HH:mm:ss.
filter.CompanyintegerІдентифікатор організації.
filter.StatusarrayІдентифікатори статусів документа продажу.
filter.ArchivebooleanОзнака повернення архівних або скасованих документів.
filter.MobileAppbooleanЯкщо true, API використовує збільшений ліміт вибірки.
pageintegerНомер сторінки. Якщо не передати, використовується перша сторінка.

Якщо 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.