Installment Lattices API
GET /billing/{tenantLocator}/installmentLattices/quotes/{quoteLocator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
quoteLocator | path | locator | required |
Response:InstallmentLatticeResponse
Security Group:installment-lattices  Permission:read
GET /billing/{tenantLocator}/installmentLattices/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:DelinquencyListResponse
Security Group:installment-lattices  Permissions:read,list
InstallmentLatticeListResponse
¶requiredlistCompleted booleanitems InstallmentLatticeResponse[]
InstallmentLatticeResponse
¶requiredlocator locatoraccountLocator locatoreffectiveTime datetimecurrency stringtimezone stringreversalLattice booleantermEndTime datetimetermStartTime datetimecreatedAt datetimecreatedBy uuidframes InstallmentLatticeFrame[]optionalpolicyLocator locator?termLocator locator?basedOnLocator locator?quoteLocator locator?settingsLocator locator?
InstallmentLatticeFrame
¶requireddueTime datetimegenerateTime datetimecoverageDuration numbercoverageEndTime datetimecoverageStartTime datetimeinstallmentDuration numberinstallmentEndTime datetimeinstallmentStartTime datetimenormalizedWeight number
GET /billing/{tenantLocator}/settings/{locator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Response:SettingsResponse
Security Group:settings  Permission:read
SettingsResponse
¶requiredlocator locatorbillingSettings BillingSettingsinstallmentSettings InstallmentSettings
BillingSettings
¶requiredbillingLevel Enum account | inherit | policy
InstallmentSettings
¶requiredanchorMode Enum generateDay | termStartDay | dueDaycadence Enum none | fullPay | weekly | everyOtherWeek | monthly | quarterly | semiannually | annually | thirtyDays | everyNDaysdueLeadDays intgenerateLeadDays intinstallmentWeights number[]optionalanchorTime datetime?anchorType Enum? none | dayOfMonth | anchorTime | dayOfWeek | weekOfMonthdayOfMonth int?dayOfWeek Enum? monday | tuesday | wednesday | thursday | friday | saturday | sundaymaxInstallmentsPerTerm int?weekOfMonth Enum? none | first | second | third | fourth | fifth