import requests
url = "https://api.paywise.de/v2/debtors/{id}/"
payload = {}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://api.paywise.de/v2/debtors/{id}/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.patch("https://api.paywise.de/v2/debtors/{id}/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{}")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.paywise.de/v2/debtors/{id}/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{}", false);
var response = await client.PatchAsync(request);
Console.WriteLine("{0}", response.Content);
curl --request PATCH \
--url https://api.paywise.de/v2/debtors/{id}/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'{
"acting_as": "consumer",
"addresses": [
{
"city": "<string>",
"country": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"postal_code": "<string>",
"primary": true,
"street": "<string>"
}
],
"bank_accounts": [
{
"account_holder": "<string>",
"bic": "<string>",
"iban": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"communication_channels": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>",
"value": "<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>",
"legal_representatives": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"legal_form": "<string>",
"legal_representatives": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"legal_form": "<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"
},
"role": "managing_director"
}
],
"organization": {
"commercial_register": "<string>",
"commercial_registration_number": "<string>",
"name": "<string>"
},
"person": {
"birth_date": "2023-12-25",
"first_name": "<string>",
"last_name": "<string>",
"salutation": "mr"
},
"role": "managing_director"
}
],
"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>"
}{
"code": "validation_error",
"detail": "The request contains invalid data.",
"errors": [
{
"code": "invalid",
"field": "claims[0].due_date",
"message": "Due date must not precede the document date."
}
]
}{
"code": "not_authenticated",
"detail": "Authentication credentials were not provided."
}{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"code": "not_found",
"detail": "The requested resource was not found."
}{
"code": "conflict",
"detail": "The resource changed state and cannot accept this command."
}{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}Update debtor
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.
import requests
url = "https://api.paywise.de/v2/debtors/{id}/"
payload = {}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://api.paywise.de/v2/debtors/{id}/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.patch("https://api.paywise.de/v2/debtors/{id}/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{}")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.paywise.de/v2/debtors/{id}/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{}", false);
var response = await client.PatchAsync(request);
Console.WriteLine("{0}", response.Content);
curl --request PATCH \
--url https://api.paywise.de/v2/debtors/{id}/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'{
"acting_as": "consumer",
"addresses": [
{
"city": "<string>",
"country": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"postal_code": "<string>",
"primary": true,
"street": "<string>"
}
],
"bank_accounts": [
{
"account_holder": "<string>",
"bic": "<string>",
"iban": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"communication_channels": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>",
"value": "<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>",
"legal_representatives": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"legal_form": "<string>",
"legal_representatives": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"legal_form": "<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"
},
"role": "managing_director"
}
],
"organization": {
"commercial_register": "<string>",
"commercial_registration_number": "<string>",
"name": "<string>"
},
"person": {
"birth_date": "2023-12-25",
"first_name": "<string>",
"last_name": "<string>",
"salutation": "mr"
},
"role": "managing_director"
}
],
"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>"
}{
"code": "validation_error",
"detail": "The request contains invalid data.",
"errors": [
{
"code": "invalid",
"field": "claims[0].due_date",
"message": "Due date must not precede the document date."
}
]
}{
"code": "not_authenticated",
"detail": "Authentication credentials were not provided."
}{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"code": "not_found",
"detail": "The requested resource was not found."
}{
"code": "conflict",
"detail": "The resource changed state and cannot accept this command."
}{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}Authorizations
Company-bound Case Management API key — the standard credential for this API.
Headers
Required when a Partner key calls the Case Management API; rejected for direct Case keys. Contains the entitled paywise company UUID.
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
UUID of the debtor in this request.
Body
Metadata and events are create-and-read only.
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.
consumer, business 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.
5Show child attributes
Show child attributes
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.
10Show child attributes
Show child attributes
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.
10Show child attributes
Show child attributes
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.
10Unknown and read-only request fields are rejected with a validation error instead of being silently ignored.
- Person identity
- Organization identity
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
Your reference for this debtor. Blank is stored as null.
255Response
Whether the debtor incurred the obligation as a consumer or in a business capacity.
consumer- consumerbusiness- business
consumer, business Postal addresses associated with the debtor. API submissions are limited to 5 entries.
Show child attributes
Show child attributes
Known bank accounts belonging to the debtor. API submissions are limited to 10 entries.
Show child attributes
Show child attributes
Email addresses and telephone numbers for the debtor. API submissions are limited to 10 entries.
Show child attributes
Show child attributes
Time at which the debtor was created.
Stored contextual events associated with this resource.
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
Stored metadata entries; duplicate types remain separate entries.
Show child attributes
Show child attributes
Organization identity for a business debtor.
Show child attributes
Show child attributes
Natural-person identity for a consumer or sole proprietor.
Show child attributes
Show child attributes
Time at which the debtor was last updated.
Your reference for this debtor.
