Installments API

Fetch Installments for a Quote

fetchInstallmentsForQuote

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
quoteLocator	path	locator	required
offset	query	int?	optional
count	query	int?	optional
extended	query	boolean?	optional

Response:InstallmentListResponse

Security Group:installments Permissions:read,list

Fetch Installments for a Policy

¶

fetchInstallmentsForPolicy

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
policyLocator	path	locator	required
offset	query	int?	optional
count	query	int?	optional
extended	query	boolean?	optional

Response:InstallmentListResponse

Security Group:installments Permissions:read,list

Fetch Installments for a Policy Transaction

¶

fetchInstallmentsForPolicyTransaction

GET /billing/{tenantLocator}/installments/transactions/{transactionLocator}/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
transactionLocator	path	locator	required
offset	query	int?	optional
count	query	int?	optional
extended	query	boolean?	optional

Response:InstallmentListResponse

Security Group:installments Permissions:read,list

InstallmentListResponse

¶

required
listCompleted boolean
items InstallmentResponse[]

InstallmentResponse

¶

required
locator locator
accountLocator locator
installmentLatticeLocator locator
dueTime datetime
generateTime datetime
currency string
timezone string
coverageDuration number
coverageEndTime datetime
coverageStartTime datetime
installmentDuration number
installmentEndTime datetime
installmentFrameIndex int
installmentStartTime datetime
updatedAt datetime
updatedBy uuid
createdAt datetime
createdBy uuid
installmentItems InstallmentItemResponse[]

optional
policyLocator locator?
transactionLocator locator?
invoiceLocator locator?
quoteLocator locator?
reversalOfInstallmentLocator locator?
reversedByInstallmentLocator locator?

InstallmentItemResponse

¶

required
locator locator
chargeLocator locator
elementLocator locator
elementStaticLocator locator
installmentLocator locator
amount number
chargeCategory Enum premium | tax | fee | credit | nonFinancial | surcharge
chargeType string
createdAt datetime
createdBy uuid

optional
invoiceItemLocator locator?
reversalOfInstallmentItemLocator locator?