Skip to main content

Automating Case Updates

Send case activity and payments through the API instead of completing the monthly case update in the Partner Portal.

How It Works

By default, Debitura generates a monthly case update request for every active case assigned to you, surfaced in the Partner Portal as an Update Case Status task.

Once your integration is feeding case activity and payments, Debitura switches your partner account to a mode where those monthly requests are no longer generated. You report continuously through the API; the recurring manual task stops.

Default Debitura → monthly update request → you complete it in the portal

Automated You → case activity + payments via API → Debitura
(no monthly update request generated)

The setting is on your partner account, not per case. It applies to every case assigned to you.

What You Need to Send

Two data types cover what the monthly update collects:

DataEndpointNotes
PaymentsPOST /cases/{id}/paymentsOmit the payout split and Debitura computes it from the case terms. See Record Payments.
Case activityPOST /cases/{id}/notes or POST /ingestion-jobsUse /ingestion-jobs to batch up to 1,000 rows. See Update Case Progress and Ingestion Jobs.

Both must arrive on a regular cadence, and both must reference cases that resolve — see Case matching below.

Case activity is free text. There is no activity-type field: POST /cases/{id}/notes takes a description and an optional eventDate, and /ingestion-jobs currently accepts only type: 0 (Note). Back-date eventDate so the timeline reflects when the activity actually happened rather than when you posted it.

Case Matching

Every row you send must resolve to a Debitura case. Rows that do not match are not applied.

Resolve case IDs ahead of time using your own reference:

  • GET /cases/by-partner-reference/{reference} — single lookup
  • GET /cases/by-partner-reference?references= — batch, up to 100
  • GET /cases/by-creditor-reference — by the creditor's reference

Set your reference on cases before you start sending data. Unmatched references are the most common reason an automated feed silently under-reports.

Checking Your Own State

GET /me returns surveyCadenceMode:

ValueMeaning
StandardMonthly update requests are generated for your cases
DecisionPointOnlyNo monthly update requests are generated

The same field appears on the collection partner object embedded in case responses, so you can branch per case without a second call.

What Still Requires the Portal

Automating case updates replaces recurring reporting. It does not replace decisions.

No API endpoint exists for these — handle them in the Partner Portal:

  • Pausing a case
  • Extending the collection period (promise to pay, payment agreement)
  • Registering a debtor dispute

Available via the API, though many partners still handle them manually:

  • POST /cases/{id}/close — closing a case, with a close code
  • POST /cases/{id}/start — accepting and starting a case

The End of the Collection Period

When a case's exclusive collection period approaches its end, the next step is a judgement call: continue, escalate to legal, extend, or recommend closure.

Debitura does not currently send you an automatic prompt at that point once monthly update requests are switched off. Track it yourself:

GET /cases/{id}/exclusive-period

This returns the full period chain, including any extensions triggered by debtor actions. Poll it, or check it when a case's activity slows, and schedule your own review before periodEndDate.

Effect on Your Quality Score

The SLA component of your quality score weights case-update responses alongside case verification and chat replies. When update requests are no longer generated for you, the score renormalises across the remaining task types rather than counting the absent ones as missed. Automating your updates does not reduce your SLA score.

Getting Switched Over

This is enabled by Debitura on your partner account, not self-serve. Contact partner@debitura.com once your integration is sending payments and case activity on a regular cadence with references that resolve.

API Endpoints

EndpointPurpose
POST /cases/{id}/paymentsRecord a payment
POST /cases/{id}/notesRecord case activity on one case
POST /ingestion-jobsBatch case activity, up to 1,000 rows
GET /ingestion-jobs/{jobId}Poll batch progress
GET /cases/by-partner-reference/{reference}Resolve your reference to a case
GET /cases/{id}/exclusive-periodCollection period chain and end date
GET /meYour partner account, including surveyCadenceMode

For full endpoint documentation, see the API Reference.