Create invoice
API Refs
- Staging: Create invoice
This endpoint creates a new invoice for a policyholder.
Request body
Name | Type | Description | Required |
---|---|---|---|
policyholderId | number | ID of the policyholder | yes |
carrierId | number | ID of the insurance carrier | yes |
grossPremium | number | Gross premium amount | yes |
effectiveDate | string | Effective date of the invoice (ISO 8601) | yes |
expirationDate | string | Expiration date of the invoice (ISO 8601) | yes |
mgaId | number | ID of the MGA | no |
commission | number | Commission amount | no |
taxes | number | Tax amount | no |
serviceFee | number | Service fee amount | no |
policyId | string | External policy ID (max 50 chars) | no |
brokerCode | string | Broker code associated with this invoice (max 50 chars) | no |
memo | string | Memo for the invoice (max 256 chars) | no |
downPayment | number | Down payment amount | no |
financeAmount | number | Finance amount | no |
shouldBeSigned | boolean | Whether the invoice should be signed | no |
paymentMethod | string | Desired payment method ("card" or "us_bank_account") | no |
Response
A successful request returns a 201 Created
status code with no response body.
Example
{
"policyholderId": 123,
"carrierId": 456,
"grossPremium": 1200.50,
"effectiveDate": "2024-01-01T00:00:00Z",
"expirationDate": "2025-01-01T00:00:00Z",
"commission": 120.05,
"taxes": 50.00,
"policyId": "POL-98765",
"brokerCode": "BRK-001",
"paymentMethod": "us_bank_account"
}
Updated about 13 hours ago