Get list of invoices
API Refs
- Staging: Get list of invoices
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:
Name | Type | Description |
---|---|---|
id | number | Unique invoice identifier |
policyholder | object | Policyholder details |
carrier | object | Carrier details |
type | string | Type of invoice (e.g., "Invoice") |
status | object | Current status of the invoice |
grossPremium | number | Gross premium amount |
commission | number | Commission amount |
createdAt | string | Date 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"
}
]
Updated 1 day ago