List debtors

The reusable debtors of your company.

List, retrieve, create, and PATCH. A supplied owned collection (addresses, bank accounts, communication channels, legal representatives) replaces that collection completely; omitted collections stay unchanged. A case’s debtor is the case’s own snapshot (published as MandateDebtor without an id) and is not a reusable debtor: it is neither listed nor readable here.

GET /v2/debtors/

List debtors

Python

import requests

url = "https://api.paywise.de/v2/debtors/"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

200

{
  "count": 123,
  "results": [
    {
      "acting_as": "consumer",
      "addresses": [
        {
          "city": "<string>",
          "country": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "postal_code": "<string>",
          "primary": true,
          "street": "<string>"
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "events": [
        {
          "description": "<string>",
          "location": "<string>",
          "occurence": "2023-11-07T05:31:56Z",
          "title": "<string>",
          "type": "<string>",
          "your_reference": "<string>"
        }
      ],
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "legal_form": "<string>",
      "metadata": [
        {
          "type": "<string>",
          "value": "<string>"
        }
      ],
      "organization": {
        "commercial_register": "<string>",
        "commercial_registration_number": "<string>",
        "name": "<string>"
      },
      "person": {
        "birth_date": "2023-12-25",
        "first_name": "<string>",
        "last_name": "<string>",
        "salutation": "mr"
      },
      "updated_at": "2023-11-07T05:31:56Z",
      "your_reference": "<string>"
    }
  ],
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

Authorizations

caseBearerAuthpartnerBearerAuth

Authorization · string · header · required

Company-bound Case Management API key — the standard credential for this API.

Headers

X-On-Behalf-Of-Company · string<uuid>

Required when a Partner key calls the Case Management API; rejected for direct Case keys. Contains the entitled paywise company UUID.

Query Parameters

acting_as · enum<string>

Exact capacity in which the debtor incurred the obligation: consumer or business.

Available options: business, consumer

cursor · string

Opaque continuation cursor for incremental synchronization, taken from the next URL of a previous page. Only valid together with updated_since: with updated_since set the list is ordered by change time and then id and pages by this cursor instead of offset, so a row that changes while you page is returned again later instead of pushing another row out of the result. Rows changed less than 60 seconds ago are held back until they are settled; use the largest updated_at you received as the next updated_since.

id · string<uuid>

Return the debtor with this UUID.

limit · integer · default: 10

Number of results to return (maximum 100).

Required range: 1 <= x <= 100

offset · integer · default: 0

Zero-based result offset. Cannot be combined with updated_since; follow the next URL (cursor) instead.

Required range: x >= 0

updated_since · string<date-time>

Return rows changed at or after this timezone-aware RFC 3339 timestamp. Results are ordered by updated_at and id (a requested ordering is ignored), page by cursor instead of offset, and rows changed less than a minute ago are held back.

your_reference · string

Case-insensitive substring of your debtor reference.

Response

200

application/json

count · integer · required

Total number of matching resources.

Example:

123

results · object[] · required

Resources returned for the requested page.

Show child attributes

next · string<uri> | null

URL for the next page, or null when this is the last page. With updated_since it carries an opaque cursor.

Example:

"http://api.example.org/accounts/?offset=400&limit=100"

previous · string<uri> | null

URL for the previous page, or null when this is the first page. Always null with updated_since.

Example:

"http://api.example.org/accounts/?offset=200&limit=100"