Report dashboard
INFO
Every response arrives in the shared envelope — code, message, messages, status_code, time — with the payload in data. The tables below describe what is inside data.
POST /reports/summary/debt/paging
Paginated debt rows for the dashboard summary card.
Request body
| Field | Type | Required | Description |
|---|---|---|---|
page | number | Yes | Default: 1 |
limit | number | Yes | Default: 20 |
date_from | string (date-time) | No | Start of the reporting window. |
date_to | string (date-time) | No | End of the reporting window. |
organization_ids | string[] | No | |
warehouse_ids | string[] | No | |
currency_id | string | No | |
responsible_ids | string[] | No | |
customer_ids | string[] | No | |
supplier_ids | string[] | No | |
product_ids | string[] | No | |
category_ids | string[] | No | |
payment_method_ids | string[] | No | |
sort_by | string | No | Field name to sort by. |
sort_order | string | No | One of: asc, desc. Default: "desc" |
search | string | No |
{
"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"
}Response
| Field | Type | Description |
|---|---|---|
list | object[] | |
total | number |
{
"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.
Request body
| Field | Type | Required | Description |
|---|---|---|---|
page | number | Yes | Default: 1 |
limit | number | Yes | Default: 20 |
date_from | string (date-time) | No | Start of the reporting window. |
date_to | string (date-time) | No | End of the reporting window. |
organization_ids | string[] | No | |
warehouse_ids | string[] | No | |
currency_id | string | No | |
responsible_ids | string[] | No | |
customer_ids | string[] | No | |
supplier_ids | string[] | No | |
product_ids | string[] | No | |
category_ids | string[] | No | |
payment_method_ids | string[] | No | |
sort_by | string | No | Field name to sort by. |
sort_order | string | No | One of: asc, desc. Default: "desc" |
search | string | No |
{
"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"
}Response
Same response shape as POST /reports/summary/debt/paging.
POST /reports/customers/health-score/charts
Customer health-score time series for charts.
Request body
| Field | Type | Required | Description |
|---|---|---|---|
date_from | string (date-time) | No | Start of the reporting window. |
date_to | string (date-time) | No | End of the reporting window. |
organization_ids | string[] | No | |
warehouse_ids | string[] | No | |
currency_id | string | No | |
responsible_ids | string[] | No | |
customer_ids | string[] | No | |
supplier_ids | string[] | No | |
product_ids | string[] | No | |
category_ids | string[] | No | |
payment_method_ids | string[] | No | |
sort_by | string | No | Field name to sort by. |
sort_order | string | No | One of: asc, desc. Default: "desc" |
{
"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"
}Response
{
"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).
Request body
| Field | Type | Required | Description |
|---|---|---|---|
date_from | string (date-time) | No | Start of the reporting window. |
date_to | string (date-time) | No | End of the reporting window. |
organization_ids | string[] | No | |
warehouse_ids | string[] | No | |
currency_id | string | No | |
responsible_ids | string[] | No | |
customer_ids | string[] | No | |
supplier_ids | string[] | No | |
product_ids | string[] | No | |
category_ids | string[] | No | |
payment_method_ids | string[] | No | |
sort_by | string | No | Field name to sort by. |
sort_order | string | No | One of: asc, desc. Default: "desc" |
{
"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"
}Response
{
"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).
Request body
| Field | Type | Required | Description |
|---|---|---|---|
date_from | string (date-time) | No | Start of the reporting window. |
date_to | string (date-time) | No | End of the reporting window. |
organization_ids | string[] | No | |
warehouse_ids | string[] | No | |
currency_id | string | No | |
responsible_ids | string[] | No | |
customer_ids | string[] | No | |
supplier_ids | string[] | No | |
product_ids | string[] | No | |
category_ids | string[] | No | |
payment_method_ids | string[] | No | |
sort_by | string | No | Field name to sort by. |
sort_order | string | No | One of: asc, desc. Default: "desc" |
{
"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"
}Response
Same response shape as POST /reports/customers/health-score/summary.
POST /reports/dashboard/chart
Main dashboard time-series chart data.
Request body
| Field | Type | Required | Description |
|---|---|---|---|
date_from | string (date-time) | No | Start of the reporting window. |
date_to | string (date-time) | No | End of the reporting window. |
organization_ids | string[] | No | |
warehouse_ids | string[] | No | |
currency_id | string | No | |
responsible_ids | string[] | No | |
customer_ids | string[] | No | |
supplier_ids | string[] | No | |
product_ids | string[] | No | |
category_ids | string[] | No | |
payment_method_ids | string[] | No | |
sort_by | string | No | Field name to sort by. |
sort_order | string | No | One of: asc, desc. Default: "desc" |
{
"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"
}Response
Same response shape as POST /reports/customers/health-score/charts.
POST /reports/dashboard/top/{key}
Top-N entities ranked by the given key (e.g. products / customers / employees).
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
key | string | Yes | Top-N grouping key: product, customer, employee, category, payment_method, etc. |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
date_from | string (date-time) | No | Start of the reporting window. |
date_to | string (date-time) | No | End of the reporting window. |
organization_ids | string[] | No | |
warehouse_ids | string[] | No | |
currency_id | string | No | |
responsible_ids | string[] | No | |
customer_ids | string[] | No | |
supplier_ids | string[] | No | |
product_ids | string[] | No | |
category_ids | string[] | No | |
payment_method_ids | string[] | No | |
sort_by | string | No | Field name to sort by. |
sort_order | string | No | One of: asc, desc. Default: "desc" |
{
"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"
}Response
Same response shape as POST /reports/summary/debt/paging.
POST /reports/order/dashboard/summary
Sale-order dashboard KPI summary.
Request body
| Field | Type | Required | Description |
|---|---|---|---|
date_from | string (date-time) | No | Start of the reporting window. |
date_to | string (date-time) | No | End of the reporting window. |
organization_ids | string[] | No | |
warehouse_ids | string[] | No | |
currency_id | string | No | |
responsible_ids | string[] | No | |
customer_ids | string[] | No | |
supplier_ids | string[] | No | |
product_ids | string[] | No | |
category_ids | string[] | No | |
payment_method_ids | string[] | No | |
sort_by | string | No | Field name to sort by. |
sort_order | string | No | One of: asc, desc. Default: "desc" |
{
"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"
}Response
Same response shape as POST /reports/customers/health-score/summary.
POST /reports/order/dashboard/chart
Sale-order dashboard time-series chart.
Request body
| Field | Type | Required | Description |
|---|---|---|---|
date_from | string (date-time) | No | Start of the reporting window. |
date_to | string (date-time) | No | End of the reporting window. |
organization_ids | string[] | No | |
warehouse_ids | string[] | No | |
currency_id | string | No | |
responsible_ids | string[] | No | |
customer_ids | string[] | No | |
supplier_ids | string[] | No | |
product_ids | string[] | No | |
category_ids | string[] | No | |
payment_method_ids | string[] | No | |
sort_by | string | No | Field name to sort by. |
sort_order | string | No | One of: asc, desc. Default: "desc" |
{
"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"
}Response
Same response shape as POST /reports/customers/health-score/charts.
POST /reports/order/dashboard/states
Sale-order count by state (new / in-progress / done / canceled).
Request body
| Field | Type | Required | Description |
|---|---|---|---|
date_from | string (date-time) | No | Start of the reporting window. |
date_to | string (date-time) | No | End of the reporting window. |
organization_ids | string[] | No | |
warehouse_ids | string[] | No | |
currency_id | string | No | |
responsible_ids | string[] | No | |
customer_ids | string[] | No | |
supplier_ids | string[] | No | |
product_ids | string[] | No | |
category_ids | string[] | No | |
payment_method_ids | string[] | No | |
sort_by | string | No | Field name to sort by. |
sort_order | string | No | One of: asc, desc. Default: "desc" |
{
"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"
}Response
Same response shape as POST /reports/customers/health-score/summary.
POST /reports/order/dashboard/top/{key}
Top-N for the sale-order dashboard, by the given key.
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
key | string | Yes |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
date_from | string (date-time) | No | Start of the reporting window. |
date_to | string (date-time) | No | End of the reporting window. |
organization_ids | string[] | No | |
warehouse_ids | string[] | No | |
currency_id | string | No | |
responsible_ids | string[] | No | |
customer_ids | string[] | No | |
supplier_ids | string[] | No | |
product_ids | string[] | No | |
category_ids | string[] | No | |
payment_method_ids | string[] | No | |
sort_by | string | No | Field name to sort by. |
sort_order | string | No | One of: asc, desc. Default: "desc" |
{
"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"
}Response
Same response shape as POST /reports/summary/debt/paging.
POST /reports/summary/debt/get-summary
Aggregate customer-debt summary for the dashboard card.
Request body
| Field | Type | Required | Description |
|---|---|---|---|
date_from | string (date-time) | No | Start of the reporting window. |
date_to | string (date-time) | No | End of the reporting window. |
organization_ids | string[] | No | |
warehouse_ids | string[] | No | |
currency_id | string | No | |
responsible_ids | string[] | No | |
customer_ids | string[] | No | |
supplier_ids | string[] | No | |
product_ids | string[] | No | |
category_ids | string[] | No | |
payment_method_ids | string[] | No | |
sort_by | string | No | Field name to sort by. |
sort_order | string | No | One of: asc, desc. Default: "desc" |
{
"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"
}Response
Same response shape as POST /reports/customers/health-score/summary.
POST /reports/summary/credit/get-summary
Aggregate customer-credit summary for the dashboard card.
Request body
| Field | Type | Required | Description |
|---|---|---|---|
date_from | string (date-time) | No | Start of the reporting window. |
date_to | string (date-time) | No | End of the reporting window. |
organization_ids | string[] | No | |
warehouse_ids | string[] | No | |
currency_id | string | No | |
responsible_ids | string[] | No | |
customer_ids | string[] | No | |
supplier_ids | string[] | No | |
product_ids | string[] | No | |
category_ids | string[] | No | |
payment_method_ids | string[] | No | |
sort_by | string | No | Field name to sort by. |
sort_order | string | No | One of: asc, desc. Default: "desc" |
{
"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"
}Response
Same response shape as POST /reports/customers/health-score/summary.
POST /reports/summary/goods/by-price/total
Total goods valuation grouped by price (dashboard card).
Request body
| Field | Type | Required | Description |
|---|---|---|---|
date_from | string (date-time) | No | Start of the reporting window. |
date_to | string (date-time) | No | End of the reporting window. |
organization_ids | string[] | No | |
warehouse_ids | string[] | No | |
currency_id | string | No | |
responsible_ids | string[] | No | |
customer_ids | string[] | No | |
supplier_ids | string[] | No | |
product_ids | string[] | No | |
category_ids | string[] | No | |
payment_method_ids | string[] | No | |
sort_by | string | No | Field name to sort by. |
sort_order | string | No | One of: asc, desc. Default: "desc" |
{
"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"
}Response
Same response shape as POST /reports/customers/health-score/summary.
POST /reports/summary/product/chart-paging
Paginated product chart rows for the dashboard.
Request body
| Field | Type | Required | Description |
|---|---|---|---|
page | number | Yes | Default: 1 |
limit | number | Yes | Default: 20 |
date_from | string (date-time) | No | Start of the reporting window. |
date_to | string (date-time) | No | End of the reporting window. |
organization_ids | string[] | No | |
warehouse_ids | string[] | No | |
currency_id | string | No | |
responsible_ids | string[] | No | |
customer_ids | string[] | No | |
supplier_ids | string[] | No | |
product_ids | string[] | No | |
category_ids | string[] | No | |
payment_method_ids | string[] | No | |
sort_by | string | No | Field name to sort by. |
sort_order | string | No | One of: asc, desc. Default: "desc" |
search | string | No |
{
"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"
}Response
Same response shape as POST /reports/summary/debt/paging.
POST /reports/summary/product/get-summary
Aggregate product summary for the dashboard card.
Request body
| Field | Type | Required | Description |
|---|---|---|---|
date_from | string (date-time) | No | Start of the reporting window. |
date_to | string (date-time) | No | End of the reporting window. |
organization_ids | string[] | No | |
warehouse_ids | string[] | No | |
currency_id | string | No | |
responsible_ids | string[] | No | |
customer_ids | string[] | No | |
supplier_ids | string[] | No | |
product_ids | string[] | No | |
category_ids | string[] | No | |
payment_method_ids | string[] | No | |
sort_by | string | No | Field name to sort by. |
sort_order | string | No | One of: asc, desc. Default: "desc" |
{
"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"
}Response
Same response shape as POST /reports/customers/health-score/summary.
POST /reports/summary/sale/chart
Sale chart time series for the dashboard.
Request body
| Field | Type | Required | Description |
|---|---|---|---|
date_from | string (date-time) | No | Start of the reporting window. |
date_to | string (date-time) | No | End of the reporting window. |
organization_ids | string[] | No | |
warehouse_ids | string[] | No | |
currency_id | string | No | |
responsible_ids | string[] | No | |
customer_ids | string[] | No | |
supplier_ids | string[] | No | |
product_ids | string[] | No | |
category_ids | string[] | No | |
payment_method_ids | string[] | No | |
sort_by | string | No | Field name to sort by. |
sort_order | string | No | One of: asc, desc. Default: "desc" |
{
"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"
}Response
Same response shape as POST /reports/customers/health-score/charts.
POST /reports/trade/customer/chart
Trade-by-customer chart time series for the dashboard.
Request body
| Field | Type | Required | Description |
|---|---|---|---|
date_from | string (date-time) | No | Start of the reporting window. |
date_to | string (date-time) | No | End of the reporting window. |
organization_ids | string[] | No | |
warehouse_ids | string[] | No | |
currency_id | string | No | |
responsible_ids | string[] | No | |
customer_ids | string[] | No | |
supplier_ids | string[] | No | |
product_ids | string[] | No | |
category_ids | string[] | No | |
payment_method_ids | string[] | No | |
sort_by | string | No | Field name to sort by. |
sort_order | string | No | One of: asc, desc. Default: "desc" |
{
"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"
}Response
Same response shape as POST /reports/customers/health-score/charts.
POST /reports/trade/customer/health-score
Customer health-score rollup based on trade history.
Request body
| Field | Type | Required | Description |
|---|---|---|---|
date_from | string (date-time) | No | Start of the reporting window. |
date_to | string (date-time) | No | End of the reporting window. |
organization_ids | string[] | No | |
warehouse_ids | string[] | No | |
currency_id | string | No | |
responsible_ids | string[] | No | |
customer_ids | string[] | No | |
supplier_ids | string[] | No | |
product_ids | string[] | No | |
category_ids | string[] | No | |
payment_method_ids | string[] | No | |
sort_by | string | No | Field name to sort by. |
sort_order | string | No | One of: asc, desc. Default: "desc" |
{
"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"
}Response
Same response shape as 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.
Request body
| Field | Type | Required | Description |
|---|---|---|---|
page | number | Yes | Default: 1 |
limit | number | Yes | Default: 20 |
date_from | string (date-time) | No | Start of the reporting window. |
date_to | string (date-time) | No | End of the reporting window. |
organization_ids | string[] | No | |
warehouse_ids | string[] | No | |
currency_id | string | No | |
responsible_ids | string[] | No | |
customer_ids | string[] | No | |
supplier_ids | string[] | No | |
product_ids | string[] | No | |
category_ids | string[] | No | |
payment_method_ids | string[] | No | |
sort_by | string | No | Field name to sort by. |
sort_order | string | No | One of: asc, desc. Default: "desc" |
search | string | No |
{
"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"
}Response
Same response shape as POST /reports/summary/debt/paging.
This page is generated from the OpenAPI spec.