`get.reports.sales` — Продажі/повернення (рядки продажів)

get.reports.sales — Продажі/повернення (рядки продажів)

Призначення

Повертає рядки продажів/повернень за період з річних таблиць (наприклад, 2024, 2025).

Авторизація

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

Параметри params

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

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

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

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

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

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

| group_by_code | bool | ні | Якщо true, агрегує продажі по товару (аналог “sumprod”). |

| with_joins | bool | ні | Якщо true, додає назви довідників (Users/Cat1/Post). За замовчуванням true. |

| order_by | string | ні | Поле сортування для “сирих” рядків: Dat, Code, Nt, Ndoc, User, Kas, Cat. |

| order_dir | string | ні | ASC або DESC. |

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

Code, Cat, Post, User, Kas, Kasm, Isreturn, Ndoc

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

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

{
  "auth": {
    "login": "<LOGIN>",
    "password": "<PASSWORD>"
  },
  "method": "get.reports.sales",
  "params": {
    "date_from": "2026-01-01",
    "date_to": "2026-01-31",
    "limit": 100,
    "offset": 0,
    "filters": {
      "Isreturn": 0
    },
    "group_by_code": false,
    "with_joins": true,
    "order_by": "Dat",
    "order_dir": "ASC"
  },
  "meta": {
    "user_card": "<USER_CARD>",
    "client_name": "MyIntegration",
    "client_version": "1.0.0"
  },
  "id": "report-sales-001"
}

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

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

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

Примітки

  • date_from та date_to приймаються тільки у форматі YYYY-MM-DD.

  • Якщо group_by_code=true, повертається агрегована статистика по товару (суми/кількість).

  • Якщо with_joins=true, додаються назви користувача/категорії/постачальника.

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

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

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

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

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

На цій сторінці