Search payments
search_paymentsFind payments by customer ID or date range to reconcile customer-paid amounts over a period or identify which payment settled an invoice.
Instructions
Find payments by customer Id or transaction-date range. Use it to reconcile what a customer has paid over a period, or to locate the payment that settled an invoice. Read-only. Filters combine with AND and the date bounds are inclusive. Which invoice a payment was applied to is not a filter: read the LinkedTxn entries on each result.
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. | |
| customer_id | No | Restrict results to payments received from 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 | ||
| payments | No | ||
| max_results | No | ||
| start_position | No |