Skip to content

Report dashboard ​

INFO

Каждый ответ приходит в общем конверте — code, message, messages, status_code, time — а полезная нагрузка лежит в data. Таблицы ниже описывают содержимое data.

POST /reports/summary/debt/paging ​

Paginated debt rows for the dashboard summary card.

Тело запроса

ПолеТипОбязательноОписание
pagenumberДаПо умолчанию: 1
limitnumberДаПо умолчанию: 20
date_fromstring (date-time)НетStart of the reporting window.
date_tostring (date-time)НетEnd of the reporting window.
organization_idsstring[]Нет
warehouse_idsstring[]Нет
currency_idstringНет
responsible_idsstring[]Нет
customer_idsstring[]Нет
supplier_idsstring[]Нет
product_idsstring[]Нет
category_idsstring[]Нет
payment_method_idsstring[]Нет
sort_bystringНетField name to sort by.
sort_orderstringНетДопустимые значения: asc, desc. По умолчанию: "desc"
searchstringНет
json
{
  "page": 1,
  "limit": 20,
  "date_from": "2025-05-01T12:00:00Z",
  "date_to": "2025-05-01T12:00:00Z",
  "organization_ids": [
    "64b7f4d9e2b3b6a0b7c5d80a"
  ],
  "warehouse_ids": [
    "string"
  ],
  "currency_id": "string",
  "responsible_ids": [
    "string"
  ],
  "customer_ids": [
    "string"
  ],
  "supplier_ids": [
    "string"
  ],
  "product_ids": [
    "string"
  ],
  "category_ids": [
    "string"
  ],
  "payment_method_ids": [
    "string"
  ],
  "sort_by": "string",
  "sort_order": "asc",
  "search": "string"
}

Ответ

ПолеТипОписание
listobject[]
totalnumber
json
{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": {
    "list": [
      {}
    ],
    "total": 0
  },
  "time": "2025-05-01T12:00:00Z"
}

POST /reports/summary/credit/paging ​

Paginated credit rows for the dashboard summary card.

Тело запроса

ПолеТипОбязательноОписание
pagenumberДаПо умолчанию: 1
limitnumberДаПо умолчанию: 20
date_fromstring (date-time)НетStart of the reporting window.
date_tostring (date-time)НетEnd of the reporting window.
organization_idsstring[]Нет
warehouse_idsstring[]Нет
currency_idstringНет
responsible_idsstring[]Нет
customer_idsstring[]Нет
supplier_idsstring[]Нет
product_idsstring[]Нет
category_idsstring[]Нет
payment_method_idsstring[]Нет
sort_bystringНетField name to sort by.
sort_orderstringНетДопустимые значения: asc, desc. По умолчанию: "desc"
searchstringНет
json
{
  "page": 1,
  "limit": 20,
  "date_from": "2025-05-01T12:00:00Z",
  "date_to": "2025-05-01T12:00:00Z",
  "organization_ids": [
    "64b7f4d9e2b3b6a0b7c5d80a"
  ],
  "warehouse_ids": [
    "string"
  ],
  "currency_id": "string",
  "responsible_ids": [
    "string"
  ],
  "customer_ids": [
    "string"
  ],
  "supplier_ids": [
    "string"
  ],
  "product_ids": [
    "string"
  ],
  "category_ids": [
    "string"
  ],
  "payment_method_ids": [
    "string"
  ],
  "sort_by": "string",
  "sort_order": "asc",
  "search": "string"
}

Ответ

Структура ответа совпадает с POST /reports/summary/debt/paging.

POST /reports/customers/health-score/charts ​

Customer health-score time series for charts.

Тело запроса

ПолеТипОбязательноОписание
date_fromstring (date-time)НетStart of the reporting window.
date_tostring (date-time)НетEnd of the reporting window.
organization_idsstring[]Нет
warehouse_idsstring[]Нет
currency_idstringНет
responsible_idsstring[]Нет
customer_idsstring[]Нет
supplier_idsstring[]Нет
product_idsstring[]Нет
category_idsstring[]Нет
payment_method_idsstring[]Нет
sort_bystringНетField name to sort by.
sort_orderstringНетДопустимые значения: asc, desc. По умолчанию: "desc"
json
{
  "date_from": "2025-05-01T12:00:00Z",
  "date_to": "2025-05-01T12:00:00Z",
  "organization_ids": [
    "64b7f4d9e2b3b6a0b7c5d80a"
  ],
  "warehouse_ids": [
    "string"
  ],
  "currency_id": "string",
  "responsible_ids": [
    "string"
  ],
  "customer_ids": [
    "string"
  ],
  "supplier_ids": [
    "string"
  ],
  "product_ids": [
    "string"
  ],
  "category_ids": [
    "string"
  ],
  "payment_method_ids": [
    "string"
  ],
  "sort_by": "string",
  "sort_order": "asc"
}

