Касові та ресторанні звіти

pos.reports_check_print_rowsПовертає товарні позиції чека для повторного друку. читання pos.read з 0.4.0

Повертає товарні позиції чека для повторного друку.

Перевірити JSON JSON Schema

Стабільність: стабільний Scope: pos.read Idempotency-Key: не потрібен

Параметри params

Поле	Що означає	Тип і формат	Правила
Додаткові
`group_rows`Group rows	Визначає, чи застосовувати параметр «Group rows». Передавайте JSON true або false.	`bool`	необов’язковийПриклад: `false`За замовчуванням: `true`
`nc`Номер чека	Номер касового чека у базі поточного клієнта.	`int`	необов’язковийПриклад: `1`За замовчуванням: `0`
`sk`Номер складу або філії	Номер складу/філії відповідно до налаштувань бази; 0 зазвичай означає основний склад.	`int`	необов’язковийПриклад: `1`За замовчуванням: `0`
`year`Рік	Поле «Рік» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.	`string`	необов’язковийПриклад: `"Приклад"`
Основні
`storage`Склад	Логічний склад: main — основний, branch — філіальний. `main` — основний склад `branch` — філіальний склад	`enum`	необов’язковийПриклад: `"main"`За замовчуванням: `"main"`

Точна схема параметрів

{
    "group_rows": {
        "type": "bool",
        "default": true,
        "title": "Group rows",
        "description": "Визначає, чи застосовувати параметр «Group rows». Передавайте JSON true або false.",
        "group": "Додаткові",
        "example": false
    },
    "nc": {
        "type": "int",
        "min": -2147483648,
        "max": 2147483647,
        "default": 0,
        "title": "Номер чека",
        "description": "Номер касового чека у базі поточного клієнта.",
        "group": "Додаткові",
        "example": 1
    },
    "sk": {
        "type": "int",
        "min": -2147483648,
        "max": 2147483647,
        "default": 0,
        "title": "Номер складу або філії",
        "description": "Номер складу/філії відповідно до налаштувань бази; 0 зазвичай означає основний склад.",
        "group": "Додаткові",
        "example": 1
    },
    "storage": {
        "type": "enum",
        "values": [
            "main",
            "branch"
        ],
        "default": "main",
        "title": "Склад",
        "description": "Логічний склад: main — основний, branch — філіальний.",
        "group": "Основні",
        "example": "main",
        "enum_labels": {
            "main": "основний склад",
            "branch": "філіальний склад"
        }
    },
    "year": {
        "type": "string",
        "max": 4,
        "pattern": "/^[0-9]{4}$/D",
        "title": "Рік",
        "description": "Поле «Рік» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": "Приклад"
    }
}

Результат

Форма відповіді: rows

Поле	Зміст	Тип	Приклад
`id`Ідентифікатор запису	Повернене значення «Ідентифікатор запису» відповідного запису, документа або підсумку ARM20.	`string`	`"Приклад"`
`code`Код товару	Повернене значення «Код товару» відповідного запису, документа або підсумку ARM20.	`string`	`"1001"`
`name`Назва	Повернене значення «Назва» відповідного запису, документа або підсумку ARM20.	`string`	`"Тестовий товар"`
`sale_price`Sale price	Точне повернене значення «Sale price» як десятковий рядок із крапкою.	`string · decimal-string · currency-of-operation`	`"100.00"`
`price`Ціна	Точне повернене значення «Ціна» як десятковий рядок із крапкою.	`string · decimal-string · currency-of-operation`	`"100.00"`
`unit_type`Одиниця виміру	Повернене значення «Одиниця виміру» відповідного запису, документа або підсумку ARM20.	`string`	`"Приклад"`
`quantity`Кількість	Точне повернене значення «Кількість» як десятковий рядок із крапкою.	`string · decimal-string · product-unit`	`"1.000"`
`document_number`Номер документа	Номер документа у базі поточного клієнта.	`string`	`"ПН-1001"`
`fiscal`Фіскальна ознака	Повернене значення «Фіскальна ознака» відповідного запису, документа або підсумку ARM20.	`string`	`"Приклад"`
`c2`C2	Повернене значення «C2» відповідного запису, документа або підсумку ARM20.	`string`	`"Приклад"`
`excise_input`Excise input	Повернене значення «Excise input» відповідного запису, документа або підсумку ARM20.	`string`	`"Приклад"`
`category_id`Ідентифікатор категорії	Повернене значення «Ідентифікатор категорії» відповідного запису, документа або підсумку ARM20.	`string`	`"Приклад"`
`uktzed`Код УКТ ЗЕД	Повернене значення «Код УКТ ЗЕД» відповідного запису, документа або підсумку ARM20.	`string`	`"Приклад"`

Точна схема результату

