Moratoriums Billing Recovery (Beta)

Warning

This feature is currently in beta and may be subject to change. Before using it in production, please contact your Socotra representative.

Overview

Billing workflows such as invoice generation, delinquency, and autopay will resume when their scheduled jobs execute and deferred work queues are processed.

Invoicing

Upon resumption of invoice generation, a single catchup invoice will be generated containing all receivable amounts that would have been invoiced during the moratorium period. If specified in the billingHoldScope object, this catchup invoice will have a dueTime scheduled based on the moratorium’s endTime plus deferredInvoiceDueOffsetDays. Otherwise, the invoice will be scheduled according to the applicable installment plan.

Depending on the volume of policies affected by a given moratorium, the catchup invoice may take some time to generate, with all invoices expected to be generated within 24 hours of the expiry of the moratorium.

Auto Pay

Auto-Pay functionality applies exclusively to invoices that have already been generated. In scenarios where invoice generation has been suspended, no new invoices will be created, eliminating any Auto-Pay concerns.

For existing invoices, whether generated prior to the moratorium becoming effective, or created because invoice generation was not suspended, the following behavior applies when Auto-Pay is suspended:

When an invoice’s scheduled Auto-Pay execution time is reached, the system will automatically defer the payment attempt by 24 hours. This process continues daily until the moratorium is lifted. During each deferral, the system recognizes that the policy is subject to an active moratorium and postpones the Auto-Pay attempt accordingly.

Deliquency

Delinquency entities for policies governed by the moratorium will continue to be created during suspension but will remain in the preGrace state. Existing delinquencies in the inGrace state will maintain that status until their graceEndAt time is reached, at which point they will revert to the preGrace state.

Billing Lifecycle Jobs

Details of rescheduled autopay jobs can be found by fetching the lifecycle job data for an invoice.

Get the list of suspended delinquencies using a policyLocator or delinquencyLocator.

Get Suspended Delinquencies
getSuspendedDelinquencies
GET /billing/{tenantLocator}/delinquencies/suspended/list
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    delinquencyLocatorquerystring?optional
    policyLocatorquerystring?optional
    offsetqueryint?optional
    countqueryint?optional
    Response:SuspendedDelinquencyListResponse
    Security Group:delinquencies   Permissions:read,list
SuspendedDelinquencyListResponse
required
listCompleted boolean
items SuspendedDelinquency[]
SuspendedDelinquency
required
policyLocator string
delinquencyLocator string
startTime datetime
endTime datetime
moratoriumType string
Fetch Create Delinquencies Job Data for Invoice
fetchCreateDelinquenciesJobDataForInvoice
GET /billing/{tenantLocator}/jobs/delinquencies/invoices/{invoiceLocator}/list
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    invoiceLocatorpathstringrequired
    offsetqueryint?optional
    countqueryint?optional
    extendedqueryboolean?optional
    Response:DelinquencyCreateJobDataListResponse
    Security Group:jobs   Permissions:read,list
Fetch Delinquency Moratorium Jobs for Tenant
fetchDelinquencyMoratoriumJobsForTenant
GET /billing/{tenantLocator}/jobs/delinquencies/moratoriums/list
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    offsetqueryint?optional
    countqueryint?optional
    Response:DelinquencyMoratoriumJobsListResponse
    Security Group:jobs   Permissions:read,list
DelinquencyMoratoriumJobsListResponse
required
listCompleted boolean
items WorkflowContextDelinquencyMoratoriumJobData[]
WorkflowContextDelinquencyMoratoriumJobData
required
workflowJobLocator string
contextData DelinquencyMoratoriumJobData
workflowType Enum DELINQUENCY_MORATORIUM_EXECUTION | INVOICE_GENERATION | INVOICE_LIFECYCLE | LATTICE_AND_INSTALLMENTS_GENERATION | PAYMENT_EXECUTION
createdAt datetime

optional
completedAt datetime?
DelinquencyMoratoriumJobData
required
startTime datetime
error string
finishTime datetime
status Enum queued | finished | failed | running
Run Delinquency Moratoriums Workflow
runDelinquencyMoratoriumsWorkflow
POST /billing/{tenantLocator}/jobs/delinquencies/moratoriums
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    Response:void
    Security Group:jobs   Permission:write