Cancel dunning document

PUT

dunning

documents

{id}

cancel

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

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

200

application/json

DunningDocument resource updated

string

The id of the dunning document

Example:

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

customer

object

The customer of the dunning document

customer.countryCode

string

required

Example:

"DE"

customer.id

string

Example:

"00000000-0000-0000-0000-000000000000"

customer.customerNumber

string

Required string length: 2 - 255

Example:

"CUSTOMER-000"

customer.timeZone

string

default:Europe/Berlin

Example:

"Europe/Berlin"

customer.firstName

string | null

Can be empty if the customer is a company.

Required string length: 2 - 255

Example:

"John"

customer.lastName

string | null

Can be empty if the customer is a company.

Required string length: 2 - 255

Example:

"Doe"

customer.currencyCode

string

Can be empty. In this case the default currency of the tenant is used.

Example:

"EUR"

customer.companyName

string | null

Required string length: 2 - 255

Example:

"Acme Inc."

customer.vatId

string | null

Required string length: 2 - 255

Example:

"DE123456789"

customer.isVatIdValid

boolean

Indicates if the VAT ID is valid. This is only available for EU VAT IDs. We validate the VAT IDs each night and directly after change.

Example:

true

customer.taxExempt

enum<string>

Available options:

auto,

exempt

customer.datevId

string | null

The ID of the customer in DATEV

Required string length: 2 - 255

Example:

"123456789"

customer.commercialRegisterName

string | null

The name of the commercial register. This is needed tofullfill the collection processes on companies.

Example:

"Amtsgericht Berlin (Charlottenburg)"

customer.commercialRegisterNumber

string | null

The ID of the customer in the commercial register, e.g. HRB 123456. This is needed tofullfill the collection processes on companies.

Example:

"HRB 123456"

customer.status

enum<string>

default:STATUS_ACTIVE

Available options:

STATUS_ACTIVE,

STATUS_ARCHIVED,

STATUS_SUSPENDED

Example:

"STATUS_ACTIVE"

customer.gender

enum<string>

This field is needed, to fullfill a collection process on a personal customer.

Available options:

male,

female,

diverse

Example:

"male"

customer.phone

string | null

Required string length: 2 - 255

Example:

"+49 123 456789"

customer.language

enum<string>

default:de

The language of the customer. This is used for the communication with the customer or on generating documents like invoices, reminders, etc.

Available options:

de,

en

Example:

"de"

customer.totalTurnOverRank

integer | null

The current customer rank, based on their revenue. Lower is better. This will calculate each night.

Example:

10

customer.createdAt

string

Example:

"2020-01-01T00:00:00+00:00"

customer.emailAddresses

object[]

customer.addresses

object[]

customer.customerGroup

object | null

The customer group of the customer.

customer.customFields

object | null

Custom fields for the entity. The keys are the field names and the values are the field values. They need to be configured under "/custom-fields" in the API documentation. The input is validated against the configuration. For more details see Custom Fields Guide

Example:

{ "field1": "value1", "field2": "value2" }

customer.businessCustomer

boolean

customer.defaultAddress

object | null

The default address of the customer. This is the address that is used for billing if no other address is specified.

customer.defaultInvoiceAddress

object | null

The invoice address of the customer. This is the address that is used for billing if defined. If not defined, the default address is used.

customer.defaultEmailAddress

object | null

The default email address of the customer. This is the email address that is used for billing if no other email address is specified.

customer.defaultInvoiceEmailAddress

object | null

The invoice email address of the customer. This is the email address that is used for billing if defined. If not defined, the default email address is used.

customer.defaultPaymentMethod

object | null

The default payment method of the customer. This is the payment method that is used for billing.

customer.defaultPaymentMethod.id

string

customer.defaultPaymentMethod.gatewayName

enum<string>

Available options:

wallet,

sepa_debit,

stripe,

fake_provider,

paypal,

bank_transfer,

go_cardless,

testing

customer.defaultPaymentMethod.type

enum<string> | null

Available options:

sepa_debit,

card,

paypal,

bank_transfer,

wallet,

fake_provider

customer.defaultPaymentMethod.referenceId

string | null

customer.defaultPaymentMethod.default

boolean

customer.defaultPaymentMethod.status

enum<string>

default:active

Available options:

active,

action_required,

expired,

revoked,

gateway_unconfigured

Example:

"active"

customer.defaultPaymentMethod.source

enum<string>

default:api

Available options:

checkout,

customerfront,

api,

add_link

Example:

"api"

customer.defaultPaymentMethod.enabled

boolean

customer.defaultPaymentMethod.name

string | null

customer.defaultPaymentMethod.data

