Skip to main content
GET
/
v1
/
debtors
Get administration debtors
curl --request GET \
  --url https://api.paytsoftware.com/v1/debtors \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "call_phone_number": "<string>",
      "coc_number": "<string>",
      "credit_limit_amount": "<string>",
      "debtor_provided_email_address": "<string>",
      "debtor_number": "<string>",
      "primary_email_address": "<string>",
      "invoice_bcc_email_address": "<string>",
      "invoice_cc_email_address": "<string>",
      "invoice_email_address": "<string>",
      "language_code": "<string>",
      "name": "<string>",
      "debtor_identifier": "<string>",
      "postal_address": {
        "city": "<string>",
        "country_code": "<string>",
        "postal_code": "<string>",
        "region": "<string>",
        "street_1": "<string>",
        "street_2": "<string>"
      },
      "relation_manager": "<string>",
      "reminder_bcc_email_address": "<string>",
      "reminder_cc_email_address": "<string>",
      "reminder_email_address": "<string>",
      "sms_phone_number": "<string>",
      "vat_number": "<string>",
      "administration_id": "<string>",
      "id": "<string>",
      "paused_at": "2023-11-07T05:31:56Z",
      "reminding_paused_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "book_open_amount": "<string>",
      "public_url": "<string>",
      "deeplink_url": "<string>",
      "internal_note_email_address": "<string>",
      "labels": [
        {
          "name": "<string>"
        }
      ],
      "payment_behaviour": 123,
      "peppol_identifier": "<string>",
      "remark": "<string>",
      "peppol_enabled": true
    }
  ],
  "pagination": {
    "cursor": "<string>"
  }
}

Authorizations

Authorization
string
header
required

OAuth2 access token or static API token. See Authorization for how to obtain one.

Query Parameters

administration_id
string
required

Administration identifier

ids
string

Filter debtors with a comma separated list of internal ids

debtor_numbers
string

Filter debtors with a comma separated list of debtor numbers

debtor_identifiers
string

Filter debtors with a comma separated list of debtor identifiers from your accounting software

updated_after
string<date-time>

ISO8601 UTC Timestamp to filter records updated after it

fields
object

JSON object defining fields to receive (e.g {"only": ["field1", {"field2": ["field3"]}]})

cursor
string

The record identifier after which to start the page

per_page
integer<int32>
default:100

How many records will be returned per page, (1..500), defaults to 100

Required range: 1 <= x <= 500

Response

Paginated list of debtors

CustomerApi_DebtorsPageEntity model

data
object[]
required

Debtor

pagination
object

Pagination details

Last modified on June 12, 2026