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);
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.
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);
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
Show child attributes
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
Show child attributes
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
Show child attributes
legal_form
string | null
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
object[]
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
Show child attributes
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.
Show child attributes
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.
Show child attributes
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.
Show child attributes
bank_accounts
object[]
required
read-only
Known bank accounts belonging to the debtor. API submissions are limited to 10 entries.
Show child attributes
communication_channels
object[]
required
read-only
Email addresses and telephone numbers for the debtor. API submissions are limited to 10 entries.
Show child attributes
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.
Show child attributes
id
string<uuid>
required
read-only
Stable identifier of this debtor.
legal_form
string | null
required
read-only
Permanent public legal-form code; look up its label and representation rules with GET /v2/legal-forms/. Null for consumers.
legal_representatives
object[]
required
read-only
People or organizations legally representing the debtor. API submissions are limited to 10 entries.
Show child attributes
metadata
object[]
required
read-only
Stored metadata entries; duplicate types remain separate entries.
Show child attributes
organization
object | null
required
Organization identity for a business debtor.
Show child attributes
person
object | null
required
Natural-person identity for a consumer or sole proprietor.
Show child attributes
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.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"paywise Knowledge Center","colors":{"primary":"#fd7e14","light":"#6a9bf4","dark":"#37384e"},"logo":{"light":"https://mintcdn.com/paywisegmbh/NM1UIIld1WRHivnS/logo/paywise-logo.svg?fit=max\u0026auto=format\u0026n=NM1UIIld1WRHivnS\u0026q=85\u0026s=0d1a1b06e878f9d25ef70b19e3df50cc","dark":"https://mintcdn.com/paywisegmbh/NM1UIIld1WRHivnS/logo/paywise-logo-light.png?fit=max\u0026auto=format\u0026n=NM1UIIld1WRHivnS\u0026q=85\u0026s=ab0f73c7353586d673c947dc946db86b"},"favicon":"https://mintcdn.com/paywisegmbh/NM1UIIld1WRHivnS/favicon-32x32.png?fit=max\u0026auto=format\u0026n=NM1UIIld1WRHivnS\u0026q=85\u0026s=f1eaf1b6461ee62ec891fd1a5309f891","api":{"examples":{"defaults":"required","languages":["python","javascript","java","csharp","curl"],"prefill":true,"autogenerate":true}},"navbar":{"links":[{"href":"mailto:[email protected]","label":"Kontakt"}],"primary":{"type":"button","label":"Login","href":"https://app.paywise.de/account/"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/paywise-gmbh","github":"https://github.com/paywise-gmbh"}},"contextual":{"options":["copy","view","chatgpt","claude","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"languages":[{"language":"de","default":true,"href":"user-docs/overview"},{"language":"en","href":"en/user-docs/overview"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"paywisegmbh","hasAudioNarration":false,"actualSubdomain":"paywisegmbh","customDomains":["docs.paywise.de"],"gitSource":{"type":"github","owner":"paywise-gmbh","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{},"buildId":"6af19bb3e7b89d498acbc16f","clientVersion":"0.0.4227","searchFilterCounts":[{"language":"en","tag":"Technical documentation","count":287},{"language":"en","tag":"Case Management API","count":135},{"language":"en","tag":"Case Management API reference","count":112},{"language":"en","tag":"Legacy APIs (v1)","count":68},{"language":"en","tag":"Frozen Case Management API","count":50},{"language":"en","tag":"Partner API","count":42},{"language":"en","tag":"Frozen Case Management API reference","count":40},{"language":"en","tag":"Mahnservice API","count":28},{"language":"en","tag":"Mandates","count":28},{"language":"en","tag":"Partner API reference","count":27},{"language":"de","tag":"Integrationen","count":20},{"language":"de","tag":"Buchhaltungs-Integrationen","count":15},{"language":"de","tag":"Anwenderdokumentation","count":12},{"language":"de","tag":"Mahnservice","count":10},{"language":"de","tag":"DATEV","count":5},{"language":"de","tag":"Technische Dokumentation","count":1},{"language":"de","tag":"Verwaltung","count":1}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"svg[data-pw-icon]{color:#fd7e14}html.dark svg[data-pw-icon]{color:#6a9bf4}img.sidebar-group-icon[src$=\"case-api.svg\"],img.sidebar-group-icon[src$=\"partner-api.svg\"],img.sidebar-group-icon[src$=\"mahnservice-api.svg\"]{content:url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'%3E%3C/svg%3E\");background-color:#fd7e14!important;-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;-webkit-mask-size:contain;mask-repeat:no-repeat;mask-position:center;mask-size:contain}img.sidebar-group-icon[src$=\"case-api.svg\"]{-webkit-mask-image:url(\"/images/icons/case-api.svg\");mask-image:url(\"/images/icons/case-api.svg\")}img.sidebar-group-icon[src$=\"partner-api.svg\"]{-webkit-mask-image:url(\"/images/icons/partner-api.svg\");mask-image:url(\"/images/icons/partner-api.svg\")}img.sidebar-group-icon[src$=\"mahnservice-api.svg\"]{-webkit-mask-image:url(\"/images/icons/mahnservice-api.svg\");mask-image:url(\"/images/icons/mahnservice-api.svg\")}html.dark img.sidebar-group-icon[src$=\"case-api.svg\"],html.dark img.sidebar-group-icon[src$=\"partner-api.svg\"],html.dark img.sidebar-group-icon[src$=\"mahnservice-api.svg\"]{background-color:#6a9bf4!important}.pw-download-button{background-color:#fd7e14;color:#fff}html.dark .pw-download-button{background-color:#6a9bf4;color:#111}.mermaid .edgeLabel,.mermaid .edgeLabel rect,.mermaid .edgeLabel .label-container{background-color:transparent!important;fill:transparent!important}"}]}
{"page":{"pagePath":"api-docs/case-management-api/reference/debtors/update-debtor","slug":"/api-docs/case-management-api/reference/debtors/update-debtor","pageMetadata":{"title":"Update debtor","description":"The reusable debtors of your company.\n\nList, retrieve, create, and PATCH. A supplied owned collection\n(addresses, bank accounts, communication channels, legal\nrepresentatives) replaces that collection completely; omitted\ncollections stay unchanged. A case's debtor is the case's own snapshot\n(published as `MandateDebtor` without an id) and is not a reusable\ndebtor: it is neither listed nor readable here.","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json patch /v2/debtors/{id}/","href":"/api-docs/case-management-api/reference/debtors/update-debtor","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"The reusable debtors of your company.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"List, retrieve, create, and PATCH. A supplied owned collection\\n(addresses, bank accounts, communication channels, legal\\nrepresentatives) replaces that collection completely; omitted\\ncollections stay unchanged. A case’s debtor is the case’s own snapshot\\n(published as \", _jsx(_components.code, {\n children: \"MandateDebtor\"\n }), \" without an id) and is not a reusable\\ndebtor: it is neither listed nor readable here.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Update debtor","description":"The reusable debtors of your company.\n\nList, retrieve, create, and PATCH. A supplied owned collection\n(addresses, bank accounts, communication channels, legal\nrepresentatives) replaces that collection completely; omitted\ncollections stay unchanged. A case's debtor is the case's own snapshot\n(published as `MandateDebtor` without an id) and is not a reusable\ndebtor: it is neither listed nor readable here.","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json patch /v2/debtors/{id}/","href":"/api-docs/case-management-api/reference/debtors/update-debtor","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/paywisegmbh/c0e4bbe3e0c9277e/api-field-anchors.js"],"openApiReferenceData":{"operation":{"description":"The reusable debtors of your company.\n\nList, retrieve, create, and PATCH. A supplied owned collection\n(addresses, bank accounts, communication channels, legal\nrepresentatives) replaces that collection completely; omitted\ncollections stay unchanged. A case's debtor is the case's own snapshot\n(published as `MandateDebtor` without an id) and is not a reusable\ndebtor: it is neither listed nor readable here.","operationId":"update-debtor","parameters":["6a11fda5-71af-417e-ad77-68cc003333c3","3f1e64d5-b164-434c-9da5-e764ea32be8b","44322944-e267-47c9-ab6d-f939dd4bf450"],"requestBody":"f939f906-75fa-41f8-aebd-94180226be24","responses":{"200":"9a9977c3-233e-4328-b9ac-62e7c0db9044","400":"55e56235-4ef9-4824-9958-06d092a10ad8","401":"ccafaaa3-38fb-4ded-a963-82a0655c440f","403":"370835a1-7e98-4e42-a197-930ab566f98a","404":"c2b721d6-33fd-40a1-842b-67dc51652def","409":"08b7c47a-c14b-48e0-b033-cf93c1262418","412":"e90361ba-cea0-4e4d-83f3-245e9d1156a7","429":"95839bdc-63bc-4df8-a2e4-a713c0a88d21","500":"5cdade80-9d67-41ad-abb5-fafee028f2fc"},"security":["75a46804-125e-4572-8c06-060341a38311","d4c79fcf-4c56-49f5-bb70-f70b419767aa"],"summary":"Update debtor","tags":["Debtors"],"x-required-scopes":["case:debtors:write"],"method":"patch","type":"path","servers":["8c8f8cc6-b41f-4cad-9749-5ef9c02d1396","554ab33b-0043-40a7-a452-cca88c2fcfe6"],"path":"/v2/debtors/{id}/","baseUrlOptions":["https://api.paywise.de","https://api-sandbox.paywise.de"],"title":"Update debtor","codeSamples":[],"requestExampleLanguages":["python","javascript","java","csharp","bash"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.communication_channels.items.0.type":"email","body.communication_channels.items.0.value":"[email protected]","body.communication_channels.items.1.type":"mobile_phone","body.communication_channels.items.1.value":"+4915123456789","body.your_reference.oneOf.0":"CUSTOMER-1001-UPDATED"}]},"dependencies":{"parameters":{"6a11fda5-71af-417e-ad77-68cc003333c3":{"description":"Required when a Partner key calls the Case Management API; rejected for direct Case keys. Contains the entitled paywise company UUID.","in":"header","name":"X-On-Behalf-Of-Company","schema":{"format":"uuid","type":"string","description":"Required when a Partner key calls the Case Management API; rejected for direct Case keys. Contains the entitled paywise company UUID.","uniqueKey":"","typeLabel":"string\u003cuuid>"}},"3f1e64d5-b164-434c-9da5-e764ea32be8b":{"description":"UUID of the debtor in this request.","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string","isRequired":true,"description":"UUID of the debtor in this request.","uniqueKey":"","typeLabel":"string\u003cuuid>"}},"44322944-e267-47c9-ab6d-f939dd4bf450":{"description":"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.","in":"header","name":"If-Match","required":false,"schema":{"type":"string","isRequired":false,"description":"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.","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"examples":{"debtor-aggregate-patch":{"title":"debtor-aggregate-patch","value":{"communication_channels":[{"type":"email","value":"[email protected]"},{"type":"mobile_phone","value":"+4915123456789"}],"your_reference":"CUSTOMER-1001-UPDATED"}}},"schema":{"description":"Metadata and events are create-and-read only.","properties":{"acting_as":{"type":"string","description":"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.","enum":["consumer","business"],"uniqueKey":"acting_as","typeLabel":"enum\u003cstring>"},"addresses":{"description":"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.","items":{"description":"Unknown and read-only request fields are rejected with a validation error instead of being silently ignored.","properties":{"city":{"description":"City or locality of the address.","maxLength":100,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"addresses.items.[INDEX].city","typeLabel":"string"},"country":{"type":"string","description":"Country as a two-letter ISO 3166-1 alpha-2 code.\n\n* `AF` - Afghanistan\n* `AX` - Åland Islands\n* `AL` - Albania\n* `DZ` - Algeria\n* `AS` - American Samoa\n* `AD` - Andorra\n* `AO` - Angola\n* `AI` - Anguilla\n* `AQ` - Antarctica\n* `AG` - Antigua and Barbuda\n* `AR` - Argentina\n* `AM` - Armenia\n* `AW` - Aruba\n* `AU` - Australia\n* `AT` - Austria\n* `AZ` - Azerbaijan\n* `BS` - Bahamas\n* `BH` - Bahrain\n* `BD` - Bangladesh\n* `BB` - Barbados\n* `BY` - Belarus\n* `BE` - Belgium\n* `BZ` - Belize\n* `BJ` - Benin\n* `BM` - Bermuda\n* `BT` - Bhutan\n* `BO` - Bolivia\n* `BQ` - Bonaire, Sint Eustatius and Saba\n* `BA` - Bosnia and Herzegovina\n* `BW` - Botswana\n* `BV` - Bouvet Island\n* `BR` - Brazil\n* `IO` - British Indian Ocean Territory\n* `BN` - Brunei\n* `BG` - Bulgaria\n* `BF` - Burkina Faso\n* `BI` - Burundi\n* `CV` - Cabo Verde\n* `KH` - Cambodia\n* `CM` - Cameroon\n* `CA` - Canada\n* `KY` - Cayman Islands\n* `CF` - Central African Republic\n* `TD` - Chad\n* `CL` - Chile\n* `CN` - China\n* `CX` - Christmas Island\n* `CC` - Cocos (Keeling) Islands\n* `CO` - Colombia\n* `KM` - Comoros\n* `CG` - Congo\n* `CD` - Congo (the Democratic Republic of the)\n* `CK` - Cook Islands\n* `CR` - Costa Rica\n* `CI` - Côte d'Ivoire\n* `HR` - Croatia\n* `CU` - Cuba\n* `CW` - Curaçao\n* `CY` - Cyprus\n* `CZ` - Czechia\n* `DK` - Denmark\n* `DJ` - Djibouti\n* `DM` - Dominica\n* `DO` - Dominican Republic\n* `EC` - Ecuador\n* `EG` - Egypt\n* `SV` - El Salvador\n* `GQ` - Equatorial Guinea\n* `ER` - Eritrea\n* `EE` - Estonia\n* `SZ` - Eswatini\n* `ET` - Ethiopia\n* `FK` - Falkland Islands (Malvinas)\n* `FO` - Faroe Islands\n* `FJ` - Fiji\n* `FI` - Finland\n* `FR` - France\n* `GF` - French Guiana\n* `PF` - French Polynesia\n* `TF` - French Southern Territories\n* `GA` - Gabon\n* `GM` - Gambia\n* `GE` - Georgia\n* `DE` - Germany\n* `GH` - Ghana\n* `GI` - Gibraltar\n* `GR` - Greece\n* `GL` - Greenland\n* `GD` - Grenada\n* `GP` - Guadeloupe\n* `GU` - Guam\n* `GT` - Guatemala\n* `GG` - Guernsey\n* `GN` - Guinea\n* `GW` - Guinea-Bissau\n* `GY` - Guyana\n* `HT` - Haiti\n* `HM` - Heard Island and McDonald Islands\n* `VA` - Holy See\n* `HN` - Honduras\n* `HK` - Hong Kong\n* `HU` - Hungary\n* `IS` - Iceland\n* `IN` - India\n* `ID` - Indonesia\n* `IR` - Iran\n* `IQ` - Iraq\n* `IE` - Ireland\n* `IM` - Isle of Man\n* `IL` - Israel\n* `IT` - Italy\n* `JM` - Jamaica\n* `JP` - Japan\n* `JE` - Jersey\n* `JO` - Jordan\n* `KZ` - Kazakhstan\n* `KE` - Kenya\n* `KI` - Kiribati\n* `XK` - Kosovo\n* `KW` - Kuwait\n* `KG` - Kyrgyzstan\n* `LA` - Laos\n* `LV` - Latvia\n* `LB` - Lebanon\n* `LS` - Lesotho\n* `LR` - Liberia\n* `LY` - Libya\n* `LI` - Liechtenstein\n* `LT` - Lithuania\n* `LU` - Luxembourg\n* `MO` - Macao\n* `MG` - Madagascar\n* `MW` - Malawi\n* `MY` - Malaysia\n* `MV` - Maldives\n* `ML` - Mali\n* `MT` - Malta\n* `MH` - Marshall Islands\n* `MQ` - Martinique\n* `MR` - Mauritania\n* `MU` - Mauritius\n* `YT` - Mayotte\n* `MX` - Mexico\n* `FM` - Micronesia\n* `MD` - Moldova\n* `MC` - Monaco\n* `MN` - Mongolia\n* `ME` - Montenegro\n* `MS` - Montserrat\n* `MA` - Morocco\n* `MZ` - Mozambique\n* `MM` - Myanmar\n* `NA` - Namibia\n* `NR` - Nauru\n* `NP` - Nepal\n* `NL` - Netherlands\n* `NC` - New Caledonia\n* `NZ` - New Zealand\n* `NI` - Nicaragua\n* `NE` - Niger\n* `NG` - Nigeria\n* `NU` - Niue\n* `NF` - Norfolk Island\n* `KP` - North Korea\n* `MK` - North Macedonia\n* `MP` - Northern Mariana Islands\n* `NO` - Norway\n* `OM` - Oman\n* `PK` - Pakistan\n* `PW` - Palau\n* `PS` - Palestine, State of\n* `PA` - Panama\n* `PG` - Papua New Guinea\n* `PY` - Paraguay\n* `PE` - Peru\n* `PH` - Philippines\n* `PN` - Pitcairn\n* `PL` - Poland\n* `PT` - Portugal\n* `PR` - Puerto Rico\n* `QA` - Qatar\n* `RE` - Réunion\n* `RO` - Romania\n* `RU` - Russia\n* `RW` - Rwanda\n* `BL` - Saint Barthélemy\n* `SH` - Saint Helena, Ascension and Tristan da Cunha\n* `KN` - Saint Kitts and Nevis\n* `LC` - Saint Lucia\n* `MF` - Saint Martin (French part)\n* `PM` - Saint Pierre and Miquelon\n* `VC` - Saint Vincent and the Grenadines\n* `WS` - Samoa\n* `SM` - San Marino\n* `ST` - Sao Tome and Principe\n* `SA` - Saudi Arabia\n* `SN` - Senegal\n* `RS` - Serbia\n* `SC` - Seychelles\n* `SL` - Sierra Leone\n* `SG` - Singapore\n* `SX` - Sint Maarten (Dutch part)\n* `SK` - Slovakia\n* `SI` - Slovenia\n* `SB` - Solomon Islands\n* `SO` - Somalia\n* `ZA` - South Africa\n* `GS` - South Georgia and the South Sandwich Islands\n* `KR` - South Korea\n* `SS` - South Sudan\n* `ES` - Spain\n* `LK` - Sri Lanka\n* `SD` - Sudan\n* `SR` - Suriname\n* `SJ` - Svalbard and Jan Mayen\n* `SE` - Sweden\n* `CH` - Switzerland\n* `SY` - Syria\n* `TW` - Taiwan\n* `TJ` - Tajikistan\n* `TZ` - Tanzania\n* `TH` - Thailand\n* `TL` - Timor-Leste\n* `TG` - Togo\n* `TK` - Tokelau\n* `TO` - Tonga\n* `TT` - Trinidad and Tobago\n* `TN` - Tunisia\n* `TR` - Türkiye\n* `TM` - Turkmenistan\n* `TC` - Turks and Caicos Islands\n* `TV` - Tuvalu\n* `UG` - Uganda\n* `UA` - Ukraine\n* `AE` - United Arab Emirates\n* `GB` - United Kingdom\n* `UM` - United States Minor Outlying Islands\n* `US` - United States of America\n* `UY` - Uruguay\n* `UZ` - Uzbekistan\n* `VU` - Vanuatu\n* `VE` - Venezuela\n* `VN` - Vietnam\n* `VG` - Virgin Islands (British)\n* `VI` - Virgin Islands (U.S.)\n* `WF` - Wallis and Futuna\n* `EH` - Western Sahara\n* `YE` - Yemen\n* `ZM` - Zambia\n* `ZW` - Zimbabwe","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","CV","KH","CM","CA","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","SZ","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","XK","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","KP","MK","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","KR","SS","ES","LK","SD","SR","SJ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","US","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"isRequired":true,"uniqueKey":"addresses.items.[INDEX].country","typeLabel":"enum\u003cstring>"},"postal_code":{"description":"Postal code of the address.","maxLength":100,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"addresses.items.[INDEX].postal_code","typeLabel":"string"},"street":{"description":"Street and house number.","maxLength":255,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"addresses.items.[INDEX].street","typeLabel":"string"},"id":{"description":"Existing address identifier to retain when replacing its collection. Omit for a new entry; supplied identifiers must belong to this parent and occur only once.","format":"uuid","type":"string","uniqueKey":"addresses.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"primary":{"description":"Whether this is the debtor's primary postal address. A single address defaults to primary when omitted; with multiple addresses, supply this flag on each and set exactly one to true.","type":"boolean","uniqueKey":"addresses.items.[INDEX].primary","typeLabel":"boolean"}},"required":["city","country","postal_code","street"],"type":"object","uniqueKey":"addresses.items.[INDEX]","typeLabel":"object"},"maxItems":5,"type":"array","uniqueKey":"addresses","typeLabel":"object[]"},"bank_accounts":{"description":"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.","items":{"description":"Unknown and read-only request fields are rejected with a validation error instead of being silently ignored.","properties":{"iban":{"description":"IBAN of the debtor's bank account.","maxLength":34,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"bank_accounts.items.[INDEX].iban","typeLabel":"string"},"account_holder":{"default":"","description":"Name of the bank-account holder.","maxLength":255,"type":"string","uniqueKey":"bank_accounts.items.[INDEX].account_holder","typeLabel":"string"},"bic":{"oneOf":[{"description":"BIC/SWIFT code; required for non-German IBANs and checked for compatibility with the IBAN country.","maxLength":11,"minLength":1,"type":"string","uniqueKey":"bank_accounts.items.[INDEX].bic.oneOf.0","typeLabel":"string"},{"description":"BIC/SWIFT code; required for non-German IBANs and checked for compatibility with the IBAN country.","maxLength":11,"minLength":1,"type":"null","uniqueKey":"bank_accounts.items.[INDEX].bic.oneOf.1","typeLabel":"null"}],"uniqueKey":"bank_accounts.items.[INDEX].bic","typeLabel":"string | null"},"id":{"description":"Existing bank account identifier to retain when replacing its collection. Omit for a new entry; supplied identifiers must belong to this parent and occur only once.","format":"uuid","type":"string","uniqueKey":"bank_accounts.items.[INDEX].id","typeLabel":"string\u003cuuid>"}},"required":["iban"],"type":"object","uniqueKey":"bank_accounts.items.[INDEX]","typeLabel":"object"},"maxItems":10,"type":"array","uniqueKey":"bank_accounts","typeLabel":"object[]"},"communication_channels":{"description":"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.","items":{"description":"Unknown and read-only request fields are rejected with a validation error instead of being silently ignored.","properties":{"type":{"type":"string","description":"Kind of contact channel.\n\n* `email` - email\n* `phone` - phone\n* `mobile_phone` - mobile_phone","enum":["email","phone","mobile_phone"],"isRequired":true,"uniqueKey":"communication_channels.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"value":{"description":"Email address for email channels, or a telephone number for phone and mobile_phone channels. Telephone numbers are normalized and validated as E.164; international format such as +4915123456789 is recommended.","maxLength":255,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"communication_channels.items.[INDEX].value","typeLabel":"string"},"id":{"description":"Existing communication channel identifier to retain when replacing its collection. Omit for a new entry; supplied identifiers must belong to this parent and occur only once.","format":"uuid","type":"string","uniqueKey":"communication_channels.items.[INDEX].id","typeLabel":"string\u003cuuid>"}},"required":["type","value"],"type":"object","uniqueKey":"communication_channels.items.[INDEX]","typeLabel":"object"},"maxItems":10,"type":"array","uniqueKey":"communication_channels","typeLabel":"object[]"},"legal_form":{"oneOf":[{"description":"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.","type":"string","uniqueKey":"legal_form.oneOf.0","typeLabel":"string"},{"description":"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.","type":"null","uniqueKey":"legal_form.oneOf.1","typeLabel":"null"}],"uniqueKey":"legal_form","typeLabel":"string | null"},"legal_representatives":{"description":"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.","items":{"description":"Unknown and read-only request fields are rejected with a validation error instead of being silently ignored.","properties":{"role":{"type":"string","description":"Legal or organizational role of the representative.\n\n* `managing_director` - managing_director\n* `director` - director\n* `board_member` - board_member\n* `chairperson` - chairperson\n* `general_partner` - general_partner\n* `shareholder` - shareholder\n* `owner` - owner\n* `authorized_signatory` - authorized_signatory\n* `partner` - partner\n* `legal_guardian` - legal_guardian\n* `other` - other","enum":["managing_director","director","board_member","chairperson","general_partner","shareholder","owner","authorized_signatory","partner","legal_guardian","other"],"isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].role","typeLabel":"enum\u003cstring>"},"id":{"description":"Existing representative identifier to retain when replacing its collection. Omit for a new entry; supplied identifiers must belong to this parent and occur only once.","format":"uuid","type":"string","uniqueKey":"legal_representatives.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"legal_form":{"oneOf":[{"description":"Legal form of an organization representative.","type":"string","uniqueKey":"legal_representatives.items.[INDEX].legal_form.oneOf.0","typeLabel":"string"},{"description":"Legal form of an organization representative.","type":"null","uniqueKey":"legal_representatives.items.[INDEX].legal_form.oneOf.1","typeLabel":"null"}],"uniqueKey":"legal_representatives.items.[INDEX].legal_form","typeLabel":"string | null"},"legal_representatives":{"description":"Second-level representatives of this representative. At most two representative levels are supported. When supplied on an existing representative, this array replaces its nested collection; [] clears it and omission preserves it. Maximum 10 entries.","items":{"description":"Unknown and read-only request fields are rejected with a validation error instead of being silently ignored.","properties":{"role":{"type":"string","description":"Legal or organizational role of the representative.\n\n* `managing_director` - managing_director\n* `director` - director\n* `board_member` - board_member\n* `chairperson` - chairperson\n* `general_partner` - general_partner\n* `shareholder` - shareholder\n* `owner` - owner\n* `authorized_signatory` - authorized_signatory\n* `partner` - partner\n* `legal_guardian` - legal_guardian\n* `other` - other","enum":["managing_director","director","board_member","chairperson","general_partner","shareholder","owner","authorized_signatory","partner","legal_guardian","other"],"isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].role","typeLabel":"enum\u003cstring>"},"id":{"description":"Existing representative identifier to retain when replacing its collection. Omit for a new entry; supplied identifiers must belong to this parent and occur only once.","format":"uuid","type":"string","uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"legal_form":{"oneOf":[{"description":"Legal form of an organization representative.","type":"string","uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].legal_form.oneOf.0","typeLabel":"string"},{"description":"Legal form of an organization representative.","type":"null","uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].legal_form.oneOf.1","typeLabel":"null"}],"uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].legal_form","typeLabel":"string | null"},"organization":{"oneOf":[{"type":"object","description":"Organization identity of the representative. Supply exactly one of person or organization; an organization requires name.","required":["name"],"properties":{"name":{"description":"Registered or trading name of the organization.","maxLength":255,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].organization.oneOf.0.name","typeLabel":"string"},"commercial_register":{"oneOf":[{"description":"Register court or authority holding the registration.","maxLength":255,"type":"string","uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].organization.oneOf.0.commercial_register.oneOf.0","typeLabel":"string"},{"description":"Register court or authority holding the registration.","maxLength":255,"type":"null","uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].organization.oneOf.0.commercial_register.oneOf.1","typeLabel":"null"}],"uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].organization.oneOf.0.commercial_register","typeLabel":"string | null"},"commercial_registration_number":{"oneOf":[{"description":"Register number beginning with HRA, HRB, VR, or PR, followed by one to nine digits and an optional letter; for example, HRB 12345. Whitespace and letter case are normalized.","maxLength":255,"type":"string","uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].organization.oneOf.0.commercial_registration_number.oneOf.0","typeLabel":"string"},{"description":"Register number beginning with HRA, HRB, VR, or PR, followed by one to nine digits and an optional letter; for example, HRB 12345. Whitespace and letter case are normalized.","maxLength":255,"type":"null","uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].organization.oneOf.0.commercial_registration_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].organization.oneOf.0.commercial_registration_number","typeLabel":"string | null"}},"uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].organization.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].organization.oneOf.1","typeLabel":"null"}],"uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].organization","typeLabel":"object | null"},"person":{"oneOf":[{"type":"object","description":"Natural-person identity of the representative. Supply exactly one of person or organization; a person requires first_name and last_name. Salutation is optional.","required":["first_name","last_name"],"properties":{"first_name":{"description":"Given name of the natural person.","maxLength":255,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].person.oneOf.0.first_name","typeLabel":"string"},"last_name":{"description":"Family name of the natural person.","maxLength":255,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].person.oneOf.0.last_name","typeLabel":"string"},"birth_date":{"oneOf":[{"description":"Date of birth used to identify the natural person; cannot be in the future.","format":"date","type":"string","uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].person.oneOf.0.birth_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Date of birth used to identify the natural person; cannot be in the future.","format":"date","type":"null","uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].person.oneOf.0.birth_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].person.oneOf.0.birth_date","typeLabel":"string\u003cdate> | null"},"salutation":{"oneOf":[{"type":"string","description":"Optional salutation of the natural person. Omit it or supply null or an empty string when unknown.","enum":["mr","ms","mx"],"uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].person.oneOf.0.salutation.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"Optional salutation of the natural person. Omit it or supply null or an empty string when unknown.","enum":[""],"uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].person.oneOf.0.salutation.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].person.oneOf.0.salutation.oneOf.2","typeLabel":"null"}],"uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].person.oneOf.0.salutation","typeLabel":"enum\u003cstring> · enum\u003cstring> · null"}},"uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].person.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].person.oneOf.1","typeLabel":"null"}],"uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].person","typeLabel":"object | null"}},"required":["role"],"type":"object","uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX]","typeLabel":"object"},"maxItems":10,"type":"array","uniqueKey":"legal_representatives.items.[INDEX].legal_representatives","typeLabel":"object[]"},"organization":{"oneOf":[{"type":"object","description":"Organization identity of the representative. Supply exactly one of person or organization; an organization requires name.","required":["name"],"properties":{"name":{"description":"Registered or trading name of the organization.","maxLength":255,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].organization.oneOf.0.name","typeLabel":"string"},"commercial_register":{"oneOf":[{"description":"Register court or authority holding the registration.","maxLength":255,"type":"string","uniqueKey":"legal_representatives.items.[INDEX].organization.oneOf.0.commercial_register.oneOf.0","typeLabel":"string"},{"description":"Register court or authority holding the registration.","maxLength":255,"type":"null","uniqueKey":"legal_representatives.items.[INDEX].organization.oneOf.0.commercial_register.oneOf.1","typeLabel":"null"}],"uniqueKey":"legal_representatives.items.[INDEX].organization.oneOf.0.commercial_register","typeLabel":"string | null"},"commercial_registration_number":{"oneOf":[{"description":"Register number beginning with HRA, HRB, VR, or PR, followed by one to nine digits and an optional letter; for example, HRB 12345. Whitespace and letter case are normalized.","maxLength":255,"type":"string","uniqueKey":"legal_representatives.items.[INDEX].organization.oneOf.0.commercial_registration_number.oneOf.0","typeLabel":"string"},{"description":"Register number beginning with HRA, HRB, VR, or PR, followed by one to nine digits and an optional letter; for example, HRB 12345. Whitespace and letter case are normalized.","maxLength":255,"type":"null","uniqueKey":"legal_representatives.items.[INDEX].organization.oneOf.0.commercial_registration_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"legal_representatives.items.[INDEX].organization.oneOf.0.commercial_registration_number","typeLabel":"string | null"}},"uniqueKey":"legal_representatives.items.[INDEX].organization.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"legal_representatives.items.[INDEX].organization.oneOf.1","typeLabel":"null"}],"uniqueKey":"legal_representatives.items.[INDEX].organization","typeLabel":"object | null"},"person":{"oneOf":[{"type":"object","description":"Natural-person identity of the representative. Supply exactly one of person or organization; a person requires first_name and last_name. Salutation is optional.","required":["first_name","last_name"],"properties":{"first_name":{"description":"Given name of the natural person.","maxLength":255,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].person.oneOf.0.first_name","typeLabel":"string"},"last_name":{"description":"Family name of the natural person.","maxLength":255,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].person.oneOf.0.last_name","typeLabel":"string"},"birth_date":{"oneOf":[{"description":"Date of birth used to identify the natural person; cannot be in the future.","format":"date","type":"string","uniqueKey":"legal_representatives.items.[INDEX].person.oneOf.0.birth_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Date of birth used to identify the natural person; cannot be in the future.","format":"date","type":"null","uniqueKey":"legal_representatives.items.[INDEX].person.oneOf.0.birth_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"legal_representatives.items.[INDEX].person.oneOf.0.birth_date","typeLabel":"string\u003cdate> | null"},"salutation":{"oneOf":[{"type":"string","description":"Optional salutation of the natural person. Omit it or supply null or an empty string when unknown.","enum":["mr","ms","mx"],"uniqueKey":"legal_representatives.items.[INDEX].person.oneOf.0.salutation.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"Optional salutation of the natural person. Omit it or supply null or an empty string when unknown.","enum":[""],"uniqueKey":"legal_representatives.items.[INDEX].person.oneOf.0.salutation.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"legal_representatives.items.[INDEX].person.oneOf.0.salutation.oneOf.2","typeLabel":"null"}],"uniqueKey":"legal_representatives.items.[INDEX].person.oneOf.0.salutation","typeLabel":"enum\u003cstring> · enum\u003cstring> · null"}},"uniqueKey":"legal_representatives.items.[INDEX].person.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"legal_representatives.items.[INDEX].person.oneOf.1","typeLabel":"null"}],"uniqueKey":"legal_representatives.items.[INDEX].person","typeLabel":"object | null"}},"required":["role"],"type":"object","uniqueKey":"legal_representatives.items.[INDEX]","typeLabel":"object"},"maxItems":10,"type":"array","uniqueKey":"legal_representatives","typeLabel":"object[]"},"organization":{"oneOf":[{"type":"object","description":"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.","minProperties":1,"properties":{"commercial_register":{"oneOf":[{"description":"Register court or authority holding the registration.","maxLength":255,"type":"string","uniqueKey":"organization.oneOf.0.commercial_register.oneOf.0","typeLabel":"string"},{"description":"Register court or authority holding the registration.","maxLength":255,"type":"null","uniqueKey":"organization.oneOf.0.commercial_register.oneOf.1","typeLabel":"null"}],"uniqueKey":"organization.oneOf.0.commercial_register","typeLabel":"string | null"},"commercial_registration_number":{"oneOf":[{"description":"Commercial, cooperative, partnership, or association register number (HRA, HRB, GnR, PR, VR; Austrian FN). Free text for foreign legal forms.","maxLength":255,"type":"string","uniqueKey":"organization.oneOf.0.commercial_registration_number.oneOf.0","typeLabel":"string"},{"description":"Commercial, cooperative, partnership, or association register number (HRA, HRB, GnR, PR, VR; Austrian FN). Free text for foreign legal forms.","maxLength":255,"type":"null","uniqueKey":"organization.oneOf.0.commercial_registration_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"organization.oneOf.0.commercial_registration_number","typeLabel":"string | null"},"name":{"description":"Registered or trading name of the organization.","maxLength":255,"minLength":1,"type":"string","uniqueKey":"organization.oneOf.0.name","typeLabel":"string"}},"uniqueKey":"organization.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"organization.oneOf.1","typeLabel":"null"}],"uniqueKey":"organization","typeLabel":"object | null"},"person":{"oneOf":[{"type":"object","description":"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.","minProperties":1,"properties":{"birth_date":{"oneOf":[{"description":"Date of birth (YYYY-MM-DD) used to identify the natural person.","format":"date","type":"string","uniqueKey":"person.oneOf.0.birth_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Date of birth (YYYY-MM-DD) used to identify the natural person.","format":"date","type":"null","uniqueKey":"person.oneOf.0.birth_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"person.oneOf.0.birth_date","typeLabel":"string\u003cdate> | null"},"first_name":{"description":"Given name of the natural person.","maxLength":255,"minLength":1,"type":"string","uniqueKey":"person.oneOf.0.first_name","typeLabel":"string"},"last_name":{"description":"Family name of the natural person.","maxLength":255,"minLength":1,"type":"string","uniqueKey":"person.oneOf.0.last_name","typeLabel":"string"},"salutation":{"oneOf":[{"type":"string","description":"Optional salutation of the natural person. Omit it or supply null or an empty string when unknown.\n\n* `mr` - mr\n* `ms` - ms\n* `mx` - mx","enum":["mr","ms","mx"],"uniqueKey":"person.oneOf.0.salutation.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"Optional salutation of the natural person. Omit it or supply null or an empty string when unknown.\n\n* `mr` - mr\n* `ms` - ms\n* `mx` - mx","enum":[""],"uniqueKey":"person.oneOf.0.salutation.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"person.oneOf.0.salutation.oneOf.2","typeLabel":"null"}],"uniqueKey":"person.oneOf.0.salutation","typeLabel":"enum\u003cstring> · enum\u003cstring> · null"}},"uniqueKey":"person.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"person.oneOf.1","typeLabel":"null"}],"uniqueKey":"person","typeLabel":"object | null"},"your_reference":{"oneOf":[{"description":"Your reference for this debtor. Blank is stored as null.","maxLength":255,"type":"string","uniqueKey":"your_reference.oneOf.0","typeLabel":"string"},{"description":"Your reference for this debtor. Blank is stored as null.","maxLength":255,"type":"null","uniqueKey":"your_reference.oneOf.1","typeLabel":"null"}],"uniqueKey":"your_reference","typeLabel":"string | null"}},"type":"object","uniqueKey":"","typeLabel":"object"},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"9a9977c3-233e-4328-b9ac-62e7c0db9044":{"content":{"application/json":{"schema":{"properties":{"acting_as":{"type":"string","description":"Whether the debtor incurred the obligation as a consumer or in a business capacity.\n\n* `consumer` - consumer\n* `business` - business","enum":["consumer","business"],"isRequired":true,"uniqueKey":"acting_as","typeLabel":"enum\u003cstring>"},"addresses":{"description":"Postal addresses associated with the debtor. API submissions are limited to 5 entries.","items":{"properties":{"city":{"description":"City or locality of the address.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"addresses.items.[INDEX].city","typeLabel":"string"},"country":{"description":"Country as a two-letter ISO 3166-1 code.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"addresses.items.[INDEX].country","typeLabel":"string"},"id":{"description":"Stable identifier of this address.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"addresses.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"postal_code":{"description":"Postal code of the address.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"addresses.items.[INDEX].postal_code","typeLabel":"string"},"primary":{"description":"Whether this is the debtor's primary postal address.","readOnly":true,"type":"boolean","isRequired":true,"uniqueKey":"addresses.items.[INDEX].primary","typeLabel":"boolean"},"street":{"description":"Street and house number.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"addresses.items.[INDEX].street","typeLabel":"string"}},"required":["city","country","id","postal_code","primary","street"],"type":"object","uniqueKey":"addresses.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"addresses","typeLabel":"object[]"},"bank_accounts":{"description":"Known bank accounts belonging to the debtor. API submissions are limited to 10 entries.","items":{"properties":{"account_holder":{"description":"Name of the bank-account holder.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"bank_accounts.items.[INDEX].account_holder","typeLabel":"string"},"bic":{"oneOf":[{"description":"BIC/SWIFT code of the bank account.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"bank_accounts.items.[INDEX].bic.oneOf.0","typeLabel":"string"},{"description":"BIC/SWIFT code of the bank account.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"bank_accounts.items.[INDEX].bic.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"bank_accounts.items.[INDEX].bic","typeLabel":"string | null"},"iban":{"description":"IBAN of the debtor's bank account.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"bank_accounts.items.[INDEX].iban","typeLabel":"string"},"id":{"description":"Stable identifier of this bank account.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"bank_accounts.items.[INDEX].id","typeLabel":"string\u003cuuid>"}},"required":["account_holder","bic","iban","id"],"type":"object","uniqueKey":"bank_accounts.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"bank_accounts","typeLabel":"object[]"},"communication_channels":{"description":"Email addresses and telephone numbers for the debtor. API submissions are limited to 10 entries.","items":{"properties":{"id":{"description":"Stable identifier of this communication channel.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"communication_channels.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"type":{"description":"Kind of contact channel.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"communication_channels.items.[INDEX].type","typeLabel":"string"},"value":{"description":"Email address or telephone number for the selected channel.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"communication_channels.items.[INDEX].value","typeLabel":"string"}},"required":["id","type","value"],"type":"object","uniqueKey":"communication_channels.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"communication_channels","typeLabel":"object[]"},"created_at":{"description":"Time at which the debtor was created.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"events":{"description":"Stored contextual events associated with this resource.","items":{"description":"Stored events may likewise use retired or internal type values.","properties":{"description":{"oneOf":[{"description":"Optional description of the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"events.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"description":"Optional description of the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"events.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"events.items.[INDEX].description","typeLabel":"string | null"},"location":{"oneOf":[{"description":"Optional location associated with the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"events.items.[INDEX].location.oneOf.0","typeLabel":"string"},{"description":"Optional location associated with the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"events.items.[INDEX].location.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"events.items.[INDEX].location","typeLabel":"string | null"},"occurence":{"description":"Time at which the event occurred; the historical field spelling is intentional.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"events.items.[INDEX].occurence","typeLabel":"string\u003cdate-time>"},"title":{"description":"Human-readable title of the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"events.items.[INDEX].title","typeLabel":"string"},"type":{"description":"Stored event type; historical values may be outside today's input enum.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"events.items.[INDEX].type","typeLabel":"string"},"your_reference":{"oneOf":[{"description":"Your optional reference for the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"events.items.[INDEX].your_reference.oneOf.0","typeLabel":"string"},{"description":"Your optional reference for the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"events.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"events.items.[INDEX].your_reference","typeLabel":"string | null"}},"required":["description","location","occurence","title","type","your_reference"],"type":"object","uniqueKey":"events.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"events","typeLabel":"object[]"},"id":{"description":"Stable identifier of this debtor.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"legal_form":{"oneOf":[{"description":"Permanent public legal-form code; look up its label and representation rules with GET /v2/legal-forms/. Null for consumers.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"legal_form.oneOf.0","typeLabel":"string"},{"description":"Permanent public legal-form code; look up its label and representation rules with GET /v2/legal-forms/. Null for consumers.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"legal_form.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"legal_form","typeLabel":"string | null"},"legal_representatives":{"description":"People or organizations legally representing the debtor. API submissions are limited to 10 entries.","items":{"properties":{"id":{"description":"Stable identifier of this legal representative.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"legal_form":{"oneOf":[{"description":"Legal form of an organization representative.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].legal_form.oneOf.0","typeLabel":"string"},{"description":"Legal form of an organization representative.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].legal_form.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].legal_form","typeLabel":"string | null"},"legal_representatives":{"description":"Second-level people or organizations legally representing this representative. API submissions are limited to 10 entries at the second and final representative level.","items":{"properties":{"id":{"description":"Stable identifier of this legal representative.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"legal_form":{"oneOf":[{"description":"Legal form of an organization representative.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].legal_form.oneOf.0","typeLabel":"string"},{"description":"Legal form of an organization representative.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].legal_form.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].legal_form","typeLabel":"string | null"},"organization":{"oneOf":[{"type":"object","description":"Organization identity of the representative.","required":["commercial_register","commercial_registration_number","name"],"properties":{"commercial_register":{"oneOf":[{"description":"Register court or authority holding the registration.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].organization.oneOf.0.commercial_register.oneOf.0","typeLabel":"string"},{"description":"Register court or authority holding the registration.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].organization.oneOf.0.commercial_register.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].organization.oneOf.0.commercial_register","typeLabel":"string | null"},"commercial_registration_number":{"oneOf":[{"description":"Commercial, association, or partnership register number.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].organization.oneOf.0.commercial_registration_number.oneOf.0","typeLabel":"string"},{"description":"Commercial, association, or partnership register number.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].organization.oneOf.0.commercial_registration_number.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].organization.oneOf.0.commercial_registration_number","typeLabel":"string | null"},"name":{"description":"Registered or trading name of the organization.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].organization.oneOf.0.name","typeLabel":"string"}},"isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].organization.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].organization.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].organization","typeLabel":"object | null"},"person":{"oneOf":[{"type":"object","description":"Natural-person identity of the representative.","required":["birth_date","first_name","last_name","salutation"],"properties":{"birth_date":{"oneOf":[{"description":"Date of birth used to identify the natural person.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].person.oneOf.0.birth_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Date of birth used to identify the natural person.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].person.oneOf.0.birth_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].person.oneOf.0.birth_date","typeLabel":"string\u003cdate> | null"},"first_name":{"description":"Given name of the natural person.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].person.oneOf.0.first_name","typeLabel":"string"},"last_name":{"description":"Family name of the natural person.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].person.oneOf.0.last_name","typeLabel":"string"},"salutation":{"oneOf":[{"type":"string","description":"Salutation of the natural person; null if no supported salutation is stored.","enum":["mr","ms","mx"],"isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].person.oneOf.0.salutation.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].person.oneOf.0.salutation.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].person.oneOf.0.salutation","typeLabel":"enum\u003cstring> | null"}},"isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].person.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].person.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].person","typeLabel":"object | null"},"role":{"type":"string","description":"Legal or organizational role of the representative.","enum":["managing_director","director","board_member","chairperson","general_partner","shareholder","owner","authorized_signatory","partner","legal_guardian","other"],"isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX].role","typeLabel":"enum\u003cstring>"}},"required":["id","legal_form","organization","person","role"],"type":"object","uniqueKey":"legal_representatives.items.[INDEX].legal_representatives.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].legal_representatives","typeLabel":"object[]"},"organization":{"oneOf":[{"type":"object","description":"Organization identity of the representative.","required":["commercial_register","commercial_registration_number","name"],"properties":{"commercial_register":{"oneOf":[{"description":"Register court or authority holding the registration.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].organization.oneOf.0.commercial_register.oneOf.0","typeLabel":"string"},{"description":"Register court or authority holding the registration.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].organization.oneOf.0.commercial_register.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].organization.oneOf.0.commercial_register","typeLabel":"string | null"},"commercial_registration_number":{"oneOf":[{"description":"Commercial, association, or partnership register number.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].organization.oneOf.0.commercial_registration_number.oneOf.0","typeLabel":"string"},{"description":"Commercial, association, or partnership register number.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].organization.oneOf.0.commercial_registration_number.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].organization.oneOf.0.commercial_registration_number","typeLabel":"string | null"},"name":{"description":"Registered or trading name of the organization.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].organization.oneOf.0.name","typeLabel":"string"}},"isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].organization.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].organization.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].organization","typeLabel":"object | null"},"person":{"oneOf":[{"type":"object","description":"Natural-person identity of the representative.","required":["birth_date","first_name","last_name","salutation"],"properties":{"birth_date":{"oneOf":[{"description":"Date of birth used to identify the natural person.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].person.oneOf.0.birth_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Date of birth used to identify the natural person.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].person.oneOf.0.birth_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].person.oneOf.0.birth_date","typeLabel":"string\u003cdate> | null"},"first_name":{"description":"Given name of the natural person.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].person.oneOf.0.first_name","typeLabel":"string"},"last_name":{"description":"Family name of the natural person.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].person.oneOf.0.last_name","typeLabel":"string"},"salutation":{"oneOf":[{"type":"string","description":"Salutation of the natural person; null if no supported salutation is stored.","enum":["mr","ms","mx"],"isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].person.oneOf.0.salutation.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].person.oneOf.0.salutation.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].person.oneOf.0.salutation","typeLabel":"enum\u003cstring> | null"}},"isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].person.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].person.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].person","typeLabel":"object | null"},"role":{"type":"string","description":"Legal or organizational role of the representative.","enum":["managing_director","director","board_member","chairperson","general_partner","shareholder","owner","authorized_signatory","partner","legal_guardian","other"],"isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].role","typeLabel":"enum\u003cstring>"}},"required":["id","legal_form","legal_representatives","organization","person","role"],"type":"object","uniqueKey":"legal_representatives.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"legal_representatives","typeLabel":"object[]"},"metadata":{"description":"Stored metadata entries; duplicate types remain separate entries.","items":{"description":"Stored types may predate today's resource-specific input choices.","properties":{"type":{"description":"Stored metadata type; historical values may be outside today's input enum.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"metadata.items.[INDEX].type","typeLabel":"string"},"value":{"description":"Stored metadata value.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"metadata.items.[INDEX].value","typeLabel":"string"}},"required":["type","value"],"type":"object","uniqueKey":"metadata.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"metadata","typeLabel":"object[]"},"organization":{"oneOf":[{"type":"object","description":"Organization identity for a business debtor.","required":["commercial_register","commercial_registration_number","name"],"properties":{"commercial_register":{"oneOf":[{"description":"Register court or authority holding the registration.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"organization.oneOf.0.commercial_register.oneOf.0","typeLabel":"string"},{"description":"Register court or authority holding the registration.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"organization.oneOf.0.commercial_register.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"organization.oneOf.0.commercial_register","typeLabel":"string | null"},"commercial_registration_number":{"oneOf":[{"description":"Commercial, association, or partnership register number.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"organization.oneOf.0.commercial_registration_number.oneOf.0","typeLabel":"string"},{"description":"Commercial, association, or partnership register number.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"organization.oneOf.0.commercial_registration_number.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"organization.oneOf.0.commercial_registration_number","typeLabel":"string | null"},"name":{"description":"Registered or trading name of the organization.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"organization.oneOf.0.name","typeLabel":"string"}},"isRequired":true,"uniqueKey":"organization.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"organization.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"organization","typeLabel":"object | null"},"person":{"oneOf":[{"type":"object","description":"Natural-person identity for a consumer or sole proprietor.","required":["birth_date","first_name","last_name","salutation"],"properties":{"birth_date":{"oneOf":[{"description":"Date of birth used to identify the natural person.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"person.oneOf.0.birth_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Date of birth used to identify the natural person.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"person.oneOf.0.birth_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"person.oneOf.0.birth_date","typeLabel":"string\u003cdate> | null"},"first_name":{"description":"Given name of the natural person.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"person.oneOf.0.first_name","typeLabel":"string"},"last_name":{"description":"Family name of the natural person.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"person.oneOf.0.last_name","typeLabel":"string"},"salutation":{"oneOf":[{"type":"string","description":"Salutation of the natural person; null if no supported salutation is stored.","enum":["mr","ms","mx"],"isRequired":true,"uniqueKey":"person.oneOf.0.salutation.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","isRequired":true,"uniqueKey":"person.oneOf.0.salutation.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"person.oneOf.0.salutation","typeLabel":"enum\u003cstring> | null"}},"isRequired":true,"uniqueKey":"person.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"person.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"person","typeLabel":"object | null"},"updated_at":{"description":"Time at which the debtor was last updated.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"},"your_reference":{"oneOf":[{"description":"Your reference for this debtor.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"your_reference.oneOf.0","typeLabel":"string"},{"description":"Your reference for this debtor.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"your_reference","typeLabel":"string | null"}},"required":["acting_as","addresses","bank_accounts","communication_channels","created_at","events","id","legal_form","legal_representatives","metadata","organization","person","updated_at","your_reference"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"acting_as":"consumer","addresses":[{"city":"\u003cstring>","country":"\u003cstring>","id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","postal_code":"\u003cstring>","primary":true,"street":"\u003cstring>"}],"bank_accounts":[{"account_holder":"\u003cstring>","bic":"\u003cstring>","iban":"\u003cstring>","id":"3c90c3cc-0d44-4b50-8888-8dd25736052a"}],"communication_channels":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","type":"\u003cstring>","value":"\u003cstring>"}],"created_at":"2023-11-07T05:31:56Z","events":[{"description":"\u003cstring>","location":"\u003cstring>","occurence":"2023-11-07T05:31:56Z","title":"\u003cstring>","type":"\u003cstring>","your_reference":"\u003cstring>"}],"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","legal_form":"\u003cstring>","legal_representatives":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","legal_form":"\u003cstring>","legal_representatives":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","legal_form":"\u003cstring>","organization":{"commercial_register":"\u003cstring>","commercial_registration_number":"\u003cstring>","name":"\u003cstring>"},"person":{"birth_date":"2023-12-25","first_name":"\u003cstring>","last_name":"\u003cstring>","salutation":"mr"},"role":"managing_director"}],"organization":{"commercial_register":"\u003cstring>","commercial_registration_number":"\u003cstring>","name":"\u003cstring>"},"person":{"birth_date":"2023-12-25","first_name":"\u003cstring>","last_name":"\u003cstring>","salutation":"mr"},"role":"managing_director"}],"metadata":[{"type":"\u003cstring>","value":"\u003cstring>"}],"organization":{"commercial_register":"\u003cstring>","commercial_registration_number":"\u003cstring>","name":"\u003cstring>"},"person":{"birth_date":"2023-12-25","first_name":"\u003cstring>","last_name":"\u003cstring>","salutation":"mr"},"updated_at":"2023-11-07T05:31:56Z","your_reference":"\u003cstring>"}}},"exampleType":"generated"}},"description":"","headers":{"Cache-Control":{"description":"Cacheability directive. Authenticated responses use `private, no-store`; the legal-form catalog may use `private, max-age=86400`.","schema":{"type":"string"}},"ETag":{"description":"Strong validator of this representation. Send it back as `If-None-Match` to skip an unchanged re-read (304) or as `If-Match` on PATCH/PUT/DELETE to fail with 412 when the resource changed.","schema":{"type":"string"}},"X-Paywise-Environment":{"description":"Environment that produced the response.","schema":{"enum":["production","sandbox"],"type":"string"}},"X-Paywise-Request-Id":{"description":"Fresh server-assigned correlation id for this response. Caller-provided request ids are ignored.","schema":{"format":"uuid","type":"string"}}},"exampleType":"generated"},"55e56235-4ef9-4824-9958-06d092a10ad8":{"content":{"application/json":{"examples":{"validation-error":{"title":"validation-error","value":{"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."}]}}},"schema":{"properties":{"code":{"description":"Machine-readable error category.","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"description":"Short human-readable summary of the error.","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"errors":{"description":"Field-level validation errors, when applicable.","items":{"properties":{"code":{"description":"Machine-readable field error code.","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"field":{"oneOf":[{"description":"Path to the field that caused the error, using dots for objects and brackets for list indexes, for example `claims[0].amount`; null for an error without a field path.","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].field.oneOf.0","typeLabel":"string"},{"description":"Path to the field that caused the error, using dots for objects and brackets for list indexes, for example `claims[0].amount`; null for an error without a field path.","type":"null","isRequired":true,"uniqueKey":"errors.items.[INDEX].field.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string | null"},"message":{"description":"Human-readable explanation of the field error.","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"required":["field","code","message"],"type":"object","uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"errors","typeLabel":"object[]"}},"required":["detail","code"],"type":"object","uniqueKey":"","typeLabel":"object"},"exampleType":"examples"}},"description":"Standard error response.","headers":{"Cache-Control":{"description":"Cacheability directive. Authenticated responses use `private, no-store`; the legal-form catalog may use `private, max-age=86400`.","schema":{"type":"string"}},"X-Paywise-Environment":{"description":"Environment that produced the response.","schema":{"enum":["production","sandbox"],"type":"string"}},"X-Paywise-Request-Id":{"description":"Fresh server-assigned correlation id for this response. Caller-provided request ids are ignored.","schema":{"format":"uuid","type":"string"}}},"exampleType":"examples"},"ccafaaa3-38fb-4ded-a963-82a0655c440f":{"content":{"application/json":{"examples":{"authentication-error":{"title":"authentication-error","value":{"code":"not_authenticated","detail":"Authentication credentials were not provided."}}},"schema":{"properties":{"code":{"description":"Machine-readable error category.","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"description":"Short human-readable summary of the error.","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"errors":{"description":"Field-level validation errors, when applicable.","items":{"properties":{"code":{"description":"Machine-readable field error code.","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"field":{"oneOf":[{"description":"Path to the field that caused the error, using dots for objects and brackets for list indexes, for example `claims[0].amount`; null for an error without a field path.","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].field.oneOf.0","typeLabel":"string"},{"description":"Path to the field that caused the error, using dots for objects and brackets for list indexes, for example `claims[0].amount`; null for an error without a field path.","type":"null","isRequired":true,"uniqueKey":"errors.items.[INDEX].field.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string | null"},"message":{"description":"Human-readable explanation of the field error.","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"required":["field","code","message"],"type":"object","uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"errors","typeLabel":"object[]"}},"required":["detail","code"],"type":"object","uniqueKey":"","typeLabel":"object"},"exampleType":"examples"}},"description":"Standard error response.","headers":{"Cache-Control":{"description":"Cacheability directive. Authenticated responses use `private, no-store`; the legal-form catalog may use `private, max-age=86400`.","schema":{"type":"string"}},"X-Paywise-Environment":{"description":"Environment that produced the response.","schema":{"enum":["production","sandbox"],"type":"string"}},"X-Paywise-Request-Id":{"description":"Fresh server-assigned correlation id for this response. Caller-provided request ids are ignored.","schema":{"format":"uuid","type":"string"}}},"exampleType":"examples"},"370835a1-7e98-4e42-a197-930ab566f98a":{"content":{"application/json":{"schema":{"properties":{"code":{"description":"Machine-readable error category.","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"description":"Short human-readable summary of the error.","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"errors":{"description":"Field-level validation errors, when applicable.","items":{"properties":{"code":{"description":"Machine-readable field error code.","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"field":{"oneOf":[{"description":"Path to the field that caused the error, using dots for objects and brackets for list indexes, for example `claims[0].amount`; null for an error without a field path.","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].field.oneOf.0","typeLabel":"string"},{"description":"Path to the field that caused the error, using dots for objects and brackets for list indexes, for example `claims[0].amount`; null for an error without a field path.","type":"null","isRequired":true,"uniqueKey":"errors.items.[INDEX].field.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string | null"},"message":{"description":"Human-readable explanation of the field error.","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"required":["field","code","message"],"type":"object","uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"errors","typeLabel":"object[]"}},"required":["detail","code"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","detail":"\u003cstring>","errors":[{"code":"\u003cstring>","field":"\u003cstring>","message":"\u003cstring>"}]}}},"exampleType":"generated"}},"description":"Standard error response.","headers":{"Cache-Control":{"description":"Cacheability directive. Authenticated responses use `private, no-store`; the legal-form catalog may use `private, max-age=86400`.","schema":{"type":"string"}},"X-Paywise-Environment":{"description":"Environment that produced the response.","schema":{"enum":["production","sandbox"],"type":"string"}},"X-Paywise-Request-Id":{"description":"Fresh server-assigned correlation id for this response. Caller-provided request ids are ignored.","schema":{"format":"uuid","type":"string"}}},"exampleType":"generated"},"c2b721d6-33fd-40a1-842b-67dc51652def":{"content":{"application/json":{"examples":{"not-found-error":{"title":"not-found-error","value":{"code":"not_found","detail":"The requested resource was not found."}}},"schema":{"properties":{"code":{"description":"Machine-readable error category.","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"description":"Short human-readable summary of the error.","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"errors":{"description":"Field-level validation errors, when applicable.","items":{"properties":{"code":{"description":"Machine-readable field error code.","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"field":{"oneOf":[{"description":"Path to the field that caused the error, using dots for objects and brackets for list indexes, for example `claims[0].amount`; null for an error without a field path.","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].field.oneOf.0","typeLabel":"string"},{"description":"Path to the field that caused the error, using dots for objects and brackets for list indexes, for example `claims[0].amount`; null for an error without a field path.","type":"null","isRequired":true,"uniqueKey":"errors.items.[INDEX].field.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string | null"},"message":{"description":"Human-readable explanation of the field error.","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"required":["field","code","message"],"type":"object","uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"errors","typeLabel":"object[]"}},"required":["detail","code"],"type":"object","uniqueKey":"","typeLabel":"object"},"exampleType":"examples"}},"description":"Standard error response.","headers":{"Cache-Control":{"description":"Cacheability directive. Authenticated responses use `private, no-store`; the legal-form catalog may use `private, max-age=86400`.","schema":{"type":"string"}},"X-Paywise-Environment":{"description":"Environment that produced the response.","schema":{"enum":["production","sandbox"],"type":"string"}},"X-Paywise-Request-Id":{"description":"Fresh server-assigned correlation id for this response. Caller-provided request ids are ignored.","schema":{"format":"uuid","type":"string"}}},"exampleType":"examples"},"08b7c47a-c14b-48e0-b033-cf93c1262418":{"content":{"application/json":{"examples":{"conflict-error":{"title":"conflict-error","value":{"code":"conflict","detail":"The resource changed state and cannot accept this command."}}},"schema":{"properties":{"code":{"description":"Machine-readable error category.","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"description":"Short human-readable summary of the error.","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"errors":{"description":"Field-level validation errors, when applicable.","items":{"properties":{"code":{"description":"Machine-readable field error code.","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"field":{"oneOf":[{"description":"Path to the field that caused the error, using dots for objects and brackets for list indexes, for example `claims[0].amount`; null for an error without a field path.","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].field.oneOf.0","typeLabel":"string"},{"description":"Path to the field that caused the error, using dots for objects and brackets for list indexes, for example `claims[0].amount`; null for an error without a field path.","type":"null","isRequired":true,"uniqueKey":"errors.items.[INDEX].field.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string | null"},"message":{"description":"Human-readable explanation of the field error.","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"required":["field","code","message"],"type":"object","uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"errors","typeLabel":"object[]"}},"required":["detail","code"],"type":"object","uniqueKey":"","typeLabel":"object"},"exampleType":"examples"}},"description":"Standard error response.","headers":{"Cache-Control":{"description":"Cacheability directive. Authenticated responses use `private, no-store`; the legal-form catalog may use `private, max-age=86400`.","schema":{"type":"string"}},"X-Paywise-Environment":{"description":"Environment that produced the response.","schema":{"enum":["production","sandbox"],"type":"string"}},"X-Paywise-Request-Id":{"description":"Fresh server-assigned correlation id for this response. Caller-provided request ids are ignored.","schema":{"format":"uuid","type":"string"}}},"exampleType":"examples"},"e90361ba-cea0-4e4d-83f3-245e9d1156a7":{"content":{"application/json":{"schema":{"properties":{"code":{"description":"Machine-readable error category.","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"description":"Short human-readable summary of the error.","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"errors":{"description":"Field-level validation errors, when applicable.","items":{"properties":{"code":{"description":"Machine-readable field error code.","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"field":{"oneOf":[{"description":"Path to the field that caused the error, using dots for objects and brackets for list indexes, for example `claims[0].amount`; null for an error without a field path.","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].field.oneOf.0","typeLabel":"string"},{"description":"Path to the field that caused the error, using dots for objects and brackets for list indexes, for example `claims[0].amount`; null for an error without a field path.","type":"null","isRequired":true,"uniqueKey":"errors.items.[INDEX].field.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string | null"},"message":{"description":"Human-readable explanation of the field error.","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"required":["field","code","message"],"type":"object","uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"errors","typeLabel":"object[]"}},"required":["detail","code"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","detail":"\u003cstring>","errors":[{"code":"\u003cstring>","field":"\u003cstring>","message":"\u003cstring>"}]}}},"exampleType":"generated"}},"description":"Standard error response.","headers":{"Cache-Control":{"description":"Cacheability directive. Authenticated responses use `private, no-store`; the legal-form catalog may use `private, max-age=86400`.","schema":{"type":"string"}},"X-Paywise-Environment":{"description":"Environment that produced the response.","schema":{"enum":["production","sandbox"],"type":"string"}},"X-Paywise-Request-Id":{"description":"Fresh server-assigned correlation id for this response. Caller-provided request ids are ignored.","schema":{"format":"uuid","type":"string"}}},"exampleType":"generated"},"95839bdc-63bc-4df8-a2e4-a713c0a88d21":{"content":{"application/json":{"schema":{"properties":{"code":{"description":"Machine-readable error category.","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"description":"Short human-readable summary of the error.","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"errors":{"description":"Field-level validation errors, when applicable.","items":{"properties":{"code":{"description":"Machine-readable field error code.","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"field":{"oneOf":[{"description":"Path to the field that caused the error, using dots for objects and brackets for list indexes, for example `claims[0].amount`; null for an error without a field path.","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].field.oneOf.0","typeLabel":"string"},{"description":"Path to the field that caused the error, using dots for objects and brackets for list indexes, for example `claims[0].amount`; null for an error without a field path.","type":"null","isRequired":true,"uniqueKey":"errors.items.[INDEX].field.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string | null"},"message":{"description":"Human-readable explanation of the field error.","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"required":["field","code","message"],"type":"object","uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"errors","typeLabel":"object[]"}},"required":["detail","code"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","detail":"\u003cstring>","errors":[{"code":"\u003cstring>","field":"\u003cstring>","message":"\u003cstring>"}]}}},"exampleType":"generated"}},"description":"Standard error response.","headers":{"Cache-Control":{"description":"Cacheability directive. Authenticated responses use `private, no-store`; the legal-form catalog may use `private, max-age=86400`.","schema":{"type":"string"}},"Retry-After":{"description":"Integer seconds to wait before retrying a throttled request.","schema":{"minimum":1,"type":"integer"}},"X-Paywise-Environment":{"description":"Environment that produced the response.","schema":{"enum":["production","sandbox"],"type":"string"}},"X-Paywise-Request-Id":{"description":"Fresh server-assigned correlation id for this response. Caller-provided request ids are ignored.","schema":{"format":"uuid","type":"string"}}},"exampleType":"generated"},"5cdade80-9d67-41ad-abb5-fafee028f2fc":{"content":{"application/json":{"schema":{"properties":{"code":{"description":"Machine-readable error category.","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"description":"Short human-readable summary of the error.","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"errors":{"description":"Field-level validation errors, when applicable.","items":{"properties":{"code":{"description":"Machine-readable field error code.","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"field":{"oneOf":[{"description":"Path to the field that caused the error, using dots for objects and brackets for list indexes, for example `claims[0].amount`; null for an error without a field path.","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].field.oneOf.0","typeLabel":"string"},{"description":"Path to the field that caused the error, using dots for objects and brackets for list indexes, for example `claims[0].amount`; null for an error without a field path.","type":"null","isRequired":true,"uniqueKey":"errors.items.[INDEX].field.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string | null"},"message":{"description":"Human-readable explanation of the field error.","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"required":["field","code","message"],"type":"object","uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"errors","typeLabel":"object[]"}},"required":["detail","code"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","detail":"\u003cstring>","errors":[{"code":"\u003cstring>","field":"\u003cstring>","message":"\u003cstring>"}]}}},"exampleType":"generated"}},"description":"Standard error response.","headers":{"Cache-Control":{"description":"Cacheability directive. Authenticated responses use `private, no-store`; the legal-form catalog may use `private, max-age=86400`.","schema":{"type":"string"}},"X-Paywise-Environment":{"description":"Environment that produced the response.","schema":{"enum":["production","sandbox"],"type":"string"}},"X-Paywise-Request-Id":{"description":"Fresh server-assigned correlation id for this response. Caller-provided request ids are ignored.","schema":{"format":"uuid","type":"string"}}},"exampleType":"generated"}},"security":{"75a46804-125e-4572-8c06-060341a38311":{"caseBearerAuth":{"description":"Company-bound Case Management API key — the standard credential for this API.","scheme":"bearer","type":"http","scopes":[],"schemeName":"caseBearerAuth"}},"d4c79fcf-4c56-49f5-bb70-f70b419767aa":{"partnerBearerAuth":{"description":"Partner API key acting for one entitled company; every Case request must then also carry the X-On-Behalf-Of-Company header.","scheme":"bearer","type":"http","scopes":[],"schemeName":"partnerBearerAuth"}}},"servers":{"8c8f8cc6-b41f-4cad-9749-5ef9c02d1396":{"description":"Production environment","url":"https://api.paywise.de"},"554ab33b-0043-40a7-a452-cca88c2fcfe6":{"description":"Sandbox environment","url":"https://api-sandbox.paywise.de"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"description":"Company-bound Case Management API key — the standard credential for this API.","scheme":"bearer","type":"http","scopes":[],"schemeName":"caseBearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Company-bound Case Management API key — the standard credential for this API.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"caseBearerAuth","name":"Authorization"}],"title":"caseBearerAuth"},{"schemes":[{"scheme":{"description":"Partner API key acting for one entitled company; every Case request must then also carry the X-On-Behalf-Of-Company header.","scheme":"bearer","type":"http","scopes":[],"schemeName":"partnerBearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Partner API key acting for one entitled company; every Case request must then also carry the X-On-Behalf-Of-Company header.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"partnerBearerAuth","name":"Authorization"}],"title":"partnerBearerAuth"}]},"originalFileLocation":"api-docs/case-management-api/openapi.json"},"subdomain":"paywisegmbh","siteName":"paywise Knowledge Center","title":"Update debtor - paywise Knowledge Center","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"de":{"href":"/user-docs/overview","matchLevel":4},"en":{"href":"/api-docs/case-management-api/reference/debtors/update-debtor","matchLevel":0}}},"lastModified":"2026-10-16T12:47:30.847Z","originalFileLocation":"api-docs/case-management-api/reference/debtors/update-debtor.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"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\u0026#x27;s debtor is the case\u0026#x27;s own snapshot (published as MandateDebtor without an id) and is not a reusable debtor: it is neither listed nor readable here.\">\u003cmeta data-mint-head name=\"application-name\" content=\"paywise Knowledge Center\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/paywisegmbh/pNaPPB2tJ3SHoGQC/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/paywisegmbh/pNaPPB2tJ3SHoGQC/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/paywisegmbh/pNaPPB2tJ3SHoGQC/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/paywisegmbh/pNaPPB2tJ3SHoGQC/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/paywisegmbh/pNaPPB2tJ3SHoGQC/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/paywisegmbh/pNaPPB2tJ3SHoGQC/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/paywisegmbh/pNaPPB2tJ3SHoGQC/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/paywisegmbh/pNaPPB2tJ3SHoGQC/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/paywisegmbh/pNaPPB2tJ3SHoGQC/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update debtor - paywise Knowledge Center\">\u003cmeta data-mint-head property=\"og:description\" content=\"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\u0026#x27;s debtor is the case\u0026#x27;s own snapshot (published as MandateDebtor without an id) and is not a reusable debtor: it is neither listed nor readable here.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"paywise Knowledge Center\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.paywise.de/api-docs/case-management-api/reference/debtors/update-debtor\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://paywisegmbh.mintlify.site/_mintlify/api/og/v2?division=Debtors\u0026amp;title=Update+debtor\u0026amp;description=The+reusable+debtors+of+your+company.%0A%0AList%2C+retrieve%2C+create%2C+and+PATCH.+A+supplied+owned+collection%0A%28addresses%2C+bank+accounts%2C+communication+channels%2C+legal%0Ar\u0026amp;theme=bad878af30f1dee220dabe6f\u0026amp;signature=dc8e3bc2049f7463221f32f10f27627eccebe4455436aef0b651c057ecb6874b\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Update debtor - paywise Knowledge Center\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"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\u0026#x27;s debtor is the case\u0026#x27;s own snapshot (published as MandateDebtor without an id) and is not a reusable debtor: it is neither listed nor readable here.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://paywisegmbh.mintlify.site/_mintlify/api/og/v2?division=Debtors\u0026amp;title=Update+debtor\u0026amp;description=The+reusable+debtors+of+your+company.%0A%0AList%2C+retrieve%2C+create%2C+and+PATCH.+A+supplied+owned+collection%0A%28addresses%2C+bank+accounts%2C+communication+channels%2C+legal%0Ar\u0026amp;theme=bad878af30f1dee220dabe6f\u0026amp;signature=dc8e3bc2049f7463221f32f10f27627eccebe4455436aef0b651c057ecb6874b\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/paywisegmbh/pNaPPB2tJ3SHoGQC/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"paywise Knowledge Center\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#fd7e14\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.paywise.de/api-docs/case-management-api/reference/debtors/update-debtor\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-docs/case-management-api/reference/debtors/update-debtor.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.paywise.de/#organization\",\"name\":\"paywise Knowledge Center\",\"url\":\"https://docs.paywise.de\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/paywisegmbh/NM1UIIld1WRHivnS/logo/paywise-logo.svg?fit=max\u0026auto=format\u0026n=NM1UIIld1WRHivnS\u0026q=85\u0026s=0d1a1b06e878f9d25ef70b19e3df50cc\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.paywise.de#website\",\"name\":\"paywise Knowledge Center\",\"url\":\"https://docs.paywise.de\",\"publisher\":{\"@id\":\"https://docs.paywise.de/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.paywise.de/api-docs/case-management-api/reference/debtors/update-debtor#webpage\",\"url\":\"https://docs.paywise.de/api-docs/case-management-api/reference/debtors/update-debtor\",\"name\":\"Update debtor\",\"description\":\"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.\",\"dateModified\":\"2026-10-16T12:47:30.847Z\",\"isPartOf\":{\"@id\":\"https://docs.paywise.de#website\"},\"breadcrumb\":{\"@id\":\"https://docs.paywise.de/api-docs/case-management-api/reference/debtors/update-debtor#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.paywise.de/api-docs/case-management-api/reference/debtors/update-debtor#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Case Management API\",\"item\":\"https://docs.paywise.de/api-docs/case-management-api/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Case Management API reference\",\"item\":\"https://docs.paywise.de/api-docs/case-management-api/reference/orders/list-orders\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Debtors\",\"item\":\"https://docs.paywise.de/api-docs/case-management-api/reference/debtors/list-debtors\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Update debtor\",\"item\":\"https://docs.paywise.de/api-docs/case-management-api/reference/debtors/update-debtor\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.paywise.de/api-docs/case-management-api/reference/debtors/update-debtor#apireference\",\"headline\":\"Update debtor\",\"name\":\"Update debtor\",\"description\":\"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.\",\"url\":\"https://docs.paywise.de/api-docs/case-management-api/reference/debtors/update-debtor\",\"mainEntityOfPage\":{\"@id\":\"https://docs.paywise.de/api-docs/case-management-api/reference/debtors/update-debtor#webpage\"},\"dateModified\":\"2026-10-16T12:47:30.847Z\",\"publisher\":{\"@id\":\"https://docs.paywise.de/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.paywise.de#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"paywise Knowledge Center\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"paywise Knowledge Center\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-docs/case-management-api/reference/debtors/update-debtor.md","siteName":"paywise Knowledge Center","nav":{"global":null,"languages":[{"language":"de","default":true,"pages":[{"title":"de","href":"/user-docs/overview"}]},{"language":"en","tabs":[{"tab":"User documentation","icon":"book-open","pages":[{"title":"User documentation","href":"/en/user-docs/overview"}]},{"tab":"Integrations","icon":"plug","pages":[{"title":"Integrations","href":"/en/integrations/overview"}]},{"tab":"Technical documentation","icon":"code","pages":[{"group":"Start here","icon":"house","pages":[{"title":"API overview","href":"/api-docs/overview"},{"title":"API Changelog","href":"/api-docs/changelog"}]},{"group":"API essentials","icon":"arrows-left-right","pages":[{"title":"Authentication and environments","href":"/api-docs/essentials/authentication-and-environments"},{"title":"Requests and responses","href":"/api-docs/essentials/requests-and-responses"},{"title":"Errors and safe retries","href":"/api-docs/essentials/errors-and-safe-retries"},{"title":"Pagination and synchronization","href":"/api-docs/essentials/pagination-and-synchronization"},{"title":"Public limits","href":"/api-docs/essentials/limits"},{"title":"Versioning and deprecation","href":"/api-docs/essentials/versioning"},{"title":"Webhooks","href":"/api-docs/essentials/webhooks"}]},{"group":"Case Management API","icon":"/images/icons/case-api.svg","pages":[{"title":"Case Management API","href":"/api-docs/case-management-api/introduction"},{"title":"Case Management quickstart","href":"/api-docs/case-management-api/quickstart"},{"group":"Concepts","pages":[{"title":"Core resources","href":"/api-docs/case-management-api/concepts/resource-model"},{"title":"Debtors","href":"/api-docs/case-management-api/concepts/debtors"},{"title":"Orders","href":"/api-docs/case-management-api/concepts/orders"},{"title":"Claims","href":"/api-docs/case-management-api/concepts/claims"},{"title":"Mandates","href":"/api-docs/case-management-api/concepts/mandates"},{"title":"Documents and communication","href":"/api-docs/case-management-api/concepts/documents-and-communication"},{"title":"Payments","href":"/api-docs/case-management-api/concepts/payments"},{"title":"Statements","href":"/api-docs/case-management-api/concepts/statements"},{"title":"Webhook events","href":"/api-docs/case-management-api/concepts/webhook-events"},{"title":"Sandbox environment","href":"/api-docs/case-management-api/concepts/sandbox"}]},{"group":"Workflows","pages":[{"title":"Submit an order","href":"/api-docs/case-management-api/workflows/submit-an-order"},{"title":"Submit a rental order","href":"/api-docs/case-management-api/workflows/submit-a-rental-order"},{"title":"Submit a titled order","href":"/api-docs/case-management-api/workflows/submit-a-titled-order"},{"title":"Manage documents","href":"/api-docs/case-management-api/workflows/manage-documents"},{"title":"Follow a case","href":"/api-docs/case-management-api/workflows/follow-a-case"},{"title":"Read debtor correspondence","href":"/api-docs/case-management-api/workflows/read-debtor-correspondence"},{"title":"Messages and client requests","href":"/api-docs/case-management-api/workflows/messages-and-client-requests"},{"title":"Report payments","href":"/api-docs/case-management-api/workflows/report-payments"},{"title":"Consume Case webhooks","href":"/api-docs/case-management-api/workflows/consume-webhooks"}]},{"title":"Migrate from Case Management API v1","href":"/api-docs/case-management-api/migrate-from-v1"},{"title":"Use with Postman","href":"/api-docs/case-management-api/postman"},{"group":"Case Management API reference","pages":[{"group":"Orders","icon":"file-lines","pages":[{"title":"List orders","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/","href":"/api-docs/case-management-api/reference/orders/list-orders"},{"title":"Create order","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/orders/","href":"/api-docs/case-management-api/reference/orders/create-order"},{"title":"Get order","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{id}/","href":"/api-docs/case-management-api/reference/orders/get-order"},{"title":"Update order","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json patch /v2/orders/{id}/","href":"/api-docs/case-management-api/reference/orders/update-order"},{"title":"Delete draft order","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json delete /v2/orders/{id}/","href":"/api-docs/case-management-api/reference/orders/delete-draft-order"},{"title":"Finalize order","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/orders/{id}/finalize/","href":"/api-docs/case-management-api/reference/orders/finalize-order"},{"title":"Withdraw order","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/orders/{id}/withdraw/","href":"/api-docs/case-management-api/reference/orders/withdraw-order"},{"group":"Messages","icon":"comments","pages":[{"title":"List order messages","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/messages/","href":"/api-docs/case-management-api/reference/orders/list-order-messages"},{"title":"Create order message","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/orders/{order_id}/messages/","href":"/api-docs/case-management-api/reference/orders/create-order-message"},{"title":"Get order message","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/messages/{id}/","href":"/api-docs/case-management-api/reference/orders/get-order-message"},{"title":"Update order message","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json patch /v2/orders/{order_id}/messages/{id}/","href":"/api-docs/case-management-api/reference/orders/update-order-message"},{"title":"List order message documents","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/messages/{message_id}/documents/","href":"/api-docs/case-management-api/reference/orders/list-order-message-documents"},{"title":"Create order message document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/orders/{order_id}/messages/{message_id}/documents/","href":"/api-docs/case-management-api/reference/orders/create-order-message-document"},{"title":"Get order message document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/messages/{message_id}/documents/{id}/","href":"/api-docs/case-management-api/reference/orders/get-order-message-document"},{"title":"Delete order message document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json delete /v2/orders/{order_id}/messages/{message_id}/documents/{id}/","href":"/api-docs/case-management-api/reference/orders/delete-order-message-document"},{"title":"Download order message document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/messages/{message_id}/documents/{id}/download/","href":"/api-docs/case-management-api/reference/orders/download-order-message-document"}]},{"group":"Requests to client","icon":"inbox","pages":[{"title":"List order requests to client","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/requests-to-client/","href":"/api-docs/case-management-api/reference/orders/list-order-requests-to-client"},{"title":"Get order request to client","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/requests-to-client/{id}/","href":"/api-docs/case-management-api/reference/orders/get-order-request-to-client"},{"title":"Answer order request to client","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/orders/{order_id}/requests-to-client/{id}/answer/","href":"/api-docs/case-management-api/reference/orders/answer-order-request-to-client"},{"title":"Download order request to client attachment","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/requests-to-client/{id}/attachments/{attachment_id}/download/","href":"/api-docs/case-management-api/reference/orders/download-order-request-to-client-attachment"},{"title":"List order request to client answer documents","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/requests-to-client/{request_id}/answer/documents/","href":"/api-docs/case-management-api/reference/orders/list-order-request-to-client-answer-documents"},{"title":"Create order request to client answer document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/orders/{order_id}/requests-to-client/{request_id}/answer/documents/","href":"/api-docs/case-management-api/reference/orders/create-order-request-to-client-answer-document"},{"title":"Get order request to client answer document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/requests-to-client/{request_id}/answer/documents/{id}/","href":"/api-docs/case-management-api/reference/orders/get-order-request-to-client-answer-document"},{"title":"Delete order request to client answer document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json delete /v2/orders/{order_id}/requests-to-client/{request_id}/answer/documents/{id}/","href":"/api-docs/case-management-api/reference/orders/delete-order-request-to-client-answer-document"},{"title":"Download order request to client answer document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/requests-to-client/{request_id}/answer/documents/{id}/download/","href":"/api-docs/case-management-api/reference/orders/download-order-request-to-client-answer-document"}]}]},{"group":"Claims","icon":"file-spreadsheet","pages":[{"title":"List claims","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/claims/","href":"/api-docs/case-management-api/reference/claims/list-claims"},{"title":"Create claim","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/claims/","href":"/api-docs/case-management-api/reference/claims/create-claim"},{"title":"Get claim","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/claims/{id}/","href":"/api-docs/case-management-api/reference/claims/get-claim"},{"title":"Update claim","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json patch /v2/claims/{id}/","href":"/api-docs/case-management-api/reference/claims/update-claim"},{"title":"Delete claim","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json delete /v2/claims/{id}/","href":"/api-docs/case-management-api/reference/claims/delete-claim"},{"group":"Documents","icon":"file-lines","pages":[{"title":"List claim documents","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/claims/{claim_id}/documents/","href":"/api-docs/case-management-api/reference/documents/list-claim-documents"},{"title":"Create claim document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/claims/{claim_id}/documents/","href":"/api-docs/case-management-api/reference/documents/create-claim-document"},{"title":"Get claim document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/claims/{claim_id}/documents/{id}/","href":"/api-docs/case-management-api/reference/documents/get-claim-document"},{"title":"Delete claim document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json delete /v2/claims/{claim_id}/documents/{id}/","href":"/api-docs/case-management-api/reference/documents/delete-claim-document"},{"title":"Download claim document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/claims/{claim_id}/documents/{id}/download/","href":"/api-docs/case-management-api/reference/documents/download-claim-document"}]},{"group":"Payments","icon":"credit-card","pages":[{"title":"List claim payments","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/claims/{claim_id}/payments/","href":"/api-docs/case-management-api/reference/claims/list-claim-payments"},{"title":"Create claim payment","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/claims/{claim_id}/payments/","href":"/api-docs/case-management-api/reference/claims/create-claim-payment"},{"title":"Delete claim payment","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json delete /v2/claims/{claim_id}/payments/{id}/","href":"/api-docs/case-management-api/reference/claims/delete-claim-payment"}]},{"group":"Enforceable titles","icon":"scale-balanced","pages":[{"title":"Get enforceable title","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/claims/{claim_id}/enforceable-title/","href":"/api-docs/case-management-api/reference/claims/get-enforceable-title"},{"title":"Replace enforceable title","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json put /v2/claims/{claim_id}/enforceable-title/","href":"/api-docs/case-management-api/reference/claims/replace-enforceable-title"},{"title":"Update enforceable title","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json patch /v2/claims/{claim_id}/enforceable-title/","href":"/api-docs/case-management-api/reference/claims/update-enforceable-title"},{"title":"Delete enforceable title","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json delete /v2/claims/{claim_id}/enforceable-title/","href":"/api-docs/case-management-api/reference/claims/delete-enforceable-title"},{"title":"List enforceable title documents","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/claims/{claim_id}/enforceable-title/documents/","href":"/api-docs/case-management-api/reference/claims/list-enforceable-title-documents"},{"title":"Create enforceable title document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/claims/{claim_id}/enforceable-title/documents/","href":"/api-docs/case-management-api/reference/claims/create-enforceable-title-document"},{"title":"Get enforceable title document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/claims/{claim_id}/enforceable-title/documents/{id}/","href":"/api-docs/case-management-api/reference/claims/get-enforceable-title-document"},{"title":"Delete enforceable title document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json delete /v2/claims/{claim_id}/enforceable-title/documents/{id}/","href":"/api-docs/case-management-api/reference/claims/delete-enforceable-title-document"},{"title":"Download enforceable title document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/claims/{claim_id}/enforceable-title/documents/{id}/download/","href":"/api-docs/case-management-api/reference/claims/download-enforceable-title-document"}]}]},{"group":"Rental agreements","icon":"house","pages":[{"title":"Get rental agreement","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/rental-agreement/","href":"/api-docs/case-management-api/reference/orders/get-rental-agreement"},{"title":"Update rental agreement","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json patch /v2/orders/{order_id}/rental-agreement/","href":"/api-docs/case-management-api/reference/orders/update-rental-agreement"},{"title":"List rental agreement documents","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/rental-agreement/documents/","href":"/api-docs/case-management-api/reference/orders/list-rental-agreement-documents"},{"title":"Create rental agreement document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/orders/{order_id}/rental-agreement/documents/","href":"/api-docs/case-management-api/reference/orders/create-rental-agreement-document"},{"title":"Get rental agreement document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/rental-agreement/documents/{id}/","href":"/api-docs/case-management-api/reference/orders/get-rental-agreement-document"},{"title":"Delete rental agreement document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json delete /v2/orders/{order_id}/rental-agreement/documents/{id}/","href":"/api-docs/case-management-api/reference/orders/delete-rental-agreement-document"},{"title":"Download rental agreement document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/rental-agreement/documents/{id}/download/","href":"/api-docs/case-management-api/reference/orders/download-rental-agreement-document"}]},{"group":"Debtors","icon":"users","pages":[{"title":"List debtors","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/debtors/","href":"/api-docs/case-management-api/reference/debtors/list-debtors"},{"title":"Create debtor","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/debtors/","href":"/api-docs/case-management-api/reference/debtors/create-debtor"},{"title":"Get debtor","description":"The reusable debtors of your company.\n\nList, retrieve, create, and PATCH. A supplied owned collection\n(addresses, bank accounts, communication channels, legal\nrepresentatives) replaces that collection completely; omitted\ncollections stay unchanged. A case's debtor is the case's own snapshot\n(published as `MandateDebtor` without an id) and is not a reusable\ndebtor: it is neither listed nor readable here.","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/debtors/{id}/","href":"/api-docs/case-management-api/reference/debtors/get-debtor"},{"title":"Update debtor","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json patch /v2/debtors/{id}/","href":"/api-docs/case-management-api/reference/debtors/update-debtor"}]},{"group":"Mandates","icon":"folder","pages":[{"title":"List mandates","description":"Accepted cases (Aktenzeichen).\n\nMain-case-centric: the list returns **main cases only**.\nSub-cases are reachable through the main case detail representation and\ndirect detail/subresource URLs, not a flat list expansion. Tenant-scoped by\nthe authenticated company.\n\nSub-resources of one mandate:\n\n * payments — the reported, non-ignored payments\n * documents — claim-document metadata and a proxy-stream download\n * history — published client activity, related resources, and attachments.\n A main case includes its subcases; a subcase includes only itself.\n\nThe sub-resource operations resolve the mandate **including sub-cases** —\nunlike the list, which hides sub-cases — so an individually-addressable\nsub-case's own track stays reachable. These public mandate operations are\nreads.","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/mandates/","href":"/api-docs/case-management-api/reference/mandates/list-mandates"},{"title":"Get mandate","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/mandates/{id}/","href":"/api-docs/case-management-api/reference/mandates/get-mandate"},{"title":"Get mandate documents","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/mandates/{id}/documents/","href":"/api-docs/case-management-api/reference/mandates/get-mandate-documents"},{"title":"Download mandate document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/mandates/{id}/documents/{doc_id}/download/","href":"/api-docs/case-management-api/reference/mandates/download-mandate-document"},{"title":"Get mandate history","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/mandates/{id}/history/","href":"/api-docs/case-management-api/reference/mandates/get-mandate-history"},{"title":"Download mandate history attachment","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/mandates/{id}/history/{entry_id}/attachments/{file_id}/download/","href":"/api-docs/case-management-api/reference/mandates/download-mandate-history-attachment"},{"title":"List mandate correspondence","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/mandates/{mandate_id}/correspondence/","href":"/api-docs/case-management-api/reference/mandates/list-mandate-correspondence"},{"title":"Get mandate correspondence item","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/mandates/{mandate_id}/correspondence/{id}/","href":"/api-docs/case-management-api/reference/mandates/get-mandate-correspondence-item"},{"title":"Download mandate correspondence attachment","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/mandates/{mandate_id}/correspondence/{id}/attachments/{attachment_id}/download/","href":"/api-docs/case-management-api/reference/mandates/download-mandate-correspondence-attachment"},{"title":"Download mandate correspondence PDF","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/mandates/{mandate_id}/correspondence/{id}/pdf/","href":"/api-docs/case-management-api/reference/mandates/download-mandate-correspondence-pdf"},{"group":"Messages","icon":"comments","pages":[{"title":"List mandate messages","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/mandates/{mandate_id}/messages/","href":"/api-docs/case-management-api/reference/mandates/list-mandate-messages"},{"title":"Create mandate message","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/mandates/{mandate_id}/messages/","href":"/api-docs/case-management-api/reference/mandates/create-mandate-message"},{"title":"Get mandate message","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/mandates/{mandate_id}/messages/{id}/","href":"/api-docs/case-management-api/reference/mandates/get-mandate-message"},{"title":"Update mandate message","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json patch /v2/mandates/{mandate_id}/messages/{id}/","href":"/api-docs/case-management-api/reference/mandates/update-mandate-message"},{"title":"List mandate message documents","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/mandates/{mandate_id}/messages/{message_id}/documents/","href":"/api-docs/case-management-api/reference/mandates/list-mandate-message-documents"},{"title":"Create mandate message document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/mandates/{mandate_id}/messages/{message_id}/documents/","href":"/api-docs/case-management-api/reference/mandates/create-mandate-message-document"},{"title":"Get mandate message document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/mandates/{mandate_id}/messages/{message_id}/documents/{id}/","href":"/api-docs/case-management-api/reference/mandates/get-mandate-message-document"},{"title":"Delete mandate message document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json delete /v2/mandates/{mandate_id}/messages/{message_id}/documents/{id}/","href":"/api-docs/case-management-api/reference/mandates/delete-mandate-message-document"},{"title":"Download mandate message document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/mandates/{mandate_id}/messages/{message_id}/documents/{id}/download/","href":"/api-docs/case-management-api/reference/mandates/download-mandate-message-document"}]},{"group":"Requests to client","icon":"inbox","pages":[{"title":"List mandate requests to client","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/mandates/{mandate_id}/requests-to-client/","href":"/api-docs/case-management-api/reference/mandates/list-mandate-requests-to-client"},{"title":"Get mandate request to client","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/mandates/{mandate_id}/requests-to-client/{id}/","href":"/api-docs/case-management-api/reference/mandates/get-mandate-request-to-client"},{"title":"Answer mandate request to client","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/mandates/{mandate_id}/requests-to-client/{id}/answer/","href":"/api-docs/case-management-api/reference/mandates/answer-mandate-request-to-client"},{"title":"Download mandate request to client attachment","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/mandates/{mandate_id}/requests-to-client/{id}/attachments/{attachment_id}/download/","href":"/api-docs/case-management-api/reference/mandates/download-mandate-request-to-client-attachment"},{"title":"List mandate request to client answer documents","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/mandates/{mandate_id}/requests-to-client/{request_id}/answer/documents/","href":"/api-docs/case-management-api/reference/mandates/list-mandate-request-to-client-answer-documents"},{"title":"Create mandate request to client answer document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/mandates/{mandate_id}/requests-to-client/{request_id}/answer/documents/","href":"/api-docs/case-management-api/reference/mandates/create-mandate-request-to-client-answer-document"},{"title":"Get mandate request to client answer document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/mandates/{mandate_id}/requests-to-client/{request_id}/answer/documents/{id}/","href":"/api-docs/case-management-api/reference/mandates/get-mandate-request-to-client-answer-document"},{"title":"Delete mandate request to client answer document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json delete /v2/mandates/{mandate_id}/requests-to-client/{request_id}/answer/documents/{id}/","href":"/api-docs/case-management-api/reference/mandates/delete-mandate-request-to-client-answer-document"},{"title":"Download mandate request to client answer document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/mandates/{mandate_id}/requests-to-client/{request_id}/answer/documents/{id}/download/","href":"/api-docs/case-management-api/reference/mandates/download-mandate-request-to-client-answer-document"}]}]},{"group":"Payments","icon":"credit-card","pages":[{"title":"List payments","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/payments/","href":"/api-docs/case-management-api/reference/payments/list-payments"},{"title":"Get payment","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/payments/{id}/","href":"/api-docs/case-management-api/reference/payments/get-payment"},{"title":"List mandate payments","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/mandates/{mandate_id}/payments/","href":"/api-docs/case-management-api/reference/mandates/list-mandate-payments"},{"title":"Create mandate payment","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/mandates/{mandate_id}/payments/","href":"/api-docs/case-management-api/reference/mandates/create-mandate-payment"}]},{"group":"Statements","icon":"chart-pie","pages":[{"title":"List statements","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/statements/","href":"/api-docs/case-management-api/reference/statements/list-statements"},{"title":"Get statement","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/statements/{id}/","href":"/api-docs/case-management-api/reference/statements/get-statement"},{"title":"Download statement","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/statements/{id}/download/","href":"/api-docs/case-management-api/reference/statements/download-statement"},{"title":"List statement cases","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/statements/{id}/mandates/","href":"/api-docs/case-management-api/reference/statements/list-statement-cases"}]},{"group":"Single mandate statements","icon":"file-invoice","pages":[{"title":"List single mandate statements","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/single-mandate-statements/","href":"/api-docs/case-management-api/reference/single-mandate-statements/list-single-mandate-statements"},{"title":"Get single mandate statement","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/single-mandate-statements/{id}/","href":"/api-docs/case-management-api/reference/single-mandate-statements/get-single-mandate-statement"},{"title":"Download single mandate statement PDF","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/single-mandate-statements/{id}/download/","href":"/api-docs/case-management-api/reference/single-mandate-statements/download-single-mandate-statement-pdf"}]},{"group":"Webhooks","icon":"bell","pages":[{"title":"List webhooks","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/webhooks/","href":"/api-docs/case-management-api/reference/webhooks/list-webhooks"},{"title":"Create webhook","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/webhooks/","href":"/api-docs/case-management-api/reference/webhooks/create-webhook"},{"title":"Get webhook","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/webhooks/{id}/","href":"/api-docs/case-management-api/reference/webhooks/get-webhook"},{"title":"Update webhook","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json patch /v2/webhooks/{id}/","href":"/api-docs/case-management-api/reference/webhooks/update-webhook"},{"title":"Delete webhook","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json delete /v2/webhooks/{id}/","href":"/api-docs/case-management-api/reference/webhooks/delete-webhook"},{"title":"Rotate webhook secret","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/webhooks/{id}/rotate-secret/","href":"/api-docs/case-management-api/reference/webhooks/rotate-webhook-secret"},{"title":"Test webhook","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/webhooks/{id}/test/","href":"/api-docs/case-management-api/reference/webhooks/test-webhook"}]},{"group":"Webhook deliveries","icon":"paper-plane","pages":[{"title":"List webhook deliveries","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/webhook-deliveries/","href":"/api-docs/case-management-api/reference/webhook-deliveries/list-webhook-deliveries"},{"title":"Get webhook delivery","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/webhook-deliveries/{id}/","href":"/api-docs/case-management-api/reference/webhook-deliveries/get-webhook-delivery"},{"title":"Redeliver webhook delivery","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/webhook-deliveries/{id}/redeliver/","href":"/api-docs/case-management-api/reference/webhook-deliveries/redeliver-webhook-delivery"}]},{"group":"Events","icon":"list-timeline","pages":[{"title":"List events","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/events/","href":"/api-docs/case-management-api/reference/events/list-events"}]},{"group":"Reference and status","icon":"circle-info","pages":[{"title":"List legal forms","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/legal-forms/","href":"/api-docs/case-management-api/reference/legal-forms/list-legal-forms"},{"title":"Get Case credential context","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/info/","href":"/api-docs/case-management-api/reference/info/get-case-credential-context"},{"title":"Get rate-limit headroom","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/usage/","href":"/api-docs/case-management-api/reference/usage/get-rate-limit-headroom"},{"title":"Health check","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/health/","href":"/api-docs/case-management-api/reference/health/health-check"}]}]}]},{"group":"Partner API","icon":"/images/icons/partner-api.svg","pages":[{"title":"Partner API","href":"/api-docs/partner-api/introduction"},{"title":"Partner quickstart","href":"/api-docs/partner-api/quickstart"},{"group":"Concepts","pages":[{"title":"Companies and users","href":"/api-docs/partner-api/concepts/resources-and-memberships"},{"title":"Readiness and access","href":"/api-docs/partner-api/concepts/readiness-and-access"},{"title":"Calling the Case Management API","href":"/api-docs/partner-api/concepts/calling-the-case-api"},{"title":"Webhooks","href":"/api-docs/partner-api/concepts/webhook-ownership"}]},{"group":"Workflows","pages":[{"title":"API-only onboarding","href":"/api-docs/partner-api/workflows/api-only-onboarding"},{"title":"Hosted onboarding","href":"/api-docs/partner-api/workflows/hosted-onboarding"},{"title":"Manage memberships","href":"/api-docs/partner-api/workflows/manage-memberships"},{"title":"Resolve readiness","href":"/api-docs/partner-api/workflows/resolve-readiness"},{"title":"Submit cases for a company","href":"/api-docs/partner-api/workflows/submit-cases-for-a-company"},{"title":"Handle access changes","href":"/api-docs/partner-api/workflows/handle-access-changes"},{"title":"Release a company","href":"/api-docs/partner-api/workflows/release-a-company"},{"title":"Consume Partner webhooks","href":"/api-docs/partner-api/workflows/consume-webhooks"}]},{"title":"Migrate from Partner API v1","href":"/api-docs/partner-api/migrate-from-v1"},{"group":"Partner API reference","pages":[{"group":"Companies","icon":"building","pages":[{"title":"List managed companies","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json get /partner/v2/companies/","href":"/api-docs/partner-api/reference/companies/list-managed-companies"},{"title":"Onboard a company","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json post /partner/v2/companies/","href":"/api-docs/partner-api/reference/companies/onboard-a-company"},{"title":"Get a managed company","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json get /partner/v2/companies/{id}/","href":"/api-docs/partner-api/reference/companies/get-a-managed-company"},{"title":"Update a company","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json patch /partner/v2/companies/{id}/","href":"/api-docs/partner-api/reference/companies/update-a-company-patch"},{"title":"Release a company","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json post /partner/v2/companies/{id}/release/","href":"/api-docs/partner-api/reference/companies/release-a-company"}]},{"group":"Company memberships","icon":"users","pages":[{"title":"List company memberships","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json get /partner/v2/companies/{company_id}/users/","href":"/api-docs/partner-api/reference/company-users/list-company-memberships"},{"title":"Add a company membership","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json post /partner/v2/companies/{company_id}/users/","href":"/api-docs/partner-api/reference/company-users/add-a-company-membership"},{"title":"Get a company membership","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json get /partner/v2/companies/{company_id}/users/{membership_id}/","href":"/api-docs/partner-api/reference/company-users/get-a-company-membership"},{"title":"Change a pending membership role","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json patch /partner/v2/companies/{company_id}/users/{membership_id}/","href":"/api-docs/partner-api/reference/company-users/change-a-pending-membership-role"},{"title":"Cancel a pending company membership","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json post /partner/v2/companies/{company_id}/users/{membership_id}/cancel/","href":"/api-docs/partner-api/reference/company-users/cancel-a-pending-company-membership"},{"title":"Replace and resend a pending setup token","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json post /partner/v2/companies/{company_id}/users/{membership_id}/resend/","href":"/api-docs/partner-api/reference/company-users/replace-and-resend-a-pending-setup-token"},{"title":"Revoke an active company membership","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json post /partner/v2/companies/{company_id}/users/{membership_id}/revoke/","href":"/api-docs/partner-api/reference/company-users/revoke-an-active-company-membership"}]},{"group":"Webhooks","icon":"bell","pages":[{"title":"List webhooks","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json get /partner/v2/webhooks/","href":"/api-docs/partner-api/reference/webhooks/list-webhooks"},{"title":"Create webhook","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json post /partner/v2/webhooks/","href":"/api-docs/partner-api/reference/webhooks/create-webhook"},{"title":"Get webhook","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json get /partner/v2/webhooks/{id}/","href":"/api-docs/partner-api/reference/webhooks/get-webhook"},{"title":"Update webhook","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json patch /partner/v2/webhooks/{id}/","href":"/api-docs/partner-api/reference/webhooks/update-webhook"},{"title":"Delete webhook","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json delete /partner/v2/webhooks/{id}/","href":"/api-docs/partner-api/reference/webhooks/delete-webhook"},{"title":"Rotate webhook secret","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json post /partner/v2/webhooks/{id}/rotate-secret/","href":"/api-docs/partner-api/reference/webhooks/rotate-webhook-secret"},{"title":"Test webhook","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json post /partner/v2/webhooks/{id}/test/","href":"/api-docs/partner-api/reference/webhooks/test-webhook"}]},{"group":"Webhook deliveries","icon":"paper-plane","pages":[{"title":"List webhook deliveries","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json get /partner/v2/webhook-deliveries/","href":"/api-docs/partner-api/reference/webhook-deliveries/list-webhook-deliveries"},{"title":"Get webhook delivery","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json get /partner/v2/webhook-deliveries/{id}/","href":"/api-docs/partner-api/reference/webhook-deliveries/get-webhook-delivery"},{"title":"Redeliver webhook delivery","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json post /partner/v2/webhook-deliveries/{id}/redeliver/","href":"/api-docs/partner-api/reference/webhook-deliveries/redeliver-webhook-delivery"}]},{"group":"Events","icon":"list-timeline","pages":[{"title":"List events","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json get /partner/v2/events/","href":"/api-docs/partner-api/reference/events/list-events"}]},{"group":"Reference and status","icon":"circle-info","pages":[{"title":"List legal forms","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json get /partner/v2/legal-forms/","href":"/api-docs/partner-api/reference/legal-forms/list-legal-forms"},{"title":"Health check","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json get /partner/v2/health/","href":"/api-docs/partner-api/reference/meta/health-check"},{"title":"Get partner token info","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json get /partner/v2/info/","href":"/api-docs/partner-api/reference/meta/get-partner-token-info"},{"title":"Get rate-limit headroom","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json get /partner/v2/usage/","href":"/api-docs/partner-api/reference/usage/get-rate-limit-headroom"}]}]}]},{"group":"Mahnservice API","icon":"/images/icons/mahnservice-api.svg","pages":[{"title":"Mahnservice API","href":"/api-docs/mahnservice-api/introduction"},{"title":"Mahnservice quickstart","href":"/api-docs/mahnservice-api/quickstart"},{"group":"Concepts","pages":[{"title":"Invoice lifecycle","href":"/api-docs/mahnservice-api/concepts/invoice-lifecycle"},{"title":"Invoice documents","href":"/api-docs/mahnservice-api/concepts/documents"},{"title":"Ownership and access","href":"/api-docs/mahnservice-api/concepts/ownership-and-access"},{"title":"Invoice groups — implementation plan","href":"/api-docs/mahnservice-api/concepts/invoice-groups"}]},{"group":"Mahnservice API reference","pages":[{"group":"Invoices","icon":"file-invoice","pages":[{"title":"List invoices","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json get /mahnservice/v1/invoices/","href":"/api-docs/mahnservice-api/reference/invoices/list-invoices"},{"title":"Submit an invoice","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json post /mahnservice/v1/invoices/","href":"/api-docs/mahnservice-api/reference/invoices/submit-an-invoice"},{"title":"Get an invoice","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json get /mahnservice/v1/invoices/{uuid}/","href":"/api-docs/mahnservice-api/reference/invoices/get-an-invoice"},{"title":"Correct a held invoice","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json patch /mahnservice/v1/invoices/{uuid}/","href":"/api-docs/mahnservice-api/reference/invoices/correct-a-held-invoice"},{"title":"Cancel an invoice (Storno)","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json post /mahnservice/v1/invoices/{uuid}/cancel/","href":"/api-docs/mahnservice-api/reference/invoices/cancel-an-invoice-storno"},{"title":"List the invoice documents","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json get /mahnservice/v1/invoices/{uuid}/documents/","href":"/api-docs/mahnservice-api/reference/invoices/list-the-invoice-documents"},{"title":"Attach the invoice PDF","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json post /mahnservice/v1/invoices/{uuid}/documents/","href":"/api-docs/mahnservice-api/reference/invoices/attach-the-invoice-pdf"},{"title":"Get an invoice document","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json get /mahnservice/v1/invoices/{uuid}/documents/{document_uuid}/","href":"/api-docs/mahnservice-api/reference/invoices/get-an-invoice-document"},{"title":"Download the invoice document","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json get /mahnservice/v1/invoices/{uuid}/documents/{document_uuid}/download/","href":"/api-docs/mahnservice-api/reference/invoices/download-the-invoice-document"},{"title":"Get the dunning state","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json get /mahnservice/v1/invoices/{uuid}/dunning/","href":"/api-docs/mahnservice-api/reference/invoices/get-the-dunning-state"},{"title":"Pause the dunning process","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json post /mahnservice/v1/invoices/{uuid}/dunning/pause/","href":"/api-docs/mahnservice-api/reference/invoices/pause-the-dunning-process"},{"title":"Resume the dunning process","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json post /mahnservice/v1/invoices/{uuid}/dunning/resume/","href":"/api-docs/mahnservice-api/reference/invoices/resume-the-dunning-process"},{"title":"List reported payments","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json get /mahnservice/v1/invoices/{uuid}/payments/","href":"/api-docs/mahnservice-api/reference/invoices/list-reported-payments"},{"title":"Report a payment","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json post /mahnservice/v1/invoices/{uuid}/payments/","href":"/api-docs/mahnservice-api/reference/invoices/report-a-payment"},{"title":"Release a held invoice for dunning","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json post /mahnservice/v1/invoices/{uuid}/release/","href":"/api-docs/mahnservice-api/reference/invoices/release-a-held-invoice-for-dunning"},{"title":"Write off an invoice (Ausbuchung)","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json post /mahnservice/v1/invoices/{uuid}/write-off/","href":"/api-docs/mahnservice-api/reference/invoices/write-off-an-invoice-ausbuchung"}]},{"group":"Debtors","icon":"users","pages":[{"title":"List debtors","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json get /mahnservice/v1/debtors/","href":"/api-docs/mahnservice-api/reference/debtors/list-debtors"},{"title":"Create a debtor","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json post /mahnservice/v1/debtors/","href":"/api-docs/mahnservice-api/reference/debtors/create-a-debtor"},{"title":"Get a debtor","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json get /mahnservice/v1/debtors/{uuid}/","href":"/api-docs/mahnservice-api/reference/debtors/get-a-debtor"}]},{"group":"Dunning flows","icon":"list-check","pages":[{"title":"List dunning flows","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json get /mahnservice/v1/dunning-flows/","href":"/api-docs/mahnservice-api/reference/dunning-flows/list-dunning-flows"},{"title":"Get a dunning flow","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json get /mahnservice/v1/dunning-flows/{uuid}/","href":"/api-docs/mahnservice-api/reference/dunning-flows/get-a-dunning-flow"}]},{"group":"Reference and status","icon":"circle-info","pages":[{"title":"Get token info","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json get /mahnservice/v1/info/","href":"/api-docs/mahnservice-api/reference/info/get-token-info"}]}]}]},{"group":"SDKs","icon":"code","pages":[{"title":"SDKs","href":"/sdks/overview"}]},{"group":"Integrations","icon":"plug","pages":[{"title":"Introduction","href":"/integrations/introduction"},{"title":"Make","href":"/integrations/make"},{"title":"n8n","href":"/integrations/n8n-node"},{"title":"Zapier","href":"/integrations/zapier"}]},{"group":"Legacy APIs (v1)","icon":"box-archive","pages":[{"title":"Legacy API v1 snapshot","href":"/api-docs/legacy/overview"},{"group":"Frozen Case Management API","pages":[{"title":"Introduction","href":"/api-docs/legacy/case-management/introduction"},{"group":"Statements guides","pages":[{"title":"Statements Overview","href":"/api-docs/legacy/case-management/statements/overview"},{"title":"Single Mandate Statements Overview","href":"/api-docs/legacy/case-management/single-mandate-statements/overview"}]},{"group":"Status update guides","pages":[{"title":"Search status updates","href":"/api-docs/legacy/case-management/status-updates/overview"}]},{"group":"Webhook guides","pages":[{"title":"Webhooks","href":"/api-docs/legacy/case-management/webhooks/overview"},{"title":"Event Types","href":"/api-docs/legacy/case-management/webhooks/event-types"},{"title":"Manage Endpoints","href":"/api-docs/legacy/case-management/webhooks/manage-endpoints"},{"title":"Signature Verification","href":"/api-docs/legacy/case-management/webhooks/signature-verification"},{"title":"Delivery \u0026 Retries","href":"/api-docs/legacy/case-management/webhooks/delivery-and-retries"}]},{"title":"Release Notes","href":"/api-docs/legacy/case-management/releasenotes"},{"group":"Frozen Case Management API reference","pages":[{"group":"claims","pages":[{"title":"List claims","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/claims/","href":"/api-docs/legacy/case-management/reference/claims/list-claims"},{"title":"Create a claim","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json post /v1/claims/","href":"/api-docs/legacy/case-management/reference/claims/create-a-claim"},{"title":"Retrieve a claim","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/claims/{id}/","href":"/api-docs/legacy/case-management/reference/claims/retrieve-a-claim"},{"title":"Delete an unreleased claim","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json delete /v1/claims/{id}/","href":"/api-docs/legacy/case-management/reference/claims/delete-an-unreleased-claim"},{"title":"Release claim for processing","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json patch /v1/claims/{id}/","href":"/api-docs/legacy/case-management/reference/claims/release-claim-for-processing"},{"title":"Upload a document to a claim","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json post /v1/claims/{id}/documents/","href":"/api-docs/legacy/case-management/reference/claims/upload-a-document-to-a-claim"}]},{"group":"debtors","pages":[{"title":"List debtors","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/debtors/","href":"/api-docs/legacy/case-management/reference/debtors/list-debtors"},{"title":"Create a debtor","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json post /v1/debtors/","href":"/api-docs/legacy/case-management/reference/debtors/create-a-debtor"},{"title":"Retrieve a debtor","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/debtors/{id}/","href":"/api-docs/legacy/case-management/reference/debtors/retrieve-a-debtor"},{"title":"Add address to a debtor","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json post /v1/debtors/{id}/addresses/","href":"/api-docs/legacy/case-management/reference/debtors/add-address-to-a-debtor"},{"title":"Add bank account to a debtor","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json post /v1/debtors/{id}/bankaccounts/","href":"/api-docs/legacy/case-management/reference/debtors/add-bank-account-to-a-debtor"},{"title":"Add debtor Communication Channel","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json post /v1/debtors/{id}/communicationchannels/","href":"/api-docs/legacy/case-management/reference/debtors/add-debtor-communication-channel"}]},{"group":"info","pages":[{"title":"Get v1info","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/info/","href":"/api-docs/legacy/case-management/reference/info/get-v1info"}]},{"group":"mandates","pages":[{"title":"List mandates","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/mandates/","href":"/api-docs/legacy/case-management/reference/mandates/list-mandates"},{"title":"Retrieve a mandate","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/mandates/{id}/","href":"/api-docs/legacy/case-management/reference/mandates/retrieve-a-mandate"},{"title":"Archive a mandate","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json patch /v1/mandates/{id}/","href":"/api-docs/legacy/case-management/reference/mandates/archive-a-mandate"},{"title":"List status updates","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/mandates/{id}/statusupdates/","href":"/api-docs/legacy/case-management/reference/mandates/list-status-updates"},{"title":"List requests to client for a mandate","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/mandates/{mandate_id}/requests-to-client/","href":"/api-docs/legacy/case-management/reference/mandates/list-requests-to-client-for-a-mandate"},{"title":"Get request to client details","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/mandates/{mandate_id}/requests-to-client/{request_id}/","href":"/api-docs/legacy/case-management/reference/mandates/get-request-to-client-details"},{"title":"Submit request to client answer","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json post /v1/mandates/{mandate_id}/requests-to-client/{request_id}/answer/","href":"/api-docs/legacy/case-management/reference/mandates/submit-request-to-client-answer"},{"title":"Upload document to request to client answer","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json post /v1/mandates/{mandate_id}/requests-to-client/{request_id}/answer/documents/","href":"/api-docs/legacy/case-management/reference/mandates/upload-document-to-request-to-client-answer"}]},{"group":"payments","pages":[{"title":"List payments","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/payments/","href":"/api-docs/legacy/case-management/reference/payments/list-payments"},{"title":"Create a payment","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json post /v1/payments/","href":"/api-docs/legacy/case-management/reference/payments/create-a-payment"},{"title":"Retrieve a payment","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/payments/{id}/","href":"/api-docs/legacy/case-management/reference/payments/retrieve-a-payment"}]},{"group":"single-mandate-statements","pages":[{"title":"List Aktenabrechnungen","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/single-mandate-statements/","href":"/api-docs/legacy/case-management/reference/single-mandate-statements/list-aktenabrechnungen"},{"title":"Retrieve an Aktenabrechnung","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/single-mandate-statements/{id}/","href":"/api-docs/legacy/case-management/reference/single-mandate-statements/retrieve-an-aktenabrechnung"}]},{"group":"statements","pages":[{"title":"List statements","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/statements/","href":"/api-docs/legacy/case-management/reference/statements/list-statements"},{"title":"Retrieve a statement","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/statements/{id}/","href":"/api-docs/legacy/case-management/reference/statements/retrieve-a-statement"},{"title":"List mandate details for statement","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/statements/{statement_id}/mandate-details/","href":"/api-docs/legacy/case-management/reference/statements/list-mandate-details-for-statement"}]},{"group":"statusupdates","pages":[{"title":"Search status updates across mandates","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/statusupdates/","href":"/api-docs/legacy/case-management/reference/statusupdates/search-status-updates-across-mandates"}]},{"group":"webhook-deliveries","pages":[{"title":"List all webhook deliveries","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/webhook-deliveries/","href":"/api-docs/legacy/case-management/reference/webhook-deliveries/list-all-webhook-deliveries"},{"title":"Retrieve a webhook delivery","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/webhook-deliveries/{id}/","href":"/api-docs/legacy/case-management/reference/webhook-deliveries/retrieve-a-webhook-delivery"}]},{"group":"webhooks","pages":[{"title":"List webhook endpoints","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/webhooks/","href":"/api-docs/legacy/case-management/reference/webhooks/list-webhook-endpoints"},{"title":"Create a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json post /v1/webhooks/","href":"/api-docs/legacy/case-management/reference/webhooks/create-a-webhook-endpoint"},{"title":"Retrieve a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/webhooks/{id}/","href":"/api-docs/legacy/case-management/reference/webhooks/retrieve-a-webhook-endpoint"},{"title":"Put v1webhooks ","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json put /v1/webhooks/{id}/","href":"/api-docs/legacy/case-management/reference/webhooks/put-v1webhooks-"},{"title":"Delete a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json delete /v1/webhooks/{id}/","href":"/api-docs/legacy/case-management/reference/webhooks/delete-a-webhook-endpoint"},{"title":"Update a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json patch /v1/webhooks/{id}/","href":"/api-docs/legacy/case-management/reference/webhooks/update-a-webhook-endpoint"},{"title":"List deliveries for a webhook","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/webhooks/{id}/deliveries/","href":"/api-docs/legacy/case-management/reference/webhooks/list-deliveries-for-a-webhook"},{"title":"Send a test event to webhook","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json post /v1/webhooks/{id}/test/","href":"/api-docs/legacy/case-management/reference/webhooks/send-a-test-event-to-webhook"}]}]}]},{"group":"Frozen Partner API","pages":[{"title":"Introduction","href":"/api-docs/legacy/partner/introduction"},{"title":"Get Started","href":"/api-docs/legacy/partner/getstarted"},{"title":"Entities","href":"/api-docs/legacy/partner/entities"},{"title":"API-Only Onboarding","href":"/api-docs/legacy/partner/onboarding-api-only"},{"title":"Web Flow Onboarding","href":"/api-docs/legacy/partner/onboarding-web-flow"},{"title":"Release Notes","href":"/api-docs/legacy/partner/releasenotes"},{"group":"Frozen Partner API reference","pages":[{"group":"companies","pages":[{"title":"List Companies","deprecated":null,"version":null,"openapi":"/api-docs/legacy/partner/openapi.json get /partner/v1/companies/","href":"/api-docs/legacy/partner/reference/companies/list-companies"},{"title":"Create Company","deprecated":null,"version":null,"openapi":"/api-docs/legacy/partner/openapi.json post /partner/v1/companies/","href":"/api-docs/legacy/partner/reference/companies/create-company"},{"title":"Get Company","deprecated":null,"version":null,"openapi":"/api-docs/legacy/partner/openapi.json get /partner/v1/companies/{id}/","href":"/api-docs/legacy/partner/reference/companies/get-company"},{"title":"Update Company","deprecated":null,"version":null,"openapi":"/api-docs/legacy/partner/openapi.json patch /partner/v1/companies/{id}/","href":"/api-docs/legacy/partner/reference/companies/update-company"}]},{"group":"info","pages":[{"title":"Get Token Info","deprecated":null,"version":null,"openapi":"/api-docs/legacy/partner/openapi.json get /partner/v1/info/","href":"/api-docs/legacy/partner/reference/info/get-token-info"}]},{"group":"userinvites","pages":[{"title":"Create User Invite","deprecated":null,"version":null,"openapi":"/api-docs/legacy/partner/openapi.json post /partner/v1/userinvites/","href":"/api-docs/legacy/partner/reference/userinvites/create-user-invite"},{"title":"Get User Invite","deprecated":null,"version":null,"openapi":"/api-docs/legacy/partner/openapi.json get /partner/v1/userinvites/{id}/","href":"/api-docs/legacy/partner/reference/userinvites/get-user-invite"},{"title":"Get Onboarded User","deprecated":null,"version":null,"openapi":"/api-docs/legacy/partner/openapi.json get /partner/v1/userinvites/{id}/get-onboarded-user/","href":"/api-docs/legacy/partner/reference/userinvites/get-onboarded-user"}]},{"group":"users","pages":[{"title":"List Users","deprecated":null,"version":null,"openapi":"/api-docs/legacy/partner/openapi.json get /partner/v1/users/","href":"/api-docs/legacy/partner/reference/users/list-users"},{"title":"Create user","deprecated":null,"version":null,"openapi":"/api-docs/legacy/partner/openapi.json post /partner/v1/users/","href":"/api-docs/legacy/partner/reference/users/create-user"},{"title":"Get User","deprecated":null,"version":null,"openapi":"/api-docs/legacy/partner/openapi.json get /partner/v1/users/{id}/","href":"/api-docs/legacy/partner/reference/users/get-user"}]}]}]}]}]}]}]},"basePath":"","title":"Update debtor - paywise Knowledge Center","deploymentId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","buildId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CrDfRf61.js","snippetPresets-Dv-cOUrx.js","utils-BUTreAgv.js","style-to-object-BY3JEAdk.js","utils-wsznt9RM.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-DEsMlaPy.js","conditional-requirements-CFM0id0Q.js","cloneDeep-DontW4xJ.js","_Uint8Array-pP7X6_RM.js","isObject-FP1Yky1u.js","ApiExamples-CU_aGGP0.js","usePlaygroundInputsStore-7dNmUIbS.js","shallow-fTtruD8x.js","isEqual-BRfNFpSD.js","CodeSnippets-52884wUJ.js","CodeSnippet-eoRjC4Le.js","getApiPlaygroundDisplay-CZyAPlR2.js","Page-Cr9IwkK7.js","DynamicMarkdown-NFqqduU7.js","SectionHeading-DQ-mJoAt.js","icon-DXTBUt6s.js","MethodPill-2v-b3js5.js","getPastedJson-v_8Y1_4v.js","DuplicateIcon-DXIkhZIo.js","createIcon-DRpYuPZs.js","axios-CsQoIw0U.js","Markdown-CwtoSfEf.js","AssistantPageLink-CTqa3eoi.js","dist-DIfYWxfm.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}