Skip to main content
POST
Create debtor

Authorizations

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.

Idempotency-Key
string
required

Required client-supplied command key scoped to the selected Case company or Partner owner, method, operation and path. An exact retry replays the original response while it is retained, including after credential rotation or replacement. Current permissions are required.

Maximum string length: 255

Body

application/json

Unknown and read-only request fields are rejected with a validation error instead of being silently ignored.

acting_as
enum<string>
required

Whether the debtor incurred the obligation as a consumer or in a business capacity. Required when creating a debtor; this choice determines the permitted identity and legal form.

Available options:
consumer
person
object
required

Natural-person identity, required for consumers and business legal forms in the privatperson or einzelkaufmann group. Also permitted for businesses without a legal form. Supply first_name and last_name; consumer salutation is optional. Organization must be absent or null.

Optional permanent code from GET /v2/legal-forms/; omit it or supply null or an empty string when unknown. Consumers cannot supply a code. The catalog group determines whether person or organization is required.

Available options:
null,
organization
object · null · null

Organization identity, required for business legal forms outside the privatperson and einzelkaufmann groups, or when no legal form is supplied. Supply name; person must be absent or null. Consumers cannot use this field.

addresses
object[]

Postal addresses. A debtor can be created without addresses, but at least one complete address is required before an order can be finalized. A non-empty list must have exactly one primary address. Maximum 5 entries.

Maximum array length: 5
bank_accounts
object[]

Known bank accounts belonging to the debtor. Maximum 10 entries.

Maximum array length: 10
communication_channels
object[]

Email addresses and telephone numbers for the debtor. Maximum 10 entries.

Maximum array length: 10
events
object[]

Contextual events supplied when creating the debtor.

People or organizations legally representing the debtor. Maximum 10 entries. Representative nesting is limited to two levels, with at most 10 second-level representatives per first-level representative.

Maximum array length: 10

Unknown and read-only request fields are rejected with a validation error instead of being silently ignored.

metadata
object[]

Metadata supplied when creating the debtor; duplicate types are allowed.

your_reference
string | null

Your reference for this debtor. Blank is stored as null.

Maximum string length: 255

Response

acting_as
enum<string>
required

Whether the debtor incurred the obligation as a consumer or in a business capacity.

  • consumer - consumer
  • business - business
Available options:
consumer,
business
addresses
object[]
required
read-only

Postal addresses associated with the debtor. API submissions are limited to 5 entries.

bank_accounts
object[]
required
read-only

Known bank accounts belonging to the debtor. API submissions are limited to 10 entries.

communication_channels
object[]
required
read-only

Email addresses and telephone numbers for the debtor. API submissions are limited to 10 entries.

created_at
string<date-time>
required
read-only

Time at which the debtor was created.

events
object[]
required
read-only

Stored contextual events associated with this resource.

id
string<uuid>
required
read-only

Stable identifier of this debtor.

Permanent public legal-form code; look up its label and representation rules with GET /v2/legal-forms/. Null for consumers.

People or organizations legally representing the debtor. API submissions are limited to 10 entries.

metadata
object[]
required
read-only

Stored metadata entries; duplicate types remain separate entries.

organization
object | null
required

Organization identity for a business debtor.

person
object | null
required

Natural-person identity for a consumer or sole proprietor.

updated_at
string<date-time>
required
read-only

Time at which the debtor was last updated.

your_reference
string | null
required
read-only

Your reference for this debtor.