string[]

customer.defaultPaymentMethod.creationDate

string

customer.defaultPaymentMethod.expirationDate

string | null

customer.defaultPaymentMethod.sepaMandate

object | null

The sepa mandate of the payment method, if the gatewayName is "payment_sepa"

customer.defaultPaymentMethod.card

object

The card data of the payment method, if the type is "card"

customer.defaultPaymentMethod.sepaDebit

object

The sepa mandate data of the payment method, if the type is "sepa_debit"

customer.defaultPaymentMethod.paypal

object

The paypal data of the payment method, if the type is "paypal"

customer.contactPerson

object | null

The contact person of the customer.

customer.isPartner

boolean

Indicates if the customer is a partner.

customer.partner

object | null

The partner of the customer. If a partner is assigned, all existing and future subscriptions of the customer will be billed to the default payment method and invoice address of the partner.

recipient

string

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

The document date of the dunning document

dueDate

string

The due date until when the invoice should be paid

media

object | null

template

string

The document template used for this dunning document

Example:

"https://example.com/"

invoice

object

The invoice for which this dunning document was created

invoice.id

string

The unique identifier of the invoice.

Example:

"00000000-0000-0000-0000-000000000000"

invoice.customer

object

The customer of the invoice.

invoice.customer.countryCode

string

required

Example:

"DE"

invoice.customer.id

string

Example:

"00000000-0000-0000-0000-000000000000"

invoice.customer.customerNumber

string

Required string length: 2 - 255

Example:

"CUSTOMER-000"

invoice.customer.timeZone

string

default:Europe/Berlin

Example:

"Europe/Berlin"

invoice.customer.firstName

string | null

Can be empty if the customer is a company.

Required string length: 2 - 255

Example:

"John"

invoice.customer.lastName

string | null

Can be empty if the customer is a company.

Required string length: 2 - 255

Example:

"Doe"

invoice.customer.currencyCode

string

Can be empty. In this case the default currency of the tenant is used.

Example:

"EUR"

invoice.customer.companyName

string | null

Required string length: 2 - 255

Example:

"Acme Inc."

invoice.customer.vatId

string | null

Required string length: 2 - 255

Example:

"DE123456789"

invoice.customer.isVatIdValid

boolean

Indicates if the VAT ID is valid. This is only available for EU VAT IDs. We validate the VAT IDs each night and directly after change.

Example:

true

invoice.customer.taxExempt

enum<string>

Available options:

auto,

exempt

invoice.customer.datevId

string | null

The ID of the customer in DATEV

Required string length: 2 - 255

Example:

"123456789"

invoice.customer.commercialRegisterName

string | null

The name of the commercial register. This is needed tofullfill the collection processes on companies.

Example:

"Amtsgericht Berlin (Charlottenburg)"

invoice.customer.commercialRegisterNumber

string | null

The ID of the customer in the commercial register, e.g. HRB 123456. This is needed tofullfill the collection processes on companies.

Example:

"HRB 123456"

invoice.customer.status

enum<string>

default:STATUS_ACTIVE

Available options:

STATUS_ACTIVE,

STATUS_ARCHIVED,

STATUS_SUSPENDED

Example:

"STATUS_ACTIVE"

invoice.customer.gender

enum<string>

This field is needed, to fullfill a collection process on a personal customer.

Available options:

male,

female,

diverse

Example:

"male"

invoice.customer.phone

string | null

Required string length: 2 - 255

Example:

"+49 123 456789"

invoice.customer.language

enum<string>

default:de

The language of the customer. This is used for the communication with the customer or on generating documents like invoices, reminders, etc.

Available options:

de,

en

Example:

"de"

invoice.customer.totalTurnOverRank

integer | null

The current customer rank, based on their revenue. Lower is better. This will calculate each night.

Example:

10

invoice.customer.createdAt

string

Example:

"2020-01-01T00:00:00+00:00"

invoice.customer.emailAddresses

object[]

invoice.customer.addresses

object[]

invoice.customer.customerGroup

object | null

The customer group of the customer.

invoice.customer.customFields

object | null

Example:

{ "field1": "value1", "field2": "value2" }

invoice.customer.businessCustomer

boolean

invoice.customer.defaultAddress

object | null

The default address of the customer. This is the address that is used for billing if no other address is specified.

invoice.customer.defaultInvoiceAddress

object | null

The invoice address of the customer. This is the address that is used for billing if defined. If not defined, the default address is used.

invoice.customer.defaultEmailAddress

object | null

The default email address of the customer. This is the email address that is used for billing if no other email address is specified.

invoice.customer.defaultInvoiceEmailAddress

