PUT
/
dunning
/
documents
/
{id}
/
cancel

Authorizations

Authorization
string
headerrequired

Value for the Authorization header parameter.

Path Parameters

id
string
required

DunningDocument identifier

Body

reason
string | null

The reason for the cancellation. This is used for internal purposes only.

Response

200 - application/json
id
string

The id of the dunning document

customer
object

The customer of the dunning document

recipient
string | null

The recipient of the dunning document

title
string

The title of the dunning document

introduction
string

The introduction of the dunning document

closing
string

The closing of the dunning document

documentDate
string

The document date of the dunning document

dueDate
string

The due date until when the invoice should be paid

media
object
template
string | null

The document template used for this dunning document

invoice
object

The invoice for which this dunning document was created

level
integer

The level of the current dunning document

type
enum<string>

The type of the current dunning document

Available options:
reminder,
dunning
status
enum<string>

The status of the current dunning document

Possible values:

  • open: The dunning document is open and can be paid.
  • cancelled: The dunning document was cancelled and can not be paid anymore.
  • paid: The dunning document was paid and can not be paid anymore. The dunning process for this invoice is stopped.
Available options:
open,
paid,
cancelled
reason
string | null

The reason for the cancellation. This is used for internal purposes only.

dunningFeeCents
integer | null

The dunning fee in cents for this dunning document. This is only relevant for dunning documents of type "dunning".

createdAt
string
updatedAt
string
dunningFee
object
number
string