Documentation

Get Invoice

Retrieve a single invoice, including its line items and payments. Site users with invoice viewing permission, the billed user for an eligible invoice, and project editors for an eligible project invoice can retrieve it.

GET /invoices/{invoice_id}

Path Parameters

Parameter Type Required Description
invoice_id string Yes QReserve invoice ID returned by List Invoices.

Example

curl -H 'Authorization: YOUR_API_KEY' 'https://api.qreserve.com/invoices/INVOICE_ID'

Response

data contains the invoice. Use items for line items and payments for payment records. Fields can vary by permission. This example is abbreviated.

{
  "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,
    "items": [
      {
        "position": 0,
        "item": "Equipment usage"
      }
    ],
    "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"
      }
    ]
  }
}

An unavailable invoice or an invoice the caller cannot view returns a not-found response.

See the Invoices API overview for shared IDs and permissions.