object | null

The invoice email address of the customer. This is the email address that is used for billing if defined. If not defined, the default email address is used.

invoice.customer.defaultPaymentMethod

object | null

The default payment method of the customer. This is the payment method that is used for billing.

invoice.customer.defaultPaymentMethod.id

string

invoice.customer.defaultPaymentMethod.gatewayName

enum<string>

Available options:

wallet,

sepa_debit,

stripe,

fake_provider,

paypal,

bank_transfer,

go_cardless,

testing

invoice.customer.defaultPaymentMethod.type

enum<string> | null

Available options:

sepa_debit,

card,

paypal,

bank_transfer,

wallet,

fake_provider

invoice.customer.defaultPaymentMethod.referenceId

string | null

invoice.customer.defaultPaymentMethod.default

boolean

invoice.customer.defaultPaymentMethod.status

enum<string>

default:active

Available options:

active,

action_required,

expired,

revoked,

gateway_unconfigured

Example:

"active"

invoice.customer.defaultPaymentMethod.source

enum<string>

default:api

Available options:

checkout,

customerfront,

api,

add_link

Example:

"api"

invoice.customer.defaultPaymentMethod.enabled

boolean

invoice.customer.defaultPaymentMethod.name

string | null

invoice.customer.defaultPaymentMethod.data

string[]

invoice.customer.defaultPaymentMethod.creationDate

string

invoice.customer.defaultPaymentMethod.expirationDate

string | null

invoice.customer.defaultPaymentMethod.sepaMandate

object | null

The sepa mandate of the payment method, if the gatewayName is "payment_sepa"

invoice.customer.defaultPaymentMethod.card

object

The card data of the payment method, if the type is "card"

invoice.customer.defaultPaymentMethod.sepaDebit

object

The sepa mandate data of the payment method, if the type is "sepa_debit"

invoice.customer.defaultPaymentMethod.paypal

object

The paypal data of the payment method, if the type is "paypal"

invoice.customer.contactPerson

object | null

The contact person of the customer.

invoice.customer.isPartner

boolean

Indicates if the customer is a partner.

invoice.customer.partner

object | null

The partner of the customer. If a partner is assigned, all existing and future subscriptions of the customer will be billed to the default payment method and invoice address of the partner.

invoice.paymentMethod

object | null

The payment method which should be used to fullfill the payment of the invoice.

invoice.paymentMethod.id

string

invoice.paymentMethod.gatewayName

enum<string>

Available options:

wallet,

sepa_debit,

stripe,

fake_provider,

paypal,

bank_transfer,

go_cardless,

testing

invoice.paymentMethod.type

enum<string> | null

Available options:

sepa_debit,

card,

paypal,

bank_transfer,

wallet,

fake_provider

invoice.paymentMethod.referenceId

string | null

invoice.paymentMethod.default

boolean

invoice.paymentMethod.status

enum<string>

default:active

Available options:

active,

action_required,

expired,

revoked,

gateway_unconfigured

Example:

"active"

invoice.paymentMethod.source

enum<string>

default:api

Available options:

checkout,

customerfront,

api,

add_link

Example:

"api"

invoice.paymentMethod.enabled

boolean

invoice.paymentMethod.name

string | null

invoice.paymentMethod.data

string[]

invoice.paymentMethod.creationDate

string

invoice.paymentMethod.expirationDate

string | null

invoice.paymentMethod.sepaMandate

object | null

The sepa mandate of the payment method, if the gatewayName is "payment_sepa"

invoice.paymentMethod.card

object

The card data of the payment method, if the type is "card"

invoice.paymentMethod.sepaDebit

object

The sepa mandate data of the payment method, if the type is "sepa_debit"

invoice.paymentMethod.paypal

object

The paypal data of the payment method, if the type is "paypal"

invoice.referencedInvoice

object | null

The referenced invoice of the invoice. This could be in case of a reminder, refund etc.

invoice.referencedInvoice.id

string

The unique identifier of the invoice.

Example:

"00000000-0000-0000-0000-000000000000"

invoice.referencedInvoice.customer

object

The customer of the invoice.

invoice.referencedInvoice.customer.countryCode

string

required

Example:

"DE"

invoice.referencedInvoice.customer.id

string

Example:

"00000000-0000-0000-0000-000000000000"

invoice.referencedInvoice.customer.customerNumber

string

Required string length: 2 - 255

Example:

"CUSTOMER-000"

invoice.referencedInvoice.customer.timeZone

string

default:Europe/Berlin

Example:

"Europe/Berlin"

invoice.referencedInvoice.customer.firstName

string | null

Can be empty if the customer is a company.

