Get dunning documents

GET

dunning

documents

curl -X GET \
 /dunning/documents \
 --header "Authorization: Bearer <token>"

{
  "data": [
    {
      "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",
        "companyName": "Acme Inc.",
        "datevId": "123456789",
        "status": "STATUS_ACTIVE"
      },
      "documentDate": "2023-11-07T05:31:56Z",
      "dueDate": "2023-11-07T05:31:56Z",
      "media": {
        "id": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ",
        "mimeType": "image/jpeg",
        "fileExtension": "jpg",
        "fileName": "invoice.jpg"
      },
      "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",
          "companyName": "Acme Inc.",
          "datevId": "123456789",
          "status": "STATUS_ACTIVE"
        },
        "paymentMethod": {
          "id": "<string>",
          "gatewayName": "wallet",
          "type": "sepa_debit",
          "default": true,
          "status": "active",
          "enabled": true,
          "name": "<string>",
          "creationDate": "2023-11-07T05:31:56Z",
          "expirationDate": "2023-11-07T05:31:56Z"
        },
        "type": "TYPE_INVOICE",
        "currencyCode": "EUR",
        "number": "RE-0000000001",
        "status": "STATUS_DRAFT",
        "finalizationDate": "2023-11-07T05:31:56Z",
        "dueDate": "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.",
        "netAmount": {},
        "grossAmount": {},
        "taxAmount": {},
        "customFields": {
          "field1": "value1",
          "field2": "value2"
        },
        "unpaidAmount": {}
      },
      "level": 123,
      "type": "reminder",
      "status": "<any>",
      "reason": "<string>",
      "dunningFeeCents": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "invoiceNumber": "<string>",
      "dunningFee": {},
      "number": "<string>"
    }
  ],
  "meta": {
    "pagination": {
      "totalItems": 123,
      "itemsPerPage": 123,
      "currentPage": 123,
      "lastPage": 123,
      "pageTotalItems": 123
    }
  }
}

Authorizations

Authorization

string

header

required

Value for the Authorization header parameter.

Query Parameters

page

integer

default:1

The collection page number

limit

integer

default:30

The number of items per page

Required range: 0 <= x <= 100

invoice

string

invoice[]

string[]

customer

string

customer[]

string[]

status

string

status[]

string[]

type

string

type[]

string[]

order[documentDate]

enum<string>

Available options:

asc,

desc

order[dueDate]

enum<string>

Available options:

asc,

desc

order[level]

enum<string>

Available options:

asc,

desc

order[type]

enum<string>

Available options:

asc,

desc

Response

200

application/json

DunningDocument collection

data

object[]

data.id

string

The id of the dunning document

Example:

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

data.customer

object

The customer of the dunning document

data.documentDate

string

The document date of the dunning document

data.dueDate

string

The due date until when the invoice should be paid

data.media

object | null

data.invoice

object

The invoice for which this dunning document was created

data.invoice.id

string

The unique identifier of the invoice.

Example:

"00000000-0000-0000-0000-000000000000"

data.invoice.customer

object

The customer of the invoice.

data.invoice.paymentMethod

object | null

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

data.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"

data.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"

data.invoice.number

string

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

Example:

"RE-0000000001"

data.invoice.status

enum<string>

Available options:

STATUS_DRAFT,

STATUS_PAID,

STATUS_CANCELLED,

STATUS_CLOSED,

STATUS_REFUNDED,

STATUS_REMINDED,

STATUS_UNPAID,

STATUS_NEW,

STATUS_FINALIZING

data.invoice.finalizationDate

string | null

data.invoice.dueDate

string | null

data.invoice.dunningLevel

integer

data.invoice.dunningStatus

enum<string>

default:none

Available options:

reminder,

dunning,

none

Example:

"none"

data.invoice.payDate

string | null

data.invoice.invoiceAddress

any | null

The invoice address of the invoice.

data.invoice.internalNote

string | null

deprecated

The notice of the invoice.

Example:

"This invoice is with a special discount."

data.invoice.netAmount

object

The net amount of the invoice.

data.invoice.grossAmount

object

data.invoice.taxAmount

object

data.invoice.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" }

data.invoice.unpaidAmount

object

data.level

integer

The level of the current dunning document

data.type

enum<string>

The type of the current dunning document

Available options:

reminder,

dunning

data.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.

data.reason

string | null

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

data.dunningFeeCents

integer | null

The dunning fee in cents for this dunning document. This is only relevant for dunning documents of type "dunning".

data.createdAt

string

data.updatedAt

string

data.invoiceNumber

string

data.dunningFee

object | null

data.number

string

meta

object

Get billing run details for an invoice Get dunning document

curl -X GET \
 /dunning/documents \
 --header "Authorization: Bearer <token>"

{
  "data": [
    {
      "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",
        "companyName": "Acme Inc.",
        "datevId": "123456789",
        "status": "STATUS_ACTIVE"
      },
      "documentDate": "2023-11-07T05:31:56Z",
      "dueDate": "2023-11-07T05:31:56Z",
      "media": {
        "id": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ",
        "mimeType": "image/jpeg",
        "fileExtension": "jpg",
        "fileName": "invoice.jpg"
      },
      "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",
          "companyName": "Acme Inc.",
          "datevId": "123456789",
          "status": "STATUS_ACTIVE"
        },
        "paymentMethod": {
          "id": "<string>",
          "gatewayName": "wallet",
          "type": "sepa_debit",
          "default": true,
          "status": "active",
          "enabled": true,
          "name": "<string>",
          "creationDate": "2023-11-07T05:31:56Z",
          "expirationDate": "2023-11-07T05:31:56Z"
        },
        "type": "TYPE_INVOICE",
        "currencyCode": "EUR",
        "number": "RE-0000000001",
        "status": "STATUS_DRAFT",
        "finalizationDate": "2023-11-07T05:31:56Z",
        "dueDate": "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.",
        "netAmount": {},
        "grossAmount": {},
        "taxAmount": {},
        "customFields": {
          "field1": "value1",
          "field2": "value2"
        },
        "unpaidAmount": {}
      },
      "level": 123,
      "type": "reminder",
      "status": "<any>",
      "reason": "<string>",
      "dunningFeeCents": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "invoiceNumber": "<string>",
      "dunningFee": {},
      "number": "<string>"
    }
  ],
  "meta": {
    "pagination": {
      "totalItems": 123,
      "itemsPerPage": 123,
      "currentPage": 123,
      "lastPage": 123,
      "pageTotalItems": 123
    }
  }
}

API documentation

User

Tenant

Feature

Entitlement

User & permissions

Settings

Payment

Analytics

Customer

Billing

Dunning

Subscription

Offers

Catalogue

Checkout

Accounting

Taxes

Get dunning documents

Authorizations

Query Parameters

Response