Ответ

json
{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": [
    {
      "label": "string",
      "value": 0
    }
  ],
  "time": "2025-05-01T12:00:00Z"
}

POST /reports/customers/health-score/summary ​

Aggregate customer health-score summary (good / warning / churn-risk counts).

Тело запроса

ПолеТипОбязательноОписание
date_fromstring (date-time)НетStart of the reporting window.
date_tostring (date-time)НетEnd of the reporting window.
organization_idsstring[]Нет
warehouse_idsstring[]Нет
currency_idstringНет
responsible_idsstring[]Нет
customer_idsstring[]Нет
supplier_idsstring[]Нет
product_idsstring[]Нет
category_idsstring[]Нет
payment_method_idsstring[]Нет
sort_bystringНетField name to sort by.
sort_orderstringНетДопустимые значения: asc, desc. По умолчанию: "desc"
json
{
  "date_from": "2025-05-01T12:00:00Z",
  "date_to": "2025-05-01T12:00:00Z",
  "organization_ids": [
    "64b7f4d9e2b3b6a0b7c5d80a"
  ],
  "warehouse_ids": [
    "string"
  ],
  "currency_id": "string",
  "responsible_ids": [
    "string"
  ],
  "customer_ids": [
    "string"
  ],
  "supplier_ids": [
    "string"
  ],
  "product_ids": [
    "string"
  ],
  "category_ids": [
    "string"
  ],
  "payment_method_ids": [
    "string"
  ],
  "sort_by": "string",
  "sort_order": "asc"
}

Ответ

json
{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": {},
  "time": "2025-05-01T12:00:00Z"
}

POST /reports/dashboard/summary ​

Main dashboard KPI summary (sales, expenses, profit, top-line counters).

Тело запроса

ПолеТипОбязательноОписание
date_fromstring (date-time)НетStart of the reporting window.
date_tostring (date-time)НетEnd of the reporting window.
organization_idsstring[]Нет
warehouse_idsstring[]Нет
currency_idstringНет
responsible_idsstring[]Нет
customer_idsstring[]Нет
supplier_idsstring[]Нет
product_idsstring[]Нет
category_idsstring[]Нет
payment_method_idsstring[]Нет
sort_bystringНетField name to sort by.
sort_orderstringНетДопустимые значения: asc, desc. По умолчанию: "desc"
json
{
  "date_from": "2025-05-01T12:00:00Z",
  "date_to": "2025-05-01T12:00:00Z",
  "organization_ids": [
    "64b7f4d9e2b3b6a0b7c5d80a"
  ],
  "warehouse_ids": [
    "string"
  ],
  "currency_id": "string",
  "responsible_ids": [
    "string"
  ],
  "customer_ids": [
    "string"
  ],
  "supplier_ids": [
    "string"
  ],
  "product_ids": [
    "string"
  ],
  "category_ids": [
    "string"
  ],
  "payment_method_ids": [
    "string"
  ],
  "sort_by": "string",
  "sort_order": "asc"
}

Ответ

Структура ответа совпадает с POST /reports/customers/health-score/summary.

POST /reports/dashboard/chart ​

Main dashboard time-series chart data.

Тело запроса