Required string length: 2 - 255

Example:

"John"

invoice.referencedInvoice.customer.lastName

string | null

Can be empty if the customer is a company.

Required string length: 2 - 255

Example:

"Doe"

invoice.referencedInvoice.customer.currencyCode

string

Can be empty. In this case the default currency of the tenant is used.

Example:

"EUR"

invoice.referencedInvoice.customer.companyName

string | null

Required string length: 2 - 255

Example:

"Acme Inc."

invoice.referencedInvoice.customer.vatId

string | null

Required string length: 2 - 255

Example:

"DE123456789"

invoice.referencedInvoice.customer.isVatIdValid

boolean

Indicates if the VAT ID is valid. This is only available for EU VAT IDs. We validate the VAT IDs each night and directly after change.

Example:

true

invoice.referencedInvoice.customer.taxExempt

enum<string>

Available options:

auto,

exempt

invoice.referencedInvoice.customer.datevId

string | null

The ID of the customer in DATEV

Required string length: 2 - 255

Example:

"123456789"

invoice.referencedInvoice.customer.commercialRegisterName

string | null

The name of the commercial register. This is needed tofullfill the collection processes on companies.

Example:

"Amtsgericht Berlin (Charlottenburg)"

invoice.referencedInvoice.customer.commercialRegisterNumber

string | null

The ID of the customer in the commercial register, e.g. HRB 123456. This is needed tofullfill the collection processes on companies.

Example:

"HRB 123456"

invoice.referencedInvoice.customer.status

enum<string>

default:STATUS_ACTIVE

Available options:

STATUS_ACTIVE,

STATUS_ARCHIVED,

STATUS_SUSPENDED

Example:

"STATUS_ACTIVE"

invoice.referencedInvoice.customer.gender

enum<string>

This field is needed, to fullfill a collection process on a personal customer.

Available options:

male,

female,

diverse

Example:

"male"

invoice.referencedInvoice.customer.phone

string | null

Required string length: 2 - 255

Example:

"+49 123 456789"

invoice.referencedInvoice.customer.language

enum<string>

default:de

The language of the customer. This is used for the communication with the customer or on generating documents like invoices, reminders, etc.

Available options:

de,

en

Example:

"de"

invoice.referencedInvoice.customer.totalTurnOverRank

integer | null

The current customer rank, based on their revenue. Lower is better. This will calculate each night.

Example:

10

invoice.referencedInvoice.customer.createdAt

string

Example:

"2020-01-01T00:00:00+00:00"

invoice.referencedInvoice.customer.emailAddresses

object[]

invoice.referencedInvoice.customer.addresses

object[]

invoice.referencedInvoice.customer.customerGroup

object | null

The customer group of the customer.

invoice.referencedInvoice.customer.customFields

object | null

Example:

{ "field1": "value1", "field2": "value2" }

invoice.referencedInvoice.customer.businessCustomer

boolean

invoice.referencedInvoice.customer.defaultAddress

object | null

The default address of the customer. This is the address that is used for billing if no other address is specified.

invoice.referencedInvoice.customer.defaultInvoiceAddress

object | null

The invoice address of the customer. This is the address that is used for billing if defined. If not defined, the default address is used.

invoice.referencedInvoice.customer.defaultEmailAddress

object | null

The default email address of the customer. This is the email address that is used for billing if no other email address is specified.

invoice.referencedInvoice.customer.defaultInvoiceEmailAddress

object | null

The invoice email address of the customer. This is the email address that is used for billing if defined. If not defined, the default email address is used.

invoice.referencedInvoice.customer.defaultPaymentMethod

object | null

The default payment method of the customer. This is the payment method that is used for billing.

invoice.referencedInvoice.customer.contactPerson

object | null

The contact person of the customer.

invoice.referencedInvoice.customer.isPartner

boolean

Indicates if the customer is a partner.

invoice.referencedInvoice.customer.partner

object | null

The partner of the customer. If a partner is assigned, all existing and future subscriptions of the customer will be billed to the default payment method and invoice address of the partner.

invoice.referencedInvoice.paymentMethod

object | null

The payment method which should be used to fullfill the payment of the invoice.

invoice.referencedInvoice.paymentMethod.id

string

invoice.referencedInvoice.paymentMethod.gatewayName

enum<string>

Available options:

wallet,

sepa_debit,

stripe,

fake_provider,

paypal,

bank_transfer,

go_cardless,

testing

invoice.referencedInvoice.paymentMethod.type

enum<string> | null

Available options:

sepa_debit,

card,

paypal,

bank_transfer,

wallet,

fake_provider

