Delinquency API

Delinquency Plan Assignment

Update the Delinquency Plan Assigned to a Quote
updateQuoteDelinquencyPlan
PATCH /policy/{tenantLocator}/quotes/{locator}/delinquencyPlan
Update the Delinquency Plan Assigned to a Policy
updatePolicyDelinquencyPlan
PATCH /policy/{tenantLocator}/policies/{locator}/delinquencyPlan
DelinquencyPlanUpdateRequest
required
delinquencyPlanName string

Fetch

Fetch a Delinquency
getDelinquency
GET /billing/{tenantLocator}/delinquencies/{locator}
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Security Group:delinquencies   Permission:read
Fetch Delinquencies for an Account
getDelinquenciesForAccount
GET /billing/{tenantLocator}/delinquencies/accounts/{accountLocator}/list
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    accountLocatorpathlocatorrequired
    offsetqueryint?optional
    countqueryint?optional
    extendedqueryboolean?optional
    Security Group:delinquencies   Permissions:read,list
Fetch Delinquencies for an Invoice
getDelinquenciesForInvoice
GET /billing/{tenantLocator}/delinquencies/invoices/{invoiceLocator}/list
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    invoiceLocatorpathlocatorrequired
    offsetqueryint?optional
    countqueryint?optional
    extendedqueryboolean?optional
    Security Group:delinquencies   Permissions:read,list
Fetch Delinquencies for a Policy
getDelinquenciesForPolicy
GET /billing/{tenantLocator}/delinquencies/policies/{policyLocator}/list
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    policyLocatorpathlocatorrequired
    offsetqueryint?optional
    countqueryint?optional
    extendedqueryboolean?optional
    Security Group:delinquencies   Permissions:read,list
Fetch Delinquencies for a Quote
getDelinquenciesForQuote
GET /billing/{tenantLocator}/delinquencies/quotes/{quoteLocator}/list
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    quoteLocatorpathlocatorrequired
    offsetqueryint?optional
    countqueryint?optional
    extendedqueryboolean?optional
    Security Group:delinquencies   Permissions:read,list
DelinquencyListResponse
required
listCompleted boolean
DelinquencyResponse
required
locator locator
accountLocator locator
timezone string
delinquencyState Enum preGrace | inGrace | lapseTriggered | settled
updatedAt datetime
createdAt datetime
configuredDelinquencyEvents ConfiguredDelinquencyEvent[]

optional
graceEndAt 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
required
locator locator
delinquencyLocator locator
referenceLocator locator
referenceType Enum policy | quote | invoice

optional
transactionLocator locator?
preemptingLapseTransactionLocator locator?
DelinquencySettings
required
advanceLapseTo Enum draft | validated | priced | underwritten | accepted | issued
gracePeriodDays int
lapseTransactionType string

optional
delinquencyLevel Enum? policy | invoice
ConfiguredDelinquencyEvent
required
name string
offsetBasis Enum delinquencyCreation | gracePeriodStart | gracePeriodEnd
offsetDays number

Delinquency Updates

This endpoint allows changing the trigger dates for an already-active delinquency.

Update Delinquency
updateDelinquency
PATCH /billing/{tenantLocator}/delinquencies/{locator}
DelinquencyUpdateRequest
optional
graceEndAt datetime?

Delinquency Events

Fetch Delinquency Event
fetchDelinquencyEvent
GET /billing/{tenantLocator}/delinquencies/events/{delinquencyEventLocator}
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    delinquencyEventLocatorpathlocatorrequired
    Security Group:delinquencies   Permission:read
DelinquencyEventResponse
required
locator locator
delinquencyLocator locator
name string
delinquencyEventState Enum active | triggered | cancelled
triggerTime datetime
updatedAt datetime
updatedBy uuid
createdAt datetime
createdBy uuid

optional
triggeredAt datetime?
Fetch Delinquency Events
fetchDelinquencyEvents
GET /billing/{tenantLocator}/delinquencies/{delinquencyLocator}/events/list
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    delinquencyLocatorpathlocatorrequired
    offsetqueryint?optional
    countqueryint?optional
    Security Group:delinquencies   Permissions:read,list
DelinquencyEventsResponse
required
accountLocator locator
delinquencyLocator locator
listCompleted boolean
Update Delinquency Event
updateDelinquencyEvent
PATCH /billing/{tenantLocator}/delinquencies/events/{delinquencyEventLocator}
DelinquencyEventUpdateRequest
optional
delinquencyEventState Enum? active | triggered | cancelled
triggerTime datetime?

See Also