Payments Report
Production
Production
GET
/api2/reports/payments
group_by chooses the card, is_summary chooses the shape./owner/reports/payments, and backs 7 of the Sales Reports tab's cards.staff_id is the invoice's staff ("Invoiced By"); collected_by is the payment's staff ("Collected By"). Separate columns, separate group_by options, and both can be sent together -- picking the wrong one silently returns a different set.Size ceilings
| Bound | Default | Applies to |
|---|---|---|
| Payment rows | 20,000 | is_summary=0 |
| Groups | 2,000 | both |
Request
Query Params
Header Params
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api2/reports/payments?group_by=monthly&is_summary=0&date_from=2025-02-01&date_to=2025-05-31¤cy=-1&client_id=7&client_category=&payment_method=cash&staff_id=&collected_by=&branch_id=&order_source_id=' \
--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": "string",
"group_by": "string",
"mode": "detailed",
"group_dimension": "string",
"title": "string"
},
"filters": {
"group_by": "string",
"is_summary": 0,
"date_from": "2019-08-24",
"date_to": "2019-08-24",
"currency": "string",
"consolidated": true,
"client_id": 0,
"client_category": [
0
],
"payment_method": "string",
"staff_id": [
0
],
"collected_by": [
0
],
"branch_id": [
0
],
"order_source_id": 0
},
"columns": [
{
"key": "string",
"label": "string"
}
],
"currencies": [
{
"currency": "string",
"totals": {
"amount": 0
},
"groups": [
{
"key": "string",
"label": "string",
"period": {
"start": "2019-08-24",
"end": "2019-08-24"
},
"id": 0,
"subtotals": {
"amount": 0
},
"payments": [
{
"id": 0,
"code": "string",
"date": "2019-08-24",
"amount": 0,
"payment_method": "string",
"payment_method_label": "string",
"transaction_id": "string",
"invoice": {
"id": 0,
"no": "string",
"type": "string"
},
"client": {
"name": "string"
},
"invoiced_by": {
"id": 0,
"name": "string"
},
"collected_by": {
"id": 0,
"name": "string"
}
}
]
}
]
}
],
"meta": {
"currency_count": 0,
"group_count": 0,
"payment_count": 0,
"is_summary": true,
"staff_column_available": true,
"client_column_available": true,
"date_column_available": true
}
}
}