invoice.referencedInvoice.paymentMethod.referenceId

string | null

invoice.referencedInvoice.paymentMethod.default

boolean

invoice.referencedInvoice.paymentMethod.status

enum<string>

default:active

Available options:

active,

action_required,

expired,

revoked,

gateway_unconfigured

Example:

"active"

invoice.referencedInvoice.paymentMethod.source

enum<string>

default:api

Available options:

checkout,

customerfront,

api,

add_link

Example:

"api"

invoice.referencedInvoice.paymentMethod.enabled

boolean

invoice.referencedInvoice.paymentMethod.name

string | null

invoice.referencedInvoice.paymentMethod.data

string[]

invoice.referencedInvoice.paymentMethod.creationDate

string

invoice.referencedInvoice.paymentMethod.expirationDate

string | null

invoice.referencedInvoice.paymentMethod.sepaMandate

object | null

The sepa mandate of the payment method, if the gatewayName is "payment_sepa"

invoice.referencedInvoice.paymentMethod.card

object

The card data of the payment method, if the type is "card"

invoice.referencedInvoice.paymentMethod.sepaDebit

object

The sepa mandate data of the payment method, if the type is "sepa_debit"

invoice.referencedInvoice.paymentMethod.paypal

object

The paypal data of the payment method, if the type is "paypal"

referencedInvoice

object

invoice.referencedInvoice.type

enum<string>

The type of the invoice.

Available options:

TYPE_INVOICE,

TYPE_CREDIT,

TYPE_REFUND,

TYPE_REMINDER,

TYPE_CANCEL,

TYPE_DUNNING

Example:

"TYPE_INVOICE"

invoice.referencedInvoice.currencyCode

string

The currency code of the invoice. If multiple currency codes will be used in the positions, they will be converted to that base currency.

Example:

"EUR"

invoice.referencedInvoice.number

string

The document id of the invoice. This will be generated, when the invoice will be finalized.

Example:

"RE-0000000001"

invoice.referencedInvoice.status

enum<string>

Available options:

STATUS_DRAFT,

STATUS_PAID,

STATUS_CANCELLED,

STATUS_CLOSED,

STATUS_REFUNDED,

STATUS_REMINDED,

STATUS_UNPAID,

STATUS_NEW,

STATUS_FINALIZING

invoice.referencedInvoice.creationDate

string

invoice.referencedInvoice.finalizationDate

string | null

invoice.referencedInvoice.dueDate

string | null

invoice.referencedInvoice.lastReminderDate

string | null

invoice.referencedInvoice.lastSentAt

string | null

invoice.referencedInvoice.dunningLevel

integer

invoice.referencedInvoice.dunningStatus

enum<string>

default:none

Available options:

reminder,

dunning,

none

Example:

"none"

invoice.referencedInvoice.payDate

string | null

invoice.referencedInvoice.invoiceAddress

any | null

The invoice address of the invoice.

invoice.referencedInvoice.internalNote

string | null

deprecated

The notice of the invoice.

Example:

"This invoice is with a special discount."

invoice.referencedInvoice.title

string | null

invoice.referencedInvoice.introduction

string | null

invoice.referencedInvoice.closing

string | null

invoice.referencedInvoice.netAmount

object

The net amount of the invoice.

invoice.referencedInvoice.grossAmount

object

invoice.referencedInvoice.taxAmount

object

invoice.referencedInvoice.discountAmount

object

The total net discount amount of the invoice.

invoice.referencedInvoice.file

object | null

invoice.referencedInvoice.xmlFile

object | null

The xml representation of the invoice in EN16931 or x-Rechnung format.

invoice.referencedInvoice.positions

object[]

The positions of the invoice.

invoice.referencedInvoice.positions.id

object

invoice.referencedInvoice.positions.position

integer | null

The position of the invoice position item in the invoice. If 0, the item will be added at the end of the invoice.

invoice.referencedInvoice.positions.quantity

object

The quantity of the invoice position item.

invoice.referencedInvoice.positions.unit

object | null

The unit of the invoice position item.

invoice.referencedInvoice.positions.unitPrice

object

The unit price of the invoice position item.

invoice.referencedInvoice.positions.netAmount

object

The net amount of the invoice position item, before discount.

invoice.referencedInvoice.positions.grossAmount

object

The gross amount of the invoice position item, after discount.

invoice.referencedInvoice.positions.taxAmount

object

The tax amount of the invoice position item, after discount.

invoice.referencedInvoice.positions.discountAmount

object

The discount amount of the invoice position item.

invoice.referencedInvoice.positions.discountPercentage

string | null

The discount percentage of the invoice position item. You can either define an amount or a percentage.