ПолеТипОбязательноОписание
date_fromstring (date-time)НетStart of the reporting window.
date_tostring (date-time)НетEnd of the reporting window.
organization_idsstring[]Нет
warehouse_idsstring[]Нет
currency_idstringНет
responsible_idsstring[]Нет
customer_idsstring[]Нет
supplier_idsstring[]Нет
product_idsstring[]Нет
category_idsstring[]Нет
payment_method_idsstring[]Нет
sort_bystringНетField name to sort by.
sort_orderstringНетДопустимые значения: asc, desc. По умолчанию: "desc"
json
{
  "date_from": "2025-05-01T12:00:00Z",
  "date_to": "2025-05-01T12:00:00Z",
  "organization_ids": [
    "64b7f4d9e2b3b6a0b7c5d80a"
  ],
  "warehouse_ids": [
    "string"
  ],
  "currency_id": "string",
  "responsible_ids": [
    "string"
  ],
  "customer_ids": [
    "string"
  ],
  "supplier_ids": [
    "string"
  ],
  "product_ids": [
    "string"
  ],
  "category_ids": [
    "string"
  ],
  "payment_method_ids": [
    "string"
  ],
  "sort_by": "string",
  "sort_order": "asc"
}

Ответ

Структура ответа совпадает с POST /reports/customers/health-score/charts.

POST /reports/dashboard/top/{key} ​

Top-N entities ranked by the given key (e.g. products / customers / employees).

Параметры пути

ПараметрТипОбязательноОписание
keystringДаTop-N grouping key: product, customer, employee, category, payment_method, etc.

Тело запроса

ПолеТипОбязательноОписание
date_fromstring (date-time)НетStart of the reporting window.
date_tostring (date-time)НетEnd of the reporting window.
organization_idsstring[]Нет
warehouse_idsstring[]Нет
currency_idstringНет
responsible_idsstring[]Нет
customer_idsstring[]Нет
supplier_idsstring[]Нет
product_idsstring[]Нет
category_idsstring[]Нет
payment_method_idsstring[]Нет
sort_bystringНетField name to sort by.
sort_orderstringНетДопустимые значения: asc, desc. По умолчанию: "desc"
json
{
  "date_from": "2025-05-01T12:00:00Z",
  "date_to": "2025-05-01T12:00:00Z",
  "organization_ids": [
    "64b7f4d9e2b3b6a0b7c5d80a"
  ],
  "warehouse_ids": [
    "string"
  ],
  "currency_id": "string",
  "responsible_ids": [
    "string"
  ],
  "customer_ids": [
    "string"
  ],
  "supplier_ids": [
    "string"
  ],
  "product_ids": [
    "string"
  ],
  "category_ids": [
    "string"
  ],
  "payment_method_ids": [
    "string"
  ],
  "sort_by": "string",
  "sort_order": "asc"
}

Ответ

Структура ответа совпадает с POST /reports/summary/debt/paging.

POST /reports/order/dashboard/summary ​

Sale-order dashboard KPI summary.

Тело запроса

ПолеТипОбязательноОписание
date_fromstring (date-time)НетStart of the reporting window.
date_tostring (date-time)НетEnd of the reporting window.
organization_idsstring[]Нет
warehouse_idsstring[]Нет
currency_idstringНет
responsible_idsstring[]Нет
customer_idsstring[]Нет
supplier_idsstring[]Нет
product_idsstring[]Нет
category_idsstring[]Нет
payment_method_idsstring[]Нет
sort_bystringНетField name to sort by.
sort_orderstringНетДопустимые значения: asc, desc. По умолчанию: "desc"
json
{
  "date_from": "2025-05-01T12:00:00Z",
  "date_to": "2025-05-01T12:00:00Z",
  "organization_ids": [
    "64b7f4d9e2b3b6a0b7c5d80a"
  ],
  "warehouse_ids": [
    "string"
  ],
  "currency_id": "string",
  "responsible_ids": [
    "string"
  ],
  "customer_ids": [
    "string"
  ],
  "supplier_ids": [
    "string"
  ],
  "product_ids": [
    "string"
  ],
  "category_ids": [
    "string"
  ],
  "payment_method_ids": [
    "string"
  ],
  "sort_by": "string",
  "sort_order": "asc"
}

Ответ

Структура ответа совпадает с POST /reports/customers/health-score/summary.

POST /reports/order/dashboard/chart ​

Sale-order dashboard time-series chart.

Тело запроса

