Get client balance
get_client_balanceRetrieve a client's outstanding balance in a specified currency with invoice counts by status (open, past due, closed) to assess what they owe.
Instructions
Amount the client owes in a currency (sum of open invoices) plus invoice counts by status (open, past_due, closed, ...). Wraps Invoices.amountDue and Invoices.getStatusCount. Use get_client with include_settings to learn the client's default currency.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"client_id": "<client_id>",
"currency": "<currency>"
},
"name": "get_client_balance"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| currency | Yes | ISO 4217 currency code, e.g. USD or EUR | |
| client_id | Yes | Numeric client ID |