Installment Lattices API

Fetch an Installment Lattice for a Quote
fetchLatestInstallmentLatticeByQuoteLocator
GET /billing/{tenantLocator}/installmentLattices/quotes/{quoteLocator}
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    quoteLocatorpathlocatorrequired
    Response:InstallmentLatticeResponse
    Security Group:installment-lattices   Permission:read
Fetch Installment Lattices for a Policy
fetchInstallmentLatticesByPolicyLocator
GET /billing/{tenantLocator}/installmentLattices/policies/{policyLocator}/list
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    policyLocatorpathlocatorrequired
    offsetqueryint?optional
    countqueryint?optional
    Response:InstallmentLatticeResponse[]
    Security Group:installment-lattices   Permissions:read,list
InstallmentLatticeResponse
required
locator locator
accountLocator locator
effectiveTime datetime
currency string
timezone string
reversalLattice boolean
termEndTime datetime
termStartTime datetime
createdAt datetime
createdBy uuid
frames InstallmentLatticeFrame[]

optional
policyLocator locator?
termLocator locator?
basedOnLocator locator?
quoteLocator locator?
settingsLocator locator?
InstallmentLatticeFrame
required
dueTime datetime
generateTime 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:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Response:SettingsResponse
    Security Group:settings   Permission:read
SettingsResponse
required
locator locator
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
dayOfMonth int?
dayOfWeek Enum? monday | tuesday | wednesday | thursday | friday | saturday | sunday
maxInstallmentsPerTerm int?
weekOfMonth Enum? none | first | second | third | fourth | fifth

See Also