API documentation
User
Tenant
Feature
Entitlement
User & permissions
Settings
- Settings
- Media
- Webhook
- Notification
Payment
- Payment Method
- Transaction
- SEPA XML
- Open Banking
- Bank Account Transaction
Customer
- Customer
- Customer Address
- Customer Email
- Customer Settings
- Customer Otp
Billing
- Invoice
- GETGet invoices
- POSTCreate draft invoice
- GETGet invoice
- PUTUpdate draft invoice
- DELDelete invoice
- POSTCancel invoice
- POSTCredit invoice
- POSTSet invoice customer address
- PUTToggle dunning
- POSTDuplicate invoice
- POSTFinalize invoice
- PUTSet invoice note
- POSTSet invoice payment method
- POSTAdd invoice payment
- POSTAdd invoice position items
- GETGet invoice preview
- PUTResend invoice
- PUTGet invoice download link
- PUTClose invoice
- POSTAdd comment
- GET
- Invoice Position Item
- Billing Run
Dunning
- Dunning Document
- Dunning Rule
Subscription
- Subscription
- Subscription Item
- Subscription Measurement
- Billing Group
Offers
- Offer
- Offer Recipient
- Offer Template
Catalogue
- Unit
- Measurement
- Product
- Product Family
- Price Plan
- Coupon
Checkout
- Checkout Link
- Cart
Accounting
Invoice
Toggle dunning
Disable or enable dunning for the invoice. This is only possible if the invoice is in status “STATUS_UNPAID”. If dunning is enabled after it was disabled, the next dunning rule will be applied automatically. This is available for invoices only.
Required permissions:invoice:write
PUT
/
invoices
/
{id}
/
dunning
curl -X PUT \
/invoices/{id}/dunning \
--header "Content-Type: application/json" \
--header "Authorization: Bearer <token>" \
--data '{
"dunningDisabled": ""
}'
{
"id": "00000000-0000-0000-0000-000000000000",
"customer": {
"id": "00000000-0000-0000-0000-000000000000",
"customerNumber": "CUSTOMER-000",
"timeZone": "Europe/Berlin",
"firstName": "John",
"lastName": "Doe",
"currencyCode": "EUR",
"companyName": "Acme Inc.",
"datevId": "123456789",
"status": "STATUS_ACTIVE"
},
"paymentMethod": {
"id": "<string>",
"gatewayName": "wallet",
"type": "sepa_debit",
"referenceId": "<string>",
"default": true,
"status": "active",
"source": "api",
"enabled": true,
"name": "<string>",
"data": [
"<string>"
],
"creationDate": "2023-11-07T05:31:56Z",
"expirationDate": "2023-11-07T05:31:56Z",
"sepaMandate": {},
"card": {
"brand": "Visa",
"last4": "4242",
"expMonth": 12,
"expYear": 2022,
"cardHolder": "Max Mustermann"
},
"sepaDebit": {
"iban": "DE8937*********3232",
"bic": "COBADEFFXXX",
"mandateReference": "MNDT-2021-123456",
"signingDate": "2021-01-01T00:00:00+00:00"
},
"paypal": {
"email": "max@mustermann.de",
"billingAgreementId": "I-1J5gqz2eZvKYlo2C2X2X2X2X"
}
},
"referencedInvoice": {},
"type": "TYPE_INVOICE",
"currencyCode": "EUR",
"number": "RE-0000000001",
"status": "STATUS_DRAFT",
"creationDate": "2023-11-07T05:31:56Z",
"finalizationDate": "2023-11-07T05:31:56Z",
"dueDate": "2023-11-07T05:31:56Z",
"lastReminderDate": "2023-11-07T05:31:56Z",
"lastSentAt": "2023-11-07T05:31:56Z",
"dunningLevel": 123,
"dunningStatus": "none",
"payDate": "2023-11-07T05:31:56Z",
"invoiceAddress": "<any>",
"internalNote": "This invoice is with a special discount.",
"title": "<string>",
"introduction": "<string>",
"closing": "<string>",
"netAmount": {},
"grossAmount": {},
"taxAmount": {},
"discountAmount": {},
"file": {
"id": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ",
"isPrivate": true,
"mimeType": "image/jpeg",
"fileExtension": "jpg",
"fileName": "invoice.jpg",
"storageFileName": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ.jpg",
"createdAt": "2021-01-01T00:00:00+00:00"
},
"xmlFile": {
"id": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ",
"isPrivate": true,
"mimeType": "image/jpeg",
"fileExtension": "jpg",
"fileName": "invoice.jpg",
"storageFileName": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ.jpg",
"createdAt": "2021-01-01T00:00:00+00:00"
},
"positions": [
{
"id": {},
"position": 123,
"quantity": 1,
"unit": {
"id": {},
"name": "Stück"
},
"unitPrice": {},
"netAmount": {},
"grossAmount": {},
"taxAmount": {},
"discountAmount": {},
"discountPercentage": 10,
"name": "My subscription product",
"description": "* my subscription product",
"taxGroup": {
"id": "00000000-0000-0000-0000-000000000000",
"internalDescription": "19%",
"reverseChargeType": "REVERSE_CHARGE",
"type": "standard"
},
"tax": {
"id": "00000000-0000-0000-0000-000000000000",
"description": "19%",
"code": "19",
"rate": 19
},
"type": "product",
"parent": {},
"group": {
"id": "ad8a3b9e-5b0a-4e1a-9c1a-0b9b2b8b0b0b",
"ranking": 1,
"name": "Subscription #12345"
},
"createdAt": "2020-01-01T00:00:00+00:00",
"product": {
"id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
"name": "Basic",
"description": "For small teams.",
"type": "product",
"invoiceVisibility": "always",
"customFields": {
"field1": "value1",
"field2": "value2"
}
},
"subscriptionItem": {
"id": "01F9ZQZJZJQZJZJZJZJZJZJZJZ",
"name": "Fitness M",
"description": "Everything included",
"furtherInformation": "Additional agreements: The contract includes a free drink flatrate.",
"status": "active",
"subscriptionId": "<string>"
},
"serviceDateFrom": "2020-01-01T00:00:00+00:00",
"serviceDateTo": "2020-01-01T00:00:00+00:00"
}
],
"applicatedExchangeRates": [
{
"sourceCurrencyCode": "EUR",
"destinationCurrencyCode": "CHF",
"exchangeRate": "1.135",
"exchangeRateDate": "2023-11-07T05:31:56Z"
}
],
"eInvoiceType": "<any>",
"leitwegId": "1234567890123",
"customFields": {
"field1": "value1",
"field2": "value2"
},
"serviceDateFrom": "2023-11-07T05:31:56Z",
"serviceDateTo": "2023-11-07T05:31:56Z",
"unpaidAmount": {},
"usageBreakdownUrl": "<string>",
"cancellationDocument": {
"number": "R2021-0001",
"id": "8d6b0f9e-5b9a-4e1a-9f0a-5e8e1a0b1b1e"
},
"dunningDisabled": true,
"sourceType": "<any>"
}
Authorizations
Value for the Authorization header parameter.
Path Parameters
Invoice identifier
Body
The updated Invoice resource
Response
200
application/json
Invoice resource updated
Was this page helpful?
curl -X PUT \
/invoices/{id}/dunning \
--header "Content-Type: application/json" \
--header "Authorization: Bearer <token>" \
--data '{
"dunningDisabled": ""
}'
{
"id": "00000000-0000-0000-0000-000000000000",
"customer": {
"id": "00000000-0000-0000-0000-000000000000",
"customerNumber": "CUSTOMER-000",
"timeZone": "Europe/Berlin",
"firstName": "John",
"lastName": "Doe",
"currencyCode": "EUR",
"companyName": "Acme Inc.",
"datevId": "123456789",
"status": "STATUS_ACTIVE"
},
"paymentMethod": {
"id": "<string>",
"gatewayName": "wallet",
"type": "sepa_debit",
"referenceId": "<string>",
"default": true,
"status": "active",
"source": "api",
"enabled": true,
"name": "<string>",
"data": [
"<string>"
],
"creationDate": "2023-11-07T05:31:56Z",
"expirationDate": "2023-11-07T05:31:56Z",
"sepaMandate": {},
"card": {
"brand": "Visa",
"last4": "4242",
"expMonth": 12,
"expYear": 2022,
"cardHolder": "Max Mustermann"
},
"sepaDebit": {
"iban": "DE8937*********3232",
"bic": "COBADEFFXXX",
"mandateReference": "MNDT-2021-123456",
"signingDate": "2021-01-01T00:00:00+00:00"
},
"paypal": {
"email": "max@mustermann.de",
"billingAgreementId": "I-1J5gqz2eZvKYlo2C2X2X2X2X"
}
},
"referencedInvoice": {},
"type": "TYPE_INVOICE",
"currencyCode": "EUR",
"number": "RE-0000000001",
"status": "STATUS_DRAFT",
"creationDate": "2023-11-07T05:31:56Z",
"finalizationDate": "2023-11-07T05:31:56Z",
"dueDate": "2023-11-07T05:31:56Z",
"lastReminderDate": "2023-11-07T05:31:56Z",
"lastSentAt": "2023-11-07T05:31:56Z",
"dunningLevel": 123,
"dunningStatus": "none",
"payDate": "2023-11-07T05:31:56Z",
"invoiceAddress": "<any>",
"internalNote": "This invoice is with a special discount.",
"title": "<string>",
"introduction": "<string>",
"closing": "<string>",
"netAmount": {},
"grossAmount": {},
"taxAmount": {},
"discountAmount": {},
"file": {
"id": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ",
"isPrivate": true,
"mimeType": "image/jpeg",
"fileExtension": "jpg",
"fileName": "invoice.jpg",
"storageFileName": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ.jpg",
"createdAt": "2021-01-01T00:00:00+00:00"
},
"xmlFile": {
"id": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ",
"isPrivate": true,
"mimeType": "image/jpeg",
"fileExtension": "jpg",
"fileName": "invoice.jpg",
"storageFileName": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ.jpg",
"createdAt": "2021-01-01T00:00:00+00:00"
},
"positions": [
{
"id": {},
"position": 123,
"quantity": 1,
"unit": {
"id": {},
"name": "Stück"
},
"unitPrice": {},
"netAmount": {},
"grossAmount": {},
"taxAmount": {},
"discountAmount": {},
"discountPercentage": 10,
"name": "My subscription product",
"description": "* my subscription product",
"taxGroup": {
"id": "00000000-0000-0000-0000-000000000000",
"internalDescription": "19%",
"reverseChargeType": "REVERSE_CHARGE",
"type": "standard"
},
"tax": {
"id": "00000000-0000-0000-0000-000000000000",
"description": "19%",
"code": "19",
"rate": 19
},
"type": "product",
"parent": {},
"group": {
"id": "ad8a3b9e-5b0a-4e1a-9c1a-0b9b2b8b0b0b",
"ranking": 1,
"name": "Subscription #12345"
},
"createdAt": "2020-01-01T00:00:00+00:00",
"product": {
"id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
"name": "Basic",
"description": "For small teams.",
"type": "product",
"invoiceVisibility": "always",
"customFields": {
"field1": "value1",
"field2": "value2"
}
},
"subscriptionItem": {
"id": "01F9ZQZJZJQZJZJZJZJZJZJZJZ",
"name": "Fitness M",
"description": "Everything included",
"furtherInformation": "Additional agreements: The contract includes a free drink flatrate.",
"status": "active",
"subscriptionId": "<string>"
},
"serviceDateFrom": "2020-01-01T00:00:00+00:00",
"serviceDateTo": "2020-01-01T00:00:00+00:00"
}
],
"applicatedExchangeRates": [
{
"sourceCurrencyCode": "EUR",
"destinationCurrencyCode": "CHF",
"exchangeRate": "1.135",
"exchangeRateDate": "2023-11-07T05:31:56Z"
}
],
"eInvoiceType": "<any>",
"leitwegId": "1234567890123",
"customFields": {
"field1": "value1",
"field2": "value2"
},
"serviceDateFrom": "2023-11-07T05:31:56Z",
"serviceDateTo": "2023-11-07T05:31:56Z",
"unpaidAmount": {},
"usageBreakdownUrl": "<string>",
"cancellationDocument": {
"number": "R2021-0001",
"id": "8d6b0f9e-5b9a-4e1a-9f0a-5e8e1a0b1b1e"
},
"dunningDisabled": true,
"sourceType": "<any>"
}
Assistant
Responses are generated using AI and may contain mistakes.