Report finance
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/balance/get
Current cashbox / account balance snapshot.
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" |
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"
}Response
json
{
"code": 0,
"message": "Success",
"status_code": 200,
"data": {},
"time": "2025-05-01T12:00:00Z"
}POST /reports/balance/get-at
Balance at a specific point in time.
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" |
at | string (date-time) | Yes |
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",
"at": "2025-05-01T12:00:00Z"
}Response
Same response shape as POST /reports/balance/get.
POST /reports/balance/items
Per-currency / per-account balance breakdown.
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" |
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"
}Response
| Field | Type | Description |
|---|---|---|
list | object[] | |
total | number |
json
{
"code": 0,
"message": "Success",
"status_code": 200,
"data": {
"list": [
{}
],
"total": 0
},
"time": "2025-05-01T12:00:00Z"
}POST /reports/cashflow/get
Cashflow report for the reporting window (in + out + net).
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" |
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"
}Response
Same response shape as POST /reports/balance/get.
POST /reports/customer-debt/get
Aggregate of outstanding customer debt.
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" |
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"
}Response
Same response shape as POST /reports/balance/get.
POST /reports/profit-loss/get
P&L report (revenue, COGS, expenses, net profit).
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" |
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"
}Response
Same response shape as POST /reports/balance/get.
POST /reports/finance/installment-plan/get-summary
Summary of installment-plan installments (debt, paid, due).
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" |
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"
}Response
Same response shape as POST /reports/balance/get.
POST /reports/finance/installment-plan/get-paging
Paginated list of installment plans.
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 |
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"
}Response
Same response shape as POST /reports/balance/items.
POST /reports/finance/installment-plan/completed
Completed installment plans within the reporting window.
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 |
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"
}Response
Same response shape as POST /reports/balance/items.
POST /reports/finance/customers-payment-overview/get-summary
Aggregate payment-overview metrics per customer.
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" |
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"
}Response
Same response shape as POST /reports/balance/get.
POST /reports/finance/customers-payment-overview/get-paging
Paginated payment-overview rows per customer.
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 |
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"
}Response
Same response shape as POST /reports/balance/items.
POST /reports/finance/customers-payment-overview/completed
Customers whose payment plan completed in the window.
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 |
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"
}Response
Same response shape as POST /reports/balance/items.
POST /reports/summary/income/pagin
Paginated income summary rows.
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 |
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"
}Response
Same response shape as POST /reports/balance/items.
POST /reports/summary/income-expense/stats
Aggregate income/expense statistics for the window.
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" |
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"
}Response
Same response shape as POST /reports/balance/get.
This page is generated from the OpenAPI spec.