Get organisation summary
get_organisation_summaryReturns receivables totals for the organisation: amount outstanding, amount overdue, unpaid and overdue invoice counts and the number of active contacts. Totals are in the organisation's base currency. Use it for a quick overview before drilling into invoices or contacts. Read only.
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": {
"organisationId": "<organisationId>"
},
"name": "get_organisation_summary"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| organisationId | Yes | Id of the organisation to act on, from list_organisations |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| currency | Yes | ||
| contactCount | Yes | Number of active contacts. Archived contacts are not counted. | |
| overdueTotal | Yes | ||
| outstandingTotal | Yes | ||
| unpaidInvoiceCount | Yes | ||
| overdueInvoiceCount | Yes |