Invoices API

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 APayment	GET/billing/{tenantLocator}/payments/{locator}/invoices/list
Update Invoice	PATCH/billing/{tenantLocator}/invoices/{locator}
Settle Negative Or Zero Invoice	POST/billing/{tenantLocator}/invoices/{locator}/settle
Fetch Debits For An Invoice	GET/billing/{tenantLocator}/invoices/{invoiceLocator}/debits/list
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
Generate Invoice Number	POST/billing/{tenantLocator}/invoices/{locator}/number/generate
Initiate Early Invoicing	POST/billing/{tenantLocator}/invoices/earlyInvoicing

Fetch

Fetch Invoices for a Quote

Fetch Invoices for a QuotefetchInvoicesForQuote

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`quoteLocator`	path	`ulid`	Yes
`includeZeroAmountInvoices`	query	`boolean?`	No
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`extended`	query	`boolean?`	No

Response:InvoiceListResponse

Security Group:invoices

Permissions:

read,list

Fetch Invoices for a Policy

Fetch Invoices for a PolicyfetchInvoicesForPolicy

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`policyLocator`	path	`ulid`	Yes
`includeZeroAmountInvoices`	query	`boolean?`	No
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`extended`	query	`boolean?`	No

Response:InvoiceListResponse

Security Group:invoices

Permissions:

read,list

Fetch Invoices for an Account

Fetch Invoices for an AccountfetchInvoicesForAccount

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`accountLocator`	path	`ulid`	Yes
`includeZeroAmountInvoices`	query	`boolean?`	No
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`extended`	query	`boolean?`	No

Response:InvoiceListResponse

Security Group:invoices

Permissions:

read,list

Fetch an Invoice with Its Items

Fetch an Invoice with Its ItemsgetInvoiceWithItems

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:InvoiceResponse

Security Group:invoices

Permission:

read

InvoiceResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`accountLocator`	`ulid`
`startTime`	`datetime`
`endTime`	`datetime`
`dueTime`	`datetime`
`currency`	`string`
`timezone`	`string`
`invoiceState`	`Enum open \| settled \| discarded`
`generatedTime`	`datetime`
`invoiceType`	`Enum normal \| aggregate`

Optional properties

Property	Type	Description
`aggregatedInvoiceLocator`	`ulid?`
`autopayTime`	`datetime?`
`invoiceNumber`	`string?`
`settledTime`	`datetime?`
`totalAmount`	`number?`
`totalRemainingAmount`	`number?`
`unsettledTime`	`datetime?`
`invoiceItems`	`InvoiceItemResponse[]?`	Not included when part of a list response

InvoiceItemResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`invoiceLocator`	`ulid`
`timezone`	`string`
`amount`	`number`
`chargeCategory`	`string`
`chargeType`	`string`
`installmentItemLocators`	`ulid[]`
`transactionLocators`	`ulid[]`

Optional properties

Property	Type	Description
`policyLocator`	`ulid?`
`elementStaticLocator`	`ulid?`
`quoteLocator`	`ulid?`
`elementType`	`string?`
`remainingAmount`	`number?`
`settlementTime`	`datetime?`
`unsettledTime`	`datetime?`

Fetch Invoice Details

Fetch Invoice DetailsfetchInvoiceDetails

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:InvoiceDetailsResponse

Security Group:invoices

Permission:

read

InvoiceDetailsResponse

Required properties

Property	Type	Description
`accountLocator`	`ulid`
`invoiceLocator`	`ulid`
`startTime`	`datetime`
`endTime`	`datetime`
`dueTime`	`datetime`
`currency`	`string`
`timezone`	`string`
`invoiceState`	`Enum open \| settled \| discarded`
`generatedTime`	`datetime`
`invoiceType`	`Enum normal \| aggregate`
`totalAmount`	`number`
`totalRemainingAmount`	`number`
`invoiceSummaries`	`InvoiceSummary[]`

Optional properties

Property	Type	Description
`aggregatedInvoiceLocator`	`ulid?`
`autopayTime`	`datetime?`
`invoiceNumber`	`string?`
`settledTime`	`datetime?`
`unsettledTime`	`datetime?`