Example:

10

invoice.referencedInvoice.positions.discountFixed

object

The fixed applied discount amount of the invoice position item.

invoice.referencedInvoice.positions.name

string

The description of the invoice position item.

Example:

"My subscription product"

invoice.referencedInvoice.positions.description

string | null

The description of the invoice position item.

Example:

"* my subscription product"

invoice.referencedInvoice.positions.taxGroup

object

The tax group of the invoice position item. Based on the customer and tax group, the correct tax rate will be calculated.

invoice.referencedInvoice.positions.tax

object | null

The tax of the invoice position item, calculated based on the tax group.

invoice.referencedInvoice.positions.type

enum<string> | null

The type of the invoice position item.

Available options:

product,

discount,

setup,

dunning_fee,

invoice

Example:

"product"

invoice.referencedInvoice.positions.parent

object | null

The parent invoice position item. Positions can be defined in a tree, with a maximum depth of two.

invoice.referencedInvoice.positions.parent.id

object

invoice.referencedInvoice.positions.parent.position

integer | null

The position of the invoice position item in the invoice. If 0, the item will be added at the end of the invoice.

invoice.referencedInvoice.positions.parent.quantity

object

The quantity of the invoice position item.

invoice.referencedInvoice.positions.parent.unit

object | null

The unit of the invoice position item.

invoice.referencedInvoice.positions.parent.unitPrice

object

The unit price of the invoice position item.

invoice.referencedInvoice.positions.parent.netAmount

object

The net amount of the invoice position item, before discount.

invoice.referencedInvoice.positions.parent.grossAmount

object

The gross amount of the invoice position item, after discount.

invoice.referencedInvoice.positions.parent.taxAmount

object

The tax amount of the invoice position item, after discount.

invoice.referencedInvoice.positions.parent.discountAmount

object

The discount amount of the invoice position item.

invoice.referencedInvoice.positions.parent.discountPercentage

string | null

The discount percentage of the invoice position item. You can either define an amount or a percentage.

Example:

10

invoice.referencedInvoice.positions.parent.discountFixed

object

The fixed applied discount amount of the invoice position item.

invoice.referencedInvoice.positions.parent.name

string

The description of the invoice position item.

Example:

"My subscription product"

invoice.referencedInvoice.positions.parent.description

string | null

The description of the invoice position item.

Example:

"* my subscription product"

invoice.referencedInvoice.positions.parent.taxGroup

object

The tax group of the invoice position item. Based on the customer and tax group, the correct tax rate will be calculated.

invoice.referencedInvoice.positions.parent.tax

object | null

The tax of the invoice position item, calculated based on the tax group.

invoice.referencedInvoice.positions.parent.type

enum<string> | null

The type of the invoice position item.

Available options:

product,

discount,

setup,

dunning_fee,

invoice

Example:

"product"

parent

object

invoice.referencedInvoice.positions.parent.group

object | null

The invoice position item group. Positions can be grouped together with a headline, which is shown on the invoice.

invoice.referencedInvoice.positions.parent.createdAt

string

The creation date of the invoice position item.

Example:

"2020-01-01T00:00:00+00:00"

invoice.referencedInvoice.positions.parent.product

string | null

Example:

"https://example.com/"

invoice.referencedInvoice.positions.parent.subscriptionItem

string | null

Example:

"https://example.com/"

invoice.referencedInvoice.positions.parent.serviceDateFrom

string | null

The service date from of the invoice position item.

Example:

"2020-01-01T00:00:00+00:00"

invoice.referencedInvoice.positions.parent.serviceDateTo

string | null

The service date to of the invoice position item.

Example:

"2020-01-01T00:00:00+00:00"

invoice.referencedInvoice.positions.group

object | null

The invoice position item group. Positions can be grouped together with a headline, which is shown on the invoice.

invoice.referencedInvoice.positions.createdAt

string

The creation date of the invoice position item.

Example:

"2020-01-01T00:00:00+00:00"

invoice.referencedInvoice.positions.product

string | null

Example:

"https://example.com/"

invoice.referencedInvoice.positions.subscriptionItem

string | null

Example:

"https://example.com/"

invoice.referencedInvoice.positions.serviceDateFrom

string | null

The service date from of the invoice position item.

Example:

"2020-01-01T00:00:00+00:00"

invoice.referencedInvoice.positions.serviceDateTo

string | null

The service date to of the invoice position item.

Example:

"2020-01-01T00:00:00+00:00"

invoice.referencedInvoice.applicatedExchangeRates

object[]

The applicated exchange rates of the invoice, fetched from the european central bank.

