Get list of invoices

📘

API Refs

This endpoint returns a list of all invoices created by the current account.

Response body

The response is an array of invoice objects, each containing the following fields:

NameTypeDescription
idnumberUnique invoice identifier
policyholderobjectPolicyholder details
carrierobjectCarrier details
typestringType of invoice (e.g., "Invoice")
statusobjectCurrent status of the invoice
grossPremiumnumberGross premium amount
commissionnumberCommission amount
createdAtstringDate of creation (ISO 8601)

Example

[
  {
    "id": 789,
    "policyholder": { "id": 123, "firstName": "John", "lastName": "Doe" },
    "carrier": { "id": 456, "businessName": "ABC Insurance Co" },
    "type": "Invoice",
    "status": { "code": 1, "value": "payment_link_pending" },
    "grossPremium": 1200.50,
    "commission": 120.05,
    "createdAt": "2024-07-22T14:30:00Z"
  }
]