{
    "mode": "rows",
    "columns": [
        "id",
        "code",
        "name",
        "sale_price",
        "price",
        "unit_type",
        "quantity",
        "document_number",
        "fiscal",
        "c2",
        "excise_input",
        "category_id",
        "uktzed"
    ],
    "field_specs": {
        "id": {
            "title": "Ідентифікатор запису",
            "description": "Повернене значення «Ідентифікатор запису» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "code": {
            "title": "Код товару",
            "description": "Повернене значення «Код товару» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "1001"
        },
        "name": {
            "title": "Назва",
            "description": "Повернене значення «Назва» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Тестовий товар"
        },
        "sale_price": {
            "title": "Sale price",
            "description": "Точне повернене значення «Sale price» як десятковий рядок із крапкою.",
            "type": "string",
            "format": "decimal-string",
            "unit": "currency-of-operation",
            "example": "100.00"
        },
        "price": {
            "title": "Ціна",
            "description": "Точне повернене значення «Ціна» як десятковий рядок із крапкою.",
            "type": "string",
            "format": "decimal-string",
            "unit": "currency-of-operation",
            "example": "100.00"
        },
        "unit_type": {
            "title": "Одиниця виміру",
            "description": "Повернене значення «Одиниця виміру» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "quantity": {
            "title": "Кількість",
            "description": "Точне повернене значення «Кількість» як десятковий рядок із крапкою.",
            "type": "string",
            "format": "decimal-string",
            "unit": "product-unit",
            "example": "1.000"
        },
        "document_number": {
            "title": "Номер документа",
            "description": "Номер документа у базі поточного клієнта.",
            "type": "string",
            "example": "ПН-1001"
        },
        "fiscal": {
            "title": "Фіскальна ознака",
            "description": "Повернене значення «Фіскальна ознака» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "c2": {
            "title": "C2",
            "description": "Повернене значення «C2» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "excise_input": {
            "title": "Excise input",
            "description": "Повернене значення «Excise input» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "category_id": {
            "title": "Ідентифікатор категорії",
            "description": "Повернене значення «Ідентифікатор категорії» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "uktzed": {
            "title": "Код УКТ ЗЕД",
            "description": "Повернене значення «Код УКТ ЗЕД» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

Приклад запиту

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json

{
    "method": "pos.reports_check_print_rows",
    "params": {
        "year": "2026",
        "nc": 1001,
        "storage": "main",
        "sk": 1
    },
    "id": "example-pos-reports-check-print-rows"
}

Замініть демонстраційні значення даними зі своєї бази.

Приклад успішної відповіді

{
    "ok": true,
    "data": {
        "method": "pos.reports_check_print_rows",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "pos"
            },
            "status": {
                "code": "OK",
                "operation": "reports_check_print_rows",
                "value": "1"
            },
            "rows": [
                {
                    "id": "Приклад",
                    "code": "1001",
                    "name": "Тестовий товар",
                    "sale_price": "100.00",
                    "price": "100.00",
                    "unit_type": "Приклад",
                    "quantity": "1.000",
                    "document_number": "ПН-1001",
                    "fiscal": "Приклад",
                    "c2": "Приклад",
                    "excise_input": "Приклад",
                    "category_id": "Приклад",
                    "uktzed": "Приклад"
                }
            ]
        },
        "id": "example-pos-reports-check-print-rows"
    },
    "request_id": "req_example_0123456789abcdef"
}

Помилки та повтори цього методу

Код	HTTP	Причина	Дія клієнта
`INVALID_PARAMETER`	422	Один із параметрів має неправильний тип, формат або значення.	Виправити запит; автоматично не повторювати.
`UPSTREAM_FAILURE`	502	Сервер бізнес-операції недоступний або відхилив безпечний контракт.	Дозволений повтор із backoff.

pos.reports_checks_todayПовертає касові чеки, створені сьогодні. читання pos.read з 0.4.0

Повертає касові чеки, створені сьогодні.

Перевірити JSON JSON Schema

Стабільність: стабільний Scope: pos.read Idempotency-Key: не потрібен

Параметри params

Поле	Що означає	Тип і формат	Правила
Дати й час
`date_from`Початкова дата	Дата «Початкова дата» у календарному форматі YYYY-MM-DD.	`string · date`	необов’язковийПриклад: `"2026-07-23"`За замовчуванням: `""`
`date_to`Кінцева дата	Дата «Кінцева дата» у календарному форматі YYYY-MM-DD.	`string · date`	необов’язковийПриклад: `"2026-07-23"`За замовчуванням: `""`
Додаткові
`limit`Максимальна кількість рядків	Максимальна кількість рядків, яку потрібно повернути. Менше значення зменшує відповідь.	`int`	необов’язковийПриклад: `1`За замовчуванням: `1990`

Точна схема параметрів

{
    "date_from": {
        "type": "string",
        "max": 512,
        "default": "",
        "title": "Початкова дата",
        "description": "Дата «Початкова дата» у календарному форматі YYYY-MM-DD.",
        "group": "Дати й час",
        "format": "date",
        "example": "2026-07-23"
    },
    "date_to": {
        "type": "string",
        "max": 512,
        "default": "",
        "title": "Кінцева дата",
        "description": "Дата «Кінцева дата» у календарному форматі YYYY-MM-DD.",
        "group": "Дати й час",
        "format": "date",
        "example": "2026-07-23"
    },
    "limit": {
        "type": "int",
        "min": 1,
        "max": 5000,
        "default": 1990,
        "title": "Максимальна кількість рядків",
        "description": "Максимальна кількість рядків, яку потрібно повернути. Менше значення зменшує відповідь.",
        "group": "Додаткові",
        "example": 1
    }
}

Результат

Форма відповіді: rows

Поле	Зміст	Тип	Приклад
`check_number`Номер чека	Номер касового чека у базі поточного клієнта.	`string`	`"Приклад"`
`total`Total	Кількість рядків або об’єктів у результаті операції.	`string · decimal-string · currency-of-operation`	`"100.00"`
`cash_received`Cash received	Точне повернене значення «Cash received» як десятковий рядок із крапкою.	`string · decimal-string · currency-of-operation`	`"100.00"`
`discount`Дисконтна картка або знижка	Точне повернене значення «Дисконтна картка або знижка» як десятковий рядок із крапкою.	`string · decimal-string · currency-of-operation`	`"100.00"`
`payment_type`Payment type	Повернене значення «Payment type» відповідного запису, документа або підсумку ARM20.	`string`	`"Приклад"`
`date`Дата	Повернена дата «Дата» у форматі YYYY-MM-DD.	`string · date`	`"2026-07-23"`
`is_return`Is return	Повернене значення «Is return» відповідного запису, документа або підсумку ARM20.	`string`	`"Приклад"`

Точна схема результату

{
    "mode": "rows",
    "columns": [
        "check_number",
        "total",
        "cash_received",
        "discount",
        "payment_type",
        "date",
        "is_return"
    ],
    "field_specs": {
        "check_number": {
            "title": "Номер чека",
            "description": "Номер касового чека у базі поточного клієнта.",
            "type": "string",
            "example": "Приклад"
        },
        "total": {
            "title": "Total",
            "description": "Кількість рядків або об’єктів у результаті операції.",
            "type": "string",
            "format": "decimal-string",
            "unit": "currency-of-operation",
            "example": "100.00"
        },
        "cash_received": {
            "title": "Cash received",
            "description": "Точне повернене значення «Cash received» як десятковий рядок із крапкою.",
            "type": "string",
            "format": "decimal-string",
            "unit": "currency-of-operation",
            "example": "100.00"
        },
        "discount": {
            "title": "Дисконтна картка або знижка",
            "description": "Точне повернене значення «Дисконтна картка або знижка» як десятковий рядок із крапкою.",
            "type": "string",
            "format": "decimal-string",
            "unit": "currency-of-operation",
            "example": "100.00"
        },
        "payment_type": {
            "title": "Payment type",
            "description": "Повернене значення «Payment type» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "date": {
            "title": "Дата",
            "description": "Повернена дата «Дата» у форматі YYYY-MM-DD.",
            "type": "string",
            "format": "date",
            "example": "2026-07-23"
        },
        "is_return": {
            "title": "Is return",
            "description": "Повернене значення «Is return» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

Приклад запиту

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json

{
    "method": "pos.reports_checks_today",
    "params": {
        "date_from": "2026-07-01",
        "date_to": "2026-07-31",
        "limit": 20
    },
    "id": "example-pos-reports-checks-today"
}

Замініть демонстраційні значення даними зі своєї бази.

Приклад успішної відповіді

{
    "ok": true,
    "data": {
        "method": "pos.reports_checks_today",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "pos"
            },
            "status": {
                "code": "OK",
                "operation": "reports_checks_today",
                "value": "1"
            },
            "rows": [
                {
                    "check_number": "Приклад",
                    "total": "100.00",
                    "cash_received": "100.00",
                    "discount": "100.00",
                    "payment_type": "Приклад",
                    "date": "2026-07-23",
                    "is_return": "Приклад"
                }
            ]
        },
        "id": "example-pos-reports-checks-today"
    },
    "request_id": "req_example_0123456789abcdef"
}

Помилки та повтори цього методу

Код	HTTP	Причина	Дія клієнта
`INVALID_PARAMETER`	422	Один із параметрів має неправильний тип, формат або значення.	Виправити запит; автоматично не повторювати.
`UPSTREAM_FAILURE`	502	Сервер бізнес-операції недоступний або відхилив безпечний контракт.	Дозволений повтор із backoff.

pos.reports_day_categoriesПовертає продажі за день у розрізі категорій товарів. читання pos.read з 0.4.0

Повертає продажі за день у розрізі категорій товарів.

Перевірити JSON JSON Schema

Стабільність: стабільний Scope: pos.read Idempotency-Key: не потрібен

Параметри params

Поле	Що означає	Тип і формат	Правила
Дати й час
`date_from`Початкова дата	Дата «Початкова дата» у календарному форматі YYYY-MM-DD.	`string · date`	необов’язковийПриклад: `"2026-07-23"`За замовчуванням: `""`
`date_to`Кінцева дата	Дата «Кінцева дата» у календарному форматі YYYY-MM-DD.	`string · date`	необов’язковийПриклад: `"2026-07-23"`За замовчуванням: `""`
Додаткові
`year`Рік	Поле «Рік» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.	`string`	необов’язковийПриклад: `"Приклад"`

Точна схема параметрів

{
    "date_from": {
        "type": "string",
        "max": 512,
        "default": "",
        "title": "Початкова дата",
        "description": "Дата «Початкова дата» у календарному форматі YYYY-MM-DD.",
        "group": "Дати й час",
        "format": "date",
        "example": "2026-07-23"
    },
    "date_to": {
        "type": "string",
        "max": 512,
        "default": "",
        "title": "Кінцева дата",
        "description": "Дата «Кінцева дата» у календарному форматі YYYY-MM-DD.",
        "group": "Дати й час",
        "format": "date",
        "example": "2026-07-23"
    },
    "year": {
        "type": "string",
        "max": 4,
        "pattern": "/^[0-9]{4}$/D",
        "title": "Рік",
        "description": "Поле «Рік» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": "Приклад"
    }
}

Результат

Форма відповіді: rows

Поле	Зміст	Тип	Приклад
`category`Категорія товару	Повернене значення «Категорія товару» відповідного запису, документа або підсумку ARM20.	`string`	`"Приклад"`
`total`Total	Кількість рядків або об’єктів у результаті операції.	`string · decimal-string · currency-of-operation`	`"100.00"`

Точна схема результату

{
    "mode": "rows",
    "columns": [
        "category",
        "total"
    ],
    "field_specs": {
        "category": {
            "title": "Категорія товару",
            "description": "Повернене значення «Категорія товару» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "total": {
            "title": "Total",
            "description": "Кількість рядків або об’єктів у результаті операції.",
            "type": "string",
            "format": "decimal-string",
            "unit": "currency-of-operation",
            "example": "100.00"
        }
    }
}

Приклад запиту

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json

{
    "method": "pos.reports_day_categories",
    "params": {
        "date_from": "2026-07-01",
        "date_to": "2026-07-31",
        "year": "2026"
    },
    "id": "example-pos-reports-day-categories"
}

Замініть демонстраційні значення даними зі своєї бази.

Приклад успішної відповіді

{
    "ok": true,
    "data": {
        "method": "pos.reports_day_categories",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "pos"
            },
            "status": {
                "code": "OK",
                "operation": "reports_day_categories",
                "value": "1"
            },
            "rows": [
                {
                    "category": "Приклад",
                    "total": "100.00"
                }
            ]
        },
        "id": "example-pos-reports-day-categories"
    },
    "request_id": "req_example_0123456789abcdef"
}

