PUT
/
dunning
/
documents
/
{id}
/
cancel
cURL
curl -X PUT \
 /dunning/documents/{id}/cancel \
 --header "Content-Type: application/json" \
 --header "Authorization: Bearer <token>" \
 --data '{
    "reason": ""
}'
{
  "id": "ad8f6b9c-4b9c-4c9c-9c4b-9c4b9c4b9c4b",
  "customer": {
    "id": "00000000-0000-0000-0000-000000000000",
    "customerNumber": "CUSTOMER-000",
    "timeZone": "Europe/Berlin",
    "firstName": "John",
    "lastName": "Doe",
    "currencyCode": "EUR",
    "countryCode": "DE",
    "companyName": "Acme Inc.",
    "vatId": "DE123456789",
    "isVatIdValid": true,
    "taxExempt": "auto",
    "datevId": "123456789",
    "commercialRegisterName": "Amtsgericht Berlin (Charlottenburg)",
    "commercialRegisterNumber": "HRB 123456",
    "status": "STATUS_ACTIVE",
    "gender": "male",
    "phone": "+49 123 456789",
    "language": "de",
    "totalTurnOverRank": 10,
    "createdAt": "2020-01-01T00:00:00+00:00",
    "emailAddresses": [
      {}
    ],
    "addresses": [
      {}
    ],
    "customerGroup": {},
    "customFields": {
      "field1": "value1",
      "field2": "value2"
    },
    "businessCustomer": true,
    "defaultAddress": {},
    "defaultInvoiceAddress": {},
    "defaultEmailAddress": {},
    "defaultInvoiceEmailAddress": {},
    "defaultPaymentMethod": {
      "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"
      }
    },
    "contactPerson": {
      "id": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "email": "<string>",
      "avatar": "<string>"
    },
    "isPartner": true,
    "partner": {
      "id": "ad8f7e7d-3b3b-4b3b-8b3b-3b3b3b3b3b3b",
      "name": "John Doe",
      "number": "123456",
      "email": "partner@example.com"
    }
  },
  "recipient": "https://example.com/",
  "title": "<string>",
  "introduction": "<string>",
  "closing": "<string>",
  "documentDate": "2023-11-07T05:31:56Z",
  "dueDate": "2023-11-07T05:31:56Z",
  "media": {
    "id": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ",
    "isPrivate": true,
    "mimeType": "image/jpeg",
    "fileExtension": "jpg",
    "fileName": "invoice.jpg",
    "storageFileName": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ.jpg",
    "createdAt": "2021-01-01T00:00:00+00:00"
  },
  "template": "https://example.com/",
  "invoice": {
    "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",
      "countryCode": "DE",
      "companyName": "Acme Inc.",
      "vatId": "DE123456789",
      "isVatIdValid": true,
      "taxExempt": "auto",
      "datevId": "123456789",
      "commercialRegisterName": "Amtsgericht Berlin (Charlottenburg)",
      "commercialRegisterNumber": "HRB 123456",
      "status": "STATUS_ACTIVE",
      "gender": "male",
      "phone": "+49 123 456789",
      "language": "de",
      "totalTurnOverRank": 10,
      "createdAt": "2020-01-01T00:00:00+00:00",
      "emailAddresses": [
        {}
      ],
      "addresses": [
        {}
      ],
      "customerGroup": {},
      "customFields": {
        "field1": "value1",
        "field2": "value2"
      },
      "businessCustomer": true,
      "defaultAddress": {},
      "defaultInvoiceAddress": {},
      "defaultEmailAddress": {},
      "defaultInvoiceEmailAddress": {},
      "defaultPaymentMethod": {
        "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"
        }
      },
      "contactPerson": {
        "id": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "email": "<string>",
        "avatar": "<string>"
      },
      "isPartner": true,
      "partner": {
        "id": "ad8f7e7d-3b3b-4b3b-8b3b-3b3b3b3b3b3b",
        "name": "John Doe",
        "number": "123456",
        "email": "partner@example.com"
      }
    },
    "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": "https://example.com/",
        "subscriptionItem": "https://example.com/",
        "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>"
  },
  "level": 123,
  "type": "reminder",
  "status": "<any>",
  "reason": "<string>",
  "dunningFeeCents": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "dunningFee": {},
  "number": "<string>"
}

Authorizations

​
Authorization
string
header
required

Value for the Authorization header parameter.

Path Parameters

​
id
string
required

DunningDocument identifier

Body

The updated DunningDocument resource

​
reason
string | null

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

Response

DunningDocument resource updated

​
id
string

The id of the dunning document

Example:

"ad8f6b9c-4b9c-4c9c-9c4b-9c4b9c4b9c4b"

​
customer
object

The customer of the dunning document

​
recipient
string<iri-reference>

The recipient of the dunning document

Example:

"https://example.com/"

​
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<date-time>

The document date of the dunning document

​
dueDate
string<date-time>

The due date until when the invoice should be paid

​
media
object | null
​
template
string<iri-reference>

The document template used for this dunning document

Example:

"https://example.com/"

​
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
any

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.
​
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<date-time>
​
updatedAt
string<date-time>
​
dunningFee
object | null
​
number
string