Installment Lattices API

Endpoint Index

Action	Endpoint
Fetch an Installment Lattice for a Quote	GET /billing/{tenantLocator}/installmentLattices/quotes/{quoteLocator}
Fetch Installment Lattices for a Policy	GET /billing/{tenantLocator}/installmentLattices/policies/{policyLocator}/list
Fetch Settings for an Installment Lattice	GET /billing/{tenantLocator}/settings/{locator}

Fetch an Installment Lattice for a Quote

¶

fetchLatestInstallmentLatticeByQuoteLocator

GET /billing/{tenantLocator}/installmentLattices/quotes/{quoteLocator}

Request Parameters:

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

Response:InstallmentLatticeResponse

Security Group:installment-lattices Permission:read

Fetch Installment Lattices for a Policy

¶

fetchInstallmentLatticesByPolicyLocator

GET /billing/{tenantLocator}/installmentLattices/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:InstallmentLatticeListResponse

Security Group:installment-lattices Permissions:read,list

InstallmentLatticeListResponse

¶

required
listCompleted boolean
items InstallmentLatticeResponse[]

InstallmentLatticeResponse

¶

required
locator string
accountLocator string
effectiveTime datetime
currency string
timezone string
reversalLattice boolean
termEndTime datetime
termStartTime datetime
createdAt datetime
createdBy uuid
frames InstallmentLatticeFrame[]

optional
policyLocator string?
termLocator string?
basedOnLocator string?
quoteLocator string?
settingsLocator string?

InstallmentLatticeFrame

¶

required
dueTime datetime
generateTime datetime
autopayTime datetime
coverageDuration number
coverageEndTime datetime
coverageStartTime datetime
installmentDuration number
installmentEndTime datetime
installmentStartTime datetime
normalizedWeight number

Fetch Settings for an Installment Lattice

¶

fetchInstallmentLatticeSettings

GET /billing/{tenantLocator}/settings/{locator}

Request Parameters:

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

Response:SettingsResponse

Security Group:settings Permission:read

SettingsResponse

¶

required
locator string
billingSettings BillingSettings
installmentSettings InstallmentSettings

BillingSettings

¶

required
billingLevel Enum account | inherit | policy

InstallmentSettings

¶

required
anchorMode Enum generateDay | termStartDay | dueDay
cadence Enum none | fullPay | weekly | everyOtherWeek | monthly | quarterly | semiannually | annually | thirtyDays | everyNDays
dueLeadDays int
generateLeadDays int
installmentWeights number[]

optional
anchorTime datetime?
anchorType Enum? none | dayOfMonth | anchorTime | dayOfWeek | weekOfMonth
autopayLeadDays number?
dayOfMonth int?
dayOfWeek Enum? monday | tuesday | wednesday | thursday | friday | saturday | sunday
maxInstallmentsPerTerm int?
weekOfMonth Enum? none | first | second | third | fourth | fifth

Installment Lattices API

Endpoint Index

See Also