GET
/
dunning
/
documents
cURL
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

The response is of type object.