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
Update Invoice	PATCH /billing/{tenantLocator}/invoices/{locator}
Preview Invoices for Quote	GET /billing/{tenantLocator}/invoices/quotes/{locator}/previewInvoices
Preview Invoices for Transaction	GET /billing/{tenantLocator}/invoices/transactions/{locator}/previewInvoices
Preview Invoices for Stateless Quote	GET /billing/{tenantLocator}/invoices/quotes/statelessPreview
Fetch Invoice with Number	GET /billing/{tenantLocator}/invoices/numbers/{invoiceNumber}
Set Invoice Number	POST /billing/{tenantLocator}/invoices/{locator}/number/set
Initiate Early Invoicing	POST /billing/{tenantLocator}/invoices/earlyInvoicing

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	string	required
includeZeroAmountInvoices	query	boolean?	optional
offset	query	int?	optional
count	query	int?	optional
extended	query	boolean?	optional

Response:InvoiceListResponse
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	string	required
includeZeroAmountInvoices	query	boolean?	optional
offset	query	int?	optional
count	query	int?	optional
extended	query	boolean?	optional

Response:InvoiceListResponse
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	string	required
includeZeroAmountInvoices	query	boolean?	optional
offset	query	int?	optional
count	query	int?	optional
extended	query	boolean?	optional

Response:InvoiceListResponse
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	string	required

Response:InvoiceResponse
Security Group:invoices   Permission:read

InvoiceResponse

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

optional
autopayTime datetime?
invoiceNumber string?
settledTime datetime?
totalAmount number?
totalRemainingAmount number?
unsettledTime datetime?
invoiceItems InvoiceItemResponse[]?
Not included when part of a list response

InvoiceItemResponse

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

optional
policyLocator string?
elementStaticLocator string?
quoteLocator string?
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	string	required

Response:InvoiceDetailsResponse
Security Group:invoices   Permission:read

InvoiceDetailsResponse

required
accountLocator string
invoiceLocator string
startTime datetime
endTime datetime
dueTime datetime
currency string
timezone string
invoiceState Enum open | settled
generatedTime datetime
totalAmount number
totalRemainingAmount number
invoiceSummaries InvoiceSummary[]
policyInvoiceSummaries PolicyInvoiceSummary[] (deprecated)

optional
autopayTime datetime?
invoiceNumber string?

InvoiceSummary

required
locator string
accountLocator string
startTime datetime
endTime datetime
dueTime datetime
currency string
timezone string
invoiceState Enum open | settled
generatedTime datetime
totalAmount number
totalRemainingAmount number

optional
autopayTime datetime?
invoiceNumber string?
settledTime datetime?
unsettledTime datetime?

PolicyInvoiceSummary

required
productName string
invoiceItemSummaries InvoiceItemSummary[]

optional
policyLocator string?
quoteLocator string?

InvoiceItemSummary

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

optional
elementStaticLocator string?
elementType string?
settlementTime datetime?

InstallmentItemSummary

required
elementLocator string
installmentItemLocator string
installmentLocator string
amount number

optional
transactionLocator string?
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	string	required
includeReversed	query	boolean?	optional
offset	query	int?	optional
count	query	int?	optional
extended	query	boolean?	optional

Response:PaymentListResponse
Security Group:invoices   Permissions:read,list

PaymentListResponse

required
listCompleted boolean
items PaymentResponse[]

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	string	required
includeReversed	query	boolean?	optional
offset	query	int?	optional
count	query	int?	optional
extended	query	boolean?	optional

Response:CreditListResponse
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	string	required
includeReversed	query	boolean?	optional
offset	query	int?	optional
count	query	int?	optional
extended	query	boolean?	optional

Response:InvoiceListResponse
Security Group:payments   Permissions:read,list

InvoiceListResponse

required
listCompleted boolean
items InvoiceSummary[]

Update

Update Invoice

updateInvoice

PATCH /billing/{tenantLocator}/invoices/{locator}

Request Parameters:

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

Request:InvoiceUpdateRequest
Response:InvoiceResponse
Security Group:invoices   Permission:write

InvoiceUpdateRequest

required
autopayTime datetime
suppressAutopay boolean

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	string	required
includeZeroAmountInvoices	query	boolean?	optional
count	query	int?	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	string	required
includeZeroAmountInvoices	query	boolean?	optional
count	query	int?	optional

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

InvoicePreviewResponse

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

InvoiceItemPreview

required
elementStaticLocator string
amount number
chargeCategory string
chargeType string
elementType string
transactionLocators string[]

optional
policyLocator string?
quoteLocator string?

Preview Invoices for Stateless Quote

previewInvoicesForStatelessQuote

GET /billing/{tenantLocator}/invoices/quotes/statelessPreview

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
quotePreviewRequest	query	QuoteBillingPreviewRequest	required
includeZeroAmountInvoices	query	boolean?	optional
count	query	int?	optional

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

Numbering

Fetch Invoice with Number

fetchInvoiceWithNumber

GET /billing/{tenantLocator}/invoices/numbers/{invoiceNumber}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
invoiceNumber	path	string	required

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

Set Invoice Number

setInvoiceNumber

POST /billing/{tenantLocator}/invoices/{locator}/number/set

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required
invoiceNumber	query	string	required

Response:InvoiceResponse
Security Group:invoices   Permission:write

Early Invoicing

Initiate Early Invoicing

initiateEarlyInvoicing

POST /billing/{tenantLocator}/invoices/earlyInvoicing

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required

Request:EarlyInvoicingRequest
Response:EarlyInvoicingResponse
Security Group:invoices   Permission:write

EarlyInvoicingRequest

required
ignoreHolds boolean
installmentLocators string[]

optional
accountLocator string?
timezone string?
invoiceDueTime datetime?
invoiceThroughTime datetime?

EarlyInvoicingResponse

required
jobLocator string
candidateInstallmentsCount int