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
- 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
Get dunning document
Get dunning document
Required permissions:dunning-document:readAuthorizations
Value for the Authorization header parameter.
Path Parameters
DunningDocument identifier
Response
The id of the dunning document
The customer of the dunning document
2 - 255Can be empty if the customer is a company.
2 - 255Can be empty if the customer is a company.
2 - 255Can be empty. In this case the default currency of the tenant is used.
2 - 2552 - 255Indicates 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.
auto, exempt The ID of the customer in DATEV
2 - 255The name of the commercial register. This is needed tofullfill the collection processes on companies.
The ID of the customer in the commercial register, e.g. HRB 123456. This is needed tofullfill the collection processes on companies.
STATUS_ACTIVE, STATUS_ARCHIVED, STATUS_SUSPENDED This field is needed, to fullfill a collection process on a personal customer.
male, female, diverse 2 - 255The language of the customer. This is used for the communication with the customer or on generating documents like invoices, reminders, etc.
de, en The current customer rank, based on their revenue. Lower is better. This will calculate each night.
The customer group of the customer.
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
The default address of the customer. This is the address that is used for billing if no other address is specified.
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.
The default email address of the customer. This is the email address that is used for billing if no other email address is specified.
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.
The default payment method of the customer. This is the payment method that is used for billing.
wallet, sepa_debit, stripe, fake_provider, paypal, bank_transfer, go_cardless, testing sepa_debit, card, paypal, bank_transfer, wallet, fake_provider active, action_required, expired, revoked, gateway_unconfigured checkout, customerfront, api, add_link The sepa mandate of the payment method, if the gatewayName is "payment_sepa"
The card data of the payment method, if the type is "card"
The brand of the card
The last 4 digits of the card
The expiration month of the card
The expiration year of the card
The card holder name
The sepa mandate data of the payment method, if the type is "sepa_debit"
The iban of the sepa mandate
The bic of the sepa mandate
The mandate reference of the sepa mandate
The signing date of the sepa mandate
Indicates if the customer is a partner.
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.
The recipient of the dunning document
The title of the dunning document
The introduction of the dunning document
The closing of the dunning document
The document date of the dunning document
The due date until when the invoice should be paid
Whether the media is public accessible or not
The mime type of the media
The file extension of the media
The original file name of the media
The file name of the media in the storage
The date and time when the media was created
The document template used for this dunning document
The invoice for which this dunning document was created
The unique identifier of the invoice.
The customer of the invoice.
2 - 255Can be empty if the customer is a company.
2 - 255Can be empty if the customer is a company.
2 - 255Can be empty. In this case the default currency of the tenant is used.
2 - 2552 - 255Indicates 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.
auto, exempt The ID of the customer in DATEV
2 - 255The name of the commercial register. This is needed tofullfill the collection processes on companies.
The ID of the customer in the commercial register, e.g. HRB 123456. This is needed tofullfill the collection processes on companies.
STATUS_ACTIVE, STATUS_ARCHIVED, STATUS_SUSPENDED This field is needed, to fullfill a collection process on a personal customer.
male, female, diverse 2 - 255The language of the customer. This is used for the communication with the customer or on generating documents like invoices, reminders, etc.
de, en The current customer rank, based on their revenue. Lower is better. This will calculate each night.
The customer group of the customer.
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
The default address of the customer. This is the address that is used for billing if no other address is specified.
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.
The default email address of the customer. This is the email address that is used for billing if no other email address is specified.
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.
The default payment method of the customer. This is the payment method that is used for billing.
wallet, sepa_debit, stripe, fake_provider, paypal, bank_transfer, go_cardless, testing sepa_debit, card, paypal, bank_transfer, wallet, fake_provider active, action_required, expired, revoked, gateway_unconfigured checkout, customerfront, api, add_link The sepa mandate of the payment method, if the gatewayName is "payment_sepa"
The card data of the payment method, if the type is "card"
The brand of the card
The last 4 digits of the card
The expiration month of the card
The expiration year of the card
The card holder name
The sepa mandate data of the payment method, if the type is "sepa_debit"
The iban of the sepa mandate
The bic of the sepa mandate
The mandate reference of the sepa mandate
The signing date of the sepa mandate
Indicates if the customer is a partner.
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.
The payment method which should be used to fullfill the payment of the invoice.
wallet, sepa_debit, stripe, fake_provider, paypal, bank_transfer, go_cardless, testing sepa_debit, card, paypal, bank_transfer, wallet, fake_provider active, action_required, expired, revoked, gateway_unconfigured checkout, customerfront, api, add_link The sepa mandate of the payment method, if the gatewayName is "payment_sepa"
The card data of the payment method, if the type is "card"
The brand of the card
The last 4 digits of the card
The expiration month of the card
The expiration year of the card
The card holder name
The sepa mandate data of the payment method, if the type is "sepa_debit"
The iban of the sepa mandate
The bic of the sepa mandate
The mandate reference of the sepa mandate
The signing date of the sepa mandate
The referenced invoice of the invoice. This could be in case of a reminder, refund etc.
The unique identifier of the invoice.
The customer of the invoice.
2 - 255Can be empty if the customer is a company.
2 - 255Can be empty if the customer is a company.
2 - 255Can be empty. In this case the default currency of the tenant is used.
2 - 2552 - 255Indicates 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.
auto, exempt The ID of the customer in DATEV
2 - 255The name of the commercial register. This is needed tofullfill the collection processes on companies.
The ID of the customer in the commercial register, e.g. HRB 123456. This is needed tofullfill the collection processes on companies.
STATUS_ACTIVE, STATUS_ARCHIVED, STATUS_SUSPENDED This field is needed, to fullfill a collection process on a personal customer.
male, female, diverse 2 - 255The language of the customer. This is used for the communication with the customer or on generating documents like invoices, reminders, etc.
de, en The current customer rank, based on their revenue. Lower is better. This will calculate each night.
The customer group of the customer.
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
The default address of the customer. This is the address that is used for billing if no other address is specified.
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.
The default email address of the customer. This is the email address that is used for billing if no other email address is specified.
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.
The default payment method of the customer. This is the payment method that is used for billing.
wallet, sepa_debit, stripe, fake_provider, paypal, bank_transfer, go_cardless, testing sepa_debit, card, paypal, bank_transfer, wallet, fake_provider active, action_required, expired, revoked, gateway_unconfigured checkout, customerfront, api, add_link The sepa mandate of the payment method, if the gatewayName is "payment_sepa"
The card data of the payment method, if the type is "card"
The sepa mandate data of the payment method, if the type is "sepa_debit"
The paypal data of the payment method, if the type is "paypal"
The contact person of the customer.
Indicates if the customer is a partner.
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.
The ID of the partner
The name of the partner
The customer number of the partner
The email address of the partner
The payment method which should be used to fullfill the payment of the invoice.
wallet, sepa_debit, stripe, fake_provider, paypal, bank_transfer, go_cardless, testing sepa_debit, card, paypal, bank_transfer, wallet, fake_provider active, action_required, expired, revoked, gateway_unconfigured checkout, customerfront, api, add_link The sepa mandate of the payment method, if the gatewayName is "payment_sepa"
The card data of the payment method, if the type is "card"
The brand of the card
The last 4 digits of the card
The expiration month of the card
The expiration year of the card
The card holder name
The sepa mandate data of the payment method, if the type is "sepa_debit"
The iban of the sepa mandate
The bic of the sepa mandate
The mandate reference of the sepa mandate
The signing date of the sepa mandate
The referenced invoice of the invoice. This could be in case of a reminder, refund etc.
The unique identifier of the invoice.
The customer of the invoice.
2 - 255Can be empty if the customer is a company.
2 - 255Can be empty if the customer is a company.
2 - 255Can be empty. In this case the default currency of the tenant is used.
2 - 2552 - 255Indicates 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.
auto, exempt The ID of the customer in DATEV
2 - 255The name of the commercial register. This is needed tofullfill the collection processes on companies.
The ID of the customer in the commercial register, e.g. HRB 123456. This is needed tofullfill the collection processes on companies.
STATUS_ACTIVE, STATUS_ARCHIVED, STATUS_SUSPENDED This field is needed, to fullfill a collection process on a personal customer.
male, female, diverse 2 - 255The language of the customer. This is used for the communication with the customer or on generating documents like invoices, reminders, etc.
de, en The current customer rank, based on their revenue. Lower is better. This will calculate each night.
The customer group of the customer.
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
The default address of the customer. This is the address that is used for billing if no other address is specified.
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.
The default email address of the customer. This is the email address that is used for billing if no other email address is specified.
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.
The default payment method of the customer. This is the payment method that is used for billing.
The contact person of the customer.
Indicates if the customer is a partner.
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.
The payment method which should be used to fullfill the payment of the invoice.
wallet, sepa_debit, stripe, fake_provider, paypal, bank_transfer, go_cardless, testing sepa_debit, card, paypal, bank_transfer, wallet, fake_provider active, action_required, expired, revoked, gateway_unconfigured checkout, customerfront, api, add_link The sepa mandate of the payment method, if the gatewayName is "payment_sepa"
The card data of the payment method, if the type is "card"
The sepa mandate data of the payment method, if the type is "sepa_debit"
The paypal data of the payment method, if the type is "paypal"
The referenced invoice of the invoice. This could be in case of a reminder, refund etc.
The unique identifier of the invoice.
The customer of the invoice.
The payment method which should be used to fullfill the payment of the invoice.
The referenced invoice of the invoice. This could be in case of a reminder, refund etc.
The type of the invoice.
TYPE_INVOICE, TYPE_CREDIT, TYPE_REFUND, TYPE_REMINDER, TYPE_CANCEL, TYPE_DUNNING The currency code of the invoice. If multiple currency codes will be used in the positions, they will be converted to that base currency.
The document id of the invoice. This will be generated, when the invoice will be finalized.
STATUS_DRAFT, STATUS_PAID, STATUS_CANCELLED, STATUS_CLOSED, STATUS_REFUNDED, STATUS_REMINDED, STATUS_UNPAID, STATUS_NEW, STATUS_FINALIZING reminder, dunning, none The invoice address of the invoice.
The notice of the invoice.
The net amount of the invoice.
The total net discount amount of the invoice.
The xml representation of the invoice in EN16931 or x-Rechnung format.
The positions of the invoice.
The applicated exchange rates of the invoice, fetched from the european central bank.
The einvoice generated xml file format.
The leitwegid used for einvoice. This is only set, when the eInvoiceType is not 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
The earliest service date of all positions.
The latest service date of all positions.
Public url to view the detailed usage breakdown of this invoice.
The referenced cancellation document.
Dunning is disabled for this invoice.
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.
The type of the invoice.
TYPE_INVOICE, TYPE_CREDIT, TYPE_REFUND, TYPE_REMINDER, TYPE_CANCEL, TYPE_DUNNING The currency code of the invoice. If multiple currency codes will be used in the positions, they will be converted to that base currency.
The document id of the invoice. This will be generated, when the invoice will be finalized.
STATUS_DRAFT, STATUS_PAID, STATUS_CANCELLED, STATUS_CLOSED, STATUS_REFUNDED, STATUS_REMINDED, STATUS_UNPAID, STATUS_NEW, STATUS_FINALIZING reminder, dunning, none The invoice address of the invoice.
The notice of the invoice.
The net amount of the invoice.
The total net discount amount of the invoice.
Whether the media is public accessible or not
The mime type of the media
The file extension of the media
The original file name of the media
The file name of the media in the storage
The date and time when the media was created
The xml representation of the invoice in EN16931 or x-Rechnung format.
Whether the media is public accessible or not
The mime type of the media
The file extension of the media
The original file name of the media
The file name of the media in the storage
The date and time when the media was created
The positions of the invoice.
The position of the invoice position item in the invoice. If 0, the item will be added at the end of the invoice.
The quantity of the invoice position item.
The unit of the invoice position item.
The unit price of the invoice position item.
The net amount of the invoice position item, before discount.
The gross amount of the invoice position item, after discount.
The tax amount of the invoice position item, after discount.
The discount amount of the invoice position item.
The discount percentage of the invoice position item. You can either define an amount or a percentage.
The fixed applied discount amount of the invoice position item.
The description of the invoice position item.
The description of the invoice position item.
The tax group of the invoice position item. Based on the customer and tax group, the correct tax rate will be calculated.
The tax of the invoice position item, calculated based on the tax group.
The type of the invoice position item.
product, discount, setup, dunning_fee, invoice The parent invoice position item. Positions can be defined in a tree, with a maximum depth of two.
The invoice position item group. Positions can be grouped together with a headline, which is shown on the invoice.
The creation date of the invoice position item.
The service date from of the invoice position item.
The service date to of the invoice position item.
The applicated exchange rates of the invoice, fetched from the european central bank.
The einvoice generated xml file format.
The leitwegid used for einvoice. This is only set, when the eInvoiceType is not 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
The earliest service date of all positions.
The latest service date of all positions.
Public url to view the detailed usage breakdown of this invoice.
Dunning is disabled for this invoice.
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.