invoice.referencedInvoice.eInvoiceType

any

The einvoice generated xml file format.

invoice.referencedInvoice.leitwegId

string | null

The leitwegid used for einvoice. This is only set, when the eInvoiceType is not null.

Example:

"1234567890123"

invoice.referencedInvoice.customFields

object | null

Example:

{ "field1": "value1", "field2": "value2" }

invoice.referencedInvoice.serviceDateFrom

string | null

The earliest service date of all positions.

invoice.referencedInvoice.serviceDateTo

string | null

The latest service date of all positions.

invoice.referencedInvoice.unpaidAmount

object

invoice.referencedInvoice.usageBreakdownUrl

string | null

Public url to view the detailed usage breakdown of this invoice.

invoice.referencedInvoice.cancellationDocument

object | null

The referenced cancellation document.

Example:

{
  "number": "R2021-0001",
  "id": "8d6b0f9e-5b9a-4e1a-9f0a-5e8e1a0b1b1e"
}

invoice.referencedInvoice.dunningDisabled

boolean

Dunning is disabled for this invoice.

invoice.referencedInvoice.sourceType

any

Where the invoice was created from.

Possible values:

cart: The invoice was created from a cart.
subscription: The invoice was created from a subscription billing run.
manual: The invoice was created by a user.

invoice.type

enum<string>

The type of the invoice.

Available options:

TYPE_INVOICE,

TYPE_CREDIT,

TYPE_REFUND,

TYPE_REMINDER,

TYPE_CANCEL,

TYPE_DUNNING

Example:

"TYPE_INVOICE"

invoice.currencyCode

string

The currency code of the invoice. If multiple currency codes will be used in the positions, they will be converted to that base currency.

Example:

"EUR"

invoice.number

string

The document id of the invoice. This will be generated, when the invoice will be finalized.

Example:

"RE-0000000001"

invoice.status

enum<string>

Available options:

STATUS_DRAFT,

STATUS_PAID,

STATUS_CANCELLED,

STATUS_CLOSED,

STATUS_REFUNDED,

STATUS_REMINDED,

STATUS_UNPAID,

STATUS_NEW,

STATUS_FINALIZING

invoice.creationDate

string

invoice.finalizationDate

string | null

invoice.dueDate

string | null

invoice.lastReminderDate

string | null

invoice.lastSentAt

string | null

invoice.dunningLevel

integer

invoice.dunningStatus

enum<string>

default:none

Available options:

reminder,

dunning,

none

Example:

"none"

invoice.payDate

string | null

invoice.invoiceAddress

any | null

The invoice address of the invoice.

invoice.internalNote

string | null

deprecated

The notice of the invoice.

Example:

"This invoice is with a special discount."

invoice.title

string | null

invoice.introduction

string | null

invoice.closing

string | null

invoice.netAmount

object

The net amount of the invoice.

invoice.grossAmount

object

invoice.taxAmount

object

invoice.discountAmount

object

The total net discount amount of the invoice.

invoice.file

object | null

invoice.xmlFile

object | null

The xml representation of the invoice in EN16931 or x-Rechnung format.

invoice.positions

object[]

The positions of the invoice.

invoice.positions.id

object

invoice.positions.position

integer | null

The position of the invoice position item in the invoice. If 0, the item will be added at the end of the invoice.

invoice.positions.quantity

object

The quantity of the invoice position item.

invoice.positions.unit

object | null

The unit of the invoice position item.

invoice.positions.unitPrice

object

The unit price of the invoice position item.

invoice.positions.netAmount

object

The net amount of the invoice position item, before discount.

invoice.positions.grossAmount

object

The gross amount of the invoice position item, after discount.

invoice.positions.taxAmount

object

The tax amount of the invoice position item, after discount.

invoice.positions.discountAmount

object

The discount amount of the invoice position item.

invoice.positions.discountPercentage

string | null

The discount percentage of the invoice position item. You can either define an amount or a percentage.

Example:

10

invoice.positions.discountFixed

object

The fixed applied discount amount of the invoice position item.

invoice.positions.name

string

The description of the invoice position item.

Example:

"My subscription product"

invoice.positions.description

string | null

The description of the invoice position item.

Example:

"* my subscription product"

invoice.positions.taxGroup

object

The tax group of the invoice position item. Based on the customer and tax group, the correct tax rate will be calculated.

invoice.positions.tax

object | null

The tax of the invoice position item, calculated based on the tax group.

invoice.positions.type

enum<string> | null

The type of the invoice position item.

Available options:

product,

discount,

setup,

dunning_fee,

invoice

Example:

"product"

invoice.positions.parent

object | null

