Sign in
Invoice
Admin

List invoices across all billables with optional filters

List invoices across all billables with optional filters

get/api/v1/admin/invoices

Query parameters

merchant_idstring uuid

The merchant_id parameter

'draft'
OR
'issued'
OR
'paid'
OR
'void'

Lifecycle status of the invoice

period_start_fromstring date

The period_start_from parameter

period_start_tostring date

The period_start_to parameter

limitstring

Page size (1-200, default 50)

Page size (1-200, default 50)

offsetstring

The offset parameter

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"
        }
      ]
    }
  ]
}

Changes

Changed in 2 of the 8 revisions of this API.11