QUINCE API. Продажі

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

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

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

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

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

Розмір сторінки фіксований і дорівнює 100 елементам.

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

filter Тип: objectДоступні поля для фільтрації (Фільтр завжди використовує логіку “AND“):
Id - ідентифікатор документу. Необов’язковий параметр
DateFrom - дата, починаючи з якої повертати документи. Обов’язковий параметр
DateTo - дата по яку повертати документи. Обов’язковий параметр
Company - ідентифікатор компанії, за якою отримуються документи. Необов’язковий параметр
Status - масив Id статусів документа продаж
page Тип: integer (необов’язковий)Якщо в запиті не передати, за замовчуванням буде встановлена перша сторінка.

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

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

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

IdІдентифікатор документу
DateДата документу (string)
NumberНомер (string)
NumberOrderSiteЗовнішній номер (string)
SumСума документу (decimal)
StoresInRowsВказує на наявність складів у табличній частині (boolean)
VatIncludeСуми включають ПДВ (boolean)
SumVatСума ПДВ (decimal)
SumWithoutVatСума без ПДВ (decimal)
CommentКоментар (string)
DeliveryAddressАдреса доставки (string)
DateScheduleShipmentДата доставки (string)
FixedОзнака публікації документа
PartnerОб’єкт з полями “Id” та “Name”
StoreОб’єкт з полями “Id” та “Name”
StatusОб’єкт з полями “Id” та “Name”
CompanyОб’єкт з полями “Id” та “Name”
ContractОб’єкт з полями “Id” та “Name”
PriceTypeОб’єкт з полями “Id” та “Name”
DiscountTypeОб’єкт з полями “Id” та “Name”
ResponsibleОб’єкт з полями “Id” та “PersonName”
RowsТоварні позиції. Об’єкт з наступними полями:
Id - Ідентифікатор позиції
RowNo - Номер рядка
Product - Ідентифікатор товару
Price - Ціна
Qty - Кількість
Sum - Сума
SumVat - СумаПДВ
PriceWithoutDiscount - Ціна без знижки
PercentDiscount - Відсоток знижки
Kind - Вид. Приймає значення “P” або “S” (товар або послуга)

Приклад:

Запит:

{
    "filter": {
        "DateFrom": "2022-06-20",
        "DateTo": "2022-07-28",
        "Status": [111, 192]
    },
    "page": 1
}

Результат:

{
    "success": true,
    "data": [
        {
            "Id": 8027,
            "NumberOrderSite": "2",
            "Date": "2022-07-01T00:00:00Z",
            "Number": 1,
            "DeliveryAddress": "Осіння 105, Дніпро, 15151",
            "DateScheduleShipment": null,
            "Sum": 3278.90,
            "StoresInRows": false,
            "Fixed": false,
            "Void": false,
            "Partner": {
                "Id": 53869,
                "Name": "Buyer"
            },
            "Store": {
                "Id": 346,
                "Name": "Store_5"
            },
            "Status": {
                "Id": 1173,
                "Name": "Новий"
            },
            "Company": {
                "Id": 298,
                "Name": "Наше підприємство"
            },
            "Contract": {
                "Id": 54066,
                "Name": "Основний контракт (грн)"
            },
            "PriceType": {
                "Id": 335,
                "Name": "Ціна продажу"
            },
            "DiscountType": {},
            "Responsible": {
                "Id": 898,
                "PersonName": "ivan"
            },
            "Rows": [
                {
                    "Id": 15705,
                    "RowNo": 4,
                    "Product": 89274,
                    "Price": 324.940000,
                    "Qty": 1.000000,
                    "Sum": 324.94,
                    "PriceWithoutDiscount": 324.940000,
                    "PercentDiscount": 0.00,
                    "Kind": "P",
                    "Store": {
                				"Id": null,
                				"Name": null
            				}
                },
                ...
            ]
        },
        ...
    ]
}