Помилки та повтори цього методу

Код	HTTP	Причина	Дія клієнта
`INVALID_PARAMETER`	422	Один із параметрів має неправильний тип, формат або значення.	Виправити запит; автоматично не повторювати.
`UPSTREAM_FAILURE`	502	Сервер бізнес-операції недоступний або відхилив безпечний контракт.	Дозволений повтор із backoff.

pos.reports_day_kassesПовертає підсумки продажів за день у розрізі кас. читання pos.read з 0.4.0

Повертає підсумки продажів за день у розрізі кас.

Перевірити JSON JSON Schema

Стабільність: стабільний Scope: pos.read Idempotency-Key: не потрібен

Параметри params

Поле	Що означає	Тип і формат	Правила
Дати й час
`date_from`Початкова дата	Дата «Початкова дата» у календарному форматі YYYY-MM-DD.	`string · date`	необов’язковийПриклад: `"2026-07-23"`За замовчуванням: `""`
`date_to`Кінцева дата	Дата «Кінцева дата» у календарному форматі YYYY-MM-DD.	`string · date`	необов’язковийПриклад: `"2026-07-23"`За замовчуванням: `""`

Точна схема параметрів

{
    "date_from": {
        "type": "string",
        "max": 512,
        "default": "",
        "title": "Початкова дата",
        "description": "Дата «Початкова дата» у календарному форматі YYYY-MM-DD.",
        "group": "Дати й час",
        "format": "date",
        "example": "2026-07-23"
    },
    "date_to": {
        "type": "string",
        "max": 512,
        "default": "",
        "title": "Кінцева дата",
        "description": "Дата «Кінцева дата» у календарному форматі YYYY-MM-DD.",
        "group": "Дати й час",
        "format": "date",
        "example": "2026-07-23"
    }
}

