Sign in

v1

latestOpenAPI 3.1.02026-07-132363652.9 MB
Invoice
Admin

Get details of an invoice (any billable type)

Get details of an invoice (any billable type)

get/api/v1/admin/invoices/{invoiceId}

Path parameters

invoiceIdstring uuid required

Unique identifier of the invoice

Unique identifier of the invoice

Response

Success

successboolean required

Indicates if the request was successful

Example response

{
  "success": true,
  "data": {
    "invoice_number": "INV-202605-000001",
    "payment_reference": "QK7L2M9X4P0R",
    "currency": "GBP",
    "total_amount": "1234.56",
    "amount_paid": "0.00",
    "outstanding_amount": "1234.56",
    "transaction_count": 42,
    "payments": [
      {
        "amount": "125.00",
        "currency": "GBP"
      }
    ],
    "fx_rates": [
      {
        "source_currency": "GBP",
        "rate": "0.85120000",
        "provider": "openexchangerates"
      }
    ]
  }
}