CreateDunningRequest (object)
Request to create a dunning (draft). Contact and address are taken from the invoice. Either invoice_id or dunning_id is required; dunning_id creates the next dunning level from an existing dunning (and closes the source).
| Field | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| currency_code | string | Currency code (e.g. EUR); otherwise from invoice or account | ||||||||||||||||||||||||||||||||||||||||||||||||
| date | string (date) | Dunning date (YYYY-MM-DD); default is today | ||||||||||||||||||||||||||||||||||||||||||||||||
| due_date | string (date) | Due date (YYYY-MM-DD); otherwise from configuration | ||||||||||||||||||||||||||||||||||||||||||||||||
| dunning_fee_amount | integer | Dunning fee in cents; if omitted, taken from document configuration (levels 0–3) | ||||||||||||||||||||||||||||||||||||||||||||||||
| dunning_id | integer | Create next dunning from this dunning (invoice and level+1 taken from it; source dunning and other open dunnings for same invoice are closed) | ||||||||||||||||||||||||||||||||||||||||||||||||
| dunning_level | integer | 0 = payment reminder, 1+ = dunning level; if omitted, next level is determined automatically | ||||||||||||||||||||||||||||||||||||||||||||||||
| exchange_rate | string | Optional exchange rate to EUR (foreign units per 1 EUR, ECB convention). When omitted, it is prefilled from the daily ECB rate for the document date. | ||||||||||||||||||||||||||||||||||||||||||||||||
| invoice_id* | integer | Invoice this dunning is for (required; when creating from dunning, use source dunning's invoice_id) | ||||||||||||||||||||||||||||||||||||||||||||||||
| print_background_id | integer | Letterhead/print background template | ||||||||||||||||||||||||||||||||||||||||||||||||
| print_layout_id | integer | Print layout | ||||||||||||||||||||||||||||||||||||||||||||||||
| print_options | object |
| ||||||||||||||||||||||||||||||||||||||||||||||||
| service_object_ids | integer[] | array Elements integer | ||||||||||||||||||||||||||||||||||||||||||||||||
| subject | string | Subject line; otherwise from text templates | ||||||||||||||||||||||||||||||||||||||||||||||||
| text_bottom | string | Footer text (HTML) | ||||||||||||||||||||||||||||||||||||||||||||||||
| text_top | string | Header text (HTML) |
Example (JSON)
{
"invoice_id": 0,
"dunning_id": 0,
"dunning_level": 0,
"dunning_fee_amount": 0,
"date": "2026-01-15",
"due_date": "2026-01-15"
}