Get administration debtor by id

{ "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 }

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

Debtor identifier

Query Parameters

administration_id

string

required

Administration identifier

identifier_type

string

Type of debtor identifier to use (can be 'debtor_number', 'debtor_identifier' or left blank to use internal id)

fields

object

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

Response

Debtor

CustomerApi_V1_DebtorEntity model

call_phone_number

string

required

Phone number to call

coc_number

string

required

CoC number

credit_limit_amount

string

required

Credit limit amount in administration currency

debtor_provided_email_address

string

required

Email address provided by debtor

debtor_number

string

required

Debtor number

primary_email_address

string

required

Primary email address

invoice_bcc_email_address

string

required

Invoice BCC email address

invoice_cc_email_address

string

required

Invoice CC email address

invoice_email_address

string

required

Invoice email address

language_code

string

required

Language used in communication

name

string

required

Name

debtor_identifier

string

required

Debtor identifier from accounting software

postal_address

object

required

Postal address

Show child attributes

relation_manager

string

required

Relation manager

reminder_bcc_email_address

string

required

Reminder BCC email address

reminder_cc_email_address

string

required

Reminder CC email address

reminder_email_address

string

required

Reminder email address

sms_phone_number

string

required

Phone number to send SMS to

vat_number

string

required

VAT number

administration_id

string

required

Owning administration identifier

string

required

Unique identifier

paused_at

string<date-time>

required

Timestamp at which the debtor was paused

reminding_paused_at

string<date-time>

required

Timestamp at which sending reminders for the debtor was paused

updated_at

string<date-time>

required

Timestamp at which the debtor was last updated

book_open_amount

string

Open amount in administration currency (request with the 'fields' parameter)

public_url

string

Link to the debtor portal (request with the 'fields' parameter)

deeplink_url

string

URL to the debtor in the debtor management interface (request with the 'fields' parameter)

internal_note_email_address

string

Internal note email address

labels

object[]

Labels (request with the 'fields' parameter)

Show child attributes

payment_behaviour

integer<int32>

Payment behaviour (request with the 'fields' parameter)

peppol_identifier

string

Peppol identifier (request with the 'fields' parameter)

remark

string

Remark (request with the 'fields' parameter)

peppol_enabled

boolean

Debtor Peppol override (true/false). Null means fallback to administration setting (request with the 'fields' parameter)