Invoices API
Endpoint Index
| Action | Endpoint |
|---|---|
| Fetch Invoices for a Quote | GET /billing/{tenantLocator}/invoices/quotes/{quoteLocator}/list |
| Fetch Invoices for a Policy | GET /billing/{tenantLocator}/invoices/policies/{policyLocator}/list |
| Fetch Invoices for an Account | GET /billing/{tenantLocator}/invoices/accounts/{accountLocator}/list |
| Fetch an Invoice with Its Items | GET /billing/{tenantLocator}/invoices/{locator} |
| Fetch Invoice Details | GET /billing/{tenantLocator}/invoices/{locator}/details |
| Fetch Payments for an Invoice | GET /billing/{tenantLocator}/invoices/{locator}/payments/list |
| Fetch Credits for an Invoice | GET /billing/{tenantLocator}/invoices/{locator}/credits/list |
| Fetch Invoices Targeted By a Payment | GET /billing/{tenantLocator}/payments/{locator}/invoices/list |
| Preview Invoices for Quote | GET /billing/{tenantLocator}/invoices/quotes/{locator}/previewInvoices |
| Preview Invoices for Transaction | GET /billing/{tenantLocator}/invoices/transactions/{locator}/previewInvoices |
Fetch
GET /billing/{tenantLocator}/invoices/quotes/{quoteLocator}/listRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| quoteLocator | path | locator | required |
| includeZeroAmountInvoices | query | boolean? | optional |
| offset | query | int? | optional |
| count | query | int? | optional |
Response:InvoiceResponse[]
Security Group:invoices  Permissions:read,list
GET /billing/{tenantLocator}/invoices/policies/{policyLocator}/listRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| policyLocator | path | locator | required |
| includeZeroAmountInvoices | query | boolean? | optional |
| offset | query | int? | optional |
| count | query | int? | optional |
Response:InvoiceResponse[]
Security Group:invoices  Permissions:read,list
GET /billing/{tenantLocator}/invoices/accounts/{accountLocator}/listRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| accountLocator | path | locator | required |
| includeZeroAmountInvoices | query | boolean? | optional |
| offset | query | int? | optional |
| count | query | int? | optional |
Response:InvoiceResponse[]
Security Group:invoices  Permissions:read,list
GET /billing/{tenantLocator}/invoices/{locator}Request Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| locator | path | locator | required |
Response:InvoiceResponse
Security Group:invoices  Permission:read
InvoiceResponse
¶requiredlocator locatoraccountLocator locatorstartTime datetimeendTime datetimedueTime datetimecurrency stringtimezone stringinvoiceState Enum open | settledgeneratedTime datetimeinvoiceItems InvoiceItemResponse[]optionalinvoiceNumber string?totalAmount number?totalRemainingAmount number?unsettledTime datetime?
InvoiceItemResponse
¶requiredlocator locatorelementStaticLocator locatorinvoiceLocator locatortimezone stringamount numberchargeCategory stringchargeType stringinstallmentItemLocators locator[]optionalpolicyLocator locator?transactionLocator locator?quoteLocator locator?elementType string?remainingAmount number?settlementTime datetime?
GET /billing/{tenantLocator}/invoices/{locator}/detailsRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| locator | path | locator | required |
Response:InvoiceDetailsResponse
Security Group:invoices  Permission:read
InvoiceDetailsResponse
¶requiredaccountLocator locatorinvoiceLocator locatorstartTime datetimeendTime datetimedueTime datetimecurrency stringtimezone stringinvoiceState Enum open | settledgeneratedTime datetimetotalAmount numbertotalRemainingAmount numberpolicyInvoiceSummaries PolicyInvoiceSummary[]
PolicyInvoiceSummary
¶requiredproductName stringinvoiceItemSummaries InvoiceItemSummary[]optionalpolicyLocator locator?quoteLocator locator?
InvoiceItemSummary
¶requiredelementStaticLocator locatorinvoiceItemLocator locatoramount numberchargeCategory stringchargeType stringelementType stringremainingAmount numberinstallmentItemSummaries InstallmentItemSummary[]optionalsettlementTime datetime?
InstallmentItemSummary
¶requiredelementLocator locatorinstallmentItemLocator locatorinstallmentLocator locatoramount numberoptionaltransactionLocator locator?transactionCategory string?transactionEffectiveTime datetime?transactionType string?
GET /billing/{tenantLocator}/invoices/{locator}/payments/listRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| locator | path | locator | required |
| includeReversed | query | boolean? | optional |
| offset | query | int? | optional |
| count | query | int? | optional |
Response:PaymentResponse[]
Security Group:invoices  Permissions:read,list
GET /billing/{tenantLocator}/invoices/{locator}/credits/listRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| locator | path | locator | required |
| includeReversed | query | boolean? | optional |
| offset | query | int? | optional |
| count | query | int? | optional |
Response:CreditResponse[]
Security Group:invoices  Permissions:read,list
GET /billing/{tenantLocator}/payments/{locator}/invoices/listRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| locator | path | locator | required |
| offset | query | int? | optional |
| count | query | int? | optional |
Response:InvoiceResponse[]
Security Group:payments  Permissions:read,list
Invoice Documents
If you have configured invoicing to generate an invoice document, you can fetch it with the Fetch Invoice Document endpoint.
Invoice Preview
GET /billing/{tenantLocator}/invoices/quotes/{locator}/previewInvoicesRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| locator | path | locator | required |
| includeZeroAmountInvoices | query | boolean? | optional |
Response:InvoicePreviewResponse[]
Security Group:invoices  Permission:read
GET /billing/{tenantLocator}/invoices/transactions/{locator}/previewInvoicesRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| locator | path | locator | required |
| includeZeroAmountInvoices | query | boolean? | optional |
Response:InvoicePreviewResponse[]
Security Group:invoices  Permission:read
InvoicePreviewResponse
¶requiredstartTime datetimeendTime datetimedueTime datetimegenerateTime datetimetotalAmount numberinvoiceItems InvoiceItemPreview[]
InvoiceItemPreview
¶requiredelementStaticLocator locatoramount numberelementType string