Documentation

Overview

Table of Contents

Use the Invoices API to retrieve invoices and payment records, reconcile payments, and manage invoices for a QReserve site.

Authentication and permissions

Send an API key in the Authorization header. See API Authentication for setup and API Overview for the base URL and response conventions. The API key uses the permissions of its QReserve user. Site-wide invoice and payment lists require invoice viewing permission. A billed user can retrieve their own eligible invoices. Creating and editing invoices, recording payments, and voiding payments have separate permission requirements.

Invoice and payment IDs

  • invoice_id is the QReserve ID returned on the invoice. Use it in invoice detail and write requests. invoice_number is the billing reference shown to users.
  • invoice_payment_record_id identifies a payment and is the value to pass as payment_record_id when voiding it.
  • Invoice lists return summary objects. Get Invoice returns more detail, including line items and payments. List Payments returns payment records with their associated invoice summaries.

Amounts and currency

In a payment record, amount is the integer amount in hundredths of a currency unit and amount_dec is the decimal equivalent. Use currency_code to interpret amounts. A refund is represented by a negative amount. The payment_amount query parameter on List Payments takes a decimal amount such as 25.00.

Endpoints