Результат

Форма відповіді: rows

Поле	Зміст	Тип	Приклад
`payment_type`Payment type	Повернене значення «Payment type» відповідного запису, документа або підсумку ARM20.	`string`	`"Приклад"`
`total`Total	Кількість рядків або об’єктів у результаті операції.	`string · decimal-string · currency-of-operation`	`"100.00"`

Точна схема результату

{
    "mode": "rows",
    "columns": [
        "payment_type",
        "total"
    ],
    "field_specs": {
        "payment_type": {
            "title": "Payment type",
            "description": "Повернене значення «Payment type» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "total": {
            "title": "Total",
            "description": "Кількість рядків або об’єктів у результаті операції.",
            "type": "string",
            "format": "decimal-string",
            "unit": "currency-of-operation",
            "example": "100.00"
        }
    }
}

Приклад запиту

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json

{
    "method": "pos.reports_day_kasses",
    "params": {
        "date_from": "2026-07-01",
        "date_to": "2026-07-31"
    },
    "id": "example-pos-reports-day-kasses"
}

Замініть демонстраційні значення даними зі своєї бази.

Приклад успішної відповіді

{
    "ok": true,
    "data": {
        "method": "pos.reports_day_kasses",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "pos"
            },
            "status": {
                "code": "OK",
                "operation": "reports_day_kasses",
                "value": "1"
            },
            "rows": [
                {
                    "payment_type": "Приклад",
                    "total": "100.00"
                }
            ]
        },
        "id": "example-pos-reports-day-kasses"
    },
    "request_id": "req_example_0123456789abcdef"
}

Помилки та повтори цього методу

Код	HTTP	Причина	Дія клієнта
`INVALID_PARAMETER`	422	Один із параметрів має неправильний тип, формат або значення.	Виправити запит; автоматично не повторювати.
`UPSTREAM_FAILURE`	502	Сервер бізнес-операції недоступний або відхилив безпечний контракт.	Дозволений повтор із backoff.

pos.reports_day_summaryПовертає загальний підсумок продажів за день. читання pos.read з 0.4.0

Повертає загальний підсумок продажів за день.

Перевірити JSON JSON Schema

Стабільність: стабільний Scope: pos.read Idempotency-Key: не потрібен

Параметри params

Поле	Що означає	Тип і формат	Правила
Дати й час
`date_from`Початкова дата	Дата «Початкова дата» у календарному форматі YYYY-MM-DD.	`string · date`	необов’язковийПриклад: `"2026-07-23"`За замовчуванням: `""`
`date_to`Кінцева дата	Дата «Кінцева дата» у календарному форматі YYYY-MM-DD.	`string · date`	необов’язковийПриклад: `"2026-07-23"`За замовчуванням: `""`

Точна схема параметрів

{
    "date_from": {
        "type": "string",
        "max": 512,
        "default": "",
        "title": "Початкова дата",
        "description": "Дата «Початкова дата» у календарному форматі YYYY-MM-DD.",
        "group": "Дати й час",
        "format": "date",
        "example": "2026-07-23"
    },
    "date_to": {
        "type": "string",
        "max": 512,
        "default": "",
        "title": "Кінцева дата",
        "description": "Дата «Кінцева дата» у календарному форматі YYYY-MM-DD.",
        "group": "Дати й час",
        "format": "date",
        "example": "2026-07-23"
    }
}

Результат

Форма відповіді: rows

Поле	Зміст	Тип	Приклад
`metric`Metric	Повернене значення «Metric» відповідного запису, документа або підсумку ARM20.	`string`	`"Приклад"`
`value`Значення	Повернене значення «Значення» відповідного запису, документа або підсумку ARM20.	`string`	`"Приклад"`

Точна схема результату

{
    "mode": "rows",
    "columns": [
        "metric",
        "value"
    ],
    "field_specs": {
        "metric": {
            "title": "Metric",
            "description": "Повернене значення «Metric» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "value": {
            "title": "Значення",
            "description": "Повернене значення «Значення» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

Приклад запиту

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json

{
    "method": "pos.reports_day_summary",
    "params": {
        "date_from": "2026-07-01",
        "date_to": "2026-07-31"
    },
    "id": "example-pos-reports-day-summary"
}

Замініть демонстраційні значення даними зі своєї бази.

Приклад успішної відповіді

{
    "ok": true,
    "data": {
        "method": "pos.reports_day_summary",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "pos"
            },
            "status": {
                "code": "OK",
                "operation": "reports_day_summary",
                "value": "1"
            },
            "rows": [
                {
                    "metric": "Приклад",
                    "value": "Приклад"
                }
            ]
        },
        "id": "example-pos-reports-day-summary"
    },
    "request_id": "req_example_0123456789abcdef"
}

Помилки та повтори цього методу

Код	HTTP	Причина	Дія клієнта
`INVALID_PARAMETER`	422	Один із параметрів має неправильний тип, формат або значення.	Виправити запит; автоматично не повторювати.
`UPSTREAM_FAILURE`	502	Сервер бізнес-операції недоступний або відхилив безпечний контракт.	Дозволений повтор із backoff.

pos.reports_printed_checkПовертає дані раніше надрукованого касового чека. читання pos.read з 0.4.0

Повертає дані раніше надрукованого касового чека.

Перевірити JSON JSON Schema

Стабільність: стабільний Scope: pos.read Idempotency-Key: не потрібен

Параметри params

Поле	Що означає	Тип і формат	Правила
Додаткові
`nc`Номер чека	Номер касового чека у базі поточного клієнта.	`string`	обов’язковийПриклад: `"Приклад"`

Точна схема параметрів

{
    "nc": {
        "type": "string",
        "max": 4096,
        "required": true,
        "title": "Номер чека",
        "description": "Номер касового чека у базі поточного клієнта.",
        "group": "Додаткові",
        "example": "Приклад"
    }
}

Результат

Форма відповіді: rows

Поле	Зміст	Тип	Приклад
`check_number`Номер чека	Номер касового чека у базі поточного клієнта.	`string`	`"Приклад"`
`text`Text	Повернене значення «Text» відповідного запису, документа або підсумку ARM20.	`string`	`"Приклад"`
`date`Дата	Повернена дата «Дата» у форматі YYYY-MM-DD.	`string · date`	`"2026-07-23"`

Точна схема результату

{
    "mode": "rows",
    "columns": [
        "check_number",
        "text",
        "date"
    ],
    "field_specs": {
        "check_number": {
            "title": "Номер чека",
            "description": "Номер касового чека у базі поточного клієнта.",
            "type": "string",
            "example": "Приклад"
        },
        "text": {
            "title": "Text",
            "description": "Повернене значення «Text» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "date": {
            "title": "Дата",
            "description": "Повернена дата «Дата» у форматі YYYY-MM-DD.",
            "type": "string",
            "format": "date",
            "example": "2026-07-23"
        }
    }
}

Приклад запиту

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json

{
    "method": "pos.reports_printed_check",
    "params": {
        "nc": "Приклад"
    },
    "id": "example-pos-reports-printed-check"
}

Замініть демонстраційні значення даними зі своєї бази.

Приклад успішної відповіді

{
    "ok": true,
    "data": {
        "method": "pos.reports_printed_check",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "pos"
            },
            "status": {
                "code": "OK",
                "operation": "reports_printed_check",
                "value": "1"
            },
            "rows": [
                {
                    "check_number": "Приклад",
                    "text": "Приклад",
                    "date": "2026-07-23"
                }
            ]
        },
        "id": "example-pos-reports-printed-check"
    },
    "request_id": "req_example_0123456789abcdef"
}