The parent invoice position item. Positions can be defined in a tree, with a maximum depth of two.

invoice.positions.parent.id

object

invoice.positions.parent.position

integer | null

The position of the invoice position item in the invoice. If 0, the item will be added at the end of the invoice.

invoice.positions.parent.quantity

object

The quantity of the invoice position item.

invoice.positions.parent.unit

object | null

The unit of the invoice position item.

invoice.positions.parent.unitPrice

object

The unit price of the invoice position item.

invoice.positions.parent.netAmount

object

The net amount of the invoice position item, before discount.

invoice.positions.parent.grossAmount

object

The gross amount of the invoice position item, after discount.

invoice.positions.parent.taxAmount

object

The tax amount of the invoice position item, after discount.

invoice.positions.parent.discountAmount

object

The discount amount of the invoice position item.

invoice.positions.parent.discountPercentage

string | null

The discount percentage of the invoice position item. You can either define an amount or a percentage.

Example:

10

invoice.positions.parent.discountFixed

object

The fixed applied discount amount of the invoice position item.

invoice.positions.parent.name

string

The description of the invoice position item.

Example:

"My subscription product"

invoice.positions.parent.description

string | null

The description of the invoice position item.

Example:

"* my subscription product"

invoice.positions.parent.taxGroup

object

The tax group of the invoice position item. Based on the customer and tax group, the correct tax rate will be calculated.

invoice.positions.parent.tax

object | null

The tax of the invoice position item, calculated based on the tax group.

invoice.positions.parent.type

enum<string> | null

The type of the invoice position item.

Available options:

product,

discount,

setup,

dunning_fee,

invoice

Example:

"product"

parent

object

invoice.positions.parent.group

object | null

The invoice position item group. Positions can be grouped together with a headline, which is shown on the invoice.

invoice.positions.parent.createdAt

string

The creation date of the invoice position item.

Example:

"2020-01-01T00:00:00+00:00"

invoice.positions.parent.product

string | null

Example:

"https://example.com/"

invoice.positions.parent.subscriptionItem

string | null

Example:

"https://example.com/"

invoice.positions.parent.serviceDateFrom

string | null

The service date from of the invoice position item.

Example:

"2020-01-01T00:00:00+00:00"

invoice.positions.parent.serviceDateTo

string | null

The service date to of the invoice position item.

Example:

"2020-01-01T00:00:00+00:00"

invoice.positions.group

object | null

The invoice position item group. Positions can be grouped together with a headline, which is shown on the invoice.

invoice.positions.createdAt

string

The creation date of the invoice position item.

Example:

"2020-01-01T00:00:00+00:00"

invoice.positions.product

string | null

Example:

"https://example.com/"

invoice.positions.subscriptionItem

string | null

Example:

"https://example.com/"

invoice.positions.serviceDateFrom

string | null

The service date from of the invoice position item.

Example:

"2020-01-01T00:00:00+00:00"

invoice.positions.serviceDateTo

string | null

The service date to of the invoice position item.

Example:

"2020-01-01T00:00:00+00:00"

invoice.applicatedExchangeRates

object[]

The applicated exchange rates of the invoice, fetched from the european central bank.

invoice.eInvoiceType

any

The einvoice generated xml file format.

invoice.leitwegId

string | null

The leitwegid used for einvoice. This is only set, when the eInvoiceType is not null.

Example:

"1234567890123"

invoice.customFields

object | null

Example:

{ "field1": "value1", "field2": "value2" }

invoice.serviceDateFrom

string | null

The earliest service date of all positions.

invoice.serviceDateTo

string | null

The latest service date of all positions.

invoice.unpaidAmount

object

invoice.usageBreakdownUrl

string | null

Public url to view the detailed usage breakdown of this invoice.

invoice.cancellationDocument

object | null

The referenced cancellation document.

Example:

{
  "number": "R2021-0001",
  "id": "8d6b0f9e-5b9a-4e1a-9f0a-5e8e1a0b1b1e"
}

invoice.dunningDisabled

boolean

Dunning is disabled for this invoice.

invoice.sourceType

any

Where the invoice was created from.

Possible values:

cart: The invoice was created from a cart.
subscription: The invoice was created from a subscription billing run.
manual: The invoice was created by a user.

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

updatedAt

string

dunningFee

object | null

number

string

Get dunning document Get overdue rules

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>"
}

API documentation

User

Tenant

Feature

Entitlement

User & permissions

Settings

Payment

Analytics

Customer

Billing

Dunning

Subscription

Offers

Catalogue

Checkout

Accounting

Taxes

Cancel dunning document

Authorizations

Path Parameters

Body

Response