Fetch Payments For An Invoice

Fetch Payments For An InvoicefetchPaymentsForAnInvoice

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`includeReversed`	query	`boolean?`	No
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`extended`	query	`boolean?`	No

Response:PaymentListResponse

Security Group:invoices

Permissions:

read,list

PaymentListResponse

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`PaymentResponse[]`

Fetch Credits For An Invoice

Fetch Credits For An InvoicefetchCreditsForAnInvoice

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`includeReversed`	query	`boolean?`	No
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`extended`	query	`boolean?`	No

Response:CreditListResponse

Security Group:invoices

Permissions:

read,list

Fetch Invoices Targeted By APayment

Fetch Invoices Targeted By A PaymentfetchInvoicesTargetedByAPayment

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`includeReversed`	query	`boolean?`	No
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`extended`	query	`boolean?`	No

Response:InvoiceListResponse

Security Group:payments

Permissions:

read,list

InvoiceListResponse

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`InvoiceSummaryView[]`

InvoiceSummary

Required properties

Property	Type	Description
`invoiceItemSummaries`	`InvoiceItemSummary[]`

Optional properties

Property	Type	Description
`policyLocator`	`ulid?`
`quoteLocator`	`ulid?`
`productName`	`string?`

InvoiceSummaryView

Required properties

Property	Type	Description
`locator`	`ulid`
`accountLocator`	`ulid`
`startTime`	`datetime`
`endTime`	`datetime`
`dueTime`	`datetime`
`currency`	`string`
`timezone`	`string`
`invoiceState`	`Enum open \| settled \| discarded`
`generatedTime`	`datetime`
`totalAmount`	`number`
`totalRemainingAmount`	`number`

Optional properties

Property	Type	Description
`autopayTime`	`datetime?`
`invoiceNumber`	`string?`
`settledTime`	`datetime?`
`unsettledTime`	`datetime?`

FlatChargeSummary

Required properties

Property	Type	Description
`amount`	`number`

Optional properties

Property	Type	Description
`transactionLocator`	`ulid?`
`transactionCategory`	`string?`
`transactionEffectiveTime`	`datetime?`
`transactionType`	`string?`

InstallmentItemSummary

Required properties

Property	Type	Description
`elementLocator`	`ulid`
`installmentItemLocator`	`ulid`
`installmentLocator`	`ulid`
`amount`	`number`

Optional properties

Property	Type	Description
`transactionLocator`	`ulid?`
`transactionCategory`	`string?`
`transactionEffectiveTime`	`datetime?`
`transactionType`	`string?`

InvoiceItemSummary

Required properties

Property	Type	Description
`invoiceItemLocator`	`ulid`
`amount`	`number`
`chargeCategory`	`string`
`chargeType`	`string`
`remainingAmount`	`number`
`installmentItemSummaries`	`InstallmentItemSummary[]`

Optional properties

Property	Type	Description
`elementStaticLocator`	`ulid?`
`elementType`	`string?`
`flatChargeSummary`	`FlatChargeSummary?`
`settlementTime`	`datetime?`
`unsettledTime`	`datetime?`

InstallmentGroupingDetails

Required properties

Property	Type	Description
`matching`	`Enum generateTime \| startTime \| all`
`window`	`Enum start \| startAndEnd \| catchUp`

Update

Update Invoice

Update InvoiceupdateInvoice

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:InvoiceUpdateRequest

Response:InvoiceResponse

Security Group:invoices

Permission:

write

InvoiceUpdateRequest

Required properties

Property	Type	Description
`autopayTime`	`datetime`
`suppressAutopay`	`boolean`

Negative Invoice Handling

Settle Negative Or Zero Invoice

Settle Negative Or Zero InvoicesettleNegativeOrZeroInvoice

POST/billing/{tenantLocator}/invoices/{locator}/settle

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`forced`	query	`boolean?`	No

Response:ListPageResponseCreditDistributionResponse

Security Group:invoices

Permission:

write

