Skip to content

Report pos ​

INFO

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

POST /reports/pos/summary/chart ​

POS summary chart (sales + income + expense combined time series).

Тело запроса

ПолеТипОбязательноОписание
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/pos/summary/sale/chart ​

POS sales chart over the reporting window.

Тело запроса

ПолеТипОбязательноОписание
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/pos/summary/chart.

POST /reports/pos/summary/income/chart ​

POS income chart over the reporting window.

Тело запроса

ПолеТипОбязательноОписание
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/pos/summary/chart.

POST /reports/pos/summary/expense/chart ​

POS expense chart over the reporting window.

Тело запроса

ПолеТипОбязательноОписание
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/pos/summary/chart.

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

Aggregate POS-issued customer debt.

Тело запроса

ПолеТипОбязательноОписание
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/pos/summary/credit/get-summary ​

Aggregate POS-issued customer credit.

Тело запроса

ПолеТипОбязательноОписание
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/pos/summary/debt/get-summary.

POST /reports/pos/summary/debt/paging ​

Paginated POS debt rows.

Тело запроса

ПолеТипОбязательноОписание
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/pos/summary/credit/paging ​

Paginated POS credit rows.

Тело запроса

ПолеТипОбязательноОписание
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/pos/summary/debt/paging.

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

Aggregate POS product (finished-goods) 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/pos/summary/debt/get-summary.

POST /reports/pos/summary/material/get-summary ​

Aggregate POS material (raw-material) 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/pos/summary/debt/get-summary.

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

Aggregate POS semi-product (work-in-progress) 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/pos/summary/debt/get-summary.

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

Paginated POS product chart data.

Тело запроса

ПолеТипОбязательноОписание
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/pos/summary/debt/paging.

POST /reports/pos/summary/material/chart-paging ​

Paginated POS material chart data.

Тело запроса

ПолеТипОбязательноОписание
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/pos/summary/debt/paging.

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

Paginated POS semi-product chart data.

Тело запроса

ПолеТипОбязательноОписание
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/pos/summary/debt/paging.

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

Total goods valuation grouped by price.

Тело запроса

ПолеТипОбязательноОписание
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/pos/summary/debt/get-summary.

POST /reports/pos/summary/goods/by-price/paging ​

Paginated goods rows grouped by price.

Тело запроса

ПолеТипОбязательноОписание
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/pos/summary/debt/paging.

POST /reports/pos/sales/by-payment-method-paging ​

POS sales aggregated by payment method.

Тело запроса

ПолеТипОбязательноОписание
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/pos/summary/debt/paging.

POST /reports/pos/cashbox/income-expense ​

Cashbox income vs expense rollup for the POS.

Тело запроса

ПолеТипОбязательноОписание
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/pos/summary/debt/get-summary.

POST /reports/pos/sale/summary ​

POS sale summary (aggregate KPIs).

Тело запроса

ПолеТипОбязательноОписание
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/pos/summary/debt/get-summary.

POST /reports/pos/sale/summary/chart ​

POS sale summary chart time series.

Тело запроса

ПолеТипОбязательноОписание
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/pos/summary/chart.

POST /reports/pos/product/top ​

Top-N best-selling products in the POS.

Тело запроса

ПолеТипОбязательноОписание
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/pos/summary/debt/paging.

POST /reports/pos/employee/top ​

Top-N best-performing employees in the POS.

Тело запроса

ПолеТипОбязательноОписание
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/pos/summary/debt/paging.

POST /reports/pos/product/stock/summary ​

Product stock summary across the POS.

Тело запроса

ПолеТипОбязательноОписание
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/pos/summary/debt/get-summary.

POST /reports/pos/production/by-product/produced ​

Manufacturing 'produced' totals grouped by product.

Тело запроса

ПолеТипОбязательноОписание
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/pos/summary/debt/paging.

POST /reports/pos/production/by-product/used ​

Manufacturing 'used' totals grouped by product (raw materials).

Тело запроса

ПолеТипОбязательноОписание
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/pos/summary/debt/paging.

POST /reports/pos/cashflow/get ​

Cashflow report scoped to the POS.

Тело запроса

ПолеТипОбязательноОписание
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/pos/summary/debt/get-summary.

POST /reports/pos/finance/installment/get-summary ​

Installment summary for POS-issued sales.

Тело запроса

ПолеТипОбязательноОписание
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/pos/summary/debt/get-summary.

POST /reports/pos/finance/installment/get-paging ​

Paginated installment rows for POS-issued sales.

Тело запроса

ПолеТипОбязательноОписание
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/pos/summary/debt/paging.

POST /reports/pos/finance/installment/completed ​

Installments completed in the reporting window (POS).

Тело запроса

ПолеТипОбязательноОписание
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/pos/summary/debt/paging.

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

Top-N for the POS 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/pos/summary/debt/paging.

POST /reports/pos/trade/by-product/pagin ​

POS trade rollup grouped by product.

Тело запроса

ПолеТипОбязательноОписание
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/pos/summary/debt/paging.


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

Bito 2.0 Integration API