ПолеТипОбязательноОписание
date_fromstring (date-time)НетStart of the reporting window.
date_tostring (date-time)НетEnd of the reporting window.
organization_idsstring[]Нет
warehouse_idsstring[]Нет
currency_idstringНет
responsible_idsstring[]Нет
customer_idsstring[]Нет
supplier_idsstring[]Нет
product_idsstring[]Нет
category_idsstring[]Нет
payment_method_idsstring[]Нет
sort_bystringНетField name to sort by.
sort_orderstringНетДопустимые значения: asc, desc. По умолчанию: "desc"
json
{
  "date_from": "2025-05-01T12:00:00Z",
  "date_to": "2025-05-01T12:00:00Z",
  "organization_ids": [
    "64b7f4d9e2b3b6a0b7c5d80a"
  ],
  "warehouse_ids": [
    "string"
  ],
  "currency_id": "string",
  "responsible_ids": [
    "string"
  ],
  "customer_ids": [
    "string"
  ],
  "supplier_ids": [
    "string"
  ],
  "product_ids": [
    "string"
  ],
  "category_ids": [
    "string"
  ],
  "payment_method_ids": [
    "string"
  ],
  "sort_by": "string",
  "sort_order": "asc"
}

Ответ

Структура ответа совпадает с POST /reports/customers/health-score/charts.

POST /reports/order/dashboard/states ​

Sale-order count by state (new / in-progress / done / canceled).

Тело запроса

ПолеТипОбязательноОписание
date_fromstring (date-time)НетStart of the reporting window.
date_tostring (date-time)НетEnd of the reporting window.
organization_idsstring[]Нет
warehouse_idsstring[]Нет
currency_idstringНет
responsible_idsstring[]Нет
customer_idsstring[]Нет
supplier_idsstring[]Нет
product_idsstring[]Нет
category_idsstring[]Нет
payment_method_idsstring[]Нет
sort_bystringНетField name to sort by.
sort_orderstringНетДопустимые значения: asc, desc. По умолчанию: "desc"
json
{
  "date_from": "2025-05-01T12:00:00Z",
  "date_to": "2025-05-01T12:00:00Z",
  "organization_ids": [
    "64b7f4d9e2b3b6a0b7c5d80a"
  ],
  "warehouse_ids": [
    "string"
  ],
  "currency_id": "string",
  "responsible_ids": [
    "string"
  ],
  "customer_ids": [
    "string"
  ],
  "supplier_ids": [
    "string"
  ],
  "product_ids": [
    "string"
  ],
  "category_ids": [
    "string"
  ],
  "payment_method_ids": [
    "string"
  ],
  "sort_by": "string",
  "sort_order": "asc"
}

Ответ

Структура ответа совпадает с POST /reports/customers/health-score/summary.

POST /reports/order/dashboard/top/{key} ​

Top-N for the sale-order dashboard, by the given key.

Параметры пути

ПараметрТипОбязательноОписание
keystringДа

Тело запроса

ПолеТипОбязательноОписание
date_fromstring (date-time)НетStart of the reporting window.
date_tostring (date-time)НетEnd of the reporting window.
organization_idsstring[]Нет
warehouse_idsstring[]Нет
currency_idstringНет
responsible_idsstring[]Нет
customer_idsstring[]Нет
supplier_idsstring[]Нет
product_idsstring[]Нет
category_idsstring[]Нет
payment_method_idsstring[]Нет
sort_bystringНетField name to sort by.
sort_orderstringНетДопустимые значения: asc, desc. По умолчанию: "desc"
json
{
  "date_from": "2025-05-01T12:00:00Z",
  "date_to": "2025-05-01T12:00:00Z",
  "organization_ids": [
    "64b7f4d9e2b3b6a0b7c5d80a"
  ],
  "warehouse_ids": [
    "string"
  ],
  "currency_id": "string",
  "responsible_ids": [
    "string"
  ],
  "customer_ids": [
    "string"
  ],
  "supplier_ids": [
    "string"
  ],
  "product_ids": [
    "string"
  ],
  "category_ids": [
    "string"
  ],
  "payment_method_ids": [
    "string"
  ],
  "sort_by": "string",
  "sort_order": "asc"
}

Ответ

Структура ответа совпадает с POST /reports/summary/debt/paging.

POST /reports/summary/debt/get-summary ​

Aggregate customer-debt summary for the dashboard card.

Тело запроса

