Delinquency API

Delinquency Plan Assignment

Update the Delinquency Plan Assigned to a Quote

updateQuoteDelinquencyPlan

PATCH /policy/{tenantLocator}/quotes/{locator}/delinquencyPlan

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Request:DelinquencyPlanUpdateRequest
Response:QuoteResponse
Security Group:quotes   Permission:write

Update the Delinquency Plan Assigned to a Policy

updatePolicyDelinquencyPlan

PATCH /policy/{tenantLocator}/policies/{locator}/delinquencyPlan

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Request:DelinquencyPlanUpdateRequest
Response:PolicyResponse
Security Group:policies   Permission:write

DelinquencyPlanUpdateRequest

required
delinquencyPlanName string

Fetch

Fetch a Delinquency

getDelinquency

GET /billing/{tenantLocator}/delinquencies/{locator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:DelinquencyResponse
Security Group:delinquencies   Permission:read

Fetch Delinquencies for an Account

getDelinquenciesForAccount

GET /billing/{tenantLocator}/delinquencies/accounts/{accountLocator}/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
accountLocator	path	string	required
offset	query	int?	optional
count	query	int?	optional
extended	query	boolean?	optional

Response:DelinquencyListResponse
Security Group:delinquencies   Permissions:read,list

Fetch Delinquencies for an Invoice

getDelinquenciesForInvoice

GET /billing/{tenantLocator}/delinquencies/invoices/{invoiceLocator}/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
invoiceLocator	path	string	required
offset	query	int?	optional
count	query	int?	optional
extended	query	boolean?	optional

Response:DelinquencyListResponse
Security Group:delinquencies   Permissions:read,list

Fetch Delinquencies for a Policy

getDelinquenciesForPolicy

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
policyLocator	path	string	required
offset	query	int?	optional
count	query	int?	optional
extended	query	boolean?	optional

Response:DelinquencyListResponse
Security Group:delinquencies   Permissions:read,list

Fetch Delinquencies for a Quote

getDelinquenciesForQuote

GET /billing/{tenantLocator}/delinquencies/quotes/{quoteLocator}/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
quoteLocator	path	string	required
offset	query	int?	optional
count	query	int?	optional
extended	query	boolean?	optional

Response:DelinquencyListResponse
Security Group:delinquencies   Permissions:read,list

DelinquencyListResponse

required
listCompleted boolean
items DelinquencyResponse[]

DelinquencyResponse

required
locator string
accountLocator string
timezone string
delinquencyState Enum preGrace | inGrace | lapseTriggered | settled
settings DelinquencySettings
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 string
delinquencyLocator string
referenceLocator string
referenceType Enum policy | quote | invoice

optional
transactionLocator string?
preemptingLapseTransactionLocator string?

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}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Request:DelinquencyUpdateRequest
Response:DelinquencyResponse
Security Group:delinquencies   Permission:write

DelinquencyUpdateRequest

optional
graceEndAt datetime?

Delinquency Events

Fetch Delinquency Event

fetchDelinquencyEvent

GET /billing/{tenantLocator}/delinquencies/events/{delinquencyEventLocator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
delinquencyEventLocator	path	string	required

Response:DelinquencyEventResponse
Security Group:delinquencies   Permission:read

DelinquencyEventResponse

required
locator string
delinquencyLocator string
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:

Name	Position	Type	Required
tenantLocator	path	uuid	required
delinquencyLocator	path	string	required
offset	query	int?	optional
count	query	int?	optional

Response:DelinquencyEventsResponse
Security Group:delinquencies   Permissions:read,list

DelinquencyEventsResponse

required
accountLocator string
delinquencyLocator string
listCompleted boolean
items DelinquencyEventResponse[]

Update Delinquency Event

updateDelinquencyEvent

PATCH /billing/{tenantLocator}/delinquencies/events/{delinquencyEventLocator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
delinquencyEventLocator	path	string	required

Request:DelinquencyEventUpdateRequest
Response:DelinquencyEventResponse
Security Group:delinquencies   Permission:write

DelinquencyEventUpdateRequest

optional
delinquencyEventState Enum? active | triggered | cancelled
triggerTime datetime?

See Also

• Delinquency Feature Guide