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

Fetch Invoices for a Quote

fetchInvoicesForQuote

GET /billing/{tenantLocator}/invoices/quotes/{quoteLocator}/list

Request 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

Fetch Invoices for a Policy

fetchInvoicesForPolicy

GET /billing/{tenantLocator}/invoices/policies/{policyLocator}/list

Request 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

Fetch Invoices for an Account

fetchInvoicesForAccount

GET /billing/{tenantLocator}/invoices/accounts/{accountLocator}/list

Request 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

Fetch an Invoice with Its Items

getInvoiceWithItems

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

required
locator locator
accountLocator locator
startTime datetime
endTime datetime
dueTime datetime
currency string
timezone string
invoiceState Enum open | settled
generatedTime datetime
invoiceItems InvoiceItemResponse[]

optional
invoiceNumber string?
totalAmount number?
totalRemainingAmount number?
unsettledTime datetime?

InvoiceItemResponse

required
locator locator
elementStaticLocator locator
invoiceLocator locator
timezone string
amount number
chargeCategory string
chargeType string
installmentItemLocators locator[]

optional
policyLocator locator?
transactionLocator locator?
quoteLocator locator?
elementType string?
remainingAmount number?
settlementTime datetime?

Fetch Invoice Details

fetchInvoiceDetails

GET /billing/{tenantLocator}/invoices/{locator}/details

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	locator	required

Response:InvoiceDetailsResponse
Security Group:invoices   Permission:read

InvoiceDetailsResponse

required
accountLocator locator
invoiceLocator locator
startTime datetime
endTime datetime
dueTime datetime
currency string
timezone string
invoiceState Enum open | settled
generatedTime datetime
totalAmount number
totalRemainingAmount number
policyInvoiceSummaries PolicyInvoiceSummary[]

PolicyInvoiceSummary

required
productName string
invoiceItemSummaries InvoiceItemSummary[]

optional
policyLocator locator?
quoteLocator locator?

InvoiceItemSummary

required
elementStaticLocator locator
invoiceItemLocator locator
amount number
chargeCategory string
chargeType string
elementType string
remainingAmount number
installmentItemSummaries InstallmentItemSummary[]

optional
settlementTime datetime?

InstallmentItemSummary

required
elementLocator locator
installmentItemLocator locator
installmentLocator locator
amount number

optional
transactionLocator locator?
transactionCategory string?
transactionEffectiveTime datetime?
transactionType string?

Fetch Payments for an Invoice

fetchPaymentsForAnInvoice

GET /billing/{tenantLocator}/invoices/{locator}/payments/list

Request 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

Fetch Credits for an Invoice

fetchCreditsForAnInvoice

GET /billing/{tenantLocator}/invoices/{locator}/credits/list

Request 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

Fetch Invoices Targeted By a Payment

fetchInvoicesTargetedByAPayment

GET /billing/{tenantLocator}/payments/{locator}/invoices/list

Request 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

Preview Invoices for Quote

previewInvoicesForQuote

GET /billing/{tenantLocator}/invoices/quotes/{locator}/previewInvoices

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	locator	required
includeZeroAmountInvoices	query	boolean?	optional

Response:InvoicePreviewResponse[]
Security Group:invoices   Permission:read

Preview Invoices for Transaction

previewInvoicesForTransaction

GET /billing/{tenantLocator}/invoices/transactions/{locator}/previewInvoices

Request 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

required
startTime datetime
endTime datetime
dueTime datetime
generateTime datetime
totalAmount number
invoiceItems InvoiceItemPreview[]

InvoiceItemPreview

required
elementStaticLocator locator
amount number
elementType string