Dunning Levels (Payment Reminders)

• Allowed query parameters
• Create a dunning
• Update a dunning
• Retrieve a dunning
• Delete a dunning
• List dunnings

Allowed query parameters

None

Create a dunning

post

/dunning

Attribute (* required)	Type	Description
title *	String	Title of the dunning template (1-255 characters)
text	String?	Content of the dunning message (supports HTML)
days_overdue *	Integer	Number of days after due date to trigger (1-365)

Example response

// HTTP 201 Created
{
    // a dunning object
}

Update a dunning

put

/dunning/{id}

Attribute (* required)	Type	Description
title	String	Title of the dunning template (1-255 characters)
text	String?	Content of the dunning message (supports HTML)
days_overdue	Integer	Number of days after due date to trigger (1-365)

Example response

// HTTP 200 OK
{
    // a dunning object
}

Retrieve a dunning

get

/dunning/{id}

Example response

// HTTP 200 OK
{
    "id": "8y3AdBxwPL",
    "level": 1,
    "days_overdue": 30,
    "title": "First Payment Reminder",
    "text": "Dear customer, your invoice {invoice_nr} is now {days_overdue} days overdue. Please settle this invoice as soon as possible."
}

Delete a dunning

delete

/dunning/{id}

Example response

// HTTP 204 No Content

List dunnings

get

/dunning

The list endpoint accepts the same parameters as in Retrieve a dunning and returns a paginated array of the same dunning object in the data property.

Read more about Pagination, Filtering, Sorting and Includes on the Introduction page.