List clients
list_clientsUse this when the user asks about their clients, who owes them money, a client's balance, or needs a client_id for another tool. Lists clients of one business by name: id, name, company, TRN, type, outstanding balance in AED (unpaid issued invoices after payments and credits, foreign invoices at their exchange rate), unused credit in AED, and issued invoice count and total in AED, as the Clients page shows them. search matches the name. No email, phone or address. Do not use it for a client's statement over a period (get_client_statement) or to add a client (create_client).
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "list_clients"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Page size, 1 to 50. Default 20. | |
| cursor | No | next_cursor from the previous page, with the same filters. | |
| search | No | ||
| business_id | No | From list_businesses. May be left out when the connection shares exactly one business. | |
| with_balance | No | Only clients with an outstanding balance. |