ПолеТипОбязательноОписание
date_fromstring (date-time)НетStart of the reporting window.
date_tostring (date-time)НетEnd of the reporting window.
organization_idsstring[]Нет
warehouse_idsstring[]Нет
currency_idstringНет
responsible_idsstring[]Нет
customer_idsstring[]Нет
supplier_idsstring[]Нет
product_idsstring[]Нет
category_idsstring[]Нет
payment_method_idsstring[]Нет
sort_bystringНетField name to sort by.
sort_orderstringНетДопустимые значения: asc, desc. По умолчанию: "desc"
json
{
  "date_from": "2025-05-01T12:00:00Z",
  "date_to": "2025-05-01T12:00:00Z",
  "organization_ids": [
    "64b7f4d9e2b3b6a0b7c5d80a"
  ],
  "warehouse_ids": [
    "string"
  ],
  "currency_id": "string",
  "responsible_ids": [
    "string"
  ],
  "customer_ids": [
    "string"
  ],
  "supplier_ids": [
    "string"
  ],
  "product_ids": [
    "string"
  ],
  "category_ids": [
    "string"
  ],
  "payment_method_ids": [
    "string"
  ],
  "sort_by": "string",
  "sort_order": "asc"
}

Ответ

Структура ответа совпадает с POST /reports/customers/health-score/summary.

POST /reports/summary/credit/get-summary ​

Aggregate customer-credit summary for the dashboard card.

Тело запроса

ПолеТипОбязательноОписание
date_fromstring (date-time)НетStart of the reporting window.
date_tostring (date-time)НетEnd of the reporting window.
organization_idsstring[]Нет
warehouse_idsstring[]Нет
currency_idstringНет
responsible_idsstring[]Нет
customer_idsstring[]Нет
supplier_idsstring[]Нет
product_idsstring[]Нет
category_idsstring[]Нет
payment_method_idsstring[]Нет
sort_bystringНетField name to sort by.
sort_orderstringНетДопустимые значения: asc, desc. По умолчанию: "desc"
json
{
  "date_from": "2025-05-01T12:00:00Z",
  "date_to": "2025-05-01T12:00:00Z",
  "organization_ids": [
    "64b7f4d9e2b3b6a0b7c5d80a"
  ],
  "warehouse_ids": [
    "string"
  ],
  "currency_id": "string",
  "responsible_ids": [
    "string"
  ],
  "customer_ids": [
    "string"
  ],
  "supplier_ids": [
    "string"
  ],
  "product_ids": [
    "string"
  ],
  "category_ids": [
    "string"
  ],
  "payment_method_ids": [
    "string"
  ],
  "sort_by": "string",
  "sort_order": "asc"
}

Ответ

Структура ответа совпадает с POST /reports/customers/health-score/summary.

POST /reports/summary/goods/by-price/total ​

Total goods valuation grouped by price (dashboard card).

Тело запроса

ПолеТипОбязательноОписание
date_fromstring (date-time)НетStart of the reporting window.
date_tostring (date-time)НетEnd of the reporting window.
organization_idsstring[]Нет
warehouse_idsstring[]Нет
currency_idstringНет
responsible_idsstring[]Нет
customer_idsstring[]Нет
supplier_idsstring[]Нет
product_idsstring[]Нет
category_idsstring[]Нет
payment_method_idsstring[]Нет
sort_bystringНетField name to sort by.
sort_orderstringНетДопустимые значения: asc, desc. По умолчанию: "desc"
json
{
  "date_from": "2025-05-01T12:00:00Z",
  "date_to": "2025-05-01T12:00:00Z",
  "organization_ids": [
    "64b7f4d9e2b3b6a0b7c5d80a"
  ],
  "warehouse_ids": [
    "string"
  ],
  "currency_id": "string",
  "responsible_ids": [
    "string"
  ],
  "customer_ids": [
    "string"
  ],
  "supplier_ids": [
    "string"
  ],
  "product_ids": [
    "string"
  ],
  "category_ids": [
    "string"
  ],
  "payment_method_ids": [
    "string"
  ],
  "sort_by": "string",
  "sort_order": "asc"
}

Ответ

Структура ответа совпадает с POST /reports/customers/health-score/summary.

POST /reports/summary/product/chart-paging ​

Paginated product chart rows for the dashboard.

Тело запроса

