List Payments
Table of Contents
- Query Parameters
- Scope and payment filters
- Filters on the associated invoice
- Billing and invoice
- Project, resource, and line item
- Reconciliation
- Example
- Response
Retrieve a page of payment records for a site. The API key user needs invoice viewing permission for that site. For payment records on one invoice, use Get Invoice.
GET /invoices/payments
Query Parameters
Scope and payment filters
| Parameter | Type | Required | Description |
|---|---|---|---|
site_id |
string | Yes | QReserve site ID. |
start |
string | No | Inclusive start date (YYYY-MM-DD) for the payment’s received date. |
end |
string | No | Inclusive end date (YYYY-MM-DD) for the payment’s received date. |
payment_success |
boolean | No | Use true for successful payments and refunds, or false for unsuccessful records, including voids. Omit to include both. |
payment_source_class |
string | No | manual, account, online, or device. |
payment_amount |
string | No | Decimal amount, such as 25.00. Matches both positive and negative amounts of that magnitude. |
limit |
integer | No | Page size. Defaults to 100 and is capped at 100. |
offset |
integer | No | Number of records to skip. Defaults to 0. |
Results are ordered by received date, newest first.
Filters on the associated invoice
The following filters select payments through their associated invoice. For example, order_id selects invoices with that payment order ID, so the response can include other payment records from a matching invoice. Reconciliation lookups by invoice number, invoice number prefix, order ID, Global Payments reference, or Portico transaction ID can also include records from deactivated invoices.
Billing and invoice
| Parameter | Type | Required | Description |
|---|---|---|---|
bill_to_user_id |
string | No | QReserve user ID of the billed user. |
bill_to_name |
string | No | Case-insensitive match against the billing name. |
bill_to_email |
string | No | Case-insensitive match against the billing email. |
usergroup_id |
integer | No | Billed user’s site user group. Requires a site and user-group viewing permission. |
invoice_number |
string | No | Case-insensitive substring of the full invoice number. Suppresses the date range. |
invoice_number_prefix |
string | No | Case-insensitive prefix of the full invoice number. |
invoice_type |
string | No | invoice or quote. |
status |
string | No | Comma-separated stored invoice or quote statuses. For invoices: draft, sent, partially paid, paid, void. Quotes can also use accepted and rejected. |
is_overdue |
boolean | No | true selects sent invoices or quotes with a past due date. false selects records without a due date or with a due date today or later. Suppresses the status filter. |
autosend |
boolean | No | Filter by whether automatic sending is enabled. |
does_recur |
boolean | No | Filter by whether a next invoice date is scheduled. |
Project, resource, and line item
| Parameter | Type | Required | Description |
|---|---|---|---|
project_id |
string | No | QReserve project ID. Includes invoices linked directly to the project or through reservation line items. |
reservable_id |
string | No | QReserve resource ID on an invoice line item. |
category |
string | No | Category of a resource on a line item. |
category_match |
string | No | How to match category: contains (default), exact, or path. |
tags[] |
string (repeatable) | No | Resource tag names on line items. Matches any supplied tag. Repeat the parameter for multiple tags. |
invoice_item_name |
string | No | Case-insensitive match against a line-item name. |
invoice_item_sku |
string | No | Case-insensitive match against a line-item SKU. |
Reconciliation
| Parameter | Type | Required | Description |
|---|---|---|---|
order_id |
string | No | Associated payment order ID. |
global_payments_reference |
string | No | Associated Global Payments reference. |
portico_transaction_id |
string | No | Associated Portico transaction ID. |
uploaded_to_quickbooks |
boolean | No | Filter by whether the invoice has a QuickBooks ID. Requires the site’s QuickBooks Exporter permission. |
Example
List successful manual payments and refunds received during October.
curl -H 'Authorization: YOUR_API_KEY' 'https://api.qreserve.com/invoices/payments?site_id=SITE_ID&start=2026-10-01&end=2026-10-31&payment_success=true&payment_source_class=manual&limit=25&offset=0'
Response
data.payments contains payment records with an invoice summary. numitems counts matches before pagination. data.total_amount sums successful matching records across all pages, in integer hundredths of a currency unit. Successful refunds reduce the sum. Fields are abbreviated in this example.
{
"status": "success",
"data": {
"payments": [
{
"invoice_payment_record_id": "PAYMENT_RECORD_ID",
"amount": 2500,
"amount_dec": 25,
"currency_code": "CAD",
"success": true,
"payment_source": "manual",
"payment_method": "Cheque",
"received_date": "2026-10-15",
"invoice": {
"invoice_id": "INVOICE_ID",
"site_id": "SITE_ID",
"invoice_number": "1042",
"invoice_number_full": "INV-1042",
"invoice_type": "invoice",
"status": "sent",
"active": true
}
}
],
"total_amount": 2500
},
"numitems": 1
}
A missing site or invalid query returns an error. A caller without invoice viewing permission receives a permission error.
See the Invoices API overview for shared IDs and permissions.