Помилки та повтори цього методу

Код	HTTP	Причина	Дія клієнта
`INVALID_PARAMETER`	422	Один із параметрів має неправильний тип, формат або значення.	Виправити запит; автоматично не повторювати.
`UPSTREAM_FAILURE`	502	Сервер бізнес-операції недоступний або відхилив безпечний контракт.	Дозволений повтор із backoff.

pos.reports_rest_client_checksПовертає чеки клієнтів ресторану, які очікують друку. читання pos.read з 0.4.0

Повертає чеки клієнтів ресторану, які очікують друку.

Перевірити JSON JSON Schema

Стабільність: стабільний Scope: pos.read Idempotency-Key: не потрібен

Параметри params

Параметри не потрібні. Передайте порожній об’єкт {}.

Точна схема параметрів

{}

Результат

Форма відповіді: rows

Поле	Зміст	Тип	Приклад
`check_number`Номер чека	Номер касового чека у базі поточного клієнта.	`string`	`"Приклад"`
`user_name`User name	Повернене значення «User name» відповідного запису, документа або підсумку ARM20.	`string`	`"Приклад"`

Точна схема результату

{
    "mode": "rows",
    "columns": [
        "check_number",
        "user_name"
    ],
    "field_specs": {
        "check_number": {
            "title": "Номер чека",
            "description": "Номер касового чека у базі поточного клієнта.",
            "type": "string",
            "example": "Приклад"
        },
        "user_name": {
            "title": "User name",
            "description": "Повернене значення «User name» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

Приклад запиту

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json

{
    "method": "pos.reports_rest_client_checks",
    "params": [],
    "id": "example-pos-reports-rest-client-checks"
}

Замініть демонстраційні значення даними зі своєї бази.

Приклад успішної відповіді

{
    "ok": true,
    "data": {
        "method": "pos.reports_rest_client_checks",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "pos"
            },
            "status": {
                "code": "OK",
                "operation": "reports_rest_client_checks",
                "value": "1"
            },
            "rows": [
                {
                    "check_number": "Приклад",
                    "user_name": "Приклад"
                }
            ]
        },
        "id": "example-pos-reports-rest-client-checks"
    },
    "request_id": "req_example_0123456789abcdef"
}

Помилки та повтори цього методу

Код	HTTP	Причина	Дія клієнта
`INVALID_PARAMETER`	422	Один із параметрів має неправильний тип, формат або значення.	Виправити запит; автоматично не повторювати.
`UPSTREAM_FAILURE`	502	Сервер бізнес-операції недоступний або відхилив безпечний контракт.	Дозволений повтор із backoff.

pos.reports_rest_client_linesПовертає позиції клієнтського ресторанного чека. читання pos.read з 0.4.0

Повертає позиції клієнтського ресторанного чека.

Перевірити JSON JSON Schema

Стабільність: стабільний Scope: pos.read Idempotency-Key: не потрібен

Параметри params

Поле	Що означає	Тип і формат	Правила
Додаткові
`nc`Номер чека	Номер касового чека у базі поточного клієнта.	`int`	необов’язковийПриклад: `1`За замовчуванням: `0`
`order_mode`Сортування	Варіант «Сортування». Використовуйте лише одне зі значень, розшифрованих нижче. `date` — за датою `dopinf` — за додатковою інформацією	`enum`	необов’язковийПриклад: `"date"`За замовчуванням: `"date"`
`year`Рік	Поле «Рік» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.	`string`	необов’язковийПриклад: `"Приклад"`

Точна схема параметрів

{
    "nc": {
        "type": "int",
        "min": -2147483648,
        "max": 2147483647,
        "default": 0,
        "title": "Номер чека",
        "description": "Номер касового чека у базі поточного клієнта.",
        "group": "Додаткові",
        "example": 1
    },
    "order_mode": {
        "type": "enum",
        "values": [
            "date",
            "dopinf"
        ],
        "default": "date",
        "title": "Сортування",
        "description": "Варіант «Сортування». Використовуйте лише одне зі значень, розшифрованих нижче.",
        "group": "Додаткові",
        "example": "date",
        "enum_labels": {
            "date": "за датою",
            "dopinf": "за додатковою інформацією"
        }
    },
    "year": {
        "type": "string",
        "max": 4,
        "pattern": "/^[0-9]{4}$/D",
        "title": "Рік",
        "description": "Поле «Рік» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": "Приклад"
    }
}

Результат

Форма відповіді: rows

Поле	Зміст	Тип	Приклад
`name`Назва	Повернене значення «Назва» відповідного запису, документа або підсумку ARM20.	`string`	`"Тестовий товар"`
`quantity`Кількість	Точне повернене значення «Кількість» як десятковий рядок із крапкою.	`string · decimal-string · product-unit`	`"1.000"`
`sale_total`Sale total	Точне повернене значення «Sale total» як десятковий рядок із крапкою.	`string · decimal-string · currency-of-operation`	`"100.00"`
`unit_type`Одиниця виміру	Повернене значення «Одиниця виміру» відповідного запису, документа або підсумку ARM20.	`string`	`"Приклад"`
`price_total`Price total	Точне повернене значення «Price total» як десятковий рядок із крапкою.	`string · decimal-string · currency-of-operation`	`"100.00"`
`additional_info`Додаткова інформація	Повернене значення «Додаткова інформація» відповідного запису, документа або підсумку ARM20.	`string`	`"Приклад"`

Точна схема результату

{
    "mode": "rows",
    "columns": [
        "name",
        "quantity",
        "sale_total",
        "unit_type",
        "price_total",
        "additional_info"
    ],
    "field_specs": {
        "name": {
            "title": "Назва",
            "description": "Повернене значення «Назва» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Тестовий товар"
        },
        "quantity": {
            "title": "Кількість",
            "description": "Точне повернене значення «Кількість» як десятковий рядок із крапкою.",
            "type": "string",
            "format": "decimal-string",
            "unit": "product-unit",
            "example": "1.000"
        },
        "sale_total": {
            "title": "Sale total",
            "description": "Точне повернене значення «Sale total» як десятковий рядок із крапкою.",
            "type": "string",
            "format": "decimal-string",
            "unit": "currency-of-operation",
            "example": "100.00"
        },
        "unit_type": {
            "title": "Одиниця виміру",
            "description": "Повернене значення «Одиниця виміру» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "price_total": {
            "title": "Price total",
            "description": "Точне повернене значення «Price total» як десятковий рядок із крапкою.",
            "type": "string",
            "format": "decimal-string",
            "unit": "currency-of-operation",
            "example": "100.00"
        },
        "additional_info": {
            "title": "Додаткова інформація",
            "description": "Повернене значення «Додаткова інформація» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

Приклад запиту

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json

{
    "method": "pos.reports_rest_client_lines",
    "params": {
        "nc": 1001,
        "order_mode": "date",
        "year": "2026"
    },
    "id": "example-pos-reports-rest-client-lines"
}

Замініть демонстраційні значення даними зі своєї бази.

Приклад успішної відповіді

{
    "ok": true,
    "data": {
        "method": "pos.reports_rest_client_lines",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "pos"
            },
            "status": {
                "code": "OK",
                "operation": "reports_rest_client_lines",
                "value": "1"
            },
            "rows": [
                {
                    "name": "Тестовий товар",
                    "quantity": "1.000",
                    "sale_total": "100.00",
                    "unit_type": "Приклад",
                    "price_total": "100.00",
                    "additional_info": "Приклад"
                }
            ]
        },
        "id": "example-pos-reports-rest-client-lines"
    },
    "request_id": "req_example_0123456789abcdef"
}

Помилки та повтори цього методу

Код	HTTP	Причина	Дія клієнта
`INVALID_PARAMETER`	422	Один із параметрів має неправильний тип, формат або значення.	Виправити запит; автоматично не повторювати.
`UPSTREAM_FAILURE`	502	Сервер бізнес-операції недоступний або відхилив безпечний контракт.	Дозволений повтор із backoff.

pos.reports_rest_client_mark_printedПозначає клієнтський ресторанний чек як надрукований. запис pos.write з 0.4.0

Позначає клієнтський ресторанний чек як надрукований.

Перевірити JSON JSON Schema

Стабільність: стабільний Scope: pos.write Idempotency-Key: потрібен

Параметри params

Поле	Що означає	Тип і формат	Правила
Додаткові
`nc`Номер чека	Номер касового чека у базі поточного клієнта.	`int`	необов’язковийПриклад: `1`За замовчуванням: `0`

Точна схема параметрів

{
    "nc": {
        "type": "int",
        "min": -2147483648,
        "max": 2147483647,
        "default": 0,
        "title": "Номер чека",
        "description": "Номер касового чека у базі поточного клієнта.",
        "group": "Додаткові",
        "example": 1
    }
}

Результат

Форма відповіді: status

Поле	Зміст	Тип	Приклад
`affected`Змінено записів	Кількість записів, які upstream фактично змінив.	`string`	`"Приклад"`

Точна схема результату

{
    "mode": "status",
    "fields": [
        "affected"
    ],
    "field_specs": {
        "affected": {
            "title": "Змінено записів",
            "description": "Кількість записів, які upstream фактично змінив.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

Приклад запиту

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
Idempotency-Key: example-pos-reports-rest-client-mark-printed-0001

{
    "method": "pos.reports_rest_client_mark_printed",
    "params": {
        "nc": 1001
    },
    "id": "example-pos-reports-rest-client-mark-printed"
}

Замініть демонстраційні значення даними зі своєї бази.

Приклад успішної відповіді

{
    "ok": true,
    "data": {
        "method": "pos.reports_rest_client_mark_printed",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "pos"
            },
            "status": {
                "code": "OK",
                "operation": "reports_rest_client_mark_printed",
                "affected": "Приклад"
            },
            "rows": []
        },
        "id": "example-pos-reports-rest-client-mark-printed"
    },
    "request_id": "req_example_0123456789abcdef"
}

Помилки та повтори цього методу

Код	HTTP	Причина	Дія клієнта
`INVALID_PARAMETER`	422	Один із параметрів має неправильний тип, формат або значення.	Виправити запит; автоматично не повторювати.
`UPSTREAM_FAILURE`	502	Сервер бізнес-операції недоступний або відхилив безпечний контракт.	Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт.
`IDEMPOTENCY_KEY_REQUIRED`	422	Для виконання запису не передано Idempotency-Key.	Створити ключ для цієї бізнес-операції та повторити.
`IDEMPOTENCY_RESULT_UNKNOWN`	409	Результат попередньої спроби невідомий; gateway не виконав запис повторно.	Звірити документ, чек або платіж; не створювати новий ключ автоматично.

pos.reports_rest_discountsПовертає знижки, застосовані в ресторанних замовленнях. читання pos.read з 0.4.0

Повертає знижки, застосовані в ресторанних замовленнях.

Перевірити JSON JSON Schema

Стабільність: стабільний Scope: pos.read Idempotency-Key: не потрібен

Параметри params

Поле	Що означає	Тип і формат	Правила
Додаткові
`nc`Номер чека	Номер касового чека у базі поточного клієнта.	`int`	необов’язковийПриклад: `1`За замовчуванням: `0`

Точна схема параметрів

{
    "nc": {
        "type": "int",
        "min": -2147483648,
        "max": 2147483647,
        "default": 0,
        "title": "Номер чека",
        "description": "Номер касового чека у базі поточного клієнта.",
        "group": "Додаткові",
        "example": 1
    }
}

Результат

Форма відповіді: rows

Поле	Зміст	Тип	Приклад
`card`Номер дисконтної картки	Повернене значення «Номер дисконтної картки» відповідного запису, документа або підсумку ARM20.	`string`	`"990000001"`
`value`Значення	Повернене значення «Значення» відповідного запису, документа або підсумку ARM20.	`string`	`"Приклад"`

Точна схема результату

{
    "mode": "rows",
    "columns": [
        "card",
        "value"
    ],
    "field_specs": {
        "card": {
            "title": "Номер дисконтної картки",
            "description": "Повернене значення «Номер дисконтної картки» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "990000001"
        },
        "value": {
            "title": "Значення",
            "description": "Повернене значення «Значення» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

Приклад запиту

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json

{
    "method": "pos.reports_rest_discounts",
    "params": {
        "nc": 1001
    },
    "id": "example-pos-reports-rest-discounts"
}

Замініть демонстраційні значення даними зі своєї бази.

Приклад успішної відповіді

{
    "ok": true,
    "data": {
        "method": "pos.reports_rest_discounts",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "pos"
            },
            "status": {
                "code": "OK",
                "operation": "reports_rest_discounts",
                "value": "1"
            },
            "rows": [
                {
                    "card": "990000001",
                    "value": "Приклад"
                }
            ]
        },
        "id": "example-pos-reports-rest-discounts"
    },
    "request_id": "req_example_0123456789abcdef"
}

Помилки та повтори цього методу

Код	HTTP	Причина	Дія клієнта
`INVALID_PARAMETER`	422	Один із параметрів має неправильний тип, формат або значення.	Виправити запит; автоматично не повторювати.
`UPSTREAM_FAILURE`	502	Сервер бізнес-операції недоступний або відхилив безпечний контракт.	Дозволений повтор із backoff.

pos.reports_rest_kitchen_linesПовертає товарні позиції кухонного замовлення. читання pos.read з 0.4.0

Повертає товарні позиції кухонного замовлення.

Перевірити JSON JSON Schema

Стабільність: стабільний Scope: pos.read Idempotency-Key: не потрібен

Параметри params

Поле	Що означає	Тип і формат	Правила
Додаткові
`kitchen`Kitchen	Поле «Kitchen» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.	`int`	необов’язковийПриклад: `1`За замовчуванням: `1`
`nc`Номер чека	Номер касового чека у базі поточного клієнта.	`int`	необов’язковийПриклад: `1`За замовчуванням: `0`

Точна схема параметрів

{
    "kitchen": {
        "type": "int",
        "min": 1,
        "max": 2,
        "default": 1,
        "title": "Kitchen",
        "description": "Поле «Kitchen» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.",
        "group": "Додаткові",
        "example": 1
    },
    "nc": {
        "type": "int",
        "min": -2147483648,
        "max": 2147483647,
        "default": 0,
        "title": "Номер чека",
        "description": "Номер касового чека у базі поточного клієнта.",
        "group": "Додаткові",
        "example": 1
    }
}

Результат

Форма відповіді: rows

Поле	Зміст	Тип	Приклад
`id`Ідентифікатор запису	Повернене значення «Ідентифікатор запису» відповідного запису, документа або підсумку ARM20.	`string`	`"Приклад"`
`code`Код товару	Повернене значення «Код товару» відповідного запису, документа або підсумку ARM20.	`string`	`"1001"`
`name`Назва	Повернене значення «Назва» відповідного запису, документа або підсумку ARM20.	`string`	`"Тестовий товар"`
`quantity`Кількість	Точне повернене значення «Кількість» як десятковий рядок із крапкою.	`string · decimal-string · product-unit`	`"1.000"`
`check_number`Номер чека	Номер касового чека у базі поточного клієнта.	`string`	`"Приклад"`
`kitchen`Kitchen	Повернене значення «Kitchen» відповідного запису, документа або підсумку ARM20.	`string`	`"Приклад"`

Точна схема результату

{
    "mode": "rows",
    "columns": [
        "id",
        "code",
        "name",
        "quantity",
        "check_number",
        "kitchen"
    ],
    "field_specs": {
        "id": {
            "title": "Ідентифікатор запису",
            "description": "Повернене значення «Ідентифікатор запису» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "code": {
            "title": "Код товару",
            "description": "Повернене значення «Код товару» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "1001"
        },
        "name": {
            "title": "Назва",
            "description": "Повернене значення «Назва» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Тестовий товар"
        },
        "quantity": {
            "title": "Кількість",
            "description": "Точне повернене значення «Кількість» як десятковий рядок із крапкою.",
            "type": "string",
            "format": "decimal-string",
            "unit": "product-unit",
            "example": "1.000"
        },
        "check_number": {
            "title": "Номер чека",
            "description": "Номер касового чека у базі поточного клієнта.",
            "type": "string",
            "example": "Приклад"
        },
        "kitchen": {
            "title": "Kitchen",
            "description": "Повернене значення «Kitchen» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

Приклад запиту

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json

{
    "method": "pos.reports_rest_kitchen_lines",
    "params": {
        "kitchen": 1,
        "nc": 1001
    },
    "id": "example-pos-reports-rest-kitchen-lines"
}

Замініть демонстраційні значення даними зі своєї бази.

Приклад успішної відповіді

{
    "ok": true,
    "data": {
        "method": "pos.reports_rest_kitchen_lines",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "pos"
            },
            "status": {
                "code": "OK",
                "operation": "reports_rest_kitchen_lines",
                "value": "1"
            },
            "rows": [
                {
                    "id": "Приклад",
                    "code": "1001",
                    "name": "Тестовий товар",
                    "quantity": "1.000",
                    "check_number": "Приклад",
                    "kitchen": "Приклад"
                }
            ]
        },
        "id": "example-pos-reports-rest-kitchen-lines"
    },
    "request_id": "req_example_0123456789abcdef"
}

Помилки та повтори цього методу

Код	HTTP	Причина	Дія клієнта
`INVALID_PARAMETER`	422	Один із параметрів має неправильний тип, формат або значення.	Виправити запит; автоматично не повторювати.
`UPSTREAM_FAILURE`	502	Сервер бізнес-операції недоступний або відхилив безпечний контракт.	Дозволений повтор із backoff.

pos.reports_rest_kitchen_mark_printedПозначає кухонне замовлення як надруковане. запис pos.write з 0.4.0

Позначає кухонне замовлення як надруковане.

Перевірити JSON JSON Schema

Стабільність: стабільний Scope: pos.write Idempotency-Key: потрібен

Параметри params

Поле	Що означає	Тип і формат	Правила
Додаткові
`nc`Номер чека	Номер касового чека у базі поточного клієнта.	`int`	необов’язковийПриклад: `1`За замовчуванням: `0`

Точна схема параметрів

{
    "nc": {
        "type": "int",
        "min": -2147483648,
        "max": 2147483647,
        "default": 0,
        "title": "Номер чека",
        "description": "Номер касового чека у базі поточного клієнта.",
        "group": "Додаткові",
        "example": 1
    }
}

Результат

Форма відповіді: status

Поле	Зміст	Тип	Приклад
`affected`Змінено записів	Кількість записів, які upstream фактично змінив.	`string`	`"Приклад"`

Точна схема результату

{
    "mode": "status",
    "fields": [
        "affected"
    ],
    "field_specs": {
        "affected": {
            "title": "Змінено записів",
            "description": "Кількість записів, які upstream фактично змінив.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

Приклад запиту

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json
Idempotency-Key: example-pos-reports-rest-kitchen-mark-printed-0001

{
    "method": "pos.reports_rest_kitchen_mark_printed",
    "params": {
        "nc": 1001
    },
    "id": "example-pos-reports-rest-kitchen-mark-printed"
}

Замініть демонстраційні значення даними зі своєї бази.

Приклад успішної відповіді

{
    "ok": true,
    "data": {
        "method": "pos.reports_rest_kitchen_mark_printed",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "pos"
            },
            "status": {
                "code": "OK",
                "operation": "reports_rest_kitchen_mark_printed",
                "affected": "Приклад"
            },
            "rows": []
        },
        "id": "example-pos-reports-rest-kitchen-mark-printed"
    },
    "request_id": "req_example_0123456789abcdef"
}

Помилки та повтори цього методу

Код	HTTP	Причина	Дія клієнта
`INVALID_PARAMETER`	422	Один із параметрів має неправильний тип, формат або значення.	Виправити запит; автоматично не повторювати.
`UPSTREAM_FAILURE`	502	Сервер бізнес-операції недоступний або відхилив безпечний контракт.	Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт.
`IDEMPOTENCY_KEY_REQUIRED`	422	Для виконання запису не передано Idempotency-Key.	Створити ключ для цієї бізнес-операції та повторити.
`IDEMPOTENCY_RESULT_UNKNOWN`	409	Результат попередньої спроби невідомий; gateway не виконав запис повторно.	Звірити документ, чек або платіж; не створювати новий ключ автоматично.

pos.reports_rest_kitchen_ordersПовертає ресторанні замовлення, які очікують друку на кухні. читання pos.read з 0.4.0

Повертає ресторанні замовлення, які очікують друку на кухні.

Перевірити JSON JSON Schema

Стабільність: стабільний Scope: pos.read Idempotency-Key: не потрібен

Параметри params

Параметри не потрібні. Передайте порожній об’єкт {}.

Точна схема параметрів

{}

Результат

Форма відповіді: rows

Поле	Зміст	Тип	Приклад
`check_number`Номер чека	Номер касового чека у базі поточного клієнта.	`string`	`"Приклад"`
`user_name`User name	Повернене значення «User name» відповідного запису, документа або підсумку ARM20.	`string`	`"Приклад"`
`table_name`Table name	Повернене значення «Table name» відповідного запису, документа або підсумку ARM20.	`string`	`"Приклад"`

Точна схема результату

{
    "mode": "rows",
    "columns": [
        "check_number",
        "user_name",
        "table_name"
    ],
    "field_specs": {
        "check_number": {
            "title": "Номер чека",
            "description": "Номер касового чека у базі поточного клієнта.",
            "type": "string",
            "example": "Приклад"
        },
        "user_name": {
            "title": "User name",
            "description": "Повернене значення «User name» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        },
        "table_name": {
            "title": "Table name",
            "description": "Повернене значення «Table name» відповідного запису, документа або підсумку ARM20.",
            "type": "string",
            "example": "Приклад"
        }
    }
}

Приклад запиту

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json

{
    "method": "pos.reports_rest_kitchen_orders",
    "params": [],
    "id": "example-pos-reports-rest-kitchen-orders"
}

Замініть демонстраційні значення даними зі своєї бази.

Приклад успішної відповіді

{
    "ok": true,
    "data": {
        "method": "pos.reports_rest_kitchen_orders",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "pos"
            },
            "status": {
                "code": "OK",
                "operation": "reports_rest_kitchen_orders",
                "value": "1"
            },
            "rows": [
                {
                    "check_number": "Приклад",
                    "user_name": "Приклад",
                    "table_name": "Приклад"
                }
            ]
        },
        "id": "example-pos-reports-rest-kitchen-orders"
    },
    "request_id": "req_example_0123456789abcdef"
}

Помилки та повтори цього методу

Код	HTTP	Причина	Дія клієнта
`INVALID_PARAMETER`	422	Один із параметрів має неправильний тип, формат або значення.	Виправити запит; автоматично не повторювати.
`UPSTREAM_FAILURE`	502	Сервер бізнес-операції недоступний або відхилив безпечний контракт.	Дозволений повтор із backoff.