ПолеТипОбязательноОписание
pagenumberДаПо умолчанию: 1
limitnumberДаПо умолчанию: 20
date_fromstring (date-time)НетStart of the reporting window.
date_tostring (date-time)НетEnd of the reporting window.
organization_idsstring[]Нет
warehouse_idsstring[]Нет
currency_idstringНет
responsible_idsstring[]Нет
customer_idsstring[]Нет
supplier_idsstring[]Нет
product_idsstring[]Нет
category_idsstring[]Нет
payment_method_idsstring[]Нет
sort_bystringНетField name to sort by.
sort_orderstringНетДопустимые значения: asc, desc. По умолчанию: "desc"
searchstringНет
json
{
  "page": 1,
  "limit": 20,
  "date_from": "2025-05-01T12:00:00Z",
  "date_to": "2025-05-01T12:00:00Z",
  "organization_ids": [
    "64b7f4d9e2b3b6a0b7c5d80a"
  ],
  "warehouse_ids": [
    "string"
  ],
  "currency_id": "string",
  "responsible_ids": [
    "string"
  ],
  "customer_ids": [
    "string"
  ],
  "supplier_ids": [
    "string"
  ],
  "product_ids": [
    "string"
  ],
  "category_ids": [
    "string"
  ],
  "payment_method_ids": [
    "string"
  ],
  "sort_by": "string",
  "sort_order": "asc",
  "search": "string"
}

Ответ

Структура ответа совпадает с POST /reports/summary/debt/paging.

POST /reports/summary/product/get-summary ​

Aggregate product summary for the dashboard card.

Тело запроса

ПолеТипОбязательноОписание
date_fromstring (date-time)НетStart of the reporting window.
date_tostring (date-time)НетEnd of the reporting window.
organization_idsstring[]Нет
warehouse_idsstring[]Нет
currency_idstringНет
responsible_idsstring[]Нет
customer_idsstring[]Нет
supplier_idsstring[]Нет
product_idsstring[]Нет
category_idsstring[]Нет
payment_method_idsstring[]Нет
sort_bystringНетField name to sort by.
sort_orderstringНетДопустимые значения: asc, desc. По умолчанию: "desc"
json
{
  "date_from": "2025-05-01T12:00:00Z",
  "date_to": "2025-05-01T12:00:00Z",
  "organization_ids": [
    "64b7f4d9e2b3b6a0b7c5d80a"
  ],
  "warehouse_ids": [
    "string"
  ],
  "currency_id": "string",
  "responsible_ids": [
    "string"
  ],
  "customer_ids": [
    "string"
  ],
  "supplier_ids": [
    "string"
  ],
  "product_ids": [
    "string"
  ],
  "category_ids": [
    "string"
  ],
  "payment_method_ids": [
    "string"
  ],
  "sort_by": "string",
  "sort_order": "asc"
}

Ответ

Структура ответа совпадает с POST /reports/customers/health-score/summary.

POST /reports/summary/sale/chart ​

Sale chart time series for the dashboard.

Тело запроса

ПолеТипОбязательноОписание
date_fromstring (date-time)НетStart of the reporting window.
date_tostring (date-time)НетEnd of the reporting window.
organization_idsstring[]Нет
warehouse_idsstring[]Нет
currency_idstringНет
responsible_idsstring[]Нет
customer_idsstring[]Нет
supplier_idsstring[]Нет
product_idsstring[]Нет
category_idsstring[]Нет
payment_method_idsstring[]Нет
sort_bystringНетField name to sort by.
sort_orderstringНетДопустимые значения: asc, desc. По умолчанию: "desc"
json
{
  "date_from": "2025-05-01T12:00:00Z",
  "date_to": "2025-05-01T12:00:00Z",
  "organization_ids": [
    "64b7f4d9e2b3b6a0b7c5d80a"
  ],
  "warehouse_ids": [
    "string"
  ],
  "currency_id": "string",
  "responsible_ids": [
    "string"
  ],
  "customer_ids": [
    "string"
  ],
  "supplier_ids": [
    "string"
  ],
  "product_ids": [
    "string"
  ],
  "category_ids": [
    "string"
  ],
  "payment_method_ids": [
    "string"
  ],
  "sort_by": "string",
  "sort_order": "asc"
}

Ответ

Структура ответа совпадает с POST /reports/customers/health-score/charts.

POST /reports/trade/customer/chart ​

Trade-by-customer chart time series for the dashboard.

Тело запроса

