Installments API

Endpoint Index

Action	Endpoint
Fetch Installments for a Quote	GET /billing/{tenantLocator}/installments/quotes/{quoteLocator}/list
Fetch Installments for a Policy	GET /billing/{tenantLocator}/installments/policies/{policyLocator}/list
Fetch Installments for a Policy Transaction	GET /billing/{tenantLocator}/installments/transactions/{transactionLocator}/list

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	string	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	string	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	string	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 InstallmentInternal[]

InstallmentInternal

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

optional
policyLocator string?
termLocator string?
transactionLocator string?
invoiceLocator string?
quoteLocator string?
reversalOfInstallmentLocator string?
reversedByInstallmentLocator string? (deprecated)

InstallmentItem

required
locator string
chargeLocator string
elementLocator string
elementStaticLocator string
installmentLocator string
amount number
chargeCategory string
chargeType string
createdAt datetime
createdBy uuid

optional
invoiceItemLocator string?
reversalOfInstallmentItemLocator string?