Skip to main content
PATCH
Update 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.

If-Match
string

Apply the change only while the current ETag matches one of the supplied validators (or *); otherwise the request fails with 412 precondition_failed and nothing is written.

Path Parameters

id
string<uuid>
required

UUID of the debtor in this request.

Body

application/json

Metadata and events are create-and-read only.

acting_as
enum<string>

Whether the debtor incurred the obligation as a consumer or in a business capacity. When changing it, update person, organization, and legal_form together to form a valid identity.

Available options:
consumer,
business
addresses
object[]

Postal addresses for the debtor. Supplied arrays replace the entire collection; [] clears it and omission leaves it unchanged. Include an existing child id to retain that entry. A non-empty list must have exactly one primary address; an order requires at least one complete address before finalization. Maximum 5 entries.

Maximum array length: 5
bank_accounts
object[]

Known bank accounts for the debtor. Supplied arrays replace the entire collection; [] clears it and omission leaves it unchanged. Include an existing child id to retain that entry. Duplicate IBANs are rejected. Maximum 10 entries.

Maximum array length: 10
communication_channels
object[]

Email addresses and telephone numbers for the debtor. Supplied arrays replace the entire collection; [] clears it and omission leaves it unchanged. Include an existing child id to retain that entry. Duplicate type/value pairs are rejected. Maximum 10 entries.

Maximum array length: 10

Optional permanent code from GET /v2/legal-forms/. Null or an empty string clears it; consumers cannot supply a code. A supplied catalog group determines the permitted identity. Omission preserves the current value.

Legal representatives for the debtor. Supplied arrays replace the entire collection; [] clears it and omission leaves it unchanged. Include an existing child id to retain that entry. Representative nesting is limited to two levels. Maximum 10 entries.

Maximum array length: 10

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

organization
object | null

Organization identity for business legal forms outside the privatperson and einzelkaufmann groups. Supplied properties update the current organization; omission leaves it unchanged and null removes it. The resulting debtor must retain a valid identity.

person
object | null

Natural-person identity for consumers and business legal forms in the privatperson or einzelkaufmann group. Supplied properties update the current person; omission leaves it unchanged and null removes it. The resulting debtor must retain a valid identity.

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.