List Invoices
Table of Contents
- Query Parameters
- Scope, dates, and visibility
- Billing and invoice
- Project, resource, and line item
- Reconciliation
- Sorting and pagination
- Examples
- Response
Retrieve a page of invoice and quote summaries. To list invoices for an entire site, supply site_id and use an API key with invoice viewing permission for that site. To list your own invoices, supply your QReserve user ID as bill_to_user_id. Project editors can use project_id to retrieve invoices linked to eligible projects.
GET /invoices
Query Parameters
Scope, dates, and visibility
| Parameter | Type | Required | Description |
|---|---|---|---|
site_id |
string | No | QReserve site ID for a site-wide list. Required with uploaded_to_quickbooks and usergroup_id. |
start |
string | No | Inclusive start date (YYYY-MM-DD) for the field selected by date_by. |
end |
string | No | Inclusive end date (YYYY-MM-DD) for the field selected by date_by. |
date_by |
string | No | invoice_date (default), payment_date, or billing_period_date. Payment mode matches an invoice with a payment in the range. Billing period mode matches invoices whose billing period overlaps the range. |
active |
boolean | No | Defaults to true. An authorized site-wide viewer can use false to list deactivated invoices. |
include_expired |
boolean | No | Defaults to true. Use false to exclude expired 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. |
Sorting and pagination
| Parameter | Type | Required | Description |
|---|---|---|---|
sort_atr |
string | No | invoice_date (default), invoice_number, or due_date. |
sort_ord |
string | No | desc (default) or asc. |
limit |
integer | No | Page size. Defaults to 100 and is capped at 100. |
offset |
integer | No | Number of records to skip. Defaults to 0. |
count_only |
boolean | No | Use true to return the matching count without invoice records. |
Examples
List sent invoices by invoice date.
curl -H 'Authorization: YOUR_API_KEY' 'https://api.qreserve.com/invoices?site_id=SITE_ID&invoice_type=invoice&status=sent&start=2026-10-01&end=2026-10-31&limit=25&offset=0'
Find invoices with a payment received during October.
GET /invoices?site_id=SITE_ID&date_by=payment_date&start=2026-10-01&end=2026-10-31
Find invoices with billing periods that overlap October.
GET /invoices?site_id=SITE_ID&date_by=billing_period_date&start=2026-10-01&end=2026-10-31
Response
data contains invoice summaries and numitems is the total number of matches before pagination. Fields are abbreviated in this example. Use Get Invoice for line items and payment records. With count_only=true, data is null.
{
"status": "success",
"data": [
{
"invoice_id": "INVOICE_ID",
"site_id": "SITE_ID",
"invoice_number": "1042",
"invoice_number_full": "INV-1042",
"invoice_type": "invoice",
"status": "sent",
"active": true
}
],
"numitems": 1
}
An invalid filter returns a validation error. A site-wide request without the necessary access returns a permission error.
See the Invoices API overview for shared IDs and permissions.