Статті на: Документація з API

QUINCE API. Списання товарів

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


/document/write_off_store/list

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



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


Назва методу: /document/write_off_store/list


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


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


filter Тип: object

Доступні поля для фільтрації (Фільтр завжди використовує логіку “AND“):

Id - ідентифікатор документу. Необов'язковий параметр

DateFrom - дата, починаючи з якої повертати замовлення. Обов'язковий параметр

DateTo - дата по яку повертати замовлення. Обов'язковий параметр

Company - ідентифікатор компанії, за якою отримуються документи. Необов'язковий параметр

page Тип: integer (необов'язковий)

Якщо в запиті не передати, за замовчуванням буде встановлена перша сторінка.


Результат запиту:


Якщо в запиті фільтр відсутній, то повертається список замовлень у порядку зростання Id.


Значення полів замовлень, що повертаються методом:


Id

Ідентифікатор замовлення

Date

Дата замовлення (string)

Number

Номер (string)

Comment

Коментар (string)

Fixed

Ознака публікації документа

Store

Об'єкт з полями "Id" та "Name"

Company

Об'єкт з полями "Id" та "Name"

Responsible

Об'єкт з полями "Id" та "PersonName"

Rows

Товарні позиції. Об'єкт з наступними полями:

Id - Ідентифікатор позиції

RowNo - Номер рядка

Product - Ідентифікатор товару

Qty - Кількість

Kind - Вид. Приймає значення "P" або "S" (товар або послуга)


Приклад:


Запит:


{
"filter": {
"DateFrom": "2022-06-20",
"DateTo": "2022-07-28"
},
"page": 1
}


Результат:


{
"success": true,
"data": [
{
"Id": 8027,
"Date": "2022-07-01T00:00:00Z",
"Number": 1,
"Fixed": false,
"Void": false,
"Store": {
"Id": 132,
"Name": "Store_5"
},
"Company": {
"Id": 298,
"Name": "Наше підприємство"
},
"Responsible": {
"Id": 898,
"PersonName": "ivan"
},
"Rows": [
{
"Id": 15705,
"RowNo": 4,
"Product": 89274,
"Qty": 1.000000,
"Kind": "P"
},
...
]
},
...
]
}

Оновлено: 23/06/2024