# Delinquency API



<EndpointIndex
  names={[
  	'updateQuoteDelinquencyPlan',
  	'updatePolicyDelinquencyPlan',
  	'getDelinquency',
  	'getDelinquenciesForAccount',
  	'getDelinquenciesForInvoice',
  	'getDelinquenciesForPolicy',
  	'updateDelinquency',
  	'fetchDelinquencyEvent',
  	'fetchDelinquencyEvents',
  	'updateDelinquencyEvent',
  ]}
  titles={{
  	updateQuoteDelinquencyPlan:
  		'Update the Delinquency Plan Assigned to a Quote',
  	updatePolicyDelinquencyPlan:
  		'Update the Delinquency Plan Assigned to a Policy',
  	getDelinquency: 'Fetch a Delinquency',
  	getDelinquenciesForAccount: 'Fetch Delinquencies for an Account',
  	getDelinquenciesForInvoice: 'Fetch Delinquencies for an Invoice',
  	getDelinquenciesForPolicy: 'Fetch Delinquencies for a Policy',
  }}
/>

Delinquency Plan Assignment [#delinquency-plan-assignment]

Update the Delinquency Plan Assigned to a Quote [#update-the-delinquency-plan-assigned-to-a-quote]

<ApiEndpoint name="updateQuoteDelinquencyPlan" title="Update the Delinquency Plan Assigned to a Quote" />

Update the Delinquency Plan Assigned to a Policy [#update-the-delinquency-plan-assigned-to-a-policy]

<ApiEndpoint name="updatePolicyDelinquencyPlan" title="Update the Delinquency Plan Assigned to a Policy" />

<ApiSchema name="DelinquencyPlanUpdateRequest" />

Fetch [#fetch]

Fetch a Delinquency [#fetch-a-delinquency]

<ApiEndpoint name="getDelinquency" title="Fetch a Delinquency" />

Fetch Delinquencies for an Account [#fetch-delinquencies-for-an-account]

<ApiEndpoint name="getDelinquenciesForAccount" title="Fetch Delinquencies for an Account" />

Fetch Delinquencies for an Invoice [#fetch-delinquencies-for-an-invoice]

<ApiEndpoint name="getDelinquenciesForInvoice" title="Fetch Delinquencies for an Invoice" />

Fetch Delinquencies for a Policy [#fetch-delinquencies-for-a-policy]

<ApiEndpoint name="getDelinquenciesForPolicy" title="Fetch Delinquencies for a Policy" />

<ApiSchema name="DelinquencyListResponse" />

<ApiSchema name="DelinquencyResponse" />

<Callout>
  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.
</Callout>

<ApiSchema name="DelinquencyReference" />

<ApiSchema name="DelinquencySettings" />

<ApiSchema name="ConfiguredDelinquencyEvent" />

Delinquency Updates [#delinquency-updates]

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

Update Delinquency [#update-delinquency]

<ApiEndpoint name="updateDelinquency" />

<ApiSchema name="DelinquencyUpdateRequest" />

Delinquency Events [#delinquency-events]

Fetch Delinquency Event [#fetch-delinquency-event]

<ApiEndpoint name="fetchDelinquencyEvent" />

<ApiSchema name="DelinquencyEventResponse" />

Fetch Delinquency Events [#fetch-delinquency-events]

<ApiEndpoint name="fetchDelinquencyEvents" />

<ApiSchema name="DelinquencyEventsResponse" />

Update Delinquency Event [#update-delinquency-event]

<ApiEndpoint name="updateDelinquencyEvent" />

<ApiSchema name="DelinquencyEventUpdateRequest" />

See Also [#see-also]

* [Delinquency Feature Guide](/features/billing/delinquency)


## API Reference

PATCH /policy/{tenantLocator}/quotes/{locator}/delinquencyPlan — updateQuoteDelinquencyPlan
Tags: quotes-controller
Permissions: write
Parameters:
  tenantLocator (uuid, path, required)
  locator (ulid, path, required)
Request body (DelinquencyPlanUpdateRequest):
Responses:
  200 QuoteResponse — OK

PATCH /policy/{tenantLocator}/policies/{locator}/delinquencyPlan — updatePolicyDelinquencyPlan
Tags: policies-controller
Permissions: write
Parameters:
  tenantLocator (uuid, path, required)
  locator (ulid, path, required)
Request body (DelinquencyPlanUpdateRequest):
Responses:
  200 PolicyResponse — OK

GET /billing/{tenantLocator}/delinquencies/{locator} — getDelinquency
Tags: delinquencies-controller
Permissions: read
Parameters:
  tenantLocator (uuid, path, required)
  locator (ulid, path, required)
Responses:
  200 DelinquencyResponse — OK

GET /billing/{tenantLocator}/delinquencies/accounts/{accountLocator}/list — getDelinquenciesForAccount
Tags: delinquencies-controller
Permissions: read, list
Parameters:
  tenantLocator (uuid, path, required)
  accountLocator (ulid, path, required)
  offset (integer, query)
  count (integer, query)
  extended (boolean, query)
Responses:
  200 DelinquencyListResponse — OK

GET /billing/{tenantLocator}/delinquencies/invoices/{invoiceLocator}/list — getDelinquenciesForInvoice
Tags: delinquencies-controller
Permissions: read, list
Parameters:
  tenantLocator (uuid, path, required)
  invoiceLocator (ulid, path, required)
  offset (integer, query)
  count (integer, query)
  extended (boolean, query)
Responses:
  200 DelinquencyListResponse — OK

GET /billing/{tenantLocator}/delinquencies/policies/{policyLocator}/list — getDelinquenciesForPolicy
Tags: delinquencies-controller
Permissions: read, list
Parameters:
  tenantLocator (uuid, path, required)
  policyLocator (ulid, path, required)
  offset (integer, query)
  count (integer, query)
  extended (boolean, query)
Responses:
  200 DelinquencyListResponse — OK

PATCH /billing/{tenantLocator}/delinquencies/{locator} — updateDelinquency
Tags: delinquencies-controller
Permissions: write
Parameters:
  tenantLocator (uuid, path, required)
  locator (ulid, path, required)
Request body (DelinquencyUpdateRequest):
Responses:
  200 DelinquencyResponse — OK

GET /billing/{tenantLocator}/delinquencies/events/{delinquencyEventLocator} — fetchDelinquencyEvent
Tags: delinquencies-controller
Permissions: read
Parameters:
  tenantLocator (uuid, path, required)
  delinquencyEventLocator (ulid, path, required)
Responses:
  200 DelinquencyEventResponse — OK

GET /billing/{tenantLocator}/delinquencies/{delinquencyLocator}/events/list — fetchDelinquencyEvents
Tags: delinquencies-controller
Permissions: read, list
Parameters:
  tenantLocator (uuid, path, required)
  delinquencyLocator (ulid, path, required)
  offset (integer, query)
  count (integer, query)
Responses:
  200 DelinquencyEventsResponse — OK

PATCH /billing/{tenantLocator}/delinquencies/events/{delinquencyEventLocator} — updateDelinquencyEvent
Tags: delinquencies-controller
Permissions: write
Parameters:
  tenantLocator (uuid, path, required)
  delinquencyEventLocator (ulid, path, required)
Request body (DelinquencyEventUpdateRequest):
Responses:
  200 DelinquencyEventResponse — OK

DelinquencyPlanUpdateRequest
Properties:
  delinquencyPlanName (string, required)

DelinquencyListResponse
Properties:
  listCompleted (boolean, required)
  items (DelinquencyResponse[], required)

DelinquencyResponse
Properties:
  locator (ulid, required)
  accountLocator (ulid, required)
  delinquencyState (Enum preGrace | inGrace | lapseTriggered | settled | lapseTransactionCreated, required)
  createdAt (datetime, required)
  updatedAt (datetime, required)
  settings (DelinquencySettings, required)
  timezone (string, required)
  references (DelinquencyReference[])
  graceStartedAt (datetime)
  graceEndAt (datetime)
  lapseTransactionEffectiveDate (datetime)
  configuredDelinquencyEvents (ConfiguredDelinquencyEvent[], required)

DelinquencyReference
Properties:
  locator (ulid, required)
  delinquencyLocator (ulid, required)
  referenceLocator (ulid, required)
  referenceType (Enum policy | invoice, required)
  transactionLocator (ulid)
  preemptingLapseTransactionLocator (ulid)

DelinquencySettings
Properties:
  lapseTransactionType (string, required)
  gracePeriodDays (integer, required)
  advanceLapseTo (Enum draft | validated | priced | underwritten | accepted | issued, required)
  delinquencyLevel (Enum policy | invoice)

ConfiguredDelinquencyEvent
Properties:
  name (string, required)
  offsetDays (number, required)
  offsetBasis (Enum gracePeriodStart | gracePeriodEnd, required)

DelinquencyUpdateRequest
Properties:
  graceEndAt (datetime)

DelinquencyEventResponse
Properties:
  locator (ulid, required)
  delinquencyLocator (ulid, required)
  delinquencyEventState (Enum active | triggered | cancelled, required)
  triggerTime (datetime, required)
  triggeredAt (datetime)
  createdAt (datetime, required)
  createdBy (uuid, required)
  updatedAt (datetime, required)
  updatedBy (uuid, required)
  name (string, required)

DelinquencyEventsResponse
Properties:
  accountLocator (ulid, required)
  delinquencyLocator (ulid, required)
  listCompleted (boolean, required)
  items (DelinquencyEventResponse[], required)

DelinquencyEventUpdateRequest
Properties:
  triggerTime (datetime)
  delinquencyEventState (Enum active | triggered | cancelled)