Skip to main content
POST
Resume the dunning process

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

uuid
string<uuid>
required

UUID of the invoice in this request.

Response

The dunning state of one invoice: the dunning process plus the history of sent notices. A held, never-released invoice reports the held shape with no process.

current_level
integer | null
required
read-only

One-based next dunning level. It can be one beyond the final configured level after the last notice; null when no dunning process exists.

dunning_flow
object | null
required

Flow assigned to this invoice's dunning process, which can be an older configuration version. Null when no process or assigned flow exists.

dunnings
object[]
required
read-only

History of sent or attempted dunning notices. Empty when the invoice has no dunning process.

next_action_date
string<date-time> | null
required
read-only

Scheduled time of the next dunning action, which can be a notice or automatic debt-collection handover. Null when no action is scheduled or no process exists.

pause_reason
enum<string> | null
required

Reason recorded for the process hold (manual user pause, subscription, administrator, debtor hold, or disconnected integration); null when no reason is recorded.

Available options:
user,
subscription,
admin,
debtor,
integration
paused_at
string<date-time> | null
required
read-only

Time the process entered its current pause. Null when not paused, when no process exists, or when a legacy pause has no recorded timestamp.

state
enum<string> | null
required

Current dunning process state. held means an API invoice awaits release; an invoice settled while held reports paid, cancelled, or written_off. Null means a bookkeeping invoice has never been enrolled.

Available options:
held,
pending,
active,
paused,
completed,
paid,
cancelled,
written_off,
inkasso