ПолеТипОбязательноОписание
date_fromstring (date-time)НетStart of the reporting window.
date_tostring (date-time)НетEnd of the reporting window.
organization_idsstring[]Нет
warehouse_idsstring[]Нет
currency_idstringНет
responsible_idsstring[]Нет
customer_idsstring[]Нет
supplier_idsstring[]Нет
product_idsstring[]Нет
category_idsstring[]Нет
payment_method_idsstring[]Нет
sort_bystringНетField name to sort by.
sort_orderstringНетДопустимые значения: asc, desc. По умолчанию: "desc"
json
{
  "date_from": "2025-05-01T12:00:00Z",
  "date_to": "2025-05-01T12:00:00Z",
  "organization_ids": [
    "64b7f4d9e2b3b6a0b7c5d80a"
  ],
  "warehouse_ids": [
    "string"
  ],
  "currency_id": "string",
  "responsible_ids": [
    "string"
  ],
  "customer_ids": [
    "string"
  ],
  "supplier_ids": [
    "string"
  ],
  "product_ids": [
    "string"
  ],
  "category_ids": [
    "string"
  ],
  "payment_method_ids": [
    "string"
  ],
  "sort_by": "string",
  "sort_order": "asc"
}

Ответ

Структура ответа совпадает с POST /reports/customers/health-score/charts.

POST /reports/trade/customer/health-score ​

Customer health-score rollup based on trade history.

Тело запроса

ПолеТипОбязательноОписание
date_fromstring (date-time)НетStart of the reporting window.
date_tostring (date-time)НетEnd of the reporting window.
organization_idsstring[]Нет
warehouse_idsstring[]Нет
currency_idstringНет
responsible_idsstring[]Нет
customer_idsstring[]Нет
supplier_idsstring[]Нет
product_idsstring[]Нет
category_idsstring[]Нет
payment_method_idsstring[]Нет
sort_bystringНетField name to sort by.
sort_orderstringНетДопустимые значения: asc, desc. По умолчанию: "desc"
json
{
  "date_from": "2025-05-01T12:00:00Z",
  "date_to": "2025-05-01T12:00:00Z",
  "organization_ids": [
    "64b7f4d9e2b3b6a0b7c5d80a"
  ],
  "warehouse_ids": [
    "string"
  ],
  "currency_id": "string",
  "responsible_ids": [
    "string"
  ],
  "customer_ids": [
    "string"
  ],
  "supplier_ids": [
    "string"
  ],
  "product_ids": [
    "string"
  ],
  "category_ids": [
    "string"
  ],
  "payment_method_ids": [
    "string"
  ],
  "sort_by": "string",
  "sort_order": "asc"
}

Ответ

Структура ответа совпадает с POST /reports/customers/health-score/summary.

POST /reports/trade/price-deviation/paging ​

Paginated rows of trades where the sold price deviates from the configured price list.

Тело запроса

ПолеТипОбязательноОписание
pagenumberДаПо умолчанию: 1
limitnumberДаПо умолчанию: 20
date_fromstring (date-time)НетStart of the reporting window.
date_tostring (date-time)НетEnd of the reporting window.
organization_idsstring[]Нет
warehouse_idsstring[]Нет
currency_idstringНет
responsible_idsstring[]Нет
customer_idsstring[]Нет
supplier_idsstring[]Нет
product_idsstring[]Нет
category_idsstring[]Нет
payment_method_idsstring[]Нет
sort_bystringНетField name to sort by.
sort_orderstringНетДопустимые значения: asc, desc. По умолчанию: "desc"
searchstringНет
json
{
  "page": 1,
  "limit": 20,
  "date_from": "2025-05-01T12:00:00Z",
  "date_to": "2025-05-01T12:00:00Z",
  "organization_ids": [
    "64b7f4d9e2b3b6a0b7c5d80a"
  ],
  "warehouse_ids": [
    "string"
  ],
  "currency_id": "string",
  "responsible_ids": [
    "string"
  ],
  "customer_ids": [
    "string"
  ],
  "supplier_ids": [
    "string"
  ],
  "product_ids": [
    "string"
  ],
  "category_ids": [
    "string"
  ],
  "payment_method_ids": [
    "string"
  ],
  "sort_by": "string",
  "sort_order": "asc",
  "search": "string"
}

Ответ

Структура ответа совпадает с POST /reports/summary/debt/paging.


Эта страница сгенерирована из спецификации OpenAPI.

Bito 2.0 Integration API