Fetch Debits For An Invoice

Fetch Debits For An InvoicefetchDebitsForAnInvoice

GET/billing/{tenantLocator}/invoices/{invoiceLocator}/debits/list

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`invoiceLocator`	path	`ulid`	Yes
`includeReversed`	query	`boolean?`	No
`offset`	query	`integer?`	No
`count`	query	`integer?`	No

Response:ListPageResponseDebitResponse

Security Group:invoices

Permissions:

read,list

ListPageResponseDebitResponse

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`DebitResponse[]`

DebitResponse

Required properties

Property	Type	Description
`invoiceLocator`	`ulid`
`targetLocator`	`ulid`
`amount`	`number`
`targetType`	`Enum invoice \| account \| subpayment \| invoiceItem`

Optional properties

Property	Type	Description
`reversed`	`boolean?`
`reversedAt`	`datetime?`

ListPageResponseCreditDistributionResponse

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`CreditDistributionResponse[]`

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

Preview Invoices For QuotepreviewInvoicesForQuote

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`includeZeroAmountInvoices`	query	`boolean?`	No
`count`	query	`integer?`	No

Response:InvoicePreviewResponse[]

Security Group:invoices

Permission:

read

Preview Invoices For Transaction

Preview Invoices For TransactionpreviewInvoicesForTransaction

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`includeZeroAmountInvoices`	query	`boolean?`	No
`count`	query	`integer?`	No

Response:InvoicePreviewResponse[]

Security Group:invoices

Permission:

read

InvoicePreviewResponse

Required properties

Property	Type	Description
`startTime`	`datetime`
`endTime`	`datetime`
`dueTime`	`datetime`
`generateTime`	`datetime`
`autopayTime`	`datetime`
`totalAmount`	`number`
`installmentLocators`	`ulid[]`
`invoiceItems`	`InvoiceItemPreview[]`

InvoiceItemPreview

Required properties

Property	Type	Description
`elementStaticLocator`	`ulid`
`amount`	`number`
`chargeCategory`	`string`
`chargeType`	`string`
`elementType`	`string`
`transactionLocators`	`ulid[]`

Optional properties

Property	Type	Description
`policyLocator`	`ulid?`
`quoteLocator`	`ulid?`

Preview Invoices For Stateless Quote

Preview Invoices For Stateless QuotepreviewInvoicesForStatelessQuote

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`quotePreviewRequest`	query	`QuoteBillingPreviewRequest`	Yes
`includeZeroAmountInvoices`	query	`boolean?`	No
`count`	query	`integer?`	No

Response:InvoicePreviewResponse[]

Security Group:invoices

Permission:

read

Numbering

Fetch Invoice With Number

Fetch Invoice With NumberfetchInvoiceWithNumber

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`invoiceNumber`	path	`string`	Yes

Response:InvoiceResponse[]

Security Group:invoices

Permission:

read

Set Invoice Number

Set Invoice NumbersetInvoiceNumber

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`invoiceNumber`	query	`string`	Yes

Response:InvoiceResponse

Security Group:invoices

Permission:

write

Generate Invoice Number

Generate Invoice NumbergenerateInvoiceNumber

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:InvoiceResponse

Security Group:invoices

Permission:

write

Early Invoicing

Initiate Early Invoicing

Initiate Early InvoicinginitiateEarlyInvoicing

POST/billing/{tenantLocator}/invoices/earlyInvoicing

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes

Request:EarlyInvoicingRequest

Response:EarlyInvoicingResponse

Security Group:invoices

Permission:

write

EarlyInvoicingRequest

Required properties

Property	Type	Description
`ignoreHolds`	`boolean`
`installmentLocators`	`ulid[]`

Optional properties

Property	Type	Description
`accountLocator`	`ulid?`
`timezone`	`string?`
`invoiceDueTime`	`datetime?`
`invoiceThroughTime`	`datetime?`

EarlyInvoicingResponse

Required properties

Property	Type	Description
`jobLocator`	`ulid`
`candidateInstallmentsCount`	`integer`

Invoices API

On this page