Installment Lattices API

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

Fetch an Installment Lattice for a QuotefetchLatestInstallmentLatticeByQuoteLocator

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

Parameters

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

Response:InstallmentLatticeResponse

Security Group:installment-lattices

Permission:

read

Fetch Installment Lattices for a Policy

Fetch Installment Lattices for a PolicyfetchInstallmentLatticesByPolicyLocator

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

Parameters

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

Response:InstallmentLatticeListResponse

Security Group:installment-lattices

Permissions:

read,list

InstallmentLatticeListResponse

Required properties

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

InstallmentLatticeResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`accountLocator`	`ulid`
`effectiveTime`	`datetime`
`currency`	`string`
`timezone`	`string`
`reversalLattice`	`boolean`
`termEndTime`	`datetime`
`termStartTime`	`datetime`
`createdAt`	`datetime`
`createdBy`	`uuid`
`frames`	`InstallmentLatticeFrame[]`

Optional properties

Property	Type	Description
`policyLocator`	`ulid?`
`termLocator`	`ulid?`
`basedOnLocator`	`ulid?`
`quoteLocator`	`ulid?`
`settingsLocator`	`ulid?`

InstallmentLatticeFrame

Required properties

Property	Type	Description
`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

Fetch Settings for an Installment LatticefetchInstallmentLatticeSettings

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

Parameters

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

Response:SettingsResponse

Security Group:settings

Permission:

read

SettingsResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`installmentSettings`	`InstallmentSettings`

InstallmentSettings

Required properties

Property	Type	Description
`anchorMode`	`Enum generateDay \| termStartDay \| dueDay`
`cadence`	`Enum none \| fullPay \| weekly \| everyOtherWeek \| monthly \| quarterly \| semiannually \| annually \| thirtyDays \| everyNDays`
`dueLeadDays`	`integer`
`generateLeadDays`	`integer`
`installmentWeights`	`number[]`

Optional properties

Property	Type	Description
`anchorTime`	`datetime?`
`anchorType`	`Enum? none \| dayOfMonth \| anchorTime \| dayOfWeek \| weekOfMonth`
`autopayLeadDays`	`number?`
`dayOfMonth`	`integer?`
`dayOfWeek`	`Enum? monday \| tuesday \| wednesday \| thursday \| friday \| saturday \| sunday`
`maxInstallmentsPerTerm`	`integer?`
`weekOfMonth`	`Enum? none \| first \| second \| third \| fourth \| fifth`

Installment Lattices API

Fetch an Installment Lattice for a Quote

Fetch Installment Lattices for a Policy

Fetch Settings for an Installment Lattice

See Also

On this page