get.reports.catalog — Каталог звітів

Повертає список доступних звітів і їх короткий опис. Це зручно, якщо ви будуєте власний інтерфейс і хочете автоматично показувати перелік звітів без «хардкоду» у клієнті.

Що саме повертається

У result приходить об’єкт, де:

• ключ — назва методу звіту (наприклад, get.reports.sales)
• значення — метадані звіту: title, required_params, optional_params, інколи notes

Авторизація

• Логін/пароль: так
• meta.user_card: обов’язково (для прив’язки запиту до користувача)

Параметри params

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

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

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

{
  "auth": {
    "login": "<LOGIN>",
    "password": "<PASSWORD>"
  },
  "method": "get.reports.catalog",
  "params": {},
  "meta": {
    "user_card": "<USER_CARD>",
    "client_name": "MyIntegration",
    "client_version": "1.0.0"
  },
  "id": "report-catalog-001"
}

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

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

{
  "ok": true,
  "result": {
    "sales": {
      "title": "Продажи/Возвраты (строки продаж)",
      "required_params": [
        "date_from",
        "date_to"
      ],
      "optional_params": [
        "filters",
        "limit",
        "offset",
        "group_by_code",
        "with_joins",
        "order_by",
        "order_dir"
      ]
    },
    "cheks": {
      "title": "Чеки за период",
      "required_params": [
        "date_from",
        "date_to"
      ],
      "optional_params": [
        "filters",
        "limit",
        "offset",
        "include_com",
        "include_disc",
        "include_chds"
      ]
    },
    "otmena": {
      "title": "Отмены",
      "required_params": [
        "date_from",
        "date_to"
      ],
      "optional_params": [
        "filters",
        "limit",
        "offset"
      ]
    },
    "sales_by_category_detailed": {
      "title": "Продажи по категориям (подробно)",
      "required_params": [
        "date_from",
        "date_to"
      ],
      "optional_params": [
        "filters",
        "limit",
        "offset"
      ]
    },
    "getsost": {
      "title": "Продажи, разбор составных товаров (таблица YYYY S)",
      "required_params": [
        "date_from",
        "date_to"
      ],
      "optional_params": [
        "filters",
        "limit",
        "offset",
        "order_by",
        "order_dir"
      ],
      "notes": "Аналог меню MFC: Отчёты → Продажи, возвраты, отмены → Продажи, разбор составных товаров."
    },
    "printed_cheks": {
      "title": "Чеки, напечатанные на принтере (Cheks_print)",
      "required_params": [
        "date_from",
        "date_to"
      ],
      "optional_params": [
        "filters",
        "limit",
        "offset"
      ]
    },
    "nakl_inout": {
      "title": "Приход и расход товаров (накладные, таблица YYYY N)",
      "required_params": [
        "date_from",
        "date_to"
      ],
      "optional_params": [
        "filters",
        "limit",
        "offset",
        "group_by_code",
        "order_by",
        "order_dir"
      ]
    },
    "search_nakl": {
      "title": "Поиск накладной (H_nakl по номеру)",
      "required_params": [
        "nn"
      ],
      "optional_params": [
        "limit",
        "offset"
      ]
    },
    "usd_nakl": {
      "title": "Приход в валюте (H_nakl_d)",
      "required_params": [
        "date_from",
        "date_to"
      ],
      "optional_params": [
        "filters",
        "limit",
        "offset"
      ]
    },
    "prih_in_cat": {
      "title": "Приходные по категориям (факт, только ПН*)",
      "required_params": [
        "date_from",
        "date_to"
      ],
      "optional_params": [
        "limit",
        "offset"
      ]
    },
    "rash_in_cat": {
      "title": "Расходные по категориям (факт, только РН*)",
      "required_params": [
        "date_from",
        "date_to"
      ],
      "optional_params": [
        "limit",
        "offset"
      ]
    },
    "all_in_cat": {
      "title": "Все накладные по категориям (факт)",
      "required_params": [
        "date_from",
        "date_to"
      ],
      "optional_params": [
        "limit",
        "offset"
      ]
    },
    "itogpok": {
      "title": "Итоговые показатели (в ценах продажи)",
      "required_params": [
        "date_from",
        "date_to"
      ],
      "optional_params": [],
      "notes": "Источник: таблица Itog_reports (Swh=Itog_reports_q). Поведение максимально повторяет MFC (itog())."
    },
    "itogpok_ss": {
      "title": "Итоговые показатели (в ценах закупки)",
      "required_params": [
        "date_from",
        "date_to"
      ],
      "optional_params": [],
      "notes": "Источник: таблица Itog_reports (Swh=Itog_reports_ss)."
    },
    "mid_chek": {
      "title": "Покупатели и средний чек",
      "required_params": [
        "date_from",
        "date_to"
      ],
      "optional_params": [],
      "notes": "Источник: таблица Itog_reports (Swh=mid_chek)."
    },
    "tmcs": {
      "title": "ТМЦ: все на сегодня (итоги)",
      "required_params": [],
      "optional_params": [],
      "notes": "Источник: таблица Itog_reports (Swh=Itog_reports_tmc)."
    },
    "ostcat": {
      "title": "ТМЦ: остатки по категориям (на сегодня)",
      "required_params": [],
      "optional_params": [
        "limit",
        "offset"
      ]
    },
    "rekpostost": {
      "title": "ТМЦ: остатки по поставщикам (рек. поставщик, на сегодня)",
      "required_params": [],
      "optional_params": [
        "limit",
        "offset"
      ]
    },
    "artrep": {
      "title": "ТМЦ: отчёт по артикулу (движение товара)",
      "required_params": [
        "date_from",
        "date_to",
        "code"
      ],
      "optional_params": [
        "limit",
        "offset"
      ],
      "notes": "Как в MFC: объединяем кассу (YYYY), накладные (YYYYN) и составные (YYYS)."
    },
    "srokistek": {
      "title": "ТМЦ: срок годности (партии, FIFO)",
      "required_params": [
        "days_left"
      ],
      "optional_params": [
        "limit",
        "offset"
      ],
      "notes": "days_left = показать партии, у которых осталось меньше N дней до окончания срока годности."
    },
    "allsostav": {
      "title": "ТМЦ: отчёт по составным товарам (список компонентов)",
      "required_params": [],
      "optional_params": [
        "limit",
        "offset"
      ]
    },
    "pricechange": {
      "title": "ТМЦ: акты переоценки (Aprc/H_aprc)",
      "required_params": [
        "date_from",
        "date_to"
      ],
      "optional_params": [
        "filters",
        "limit",
        "offset",
        "operation"
      ],
      "notes": "operation: up|down (только дооценка или только уценка)."
    },
    "no_sells_rep": {
      "title": "ТМЦ: товары без продаж за период",
      "required_params": [
        "date_from",
        "date_to"
      ],
      "optional_params": [
        "limit",
        "offset"
      ]
    },
    "cash_operations": {
      "title": "Кассовые операции (Kas_report)",
      "required_params": [
        "date_from",
        "date_to"
      ],
      "optional_params": [
        "filters",
        "limit",
        "offset"
      ]
    },
    "userlog": {
      "title": "Действия пользователей (User_log)",
      "required_params": [],
      "optional_params": [
        "date_from",
        "date_to",
        "filters",
        "limit",
        "offset"
      ]
    }
  },
  "meta": {
    "api_version": "0.1.0",
    "ts": "2026-01-26T12:00:00+00:00"
  },
  "id": "report-catalog-001"
}

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

• AUTH_FAILED, USER_NOT_FOUND — помилка авторизації