get.reports.cheks — Чеки за період

Призначення

Повертає чеки за період з таблиці Cheks (за потреби приєднує Cheks_com / Cheks_cli / Cheks_chds).

Авторизація

• Логін/пароль: так.
• meta.user_card: обов’язково.

Параметри params

Поле	Тип	Обовʼязково	Опис

| date_from | string | так | Дата початку, формат YYYY-MM-DD. |

| date_to | string | так | Дата кінця, формат YYYY-MM-DD. |

| limit | int | ні | Кількість рядків. За замовчуванням 100, максимум 5000. |

| offset | int | ні | Зсув для пагінації. |

| filters | object | ні | Точні фільтри. Дозволені поля наведені нижче. |

| include_com | bool | ні | Додати коментарі чека (Cheks_com). |

| include_disc | bool | ні | Додати дані по дисконтам (Cheks_cli). |

| include_chds | bool | ні | Додати детальні розбивки (Cheks_chds), якщо таблиця є. |

Дозволені поля у filters

Ndoc, User, Kas, Kasm, Isreturn

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

Мокап: mockups/reports/get.reports.cheks/request.json

{
  "auth": {
    "login": "<LOGIN>",
    "password": "<PASSWORD>"
  },
  "method": "get.reports.cheks",
  "params": {
    "date_from": "2026-01-01",
    "date_to": "2026-01-31",
    "limit": 100,
    "offset": 0,
    "filters": {
      "Kas": "Каса 1"
    },
    "include_com": false,
    "include_disc": true,
    "include_chds": false
  },
  "meta": {
    "user_card": "<USER_CARD>",
    "client_name": "MyIntegration",
    "client_version": "1.0.0"
  },
  "id": "report-cheks-001"
}

Приклад відповіді (успіх)

Мокап: mockups/reports/get.reports.cheks/response.ok.json

{
  "ok": true,
  "result": {
    "items": [
      {
        "...": "..."
      }
    ]
  },
  "meta": {
    "api_version": "0.1.0",
    "ts": "2026-01-26T12:00:00+00:00"
  },
  "id": "report-cheks-001"
}

Примітки

• Параметри include_* додають додаткові таблиці (може бути повільніше).

• filters дозволяє відфільтрувати по касі/користувачу/номер документу.

Типові помилки

• MISSING_DATE_RANGE — не передали date_from/date_to.

• INVALID_DATE — неправильний формат дати (має бути YYYY-MM-DD).

• NO_DATA — немає даних/таблиць для цього діапазону.

• INVALID_FILTERS — неправильний filters.