Search Invoices Tool
search-invoicesSearches authorized invoices using bounded customer, job, status, payment, due-date, and total fields; payment links and addresses are excluded. Use to search invoices in the connected business. Returns query, count, total, invoices, resolution, scope.
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": "search-invoices"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of invoices to return. | |
| query | No | Invoice number, customer name, email, phone, job title, or description. | |
| job_id | No | Restrict results to one job ID. | |
| status | No | Invoice lifecycle status. | |
| customer_id | No | Restrict results to one customer ID. | |
| payment_status | No | Authoritative payment state, such as unpaid, pending, paid, or refunded. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| count | Yes | Count for the returned result. | |
| query | Yes | Query used or returned by this tool. | |
| scope | Yes | Authorization scope of this result; data remains restricted to the connected business. | |
| total | Yes | Total for the returned result. | |
| invoices | Yes | Bounded invoices records returned by this tool. | |
| resolution | Yes | Resolution metadata; empty collections retain their existing JSON array representation. |