Reports
Get customer balance summary report
GET
Headers
Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token.
Example:
"Bearer bc_1234567890abcdef"
Required if Authorization is a JWT token. The organization ID to operate within.
Query Parameters
The date as of which the balance summary is calculated
Example:
"2024-01-01"
Number of decimal places to display
Example:
2
Whether to divide the number by 1000
Example:
false
Whether to show zero values
Example:
true
How to format money values
Available options:
total, always, none Example:
"total"
How to format negative numbers
Available options:
parentheses, mines Example:
"parentheses"
Whether to show the percentage column in the summary
Example:
false
Whether to exclude contacts with no transactions
Example:
false
Whether to exclude contacts with zero balance
Example:
false
Array of customer IDs to filter the summary
Example:
[1, 2, 3]Response
200
Customer balance summary report