Invoices & Finance

As an Admin, you can view invoices via the API.

List Invoices

GET/invoices Bearer Token

Retrieve a paginated list of invoices.

Parameter	Type	Required	Description
per_page	number	No	Results per page

Response

Success (200):

{
  "data": [
    {
      "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "reference": "INV-00001",
      "amount": 5000,
      "status": "paid",
      "payment_method": "bank_transfer",
      "created_at": "2025-01-15T10:00:00Z"
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "limit": 50,
      "total": 24,
      "pages": 1
    }
  }
}

Show Invoice

GET/invoices/{id}/show Bearer Token

Retrieve a single invoice by ID.

Response

Success (200):

{
  "data": {
    "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
    "reference": "INV-00001",
    "amount": 5000,
    "status": "paid",
    "payment_method": "bank_transfer",
    "created_at": "2025-01-15T10:00:00Z",
    "updated_at": "2025-01-16T08:00:00Z"
  },
  "meta": {}
}

Not found (404):

{
  "error": {
    "code": "HTTP_ERROR",
    "message": "Resource not found."
  }
}