Delinquency API
Delinquency Plan Assignment
PATCH /policy/{tenantLocator}/quotes/{locator}/delinquencyPlan
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Request:DelinquencyPlanUpdateRequest
Response:QuoteResponse
Security Group:quotes  Permission:write
PATCH /policy/{tenantLocator}/policies/{locator}/delinquencyPlan
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Request:DelinquencyPlanUpdateRequest
Response:PolicyResponse
Security Group:policies  Permission:write
DelinquencyPlanUpdateRequest
¶requireddelinquencyPlanName string
Fetch
GET /billing/{tenantLocator}/delinquencies/{locator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Response:DelinquencyResponse
Security Group:delinquencies  Permission:read
GET /billing/{tenantLocator}/delinquencies/accounts/{accountLocator}/list
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
accountLocator | path | locator | required |
offset | query | int? | optional |
count | query | int? | optional |
extended | query | boolean? | optional |
Response:DelinquencyListResponse
Security Group:delinquencies  Permissions:read,list
GET /billing/{tenantLocator}/delinquencies/invoices/{invoiceLocator}/list
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
invoiceLocator | path | locator | required |
offset | query | int? | optional |
count | query | int? | optional |
extended | query | boolean? | optional |
Response:DelinquencyListResponse
Security Group:delinquencies  Permissions:read,list
GET /billing/{tenantLocator}/delinquencies/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:delinquencies  Permissions:read,list
GET /billing/{tenantLocator}/delinquencies/quotes/{quoteLocator}/list
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
quoteLocator | path | locator | required |
offset | query | int? | optional |
count | query | int? | optional |
extended | query | boolean? | optional |
Response:DelinquencyListResponse
Security Group:delinquencies  Permissions:read,list
DelinquencyListResponse
¶requiredlistCompleted booleanitems DelinquencyResponse[]
DelinquencyResponse
¶requiredlocator locatoraccountLocator locatortimezone stringdelinquencyState Enum preGrace | inGrace | lapseTriggered | settledsettings DelinquencySettingsupdatedAt datetimecreatedAt datetimeconfiguredDelinquencyEvents ConfiguredDelinquencyEvent[]optionalgraceEndAt datetime?graceStartedAt datetime?lapseTransactionEffectiveDate datetime?references DelinquencyReference[]?
Note
The references
property will only be populated when fetching an individual delinquency. It will be null when fetching all the delinquencies for an account, policy, etc.
DelinquencyReference
¶requiredlocator locatordelinquencyLocator locatorreferenceLocator locatorreferenceType Enum policy | quote | invoiceoptionaltransactionLocator locator?preemptingLapseTransactionLocator locator?
DelinquencySettings
¶requiredadvanceLapseTo Enum draft | validated | priced | underwritten | accepted | issuedgracePeriodDays intlapseTransactionType stringoptionaldelinquencyLevel Enum? policy | invoice
ConfiguredDelinquencyEvent
¶requiredname stringoffsetBasis Enum delinquencyCreation | gracePeriodStart | gracePeriodEndoffsetDays number
Delinquency Updates
This endpoint allows changing the trigger dates for an already-active delinquency.
PATCH /billing/{tenantLocator}/delinquencies/{locator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Request:DelinquencyUpdateRequest
Response:DelinquencyResponse
Security Group:delinquencies  Permission:write
DelinquencyUpdateRequest
¶optionalgraceEndAt datetime?
Delinquency Events
GET /billing/{tenantLocator}/delinquencies/events/{delinquencyEventLocator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
delinquencyEventLocator | path | locator | required |
Response:DelinquencyEventResponse
Security Group:delinquencies  Permission:read
DelinquencyEventResponse
¶requiredlocator locatordelinquencyLocator locatorname stringdelinquencyEventState Enum active | triggered | cancelledtriggerTime datetimeupdatedAt datetimeupdatedBy uuidcreatedAt datetimecreatedBy uuidoptionaltriggeredAt datetime?
GET /billing/{tenantLocator}/delinquencies/{delinquencyLocator}/events/list
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
delinquencyLocator | path | locator | required |
offset | query | int? | optional |
count | query | int? | optional |
Response:DelinquencyEventsResponse
Security Group:delinquencies  Permissions:read,list
DelinquencyEventsResponse
¶requiredaccountLocator locatordelinquencyLocator locatorlistCompleted booleanitems DelinquencyEventResponse[]
PATCH /billing/{tenantLocator}/delinquencies/events/{delinquencyEventLocator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
delinquencyEventLocator | path | locator | required |
Request:DelinquencyEventUpdateRequest
Response:DelinquencyEventResponse
Security Group:delinquencies  Permission:write
DelinquencyEventUpdateRequest
¶optionaldelinquencyEventState Enum? active | triggered | cancelledtriggerTime datetime?