Get invoice by ID

📘
API Refs

Staging: Get invoice by ID

This endpoint returns detailed information for a specific invoice.

URI Parameters

Name	Type	Description	Required
invoiceId	number	The ID of the invoice to retrieve	yes

Response body

The response is a single invoice object with the same structure as in the Get list of invoices endpoint.

Example

{
  "id": 789,
  "policyholder": { "id": 123, "firstName": "John", "lastName": "Doe", "email": "[email protected]" },
  "carrier": { "id": 456, "businessName": "ABC Insurance Co", "email": "[email protected]" },
  "type": "Invoice",
  "status": { "code": 1, "value": "payment_link_pending" },
  "grossPremium": 1200.50,
  "commission": 120.05,
  "taxes": 50.00,
  "serviceFee": 10.00,
  "downPayment": 200.00,
  "financeAmount": 1000.50,
  "memo": "Annual premium for policy POL-98765",
  "policyId": "POL-98765",
  "createdAt": "2024-07-22T14:30:00Z",
  "effectiveDate": "2024-01-01T00:00:00Z",
  "expirationDate": "2025-01-01T00:00:00Z"
}