Search invoices
search_invoicesFind invoices by customer, date range, or document number to see billed amounts or get the invoice ID from a document number. Read-only filters combine with AND.
Instructions
Find invoices by customer Id, transaction-date range, or document number. Use it to answer what a customer was billed in a period, or to turn a document number into an invoice Id. Read-only. Filters combine with AND and the date bounds are inclusive. Payment status cannot be filtered here: read the Balance field on each result, where zero means settled.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| max_date | No | Latest transaction date to include, inclusive, as YYYY-MM-DD. Omit for no upper bound. | |
| min_date | No | Earliest transaction date to include, inclusive, as YYYY-MM-DD. Omit for no lower bound. | |
| doc_number | No | Exact document number printed on the invoice, for example 1042. Matched exactly, not as a prefix. | |
| customer_id | No | Restrict results to invoices billed to this QuickBooks Customer Id. | |
| max_results | No | Maximum rows to return in this page, between 1 and 1000. QuickBooks serves at most 1000 rows per query, so larger result sets need several calls. | |
| start_position | No | One-based index of the first row to return. Page by adding max_results to it: with max_results 20, the second page starts at 21. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | Yes | ||
| count | No | ||
| error | No | ||
| invoices | No | ||
| max_results | No | ||
| start_position | No |