Sales Revenue Report
Production
Production
GET
/api2/reports/revenue
report_type=invoice is the Detailed view and returns document rows inside each group; client, staff, sales_person and period are Summary views and return one figure block per group.currency=-1 to convert everything into the base currency and receive a single bucket./owner/reports/revenue, and backs 7 of the Sales Reports tab's cards.{format} suffix. /api2/reports/revenue.json is not a route, and the response is always JSON.Size ceilings
| Bound | Default | Applies to |
|---|---|---|
| Documents | 7,000 | report_type=invoice |
| Groups | 2,000 | every report type |
400 rather than truncating.Request
Query Params
Header Params
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api2/reports/revenue?report_type=invoice&group_by=monthly&date_from=2025-02-01&date_to=2025-05-31&client_id=7&client_category=&staff_id=&invoice_type=¤cy=-1&shipping_option_id=&show_not_taxed=&work_order_id=&order_source_id=&branch_id=&e_invoice_status=' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ' \
--header 'apikey: ' \
--header 'Content-Type: application/json'Response Response Example
200 - Example 1
{
"result": "successful",
"code": 200,
"data": {
"report": {
"key": "revenue",
"report_type": "client",
"mode": "detailed",
"group_by": "string",
"group_dimension": "string",
"title": "string"
},
"filters": {
"report_type": "string",
"group_by": "string",
"date_from": "2019-08-24",
"date_to": "2019-08-24",
"client_id": 0,
"client_category": [
0
],
"staff_id": [
"string"
],
"invoice_type": [
"string"
],
"currency": "string",
"shipping_option_id": 0,
"show_not_taxed": true,
"work_order_id": 0,
"order_source_id": 0,
"branch_id": [
0
],
"e_invoice_status": [
"string"
],
"converted_to": "string"
},
"columns": [
{
"key": "string",
"label": "string"
}
],
"currencies": [
{
"currency": "string",
"totals": {
"paid": 0,
"unpaid": 0,
"refund": 0,
"total": 0,
"total_without_tax": 0,
"unpaid_retention": 0
},
"groups": [
{
"key": "string",
"label": "string",
"period": {
"start": "2019-08-24",
"end": "2019-08-24"
},
"id": 0,
"client_identity": {
"bn1": "string",
"bn1_label": "string"
},
"subtotals": {
"paid": 0,
"unpaid": 0,
"refund": 0,
"total": 0,
"total_without_tax": 0,
"unpaid_retention": 0
},
"invoices": [
{
"paid": 0,
"unpaid": 0,
"refund": 0,
"total": 0,
"total_without_tax": 0,
"unpaid_retention": 0,
"no": "string",
"document_type": "invoice",
"date": "2019-08-24",
"client": {
"id": 0,
"name": "string",
"bn1": "string",
"bn1_label": "string",
"bn2": "string",
"bn2_label": "string"
},
"staff": {
"id": 0,
"name": "string"
},
"sales_person": {
"id": 0,
"name": "string"
},
"e_invoice_status": {
"code": "string",
"label": "string"
},
"shows_retention": true
}
]
}
]
}
],
"meta": {
"currency_count": 0,
"group_count": 0,
"retention_enabled": true,
"e_invoice_enabled": true,
"sales_without_tax_enabled": true,
"invoice_count": 0,
"invoice_id_available": true,
"converted_to": "string"
}
}
}