v2

latestOpenAPI 3.0.0raw.githubusercontent.com2026-02-16143114179.4 KB
Customer Portal

List customer invoices

Returns a paginated list of invoices. Filter by status to show only pending invoices.

get/api/portal/customers/{externalId}/invoices

Path parameters

externalIdstring required

Customer external ID

Query parameters

status'PENDING' | 'PAID' | 'FAILED' | 'CANCELED'
pagenumber
limitnumber

Response

Paginated invoices

Example response

{
  "data": [
    {
      "id": "clx1234567890",
      "invoiceNumber": "INV-2026-0001",
      "customerId": "clxcust123",
      "amount": "99.9900",
      "currency": "USD",
      "status": "DRAFT",
      "pdfUrl": "/uploads/invoices/inv-123.pdf",
      "customer": {
        "id": "clx1234567890",
        "name": "Jane Doe",
        "email": "jane@example.com"
      }
    }
  ],
  "meta": {
    "total": 150,
    "page": 1,
    "limit": 20,
    "totalPages": 8
  }
}