Delinquency API

Action	Endpoint
Update the Delinquency Plan Assigned to a Quote	PATCH/policy/{tenantLocator}/quotes/{locator}/delinquencyPlan
Update the Delinquency Plan Assigned to a Policy	PATCH/policy/{tenantLocator}/policies/{locator}/delinquencyPlan
Fetch a Delinquency	GET/billing/{tenantLocator}/delinquencies/{locator}
Fetch Delinquencies for an Account	GET/billing/{tenantLocator}/delinquencies/accounts/{accountLocator}/list
Fetch Delinquencies for an Invoice	GET/billing/{tenantLocator}/delinquencies/invoices/{invoiceLocator}/list
Fetch Delinquencies for a Policy	GET/billing/{tenantLocator}/delinquencies/policies/{policyLocator}/list
Update Delinquency	PATCH/billing/{tenantLocator}/delinquencies/{locator}
Fetch Delinquency Event	GET/billing/{tenantLocator}/delinquencies/events/{delinquencyEventLocator}
Fetch Delinquency Events	GET/billing/{tenantLocator}/delinquencies/{delinquencyLocator}/events/list
Update Delinquency Event	PATCH/billing/{tenantLocator}/delinquencies/events/{delinquencyEventLocator}

Delinquency Plan Assignment

Update the Delinquency Plan Assigned to a Quote

Update the Delinquency Plan Assigned to a QuoteupdateQuoteDelinquencyPlan

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:DelinquencyPlanUpdateRequest

Response:QuoteResponse

Security Group:quotes

Permission:

write

Update the Delinquency Plan Assigned to a Policy

Update the Delinquency Plan Assigned to a PolicyupdatePolicyDelinquencyPlan

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:DelinquencyPlanUpdateRequest

Response:PolicyResponse

Security Group:policies

Permission:

write

DelinquencyPlanUpdateRequest

Required properties

Property	Type	Description
`delinquencyPlanName`	`string`

Fetch

Fetch a Delinquency

Fetch a DelinquencygetDelinquency

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:DelinquencyResponse

Security Group:delinquencies

Permission:

read

Fetch Delinquencies for an Account

Fetch Delinquencies for an AccountgetDelinquenciesForAccount

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`accountLocator`	path	`ulid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`extended`	query	`boolean?`	No

Response:DelinquencyListResponse

Security Group:delinquencies

Permissions:

read,list

Fetch Delinquencies for an Invoice

Fetch Delinquencies for an InvoicegetDelinquenciesForInvoice

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`invoiceLocator`	path	`ulid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`extended`	query	`boolean?`	No

Response:DelinquencyListResponse

Security Group:delinquencies

Permissions:

read,list

Fetch Delinquencies for a Policy

Fetch Delinquencies for a PolicygetDelinquenciesForPolicy

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`policyLocator`	path	`ulid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`extended`	query	`boolean?`	No

Response:DelinquencyListResponse

Security Group:delinquencies

Permissions:

read,list

DelinquencyListResponse

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`DelinquencyResponse[]`

DelinquencyResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`accountLocator`	`ulid`
`timezone`	`string`
`delinquencyState`	`Enum preGrace \| inGrace \| lapseTriggered \| settled \| lapseTransactionCreated`
`settings`	`DelinquencySettings`
`updatedAt`	`datetime`
`createdAt`	`datetime`
`configuredDelinquencyEvents`	`ConfiguredDelinquencyEvent[]`

Optional properties

Property	Type	Description
`graceEndAt`	`datetime?`
`graceStartedAt`	`datetime?`
`lapseTransactionEffectiveDate`	`datetime?`
`references`	`DelinquencyReference[]?`

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 properties

Property	Type	Description
`locator`	`ulid`
`delinquencyLocator`	`ulid`
`referenceLocator`	`ulid`
`referenceType`	`Enum policy \| invoice`

Optional properties

Property	Type	Description
`transactionLocator`	`ulid?`
`preemptingLapseTransactionLocator`	`ulid?`

DelinquencySettings

Required properties

Property	Type	Description
`advanceLapseTo`	`Enum draft \| validated \| priced \| underwritten \| accepted \| issued`
`gracePeriodDays`	`integer`
`lapseTransactionType`	`string`

Optional properties

Property	Type	Description
`delinquencyLevel`	`Enum? policy \| invoice`

ConfiguredDelinquencyEvent

Required properties

Property	Type	Description
`name`	`string`
`offsetBasis`	`Enum gracePeriodStart \| gracePeriodEnd`
`offsetDays`	`number`

Delinquency Updates

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

Update Delinquency

Update DelinquencyupdateDelinquency

PATCH/billing/{tenantLocator}/delinquencies/{locator}

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:DelinquencyUpdateRequest

Response:DelinquencyResponse

Security Group:delinquencies

Permission:

write

DelinquencyUpdateRequest

Properties

Property	Type	Description
`graceEndAt`	`datetime?`

Delinquency Events

Fetch Delinquency Event

Fetch Delinquency EventfetchDelinquencyEvent

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`delinquencyEventLocator`	path	`ulid`	Yes

Response:DelinquencyEventResponse

Security Group:delinquencies

Permission:

read

DelinquencyEventResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`delinquencyLocator`	`ulid`
`name`	`string`
`delinquencyEventState`	`Enum active \| triggered \| cancelled`
`triggerTime`	`datetime`
`updatedAt`	`datetime`
`updatedBy`	`uuid`
`createdAt`	`datetime`
`createdBy`	`uuid`

Optional properties

Property	Type	Description
`triggeredAt`	`datetime?`

Fetch Delinquency Events

Fetch Delinquency EventsfetchDelinquencyEvents

GET/billing/{tenantLocator}/delinquencies/{delinquencyLocator}/events/list

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`delinquencyLocator`	path	`ulid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No

Response:DelinquencyEventsResponse

Security Group:delinquencies

Permissions:

read,list

DelinquencyEventsResponse

Required properties

Property	Type	Description
`accountLocator`	`ulid`
`delinquencyLocator`	`ulid`
`listCompleted`	`boolean`
`items`	`DelinquencyEventResponse[]`

Update Delinquency Event

Update Delinquency EventupdateDelinquencyEvent

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`delinquencyEventLocator`	path	`ulid`	Yes

Request:DelinquencyEventUpdateRequest

Response:DelinquencyEventResponse

Security Group:delinquencies

Permission:

write

DelinquencyEventUpdateRequest

Properties

Property	Type	Description
`delinquencyEventState`	`Enum? active \| triggered \| cancelled`
`triggerTime`	`datetime?`

Delinquency API

Delinquency Plan Assignment

Update the Delinquency Plan Assigned to a Quote

Update the Delinquency Plan Assigned to a Policy

Fetch

Fetch a Delinquency

Fetch Delinquencies for an Account

Fetch Delinquencies for an Invoice

Fetch Delinquencies for a Policy

Delinquency Updates

Update Delinquency

Delinquency Events

Fetch Delinquency Event

Fetch Delinquency Events

Update Delinquency Event

See Also

On this page