using RestSharp;
var options = new RestClientOptions("https://api.paywise.de/v2/mandates/{id}/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
Main-case-centric: the list returns main cases only.
Sub-cases are reachable through the main case detail representation and
direct detail/subresource URLs, not a flat list expansion. Tenant-scoped by
the authenticated company.
Sub-resources of one mandate:
payments — the reported, non-ignored payments
documents — claim-document metadata and a proxy-stream download
history — published client activity, related resources, and attachments.
A main case includes its subcases; a subcase includes only itself.
The sub-resource operations resolve the mandate including sub-cases —
unlike the list, which hides sub-cases — so an individually-addressable
sub-case’s own track stays reachable. These public mandate operations are
reads.
using RestSharp;
var options = new RestClientOptions("https://api.paywise.de/v2/mandates/{id}/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
Claims of the main case, shared by the main case and its sub-cases, ordered by creation time.
A receivable claim based on an invoice, rent, or another obligation. Its principal amount, dates, charges, and documents belong to the claim.
Receivable claim
Titled claim
Show child attributes
created_at
string<date-time>
required
read-only
Time at which the accepted case was created.
debtor
object | null
required
Debtor associated with the accepted case.
Show child attributes
id
string<uuid>
required
read-only
Stable identifier of the accepted case.
legal_balance
object | null
required
Legal claim, payments, and remaining balance by component for the main case, shared with its sub-cases; null when no legal balance is available.
Show child attributes
main_case
object | null
required
Main case when this resource is a sub-case.
Show child attributes
previous_reference_numbers
string[]
required
read-only
Earlier paywise case-file reference numbers of this case. Usually empty: when a case is re-keyed, reference_number shows the new number and the previous one is appended here. The reference_number list filter also matches these exactly.
reference_number
string
required
read-only
paywise case-file reference number.
state
object
required
Current legal, processing, and payment states.
Show child attributes
subcases
object[]
required
read-only
Up to 100 sub-cases grouped under this main case, ordered by sub-case number. Empty when this resource is itself a sub-case.
Show child attributes
total_amount
object | null
required
Current claim total maintained on the main case, shared with its sub-cases. Use the mandate detail legal_balance for the legal claim and remaining balance broken down by component.
Show child attributes
updated_at
string<date-time>
required
read-only
Time at which the accepted case was last updated.
history
object[]
Up to 100 published history entries. Included only when history=true; use the paginated history endpoint for the full timeline.
Show child attributes
{"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.4248","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/mandates/get-mandate","slug":"/api-docs/case-management-api/reference/mandates/get-mandate","pageMetadata":{"title":"Get mandate","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/{id}/","href":"/api-docs/case-management-api/reference/mandates/get-mandate","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 li: \"li\",\n p: \"p\",\n strong: \"strong\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Accepted cases (Aktenzeichen).\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Main-case-centric: the list returns \", _jsx(_components.strong, {\n children: \"main cases only\"\n }), \".\\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 }), \"\\n\", _jsx(_components.p, {\n children: \"Sub-resources of one mandate:\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"payments — the reported, non-ignored payments\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"documents — claim-document metadata and a proxy-stream download\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"history — published client activity, related resources, and attachments.\\nA main case includes its subcases; a subcase includes only itself.\"\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"The sub-resource operations resolve the mandate \", _jsx(_components.strong, {\n children: \"including sub-cases\"\n }), \" —\\nunlike the list, which hides sub-cases — so an individually-addressable\\nsub-case’s own track stays reachable. These public mandate operations are\\nreads.\"]\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":"Get mandate","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/{id}/","href":"/api-docs/case-management-api/reference/mandates/get-mandate","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/paywisegmbh/c0e4bbe3e0c9277e/api-field-anchors.js"],"openApiReferenceData":{"operation":{"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.","operationId":"get-mandate","parameters":["67b4b221-f5f5-4bdb-b6a1-e0a1ebf9857d","75c8efc2-c573-4da5-8e4c-4fd3f122b8ea","63d3e241-e9ad-4e53-8907-46a5d649ccfd","d347d971-7fae-45ee-b9ab-a9eb162ab1a5","c54c776b-323b-4c47-817b-f5092b249d79"],"responses":{"200":"8a2d0827-e60c-420d-82f3-f60e5e4410f1","304":"21d23399-5b98-4d73-95dc-b031267df514","400":"7574a124-94fb-48c9-b48d-6a4a4ecbf276","401":"b46e266c-1c8c-45db-a904-e44f3464c014","403":"51a7f002-11d4-4a89-862d-49c6164d2bf2","404":"e0d6a9a9-ebca-42d5-b97f-ac5f9df6eccf","429":"7121775a-d4a1-4e14-876f-ab92d38496d2","500":"678071ea-6bdf-405e-b871-1116ee509320"},"security":["25c2f2d8-676c-4ad4-9790-4f6ecbb59259","1b34f359-5912-49bc-978d-836313486b96"],"summary":"Get mandate","tags":["Mandates"],"x-required-scopes":["case:mandates:read"],"method":"get","type":"path","servers":["8c8f8cc6-b41f-4cad-9749-5ef9c02d1396","554ab33b-0043-40a7-a452-cca88c2fcfe6"],"path":"/v2/mandates/{id}/","baseUrlOptions":["https://api.paywise.de","https://api-sandbox.paywise.de"],"title":"Get mandate","codeSamples":[],"requestExampleLanguages":["python","javascript","java","csharp","bash"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[]},"dependencies":{"parameters":{"67b4b221-f5f5-4bdb-b6a1-e0a1ebf9857d":{"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>"}},"75c8efc2-c573-4da5-8e4c-4fd3f122b8ea":{"description":"With history=true, embed the typed related resource body.","in":"query","name":"expand","schema":{"enum":["history.related_resources"],"type":"string","description":"With history=true, embed the typed related resource body.","uniqueKey":"","typeLabel":"enum\u003cstring>"}},"63d3e241-e9ad-4e53-8907-46a5d649ccfd":{"description":"Embed up to 100 unified history entries.","in":"query","name":"history","schema":{"type":"boolean","description":"Embed up to 100 unified history entries.","uniqueKey":"","typeLabel":"boolean"}},"d347d971-7fae-45ee-b9ab-a9eb162ab1a5":{"description":"UUID of the accepted case in this request.","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string","isRequired":true,"description":"UUID of the accepted case in this request.","uniqueKey":"","typeLabel":"string\u003cuuid>"}},"c54c776b-323b-4c47-817b-f5092b249d79":{"description":"Return 304 with an empty body when the current `ETag` matches one of the supplied validators (or `*`).","in":"header","name":"If-None-Match","required":false,"schema":{"type":"string","isRequired":false,"description":"Return 304 with an empty body when the current `ETag` matches one of the supplied validators (or `*`).","uniqueKey":"","typeLabel":"string"}}},"responses":{"8a2d0827-e60c-420d-82f3-f60e5e4410f1":{"content":{"application/json":{"examples":{"mandate-main-case":{"title":"mandate-main-case","value":{"archived":false,"claims":[{"additional_charges":[],"additional_charges_amount":{"currency":"EUR","value":"0.00"},"additional_debtor_ids":[],"created_at":"2026-07-18T10:00:00Z","debtor_id":"40000000-0000-4000-8000-000000000001","delay_date":"2026-07-09","dispute_reason":null,"document_date":"2026-06-05","document_reference":"2026-0042","documents":[],"due_date":"2026-06-19","events":[{"description":null,"location":null,"occurence":"2026-06-05T09:00:00Z","title":"Invoice issued","type":"claim","your_reference":"2026-0042"}],"id":"30000000-0000-4000-8000-000000000001","is_disputed":false,"items":[],"legal_basis":{"claim_type_code":null,"contract_date":null,"description":null},"mandate_id":"50000000-0000-4000-8000-000000000001","metadata":[{"type":"comment","value":"Consulting invoice from the customer portal"}],"order_id":"20000000-0000-4000-8000-000000000001","payments":[],"principal_amount":{"currency":"EUR","value":"100.00"},"reminders":[],"status":"accepted","subject_matter":"Website accessibility consulting in June 2026","total_amount":{"currency":"EUR","value":"100.00"},"type":"receivable","updated_at":"2026-07-18T10:00:00Z","your_reference":"INV-2026-0042"}],"created_at":"2026-07-18T11:00:00Z","debtor":{"acting_as":"consumer","events":[{"description":null,"location":null,"occurence":"2026-05-01T09:00:00Z","title":"Customer registered","type":"registration","your_reference":null}],"legal_form":null,"metadata":[{"type":"user:reference","value":"CUSTOMER-1001"}],"organization":null,"person":{"birth_date":null,"first_name":"Alex","last_name":"Example","salutation":"mx"},"your_reference":"CUSTOMER-1001"},"id":"50000000-0000-4000-8000-000000000001","legal_balance":null,"main_case":null,"previous_reference_numbers":[],"reference_number":"PW-2026-000123","state":{"legal_stage":{"code":"extrajudicial","label":"Außergerichtlich","label_key":"mandate.state.legal_stage.extrajudicial"},"payment":{"code":"unpaid","label":"Unbezahlt","label_key":"mandate.state.payment.unpaid"},"processing":{"code":"in_progress","label":"Laufend","label_key":"mandate.state.processing.in_progress"}},"subcases":[],"total_amount":{"currency":"EUR","value":"100.00"},"updated_at":"2026-07-18T11:00:00Z"}},"mandate-subcase":{"title":"mandate-subcase","value":{"archived":false,"claims":[{"additional_charges":[],"additional_charges_amount":{"currency":"EUR","value":"0.00"},"additional_debtor_ids":[],"created_at":"2026-07-18T10:00:00Z","debtor_id":"40000000-0000-4000-8000-000000000001","delay_date":"2026-07-09","dispute_reason":null,"document_date":"2026-06-05","document_reference":"2026-0042","documents":[],"due_date":"2026-06-19","events":[{"description":null,"location":null,"occurence":"2026-06-05T09:00:00Z","title":"Invoice issued","type":"claim","your_reference":"2026-0042"}],"id":"30000000-0000-4000-8000-000000000001","is_disputed":false,"items":[],"legal_basis":{"claim_type_code":null,"contract_date":null,"description":null},"mandate_id":"50000000-0000-4000-8000-000000000001","metadata":[{"type":"comment","value":"Consulting invoice from the customer portal"}],"order_id":"20000000-0000-4000-8000-000000000001","payments":[],"principal_amount":{"currency":"EUR","value":"100.00"},"reminders":[],"status":"accepted","subject_matter":"Website accessibility consulting in June 2026","total_amount":{"currency":"EUR","value":"100.00"},"type":"receivable","updated_at":"2026-07-18T10:00:00Z","your_reference":"INV-2026-0042"}],"created_at":"2026-07-18T11:00:00Z","debtor":{"acting_as":"consumer","events":[{"description":null,"location":null,"occurence":"2026-05-01T09:00:00Z","title":"Customer registered","type":"registration","your_reference":null}],"legal_form":null,"metadata":[{"type":"user:reference","value":"CUSTOMER-1001"}],"organization":null,"person":{"birth_date":null,"first_name":"Alex","last_name":"Example","salutation":"mx"},"your_reference":"CUSTOMER-1001"},"id":"50000000-0000-4000-8000-000000000002","legal_balance":null,"main_case":{"debtor":{"acting_as":"consumer","events":[{"description":null,"location":null,"occurence":"2026-05-01T09:00:00Z","title":"Customer registered","type":"registration","your_reference":null}],"legal_form":null,"metadata":[{"type":"user:reference","value":"CUSTOMER-1001"}],"organization":null,"person":{"birth_date":null,"first_name":"Alex","last_name":"Example","salutation":"mx"},"your_reference":"CUSTOMER-1001"},"id":"50000000-0000-4000-8000-000000000001","reference_number":"PW-2026-000123"},"previous_reference_numbers":[],"reference_number":"PW-2026-000123-2","state":{"legal_stage":{"code":"extrajudicial","label":"Außergerichtlich","label_key":"mandate.state.legal_stage.extrajudicial"},"payment":{"code":"unpaid","label":"Unbezahlt","label_key":"mandate.state.payment.unpaid"},"processing":{"code":"in_progress","label":"Laufend","label_key":"mandate.state.processing.in_progress"}},"subcases":[],"total_amount":{"currency":"EUR","value":"100.00"},"updated_at":"2026-07-18T11:00:00Z"}}},"schema":{"description":"Complete representation of one case, including its main case and sub-cases.","properties":{"archived":{"description":"Whether your company archived the case from its active view.","readOnly":true,"type":"boolean","isRequired":true,"uniqueKey":"archived","typeLabel":"boolean"},"claims":{"description":"Claims of the main case, shared by the main case and its sub-cases, ordered by creation time.","items":{"oneOf":[{"type":"object","title":"Receivable claim","description":"A receivable claim based on an invoice, rent, or another obligation. Its principal amount, dates, charges, and documents belong to the claim.","required":["additional_charges","additional_charges_amount","additional_debtor_ids","created_at","debtor_id","delay_date","dispute_reason","document_date","document_reference","documents","due_date","events","id","is_disputed","items","legal_basis","mandate_id","metadata","order_id","payments","principal_amount","reminders","status","subject_matter","total_amount","type","updated_at","your_reference"],"properties":{"additional_charges":{"description":"Itemized incidental claims such as reminder or bank fees. API submissions are limited to 50 entries.","items":{"description":"Read representation of one canonical additional charge.","properties":{"amount":{"type":"object","description":"Amount of the additional charge.","required":["currency","value"],"properties":{"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","enum":["EUR"],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].amount.currency","typeLabel":"enum\u003cstring>"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].amount.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].amount","typeLabel":"object"},"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":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"description":"Optional description of the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].description","typeLabel":"string | null"},"location":{"oneOf":[{"description":"Optional location associated with the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].location.oneOf.0","typeLabel":"string"},{"description":"Optional location associated with the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].location.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].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":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].occurence","typeLabel":"string\u003cdate-time>"},"title":{"description":"Human-readable title of the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].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":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].type","typeLabel":"string"},"your_reference":{"oneOf":[{"description":"Your optional reference for the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].your_reference.oneOf.0","typeLabel":"string"},{"description":"Your optional reference for the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].your_reference","typeLabel":"string | null"}},"required":["description","location","occurence","title","type","your_reference"],"type":"object","uniqueKey":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events","typeLabel":"object[]"},"id":{"description":"Stable identifier of this additional charge.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"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":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].metadata.items.[INDEX].type","typeLabel":"string"},"value":{"description":"Stored metadata value.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].metadata.items.[INDEX].value","typeLabel":"string"}},"required":["type","value"],"type":"object","uniqueKey":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].metadata.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].metadata","typeLabel":"object[]"},"occurrence_date":{"oneOf":[{"description":"Date on which the additional charge arose.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].occurrence_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Date on which the additional charge arose.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].occurrence_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].occurrence_date","typeLabel":"string\u003cdate> | null"},"subject_matter":{"oneOf":[{"description":"Reason or subject of the additional charge.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].subject_matter.oneOf.0","typeLabel":"string"},{"description":"Reason or subject of the additional charge.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].subject_matter.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].subject_matter","typeLabel":"string | null"},"type":{"type":"string","description":"Business category of the additional charge.\n\n* `reminder_fee` - reminder_fee\n* `bank_charge` - bank_charge\n* `research_costs` - research_costs","enum":["reminder_fee","bank_charge","research_costs"],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"your_reference":{"oneOf":[{"description":"Your reference for this additional charge.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].your_reference.oneOf.0","typeLabel":"string"},{"description":"Your reference for this additional charge.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].your_reference","typeLabel":"string | null"}},"required":["amount","events","id","metadata","occurrence_date","subject_matter","type","your_reference"],"type":"object","uniqueKey":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.additional_charges","typeLabel":"object[]"},"additional_charges_amount":{"type":"object","description":"Sum of all itemized additional charges.","required":["currency","value"],"properties":{"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","enum":["EUR"],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.additional_charges_amount.currency","typeLabel":"enum\u003cstring>"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.additional_charges_amount.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.additional_charges_amount","typeLabel":"object"},"additional_debtor_ids":{"description":"Read-only additional debtor identifiers projected from the current order.","items":{"format":"uuid","type":"string","uniqueKey":"claims.items.[INDEX].oneOf.0.additional_debtor_ids.items.[INDEX]","typeLabel":"string\u003cuuid>"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.additional_debtor_ids","typeLabel":"string\u003cuuid>[]"},"created_at":{"description":"Time at which the claim was created.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.created_at","typeLabel":"string\u003cdate-time>"},"debtor_id":{"oneOf":[{"description":"Read-only primary debtor identifier projected from the current order. Change party membership only on a draft order; debtor details use the debtor resource.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.debtor_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"description":"Read-only primary debtor identifier projected from the current order. Change party membership only on a draft order; debtor details use the debtor resource.","format":"uuid","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.debtor_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.debtor_id","typeLabel":"string\u003cuuid> | null"},"delay_date":{"oneOf":[{"description":"Date from which the debtor is considered in payment default.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.delay_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Date from which the debtor is considered in payment default.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.delay_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.delay_date","typeLabel":"string\u003cdate> | null"},"dispute_reason":{"oneOf":[{"description":"Debtor's stated reason for disputing the claim.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.dispute_reason.oneOf.0","typeLabel":"string"},{"description":"Debtor's stated reason for disputing the claim.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.dispute_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.dispute_reason","typeLabel":"string | null"},"document_date":{"oneOf":[{"description":"Date of the invoice, contract, or other claim document.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.document_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Date of the invoice, contract, or other claim document.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.document_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.document_date","typeLabel":"string\u003cdate> | null"},"document_reference":{"oneOf":[{"description":"Invoice, contract, or other source-document number.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.document_reference.oneOf.0","typeLabel":"string"},{"description":"Invoice, contract, or other source-document number.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.document_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.document_reference","typeLabel":"string | null"},"documents":{"description":"Documents relevant to processing the claim.","items":{"description":"Resource representation with a native UUID `id`.","properties":{"created_at":{"description":"Time at which the document was submitted.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.documents.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"download_url":{"oneOf":[{"description":"Authenticated API URL for downloading the document; null while its status is not `ready`.","format":"uri","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.documents.items.[INDEX].download_url.oneOf.0","typeLabel":"string\u003curi>"},{"description":"Authenticated API URL for downloading the document; null while its status is not `ready`.","format":"uri","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.documents.items.[INDEX].download_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.documents.items.[INDEX].download_url","typeLabel":"string\u003curi> | null"},"failure_reason":{"oneOf":[{"type":"string","description":"Why processing failed when status is `failed`; `null` otherwise. `page_limit_exceeded`: PDF above the 100-page ceiling; `encrypted`: password-protected PDF; `corrupt`: bytes could not be parsed; `unsupported`: content type not accepted; `processing_failed`: any other processing error.","enum":["page_limit_exceeded","encrypted","corrupt","unsupported","processing_failed"],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.documents.items.[INDEX].failure_reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.documents.items.[INDEX].failure_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.documents.items.[INDEX].failure_reason","typeLabel":"enum\u003cstring> | null"},"filename":{"description":"Original filename shown to users.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.documents.items.[INDEX].filename","typeLabel":"string"},"id":{"description":"Stable identifier for this resource.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.documents.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"mime_type":{"oneOf":[{"description":"Detected media type of the document.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.documents.items.[INDEX].mime_type.oneOf.0","typeLabel":"string"},{"description":"Detected media type of the document.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.documents.items.[INDEX].mime_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.documents.items.[INDEX].mime_type","typeLabel":"string | null"},"parent":{"type":"object","description":"Resource that owns the document.","required":["id","type"],"properties":{"id":{"description":"Identifier of the resource that owns the document.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.documents.items.[INDEX].parent.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","description":"Kind of resource that owns the document.\n\n* `claim` - claim\n* `message` - message\n* `request_to_client_answer` - request_to_client_answer\n* `rental_agreement` - rental_agreement\n* `enforceable_title` - enforceable_title","enum":["claim","message","request_to_client_answer","rental_agreement","enforceable_title"],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.documents.items.[INDEX].parent.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.documents.items.[INDEX].parent","typeLabel":"object"},"status":{"type":"string","description":"Document availability: `pending` while scanning or processing is incomplete; `ready` when processing permits download; `failed` when scanning or processing failed; `rejected` when the malware check rejected the file.","enum":["pending","ready","failed","rejected"],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.documents.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"type":{"type":"string","description":"Business purpose of the document.","enum":["bank_statement","claim_statement","correspondence","enforceable_title","invoice","other","payment_proof","reminder","rental_agreement"],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.documents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updated_at":{"description":"Time at which document processing last changed.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.documents.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"}},"required":["created_at","download_url","failure_reason","filename","id","mime_type","parent","status","type","updated_at"],"type":"object","uniqueKey":"claims.items.[INDEX].oneOf.0.documents.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.documents","typeLabel":"object[]"},"due_date":{"oneOf":[{"description":"Date on which payment of the principal claim became due.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.due_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Date on which payment of the principal claim became due.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.due_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.due_date","typeLabel":"string\u003cdate> | null"},"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":"claims.items.[INDEX].oneOf.0.events.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"description":"Optional description of the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.events.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.events.items.[INDEX].description","typeLabel":"string | null"},"location":{"oneOf":[{"description":"Optional location associated with the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.events.items.[INDEX].location.oneOf.0","typeLabel":"string"},{"description":"Optional location associated with the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.events.items.[INDEX].location.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.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":"claims.items.[INDEX].oneOf.0.events.items.[INDEX].occurence","typeLabel":"string\u003cdate-time>"},"title":{"description":"Human-readable title of the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.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":"claims.items.[INDEX].oneOf.0.events.items.[INDEX].type","typeLabel":"string"},"your_reference":{"oneOf":[{"description":"Your optional reference for the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.events.items.[INDEX].your_reference.oneOf.0","typeLabel":"string"},{"description":"Your optional reference for the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.events.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.events.items.[INDEX].your_reference","typeLabel":"string | null"}},"required":["description","location","occurence","title","type","your_reference"],"type":"object","uniqueKey":"claims.items.[INDEX].oneOf.0.events.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.events","typeLabel":"object[]"},"id":{"description":"Stable identifier of this claim.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.id","typeLabel":"string\u003cuuid>"},"is_disputed":{"description":"Whether the debtor disputes the claim.","readOnly":true,"type":"boolean","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.is_disputed","typeLabel":"boolean"},"items":{"description":"Invoice or contract lines that make up the principal claim. API submissions are limited to 100 entries.","items":{"description":"Read representation of one invoice line.","properties":{"amount":{"type":"object","description":"Calculated line total: quantity multiplied by unit price.","required":["currency","value"],"properties":{"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","enum":["EUR"],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.\\items.items.[INDEX].amount.currency","typeLabel":"enum\u003cstring>"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.\\items.items.[INDEX].amount.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.\\items.items.[INDEX].amount","typeLabel":"object"},"description":{"description":"Goods or service represented by this invoice or contract line.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.\\items.items.[INDEX].description","typeLabel":"string"},"quantity":{"description":"Number of units represented by this line. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,10}(?:\\.[0-9]{1,6})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.\\items.items.[INDEX].quantity","typeLabel":"string"},"unit":{"oneOf":[{"description":"Unit of measure for the quantity, when applicable.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.\\items.items.[INDEX].unit.oneOf.0","typeLabel":"string"},{"description":"Unit of measure for the quantity, when applicable.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.\\items.items.[INDEX].unit.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.\\items.items.[INDEX].unit","typeLabel":"string | null"},"unit_price":{"type":"object","description":"Price of one unit before multiplying by quantity.","required":["currency","value"],"properties":{"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","enum":["EUR"],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.\\items.items.[INDEX].unit_price.currency","typeLabel":"enum\u003cstring>"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.\\items.items.[INDEX].unit_price.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.\\items.items.[INDEX].unit_price","typeLabel":"object"}},"required":["amount","description","quantity","unit","unit_price"],"type":"object","uniqueKey":"claims.items.[INDEX].oneOf.0.\\items.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.\\items","typeLabel":"object[]"},"legal_basis":{"type":"object","description":"Contract or obligation that establishes the principal claim.","required":["claim_type_code","contract_date","description"],"properties":{"claim_type_code":{"oneOf":[{"description":"Code identifying the contract or transaction underlying the claim. H17 is commercial rent, H19 is residential rent, and K014 identifies receivable enforcement costs in titled orders. See [legal basis codes](https://docs.paywise.de/api-docs/case-management-api/concepts/claims#legal-basis-codes) for the full code-to-meaning table.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.legal_basis.claim_type_code.oneOf.0","typeLabel":"string"},{"description":"Code identifying the contract or transaction underlying the claim. H17 is commercial rent, H19 is residential rent, and K014 identifies receivable enforcement costs in titled orders. See [legal basis codes](https://docs.paywise.de/api-docs/case-management-api/concepts/claims#legal-basis-codes) for the full code-to-meaning table.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.legal_basis.claim_type_code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.legal_basis.claim_type_code","typeLabel":"string | null"},"contract_date":{"oneOf":[{"description":"Date on which the underlying contract or obligation arose.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.legal_basis.contract_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Date on which the underlying contract or obligation arose.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.legal_basis.contract_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.legal_basis.contract_date","typeLabel":"string\u003cdate> | null"},"description":{"oneOf":[{"description":"Terms or circumstances establishing the principal claim. API submissions are limited to 2000 characters.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.legal_basis.description.oneOf.0","typeLabel":"string"},{"description":"Terms or circumstances establishing the principal claim. API submissions are limited to 2000 characters.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.legal_basis.description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.legal_basis.description","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.legal_basis","typeLabel":"object"},"mandate_id":{"oneOf":[{"description":"Read-only accepted mandate identifier, or null before acceptance.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.mandate_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"description":"Read-only accepted mandate identifier, or null before acceptance.","format":"uuid","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.mandate_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.mandate_id","typeLabel":"string\u003cuuid> | null"},"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":"claims.items.[INDEX].oneOf.0.metadata.items.[INDEX].type","typeLabel":"string"},"value":{"description":"Stored metadata value.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.metadata.items.[INDEX].value","typeLabel":"string"}},"required":["type","value"],"type":"object","uniqueKey":"claims.items.[INDEX].oneOf.0.metadata.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.metadata","typeLabel":"object[]"},"order_id":{"description":"Read-only current order identifier. Internal review may change this relationship while the claim identifier and all claim-specific URLs remain stable.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.order_id","typeLabel":"string\u003cuuid>"},"payments":{"description":"Read-only payments attributed to this claim. Report subsequent payments through the stable claim payments URL, including after acceptance or an internal order move. Reporting requires case:payments:write.","items":{"description":"Read representation of one reported payment.","properties":{"amount":{"oneOf":[{"type":"object","description":"Amount received.","required":["currency","value"],"properties":{"currency":{"description":"Currency of the payment.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.payments.items.[INDEX].amount.oneOf.0.currency","typeLabel":"string"},"value":{"description":"Amount received, expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.payments.items.[INDEX].amount.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.payments.items.[INDEX].amount.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.payments.items.[INDEX].amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.payments.items.[INDEX].amount","typeLabel":"object | null"},"claim":{"oneOf":[{"type":"object","description":"Claim to which the payment was reported.","required":["document_reference","id","your_reference"],"properties":{"document_reference":{"oneOf":[{"description":"Invoice, contract, or source-document number of the claim.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.payments.items.[INDEX].claim.oneOf.0.document_reference.oneOf.0","typeLabel":"string"},{"description":"Invoice, contract, or source-document number of the claim.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.payments.items.[INDEX].claim.oneOf.0.document_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.payments.items.[INDEX].claim.oneOf.0.document_reference","typeLabel":"string | null"},"id":{"description":"Identifier of the claim receiving the payment.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.payments.items.[INDEX].claim.oneOf.0.id","typeLabel":"string\u003cuuid>"},"your_reference":{"oneOf":[{"description":"Your reference for the claim.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.payments.items.[INDEX].claim.oneOf.0.your_reference.oneOf.0","typeLabel":"string"},{"description":"Your reference for the claim.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.payments.items.[INDEX].claim.oneOf.0.your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.payments.items.[INDEX].claim.oneOf.0.your_reference","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.payments.items.[INDEX].claim.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.payments.items.[INDEX].claim.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.payments.items.[INDEX].claim","typeLabel":"object | null"},"created_at":{"description":"Time at which the payment was reported.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.payments.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"id":{"description":"Stable identifier of this reported payment.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.payments.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"mandate":{"oneOf":[{"type":"object","description":"Accepted case containing the claim.","required":["id","reference_number"],"properties":{"id":{"description":"Identifier of the accepted case receiving the payment.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.payments.items.[INDEX].mandate.oneOf.0.id","typeLabel":"string\u003cuuid>"},"reference_number":{"description":"paywise case-file reference number.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.payments.items.[INDEX].mandate.oneOf.0.reference_number","typeLabel":"string"}},"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.payments.items.[INDEX].mandate.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.payments.items.[INDEX].mandate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.payments.items.[INDEX].mandate","typeLabel":"object | null"},"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":"claims.items.[INDEX].oneOf.0.payments.items.[INDEX].metadata.items.[INDEX].type","typeLabel":"string"},"value":{"description":"Stored metadata value.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.payments.items.[INDEX].metadata.items.[INDEX].value","typeLabel":"string"}},"required":["type","value"],"type":"object","uniqueKey":"claims.items.[INDEX].oneOf.0.payments.items.[INDEX].metadata.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.payments.items.[INDEX].metadata","typeLabel":"object[]"},"updated_at":{"description":"Time at which the payment record was last updated.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.payments.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"},"value_date":{"description":"Date on which the payment was credited.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.payments.items.[INDEX].value_date","typeLabel":"string\u003cdate>"},"your_reference":{"oneOf":[{"description":"Your reference for reconciling this payment.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.payments.items.[INDEX].your_reference.oneOf.0","typeLabel":"string"},{"description":"Your reference for reconciling this payment.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.payments.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.payments.items.[INDEX].your_reference","typeLabel":"string | null"}},"required":["amount","claim","created_at","id","mandate","metadata","updated_at","value_date","your_reference"],"type":"object","uniqueKey":"claims.items.[INDEX].oneOf.0.payments.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.payments","typeLabel":"object[]"},"principal_amount":{"oneOf":[{"type":"object","description":"Original principal amount including VAT, before charges and payments.","required":["currency","value"],"properties":{"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","enum":["EUR"],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.principal_amount.oneOf.0.currency","typeLabel":"enum\u003cstring>"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.principal_amount.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.principal_amount.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.principal_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.principal_amount","typeLabel":"object | null"},"reminders":{"description":"Payment reminders issued for this claim in chronological order. API submissions are limited to 50 entries.","items":{"description":"Read representation of one normalized reminder.","properties":{"date":{"oneOf":[{"description":"Date on which the payment reminder was issued.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.reminders.items.[INDEX].date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Date on which the payment reminder was issued.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.reminders.items.[INDEX].date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.reminders.items.[INDEX].date","typeLabel":"string\u003cdate> | null"},"due_date":{"oneOf":[{"description":"Payment deadline stated in the reminder, when present.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.reminders.items.[INDEX].due_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Payment deadline stated in the reminder, when present.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.reminders.items.[INDEX].due_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.reminders.items.[INDEX].due_date","typeLabel":"string\u003cdate> | null"},"id":{"oneOf":[{"description":"Stable identifier of this reminder.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.reminders.items.[INDEX].id.oneOf.0","typeLabel":"string\u003cuuid>"},{"description":"Stable identifier of this reminder.","format":"uuid","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.reminders.items.[INDEX].id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.reminders.items.[INDEX].id","typeLabel":"string\u003cuuid> | null"}},"required":["date","due_date","id"],"type":"object","uniqueKey":"claims.items.[INDEX].oneOf.0.reminders.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.reminders","typeLabel":"object[]"},"status":{"type":"string","description":"Read-only effective claim lifecycle. Draft-only commands return 409 claim_not_editable after submission and 409 order_expired once the draft has passed its expires_at; payment and title commands retain their specific lifecycle conflict codes.","enum":["draft","submitted","awaiting_client_response","accepted","rejected","withdrawn"],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.status","typeLabel":"enum\u003cstring>"},"subject_matter":{"oneOf":[{"description":"Goods, services, or other obligation underlying the claim. API submissions are limited to 2000 characters.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.subject_matter.oneOf.0","typeLabel":"string"},{"description":"Goods, services, or other obligation underlying the claim. API submissions are limited to 2000 characters.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.subject_matter.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.subject_matter","typeLabel":"string | null"},"total_amount":{"oneOf":[{"type":"object","description":"Current open amount after charges and reported payments.","required":["currency","value"],"properties":{"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","enum":["EUR"],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.total_amount.oneOf.0.currency","typeLabel":"enum\u003cstring>"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.total_amount.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.total_amount.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.total_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.total_amount","typeLabel":"object | null"},"type":{"type":"string","description":"Literal receivable claim discriminator.","enum":["receivable"],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"updated_at":{"description":"Time at which the claim was last updated.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.updated_at","typeLabel":"string\u003cdate-time>"},"your_reference":{"oneOf":[{"description":"Your reference for this claim.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.your_reference.oneOf.0","typeLabel":"string"},{"description":"Your reference for this claim.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.your_reference","typeLabel":"string | null"}},"uniqueKey":"claims.items.[INDEX].oneOf.0","typeLabel":"Receivable claim · object"},{"type":"object","title":"Titled claim","description":"A claim backed by an enforceable title. The title's amount, dates, and documents belong to `enforceable_title`.","required":["additional_debtor_ids","created_at","debtor_id","dispute_reason","document_reference","enforceable_title","events","id","is_disputed","mandate_id","metadata","order_id","payments","principal_amount","status","subject_matter","total_amount","type","updated_at","your_reference"],"properties":{"additional_debtor_ids":{"description":"Read-only additional debtor identifiers projected from the current order.","items":{"format":"uuid","type":"string","uniqueKey":"claims.items.[INDEX].oneOf.1.additional_debtor_ids.items.[INDEX]","typeLabel":"string\u003cuuid>"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.additional_debtor_ids","typeLabel":"string\u003cuuid>[]"},"created_at":{"description":"Time at which the claim was created.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.created_at","typeLabel":"string\u003cdate-time>"},"debtor_id":{"oneOf":[{"description":"Read-only primary debtor identifier projected from the current order. Change party membership only on a draft order; debtor details use the debtor resource.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.debtor_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"description":"Read-only primary debtor identifier projected from the current order. Change party membership only on a draft order; debtor details use the debtor resource.","format":"uuid","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.debtor_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.debtor_id","typeLabel":"string\u003cuuid> | null"},"dispute_reason":{"oneOf":[{"description":"Debtor's stated reason for disputing the claim.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.dispute_reason.oneOf.0","typeLabel":"string"},{"description":"Debtor's stated reason for disputing the claim.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.dispute_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.dispute_reason","typeLabel":"string | null"},"document_reference":{"oneOf":[{"description":"Invoice, contract, or other source-document number.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.document_reference.oneOf.0","typeLabel":"string"},{"description":"Invoice, contract, or other source-document number.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.document_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.document_reference","typeLabel":"string | null"},"enforceable_title":{"oneOf":[{"type":"object","description":"Enforceable title that owns this claim's gross amount, legal metadata, and title documents.","required":["amount","created_at","documents","file_number","id","issued_on","issuing_authority","legally_binding_since","served_on","title_type","updated_at"],"properties":{"amount":{"oneOf":[{"type":"object","description":"Gross amount confirmed by the client and owned by the enforceable title.","required":["value"],"properties":{"value":{"description":"Gross title amount in major currency units, with at most two decimal places. Zero is accepted while drafting; the amount must be positive before finalization. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.amount.oneOf.0.value","typeLabel":"string"},"currency":{"type":"string","description":"Currency of the title amount; only EUR is supported.","default":"EUR","enum":["EUR"],"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.amount.oneOf.0.currency","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.amount.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.amount","typeLabel":"object | null"},"created_at":{"description":"Time at which the enforceable title was created.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.created_at","typeLabel":"string\u003cdate-time>"},"documents":{"description":"Documents owned by the title; one primary enforceable-title document is required before finalization.","items":{"description":"Resource representation with a native UUID `id`.","properties":{"created_at":{"description":"Time at which the document was submitted.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"download_url":{"oneOf":[{"description":"Authenticated API URL for downloading the document; null while its status is not `ready`.","format":"uri","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].download_url.oneOf.0","typeLabel":"string\u003curi>"},{"description":"Authenticated API URL for downloading the document; null while its status is not `ready`.","format":"uri","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].download_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].download_url","typeLabel":"string\u003curi> | null"},"failure_reason":{"oneOf":[{"type":"string","description":"Why processing failed when status is `failed`; `null` otherwise. `page_limit_exceeded`: PDF above the 100-page ceiling; `encrypted`: password-protected PDF; `corrupt`: bytes could not be parsed; `unsupported`: content type not accepted; `processing_failed`: any other processing error.","enum":["page_limit_exceeded","encrypted","corrupt","unsupported","processing_failed"],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].failure_reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].failure_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].failure_reason","typeLabel":"enum\u003cstring> | null"},"filename":{"description":"Original filename shown to users.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].filename","typeLabel":"string"},"id":{"description":"Stable identifier for this resource.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"mime_type":{"oneOf":[{"description":"Detected media type of the document.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].mime_type.oneOf.0","typeLabel":"string"},{"description":"Detected media type of the document.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].mime_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].mime_type","typeLabel":"string | null"},"parent":{"type":"object","description":"Resource that owns the document.","required":["id","type"],"properties":{"id":{"description":"Identifier of the resource that owns the document.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].parent.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","description":"Kind of resource that owns the document.\n\n* `claim` - claim\n* `message` - message\n* `request_to_client_answer` - request_to_client_answer\n* `rental_agreement` - rental_agreement\n* `enforceable_title` - enforceable_title","enum":["claim","message","request_to_client_answer","rental_agreement","enforceable_title"],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].parent.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].parent","typeLabel":"object"},"status":{"type":"string","description":"Document availability: `pending` while scanning or processing is incomplete; `ready` when processing permits download; `failed` when scanning or processing failed; `rejected` when the malware check rejected the file.","enum":["pending","ready","failed","rejected"],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"type":{"type":"string","description":"Business purpose of the document.","enum":["bank_statement","claim_statement","correspondence","enforceable_title","invoice","other","payment_proof","reminder","rental_agreement"],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updated_at":{"description":"Time at which document processing last changed.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"}},"required":["created_at","download_url","failure_reason","filename","id","mime_type","parent","status","type","updated_at"],"type":"object","uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents","typeLabel":"object[]"},"file_number":{"description":"Official file or reference number shown on the title.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.file_number","typeLabel":"string"},"id":{"description":"Stable identifier of the enforceable title.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.id","typeLabel":"string\u003cuuid>"},"issued_on":{"oneOf":[{"description":"Date on which the enforceable title was issued.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.issued_on.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Date on which the enforceable title was issued.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.issued_on.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.issued_on","typeLabel":"string\u003cdate> | null"},"issuing_authority":{"description":"Court, notary, or other authority that issued the title.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.issuing_authority","typeLabel":"string"},"legally_binding_since":{"oneOf":[{"description":"Optional date from which the title is legally binding; it cannot precede issued_on.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.legally_binding_since.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Optional date from which the title is legally binding; it cannot precede issued_on.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.legally_binding_since.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.legally_binding_since","typeLabel":"string\u003cdate> | null"},"served_on":{"oneOf":[{"description":"Optional date on which the title was served; it cannot precede issued_on.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.served_on.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Optional date on which the title was served; it cannot precede issued_on.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.served_on.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.served_on","typeLabel":"string\u003cdate> | null"},"title_type":{"oneOf":[{"type":"string","description":"Legal title category: enforcement_order = Vollstreckungsbescheid; default_judgment = Versäumnisurteil; final_judgment = Endurteil; acknowledgment_judgment = Anerkenntnisurteil; reservation_judgment = Vorbehaltsurteil; court_settlement = Gerichtlicher Vergleich; enforceable_notarial_deed = Vollstreckbare notarielle Urkunde; cost_assessment_order = Kostenfestsetzungsbeschluss; other = Sonstiger Titel.","enum":["enforcement_order","default_judgment","final_judgment","acknowledgment_judgment","reservation_judgment","court_settlement","enforceable_notarial_deed","cost_assessment_order","other"],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.title_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.title_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.title_type","typeLabel":"enum\u003cstring> | null"},"updated_at":{"description":"Time at which the enforceable title last changed.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.updated_at","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title","typeLabel":"object | null"},"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":"claims.items.[INDEX].oneOf.1.events.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"description":"Optional description of the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.events.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.events.items.[INDEX].description","typeLabel":"string | null"},"location":{"oneOf":[{"description":"Optional location associated with the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.events.items.[INDEX].location.oneOf.0","typeLabel":"string"},{"description":"Optional location associated with the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.events.items.[INDEX].location.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.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":"claims.items.[INDEX].oneOf.1.events.items.[INDEX].occurence","typeLabel":"string\u003cdate-time>"},"title":{"description":"Human-readable title of the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.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":"claims.items.[INDEX].oneOf.1.events.items.[INDEX].type","typeLabel":"string"},"your_reference":{"oneOf":[{"description":"Your optional reference for the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.events.items.[INDEX].your_reference.oneOf.0","typeLabel":"string"},{"description":"Your optional reference for the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.events.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.events.items.[INDEX].your_reference","typeLabel":"string | null"}},"required":["description","location","occurence","title","type","your_reference"],"type":"object","uniqueKey":"claims.items.[INDEX].oneOf.1.events.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.events","typeLabel":"object[]"},"id":{"description":"Stable identifier of this claim.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.id","typeLabel":"string\u003cuuid>"},"is_disputed":{"description":"Whether the debtor disputes the claim.","readOnly":true,"type":"boolean","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.is_disputed","typeLabel":"boolean"},"mandate_id":{"oneOf":[{"description":"Read-only accepted mandate identifier, or null before acceptance.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.mandate_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"description":"Read-only accepted mandate identifier, or null before acceptance.","format":"uuid","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.mandate_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.mandate_id","typeLabel":"string\u003cuuid> | null"},"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":"claims.items.[INDEX].oneOf.1.metadata.items.[INDEX].type","typeLabel":"string"},"value":{"description":"Stored metadata value.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.metadata.items.[INDEX].value","typeLabel":"string"}},"required":["type","value"],"type":"object","uniqueKey":"claims.items.[INDEX].oneOf.1.metadata.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.metadata","typeLabel":"object[]"},"order_id":{"description":"Read-only current order identifier. Internal review may change this relationship while the claim identifier and all claim-specific URLs remain stable.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.order_id","typeLabel":"string\u003cuuid>"},"payments":{"description":"Read-only payments attributed to this claim. Report subsequent payments through the stable claim payments URL, including after acceptance or an internal order move. Reporting requires case:payments:write.","items":{"description":"Read representation of one reported payment.","properties":{"amount":{"oneOf":[{"type":"object","description":"Amount received.","required":["currency","value"],"properties":{"currency":{"description":"Currency of the payment.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.payments.items.[INDEX].amount.oneOf.0.currency","typeLabel":"string"},"value":{"description":"Amount received, expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.payments.items.[INDEX].amount.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.payments.items.[INDEX].amount.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.payments.items.[INDEX].amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.payments.items.[INDEX].amount","typeLabel":"object | null"},"claim":{"oneOf":[{"type":"object","description":"Claim to which the payment was reported.","required":["document_reference","id","your_reference"],"properties":{"document_reference":{"oneOf":[{"description":"Invoice, contract, or source-document number of the claim.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.payments.items.[INDEX].claim.oneOf.0.document_reference.oneOf.0","typeLabel":"string"},{"description":"Invoice, contract, or source-document number of the claim.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.payments.items.[INDEX].claim.oneOf.0.document_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.payments.items.[INDEX].claim.oneOf.0.document_reference","typeLabel":"string | null"},"id":{"description":"Identifier of the claim receiving the payment.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.payments.items.[INDEX].claim.oneOf.0.id","typeLabel":"string\u003cuuid>"},"your_reference":{"oneOf":[{"description":"Your reference for the claim.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.payments.items.[INDEX].claim.oneOf.0.your_reference.oneOf.0","typeLabel":"string"},{"description":"Your reference for the claim.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.payments.items.[INDEX].claim.oneOf.0.your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.payments.items.[INDEX].claim.oneOf.0.your_reference","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.payments.items.[INDEX].claim.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.payments.items.[INDEX].claim.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.payments.items.[INDEX].claim","typeLabel":"object | null"},"created_at":{"description":"Time at which the payment was reported.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.payments.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"id":{"description":"Stable identifier of this reported payment.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.payments.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"mandate":{"oneOf":[{"type":"object","description":"Accepted case containing the claim.","required":["id","reference_number"],"properties":{"id":{"description":"Identifier of the accepted case receiving the payment.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.payments.items.[INDEX].mandate.oneOf.0.id","typeLabel":"string\u003cuuid>"},"reference_number":{"description":"paywise case-file reference number.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.payments.items.[INDEX].mandate.oneOf.0.reference_number","typeLabel":"string"}},"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.payments.items.[INDEX].mandate.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.payments.items.[INDEX].mandate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.payments.items.[INDEX].mandate","typeLabel":"object | null"},"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":"claims.items.[INDEX].oneOf.1.payments.items.[INDEX].metadata.items.[INDEX].type","typeLabel":"string"},"value":{"description":"Stored metadata value.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.payments.items.[INDEX].metadata.items.[INDEX].value","typeLabel":"string"}},"required":["type","value"],"type":"object","uniqueKey":"claims.items.[INDEX].oneOf.1.payments.items.[INDEX].metadata.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.payments.items.[INDEX].metadata","typeLabel":"object[]"},"updated_at":{"description":"Time at which the payment record was last updated.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.payments.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"},"value_date":{"description":"Date on which the payment was credited.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.payments.items.[INDEX].value_date","typeLabel":"string\u003cdate>"},"your_reference":{"oneOf":[{"description":"Your reference for reconciling this payment.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.payments.items.[INDEX].your_reference.oneOf.0","typeLabel":"string"},{"description":"Your reference for reconciling this payment.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.payments.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.payments.items.[INDEX].your_reference","typeLabel":"string | null"}},"required":["amount","claim","created_at","id","mandate","metadata","updated_at","value_date","your_reference"],"type":"object","uniqueKey":"claims.items.[INDEX].oneOf.1.payments.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.payments","typeLabel":"object[]"},"principal_amount":{"oneOf":[{"type":"object","description":"Always null for a titled claim; use enforceable_title.amount for the authoritative gross amount.","required":["currency","value"],"properties":{"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","enum":["EUR"],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.principal_amount.oneOf.0.currency","typeLabel":"enum\u003cstring>"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.principal_amount.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.principal_amount.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.principal_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.principal_amount","typeLabel":"object | null"},"status":{"type":"string","description":"Read-only effective claim lifecycle. Draft-only commands return 409 claim_not_editable after submission and 409 order_expired once the draft has passed its expires_at; payment and title commands retain their specific lifecycle conflict codes.","enum":["draft","submitted","awaiting_client_response","accepted","rejected","withdrawn"],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.status","typeLabel":"enum\u003cstring>"},"subject_matter":{"oneOf":[{"description":"Goods, services, or other obligation underlying the claim. API submissions are limited to 2000 characters.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.subject_matter.oneOf.0","typeLabel":"string"},{"description":"Goods, services, or other obligation underlying the claim. API submissions are limited to 2000 characters.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.subject_matter.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.subject_matter","typeLabel":"string | null"},"total_amount":{"oneOf":[{"type":"object","description":"Authoritative gross enforceable-title amount; reported payments are exposed separately and do not reduce it.","required":["currency","value"],"properties":{"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","enum":["EUR"],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.total_amount.oneOf.0.currency","typeLabel":"enum\u003cstring>"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.total_amount.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.total_amount.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.total_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.total_amount","typeLabel":"object | null"},"type":{"type":"string","description":"Literal titled claim discriminator.","enum":["titled"],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"updated_at":{"description":"Time at which the claim was last updated.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.updated_at","typeLabel":"string\u003cdate-time>"},"your_reference":{"oneOf":[{"description":"Your reference for this claim.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.your_reference.oneOf.0","typeLabel":"string"},{"description":"Your reference for this claim.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.your_reference","typeLabel":"string | null"}},"uniqueKey":"claims.items.[INDEX].oneOf.1","typeLabel":"Titled claim · object"}],"uniqueKey":"claims.items.[INDEX]","typeLabel":"Receivable claim · object | Titled claim · object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"claims","typeLabel":"(Receivable claim · object | Titled claim · object)[]"},"created_at":{"description":"Time at which the accepted case was created.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"debtor":{"oneOf":[{"type":"object","description":"Debtor associated with the accepted case.","required":["acting_as","events","legal_form","metadata","organization","person","your_reference"],"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":"debtor.oneOf.0.acting_as","typeLabel":"enum\u003cstring>"},"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":"debtor.oneOf.0.events.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"description":"Optional description of the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"debtor.oneOf.0.events.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"debtor.oneOf.0.events.items.[INDEX].description","typeLabel":"string | null"},"location":{"oneOf":[{"description":"Optional location associated with the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"debtor.oneOf.0.events.items.[INDEX].location.oneOf.0","typeLabel":"string"},{"description":"Optional location associated with the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"debtor.oneOf.0.events.items.[INDEX].location.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"debtor.oneOf.0.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":"debtor.oneOf.0.events.items.[INDEX].occurence","typeLabel":"string\u003cdate-time>"},"title":{"description":"Human-readable title of the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"debtor.oneOf.0.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":"debtor.oneOf.0.events.items.[INDEX].type","typeLabel":"string"},"your_reference":{"oneOf":[{"description":"Your optional reference for the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"debtor.oneOf.0.events.items.[INDEX].your_reference.oneOf.0","typeLabel":"string"},{"description":"Your optional reference for the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"debtor.oneOf.0.events.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"debtor.oneOf.0.events.items.[INDEX].your_reference","typeLabel":"string | null"}},"required":["description","location","occurence","title","type","your_reference"],"type":"object","uniqueKey":"debtor.oneOf.0.events.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"debtor.oneOf.0.events","typeLabel":"object[]"},"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":"debtor.oneOf.0.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":"debtor.oneOf.0.legal_form.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"debtor.oneOf.0.legal_form","typeLabel":"string | null"},"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":"debtor.oneOf.0.metadata.items.[INDEX].type","typeLabel":"string"},"value":{"description":"Stored metadata value.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"debtor.oneOf.0.metadata.items.[INDEX].value","typeLabel":"string"}},"required":["type","value"],"type":"object","uniqueKey":"debtor.oneOf.0.metadata.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"debtor.oneOf.0.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":"debtor.oneOf.0.organization.oneOf.0.commercial_register.oneOf.0","typeLabel":"string"},{"description":"Register court or authority holding the registration.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"debtor.oneOf.0.organization.oneOf.0.commercial_register.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"debtor.oneOf.0.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":"debtor.oneOf.0.organization.oneOf.0.commercial_registration_number.oneOf.0","typeLabel":"string"},{"description":"Commercial, association, or partnership register number.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"debtor.oneOf.0.organization.oneOf.0.commercial_registration_number.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"debtor.oneOf.0.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":"debtor.oneOf.0.organization.oneOf.0.name","typeLabel":"string"}},"isRequired":true,"uniqueKey":"debtor.oneOf.0.organization.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"debtor.oneOf.0.organization.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"debtor.oneOf.0.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":"debtor.oneOf.0.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":"debtor.oneOf.0.person.oneOf.0.birth_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"debtor.oneOf.0.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":"debtor.oneOf.0.person.oneOf.0.first_name","typeLabel":"string"},"last_name":{"description":"Family name of the natural person.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"debtor.oneOf.0.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":"debtor.oneOf.0.person.oneOf.0.salutation.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","isRequired":true,"uniqueKey":"debtor.oneOf.0.person.oneOf.0.salutation.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"debtor.oneOf.0.person.oneOf.0.salutation","typeLabel":"enum\u003cstring> | null"}},"isRequired":true,"uniqueKey":"debtor.oneOf.0.person.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"debtor.oneOf.0.person.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"debtor.oneOf.0.person","typeLabel":"object | null"},"your_reference":{"oneOf":[{"description":"Your reference for this debtor.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"debtor.oneOf.0.your_reference.oneOf.0","typeLabel":"string"},{"description":"Your reference for this debtor.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"debtor.oneOf.0.your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"debtor.oneOf.0.your_reference","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"debtor.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"debtor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"debtor","typeLabel":"object | null"},"id":{"description":"Stable identifier of the accepted case.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"legal_balance":{"oneOf":[{"type":"object","description":"Legal claim, payments, and remaining balance by component for the main case, shared with its sub-cases; null when no legal balance is available.","required":["balance_of_costs_interest_bearing","balance_of_costs_interest_free","balance_of_interest_on_costs","balance_of_interest_on_principal_claim","balance_of_principal_claim","legal_claim_of_costs_interest_bearing","legal_claim_of_costs_interest_free","legal_claim_of_interest_on_costs","legal_claim_of_interest_on_principal_claim","legal_claim_of_principal_claim","payment_on_costs_interest_bearing","payment_on_costs_interest_free","payment_on_interest_on_costs","payment_on_interest_on_principal_claim","payment_on_principal_claim","total_balance","total_legal_claim","total_payment","updated"],"properties":{"balance_of_costs_interest_bearing":{"oneOf":[{"type":"object","description":"Open balance of interest-bearing costs.","required":["currency","value"],"properties":{"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","enum":["EUR"],"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.balance_of_costs_interest_bearing.oneOf.0.currency","typeLabel":"enum\u003cstring>"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"legal_balance.oneOf.0.balance_of_costs_interest_bearing.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.balance_of_costs_interest_bearing.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"legal_balance.oneOf.0.balance_of_costs_interest_bearing.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.balance_of_costs_interest_bearing","typeLabel":"object | null"},"balance_of_costs_interest_free":{"oneOf":[{"type":"object","description":"Open balance of interest-free costs.","required":["currency","value"],"properties":{"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","enum":["EUR"],"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.balance_of_costs_interest_free.oneOf.0.currency","typeLabel":"enum\u003cstring>"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"legal_balance.oneOf.0.balance_of_costs_interest_free.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.balance_of_costs_interest_free.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"legal_balance.oneOf.0.balance_of_costs_interest_free.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.balance_of_costs_interest_free","typeLabel":"object | null"},"balance_of_interest_on_costs":{"oneOf":[{"type":"object","description":"Open balance of interest charged on costs.","required":["currency","value"],"properties":{"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","enum":["EUR"],"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.balance_of_interest_on_costs.oneOf.0.currency","typeLabel":"enum\u003cstring>"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"legal_balance.oneOf.0.balance_of_interest_on_costs.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.balance_of_interest_on_costs.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"legal_balance.oneOf.0.balance_of_interest_on_costs.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.balance_of_interest_on_costs","typeLabel":"object | null"},"balance_of_interest_on_principal_claim":{"oneOf":[{"type":"object","description":"Open balance of interest charged on the principal claim.","required":["currency","value"],"properties":{"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","enum":["EUR"],"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.balance_of_interest_on_principal_claim.oneOf.0.currency","typeLabel":"enum\u003cstring>"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"legal_balance.oneOf.0.balance_of_interest_on_principal_claim.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.balance_of_interest_on_principal_claim.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"legal_balance.oneOf.0.balance_of_interest_on_principal_claim.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.balance_of_interest_on_principal_claim","typeLabel":"object | null"},"balance_of_principal_claim":{"oneOf":[{"type":"object","description":"Open balance of the principal claim.","required":["currency","value"],"properties":{"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","enum":["EUR"],"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.balance_of_principal_claim.oneOf.0.currency","typeLabel":"enum\u003cstring>"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"legal_balance.oneOf.0.balance_of_principal_claim.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.balance_of_principal_claim.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"legal_balance.oneOf.0.balance_of_principal_claim.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.balance_of_principal_claim","typeLabel":"object | null"},"legal_claim_of_costs_interest_bearing":{"oneOf":[{"type":"object","description":"Total legal claim for interest-bearing costs.","required":["currency","value"],"properties":{"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","enum":["EUR"],"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.legal_claim_of_costs_interest_bearing.oneOf.0.currency","typeLabel":"enum\u003cstring>"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"legal_balance.oneOf.0.legal_claim_of_costs_interest_bearing.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.legal_claim_of_costs_interest_bearing.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"legal_balance.oneOf.0.legal_claim_of_costs_interest_bearing.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.legal_claim_of_costs_interest_bearing","typeLabel":"object | null"},"legal_claim_of_costs_interest_free":{"oneOf":[{"type":"object","description":"Total legal claim for interest-free costs.","required":["currency","value"],"properties":{"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","enum":["EUR"],"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.legal_claim_of_costs_interest_free.oneOf.0.currency","typeLabel":"enum\u003cstring>"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"legal_balance.oneOf.0.legal_claim_of_costs_interest_free.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.legal_claim_of_costs_interest_free.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"legal_balance.oneOf.0.legal_claim_of_costs_interest_free.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.legal_claim_of_costs_interest_free","typeLabel":"object | null"},"legal_claim_of_interest_on_costs":{"oneOf":[{"type":"object","description":"Total legal claim for interest on costs.","required":["currency","value"],"properties":{"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","enum":["EUR"],"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.legal_claim_of_interest_on_costs.oneOf.0.currency","typeLabel":"enum\u003cstring>"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"legal_balance.oneOf.0.legal_claim_of_interest_on_costs.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.legal_claim_of_interest_on_costs.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"legal_balance.oneOf.0.legal_claim_of_interest_on_costs.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.legal_claim_of_interest_on_costs","typeLabel":"object | null"},"legal_claim_of_interest_on_principal_claim":{"oneOf":[{"type":"object","description":"Total legal claim for interest on the principal claim.","required":["currency","value"],"properties":{"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","enum":["EUR"],"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.legal_claim_of_interest_on_principal_claim.oneOf.0.currency","typeLabel":"enum\u003cstring>"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"legal_balance.oneOf.0.legal_claim_of_interest_on_principal_claim.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.legal_claim_of_interest_on_principal_claim.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"legal_balance.oneOf.0.legal_claim_of_interest_on_principal_claim.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.legal_claim_of_interest_on_principal_claim","typeLabel":"object | null"},"legal_claim_of_principal_claim":{"oneOf":[{"type":"object","description":"Total legal principal claim.","required":["currency","value"],"properties":{"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","enum":["EUR"],"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.legal_claim_of_principal_claim.oneOf.0.currency","typeLabel":"enum\u003cstring>"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"legal_balance.oneOf.0.legal_claim_of_principal_claim.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.legal_claim_of_principal_claim.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"legal_balance.oneOf.0.legal_claim_of_principal_claim.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.legal_claim_of_principal_claim","typeLabel":"object | null"},"payment_on_costs_interest_bearing":{"oneOf":[{"type":"object","description":"Payments allocated to interest-bearing costs.","required":["currency","value"],"properties":{"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","enum":["EUR"],"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.payment_on_costs_interest_bearing.oneOf.0.currency","typeLabel":"enum\u003cstring>"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"legal_balance.oneOf.0.payment_on_costs_interest_bearing.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.payment_on_costs_interest_bearing.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"legal_balance.oneOf.0.payment_on_costs_interest_bearing.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.payment_on_costs_interest_bearing","typeLabel":"object | null"},"payment_on_costs_interest_free":{"oneOf":[{"type":"object","description":"Payments allocated to interest-free costs.","required":["currency","value"],"properties":{"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","enum":["EUR"],"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.payment_on_costs_interest_free.oneOf.0.currency","typeLabel":"enum\u003cstring>"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"legal_balance.oneOf.0.payment_on_costs_interest_free.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.payment_on_costs_interest_free.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"legal_balance.oneOf.0.payment_on_costs_interest_free.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.payment_on_costs_interest_free","typeLabel":"object | null"},"payment_on_interest_on_costs":{"oneOf":[{"type":"object","description":"Payments allocated to interest on costs.","required":["currency","value"],"properties":{"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","enum":["EUR"],"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.payment_on_interest_on_costs.oneOf.0.currency","typeLabel":"enum\u003cstring>"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"legal_balance.oneOf.0.payment_on_interest_on_costs.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.payment_on_interest_on_costs.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"legal_balance.oneOf.0.payment_on_interest_on_costs.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.payment_on_interest_on_costs","typeLabel":"object | null"},"payment_on_interest_on_principal_claim":{"oneOf":[{"type":"object","description":"Payments allocated to interest on the principal claim.","required":["currency","value"],"properties":{"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","enum":["EUR"],"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.payment_on_interest_on_principal_claim.oneOf.0.currency","typeLabel":"enum\u003cstring>"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"legal_balance.oneOf.0.payment_on_interest_on_principal_claim.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.payment_on_interest_on_principal_claim.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"legal_balance.oneOf.0.payment_on_interest_on_principal_claim.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.payment_on_interest_on_principal_claim","typeLabel":"object | null"},"payment_on_principal_claim":{"oneOf":[{"type":"object","description":"Payments allocated to the principal claim.","required":["currency","value"],"properties":{"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","enum":["EUR"],"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.payment_on_principal_claim.oneOf.0.currency","typeLabel":"enum\u003cstring>"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"legal_balance.oneOf.0.payment_on_principal_claim.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.payment_on_principal_claim.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"legal_balance.oneOf.0.payment_on_principal_claim.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.payment_on_principal_claim","typeLabel":"object | null"},"total_balance":{"oneOf":[{"type":"object","description":"Current total open balance of the legal claim.","required":["currency","value"],"properties":{"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","enum":["EUR"],"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.total_balance.oneOf.0.currency","typeLabel":"enum\u003cstring>"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"legal_balance.oneOf.0.total_balance.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.total_balance.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"legal_balance.oneOf.0.total_balance.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.total_balance","typeLabel":"object | null"},"total_legal_claim":{"oneOf":[{"type":"object","description":"Total legal claim before deducting payments.","required":["currency","value"],"properties":{"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","enum":["EUR"],"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.total_legal_claim.oneOf.0.currency","typeLabel":"enum\u003cstring>"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"legal_balance.oneOf.0.total_legal_claim.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.total_legal_claim.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"legal_balance.oneOf.0.total_legal_claim.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.total_legal_claim","typeLabel":"object | null"},"total_payment":{"oneOf":[{"type":"object","description":"Total payments allocated to the legal claim.","required":["currency","value"],"properties":{"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","enum":["EUR"],"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.total_payment.oneOf.0.currency","typeLabel":"enum\u003cstring>"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"legal_balance.oneOf.0.total_payment.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.total_payment.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"legal_balance.oneOf.0.total_payment.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"legal_balance.oneOf.0.total_payment","typeLabel":"object | null"},"updated":{"description":"Time at which the legal-claim balance was last updated.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"legal_balance.oneOf.0.updated","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"legal_balance.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"legal_balance.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"legal_balance","typeLabel":"object | null"},"main_case":{"oneOf":[{"type":"object","description":"Main case when this resource is a sub-case.","required":["debtor","id","reference_number"],"properties":{"debtor":{"oneOf":[{"type":"object","description":"Debtor associated with the accepted case.","required":["acting_as","events","legal_form","metadata","organization","person","your_reference"],"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":"main_case.oneOf.0.debtor.oneOf.0.acting_as","typeLabel":"enum\u003cstring>"},"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":"main_case.oneOf.0.debtor.oneOf.0.events.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"description":"Optional description of the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"main_case.oneOf.0.debtor.oneOf.0.events.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"main_case.oneOf.0.debtor.oneOf.0.events.items.[INDEX].description","typeLabel":"string | null"},"location":{"oneOf":[{"description":"Optional location associated with the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"main_case.oneOf.0.debtor.oneOf.0.events.items.[INDEX].location.oneOf.0","typeLabel":"string"},{"description":"Optional location associated with the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"main_case.oneOf.0.debtor.oneOf.0.events.items.[INDEX].location.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"main_case.oneOf.0.debtor.oneOf.0.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":"main_case.oneOf.0.debtor.oneOf.0.events.items.[INDEX].occurence","typeLabel":"string\u003cdate-time>"},"title":{"description":"Human-readable title of the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"main_case.oneOf.0.debtor.oneOf.0.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":"main_case.oneOf.0.debtor.oneOf.0.events.items.[INDEX].type","typeLabel":"string"},"your_reference":{"oneOf":[{"description":"Your optional reference for the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"main_case.oneOf.0.debtor.oneOf.0.events.items.[INDEX].your_reference.oneOf.0","typeLabel":"string"},{"description":"Your optional reference for the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"main_case.oneOf.0.debtor.oneOf.0.events.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"main_case.oneOf.0.debtor.oneOf.0.events.items.[INDEX].your_reference","typeLabel":"string | null"}},"required":["description","location","occurence","title","type","your_reference"],"type":"object","uniqueKey":"main_case.oneOf.0.debtor.oneOf.0.events.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"main_case.oneOf.0.debtor.oneOf.0.events","typeLabel":"object[]"},"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":"main_case.oneOf.0.debtor.oneOf.0.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":"main_case.oneOf.0.debtor.oneOf.0.legal_form.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"main_case.oneOf.0.debtor.oneOf.0.legal_form","typeLabel":"string | null"},"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":"main_case.oneOf.0.debtor.oneOf.0.metadata.items.[INDEX].type","typeLabel":"string"},"value":{"description":"Stored metadata value.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"main_case.oneOf.0.debtor.oneOf.0.metadata.items.[INDEX].value","typeLabel":"string"}},"required":["type","value"],"type":"object","uniqueKey":"main_case.oneOf.0.debtor.oneOf.0.metadata.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"main_case.oneOf.0.debtor.oneOf.0.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":"main_case.oneOf.0.debtor.oneOf.0.organization.oneOf.0.commercial_register.oneOf.0","typeLabel":"string"},{"description":"Register court or authority holding the registration.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"main_case.oneOf.0.debtor.oneOf.0.organization.oneOf.0.commercial_register.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"main_case.oneOf.0.debtor.oneOf.0.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":"main_case.oneOf.0.debtor.oneOf.0.organization.oneOf.0.commercial_registration_number.oneOf.0","typeLabel":"string"},{"description":"Commercial, association, or partnership register number.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"main_case.oneOf.0.debtor.oneOf.0.organization.oneOf.0.commercial_registration_number.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"main_case.oneOf.0.debtor.oneOf.0.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":"main_case.oneOf.0.debtor.oneOf.0.organization.oneOf.0.name","typeLabel":"string"}},"isRequired":true,"uniqueKey":"main_case.oneOf.0.debtor.oneOf.0.organization.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"main_case.oneOf.0.debtor.oneOf.0.organization.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"main_case.oneOf.0.debtor.oneOf.0.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":"main_case.oneOf.0.debtor.oneOf.0.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":"main_case.oneOf.0.debtor.oneOf.0.person.oneOf.0.birth_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"main_case.oneOf.0.debtor.oneOf.0.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":"main_case.oneOf.0.debtor.oneOf.0.person.oneOf.0.first_name","typeLabel":"string"},"last_name":{"description":"Family name of the natural person.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"main_case.oneOf.0.debtor.oneOf.0.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":"main_case.oneOf.0.debtor.oneOf.0.person.oneOf.0.salutation.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","isRequired":true,"uniqueKey":"main_case.oneOf.0.debtor.oneOf.0.person.oneOf.0.salutation.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"main_case.oneOf.0.debtor.oneOf.0.person.oneOf.0.salutation","typeLabel":"enum\u003cstring> | null"}},"isRequired":true,"uniqueKey":"main_case.oneOf.0.debtor.oneOf.0.person.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"main_case.oneOf.0.debtor.oneOf.0.person.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"main_case.oneOf.0.debtor.oneOf.0.person","typeLabel":"object | null"},"your_reference":{"oneOf":[{"description":"Your reference for this debtor.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"main_case.oneOf.0.debtor.oneOf.0.your_reference.oneOf.0","typeLabel":"string"},{"description":"Your reference for this debtor.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"main_case.oneOf.0.debtor.oneOf.0.your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"main_case.oneOf.0.debtor.oneOf.0.your_reference","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"main_case.oneOf.0.debtor.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"main_case.oneOf.0.debtor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"main_case.oneOf.0.debtor","typeLabel":"object | null"},"id":{"description":"Stable identifier of the accepted case.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"main_case.oneOf.0.id","typeLabel":"string\u003cuuid>"},"reference_number":{"description":"paywise case-file reference number.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"main_case.oneOf.0.reference_number","typeLabel":"string"}},"isRequired":true,"uniqueKey":"main_case.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"main_case.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"main_case","typeLabel":"object | null"},"previous_reference_numbers":{"description":"Earlier paywise case-file reference numbers of this case. Usually empty: when a case is re-keyed, `reference_number` shows the new number and the previous one is appended here. The `reference_number` list filter also matches these exactly.","items":{"type":"string","uniqueKey":"previous_reference_numbers.items.[INDEX]","typeLabel":"string"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"previous_reference_numbers","typeLabel":"string[]"},"reference_number":{"description":"paywise case-file reference number.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"reference_number","typeLabel":"string"},"state":{"type":"object","description":"Current legal, processing, and payment states.","required":["legal_stage","payment","processing"],"properties":{"legal_stage":{"type":"object","description":"Current legal collection stage.","required":["code","label","label_key"],"properties":{"code":{"description":"Stable machine-readable state code; an empty string when that state has not been set.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"state.legal_stage.code","typeLabel":"string"},"label":{"description":"Current human-readable state label; an empty string when its code is unset.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"state.legal_stage.label","typeLabel":"string"},"label_key":{"description":"Stable translation key for the state; an empty string when its code is unset.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"state.legal_stage.label_key","typeLabel":"string"}},"isRequired":true,"uniqueKey":"state.legal_stage","typeLabel":"object"},"payment":{"type":"object","description":"Current payment or settlement state.","required":["code","label","label_key"],"properties":{"code":{"description":"Stable machine-readable state code; an empty string when that state has not been set.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"state.payment.code","typeLabel":"string"},"label":{"description":"Current human-readable state label; an empty string when its code is unset.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"state.payment.label","typeLabel":"string"},"label_key":{"description":"Stable translation key for the state; an empty string when its code is unset.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"state.payment.label_key","typeLabel":"string"}},"isRequired":true,"uniqueKey":"state.payment","typeLabel":"object"},"processing":{"type":"object","description":"Current operational processing state.","required":["code","label","label_key"],"properties":{"code":{"description":"Stable machine-readable state code; an empty string when that state has not been set.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"state.processing.code","typeLabel":"string"},"label":{"description":"Current human-readable state label; an empty string when its code is unset.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"state.processing.label","typeLabel":"string"},"label_key":{"description":"Stable translation key for the state; an empty string when its code is unset.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"state.processing.label_key","typeLabel":"string"}},"isRequired":true,"uniqueKey":"state.processing","typeLabel":"object"}},"isRequired":true,"uniqueKey":"state","typeLabel":"object"},"subcases":{"description":"Up to 100 sub-cases grouped under this main case, ordered by sub-case number. Empty when this resource is itself a sub-case.","items":{"properties":{"debtor":{"oneOf":[{"type":"object","description":"Debtor associated with the accepted case.","required":["acting_as","events","legal_form","metadata","organization","person","your_reference"],"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":"subcases.items.[INDEX].debtor.oneOf.0.acting_as","typeLabel":"enum\u003cstring>"},"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":"subcases.items.[INDEX].debtor.oneOf.0.events.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"description":"Optional description of the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"subcases.items.[INDEX].debtor.oneOf.0.events.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"subcases.items.[INDEX].debtor.oneOf.0.events.items.[INDEX].description","typeLabel":"string | null"},"location":{"oneOf":[{"description":"Optional location associated with the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"subcases.items.[INDEX].debtor.oneOf.0.events.items.[INDEX].location.oneOf.0","typeLabel":"string"},{"description":"Optional location associated with the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"subcases.items.[INDEX].debtor.oneOf.0.events.items.[INDEX].location.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"subcases.items.[INDEX].debtor.oneOf.0.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":"subcases.items.[INDEX].debtor.oneOf.0.events.items.[INDEX].occurence","typeLabel":"string\u003cdate-time>"},"title":{"description":"Human-readable title of the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"subcases.items.[INDEX].debtor.oneOf.0.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":"subcases.items.[INDEX].debtor.oneOf.0.events.items.[INDEX].type","typeLabel":"string"},"your_reference":{"oneOf":[{"description":"Your optional reference for the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"subcases.items.[INDEX].debtor.oneOf.0.events.items.[INDEX].your_reference.oneOf.0","typeLabel":"string"},{"description":"Your optional reference for the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"subcases.items.[INDEX].debtor.oneOf.0.events.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"subcases.items.[INDEX].debtor.oneOf.0.events.items.[INDEX].your_reference","typeLabel":"string | null"}},"required":["description","location","occurence","title","type","your_reference"],"type":"object","uniqueKey":"subcases.items.[INDEX].debtor.oneOf.0.events.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"subcases.items.[INDEX].debtor.oneOf.0.events","typeLabel":"object[]"},"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":"subcases.items.[INDEX].debtor.oneOf.0.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":"subcases.items.[INDEX].debtor.oneOf.0.legal_form.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"subcases.items.[INDEX].debtor.oneOf.0.legal_form","typeLabel":"string | null"},"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":"subcases.items.[INDEX].debtor.oneOf.0.metadata.items.[INDEX].type","typeLabel":"string"},"value":{"description":"Stored metadata value.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"subcases.items.[INDEX].debtor.oneOf.0.metadata.items.[INDEX].value","typeLabel":"string"}},"required":["type","value"],"type":"object","uniqueKey":"subcases.items.[INDEX].debtor.oneOf.0.metadata.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"subcases.items.[INDEX].debtor.oneOf.0.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":"subcases.items.[INDEX].debtor.oneOf.0.organization.oneOf.0.commercial_register.oneOf.0","typeLabel":"string"},{"description":"Register court or authority holding the registration.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"subcases.items.[INDEX].debtor.oneOf.0.organization.oneOf.0.commercial_register.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"subcases.items.[INDEX].debtor.oneOf.0.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":"subcases.items.[INDEX].debtor.oneOf.0.organization.oneOf.0.commercial_registration_number.oneOf.0","typeLabel":"string"},{"description":"Commercial, association, or partnership register number.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"subcases.items.[INDEX].debtor.oneOf.0.organization.oneOf.0.commercial_registration_number.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"subcases.items.[INDEX].debtor.oneOf.0.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":"subcases.items.[INDEX].debtor.oneOf.0.organization.oneOf.0.name","typeLabel":"string"}},"isRequired":true,"uniqueKey":"subcases.items.[INDEX].debtor.oneOf.0.organization.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"subcases.items.[INDEX].debtor.oneOf.0.organization.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"subcases.items.[INDEX].debtor.oneOf.0.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":"subcases.items.[INDEX].debtor.oneOf.0.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":"subcases.items.[INDEX].debtor.oneOf.0.person.oneOf.0.birth_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"subcases.items.[INDEX].debtor.oneOf.0.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":"subcases.items.[INDEX].debtor.oneOf.0.person.oneOf.0.first_name","typeLabel":"string"},"last_name":{"description":"Family name of the natural person.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"subcases.items.[INDEX].debtor.oneOf.0.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":"subcases.items.[INDEX].debtor.oneOf.0.person.oneOf.0.salutation.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","isRequired":true,"uniqueKey":"subcases.items.[INDEX].debtor.oneOf.0.person.oneOf.0.salutation.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"subcases.items.[INDEX].debtor.oneOf.0.person.oneOf.0.salutation","typeLabel":"enum\u003cstring> | null"}},"isRequired":true,"uniqueKey":"subcases.items.[INDEX].debtor.oneOf.0.person.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"subcases.items.[INDEX].debtor.oneOf.0.person.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"subcases.items.[INDEX].debtor.oneOf.0.person","typeLabel":"object | null"},"your_reference":{"oneOf":[{"description":"Your reference for this debtor.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"subcases.items.[INDEX].debtor.oneOf.0.your_reference.oneOf.0","typeLabel":"string"},{"description":"Your reference for this debtor.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"subcases.items.[INDEX].debtor.oneOf.0.your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"subcases.items.[INDEX].debtor.oneOf.0.your_reference","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"subcases.items.[INDEX].debtor.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"subcases.items.[INDEX].debtor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"subcases.items.[INDEX].debtor","typeLabel":"object | null"},"id":{"description":"Stable identifier of the accepted case.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"subcases.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"reference_number":{"description":"paywise case-file reference number.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"subcases.items.[INDEX].reference_number","typeLabel":"string"}},"required":["debtor","id","reference_number"],"type":"object","uniqueKey":"subcases.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"subcases","typeLabel":"object[]"},"total_amount":{"oneOf":[{"type":"object","description":"Current claim total maintained on the main case, shared with its sub-cases. Use the mandate detail `legal_balance` for the legal claim and remaining balance broken down by component.","required":["currency","value"],"properties":{"currency":{"description":"Currency of the payment.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"total_amount.oneOf.0.currency","typeLabel":"string"},"value":{"description":"Amount received, expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"total_amount.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"total_amount.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"total_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"total_amount","typeLabel":"object | null"},"updated_at":{"description":"Time at which the accepted case was last updated.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"},"history":{"description":"Up to 100 published history entries. Included only when `history=true`; use the paginated history endpoint for the full timeline.","items":{"description":"One published status and the resources it makes available to the client.","properties":{"advance_type":{"oneOf":[{"description":"Category of the requested advance, when applicable.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].advance_type.oneOf.0","typeLabel":"string"},{"description":"Category of the requested advance, when applicable.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].advance_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].advance_type","typeLabel":"string | null"},"attachments":{"description":"Files explicitly published with this entry.","items":{"properties":{"download_url":{"oneOf":[{"description":"Authenticated history attachment download URL, or null when no file is available.","format":"uri","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].attachments.items.[INDEX].download_url.oneOf.0","typeLabel":"string\u003curi>"},{"description":"Authenticated history attachment download URL, or null when no file is available.","format":"uri","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].attachments.items.[INDEX].download_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].attachments.items.[INDEX].download_url","typeLabel":"string\u003curi> | null"},"filename":{"description":"Original filename of the published attachment.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].attachments.items.[INDEX].filename","typeLabel":"string"},"id":{"description":"Stable identifier of the published file.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].attachments.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"mime_type":{"description":"Media type of the attachment.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].attachments.items.[INDEX].mime_type","typeLabel":"string"}},"required":["download_url","filename","id","mime_type"],"type":"object","uniqueKey":"history.items.[INDEX].attachments.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"history.items.[INDEX].attachments","typeLabel":"object[]"},"description":{"oneOf":[{"description":"Plain-text explanation of the published event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"description":"Plain-text explanation of the published event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].description","typeLabel":"string | null"},"id":{"description":"Stable identifier of this history entry.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"is_advance_request":{"description":"Whether this update requests an advance payment.","readOnly":true,"type":"boolean","isRequired":true,"uniqueKey":"history.items.[INDEX].is_advance_request","typeLabel":"boolean"},"occurred_at":{"description":"Time at which the published event occurred.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].occurred_at","typeLabel":"string\u003cdate-time>"},"related_resources":{"description":"Resources published through this entry. Multiple resources may be linked; bodies are included only when explicitly expanded and authorized.","items":{"oneOf":[{"type":"object","title":"Client request","required":["id","type","url"],"properties":{"id":{"description":"Identifier of the related resource.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","description":"Related resource kind.\n\n* `request_to_client` - request_to_client","enum":["request_to_client"],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"url":{"description":"Authenticated API URL of the related resource.","format":"uri","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.url","typeLabel":"string\u003curi>"},"body":{"type":"object","description":"Expanded client request, included only with `expand=history.related_resources` and the `case:requests_to_client:read` scope. On mandate detail, also set `history=true`.","required":["allowed_answer_types","answer","answered","answered_at","created_at","description","href","id","mandate","question_attachments","title","updated_at"],"properties":{"allowed_answer_types":{"type":"string","description":"Answer format accepted by the answer endpoint. Choice formats use `text: yes` or `text: no`; `yes-no-dontknow` also permits `dontknow`. Formats ending in `freetext-on-no` require `additional_comment` for `no`; `yes-with-date-no-freetext-on-no` requires `booking_date` for `yes`. `freetext` requires text; `fileupload` accepts text, documents, or both.","enum":["fileupload","freetext","yes-no","yes-no-dontknow","yes-no-freetext-on-no","yes-with-date-no-freetext-on-no"],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.allowed_answer_types","typeLabel":"enum\u003cstring>"},"answer":{"oneOf":[{"type":"object","description":"Submitted answer, or null while unanswered.","required":["additional_comment","booking_date","created_at","documents","id","text","updated_at"],"properties":{"additional_comment":{"oneOf":[{"description":"Additional context supplied with the answer.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.answer.oneOf.0.additional_comment.oneOf.0","typeLabel":"string"},{"description":"Additional context supplied with the answer.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.answer.oneOf.0.additional_comment.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.answer.oneOf.0.additional_comment","typeLabel":"string | null"},"booking_date":{"oneOf":[{"description":"Relevant booking date requested by the question, when applicable.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.answer.oneOf.0.booking_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Relevant booking date requested by the question, when applicable.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.answer.oneOf.0.booking_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.answer.oneOf.0.booking_date","typeLabel":"string\u003cdate> | null"},"created_at":{"description":"Time at which the answer was submitted.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.answer.oneOf.0.created_at","typeLabel":"string\u003cdate-time>"},"documents":{"description":"Documents supplied with the answer.","items":{"description":"Resource representation with a native UUID `id`.","properties":{"created_at":{"description":"Time at which the document was submitted.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.answer.oneOf.0.documents.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"download_url":{"oneOf":[{"description":"Authenticated API URL for downloading the document; null while its status is not `ready`.","format":"uri","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.answer.oneOf.0.documents.items.[INDEX].download_url.oneOf.0","typeLabel":"string\u003curi>"},{"description":"Authenticated API URL for downloading the document; null while its status is not `ready`.","format":"uri","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.answer.oneOf.0.documents.items.[INDEX].download_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.answer.oneOf.0.documents.items.[INDEX].download_url","typeLabel":"string\u003curi> | null"},"failure_reason":{"oneOf":[{"type":"string","description":"Why processing failed when status is `failed`; `null` otherwise. `page_limit_exceeded`: PDF above the 100-page ceiling; `encrypted`: password-protected PDF; `corrupt`: bytes could not be parsed; `unsupported`: content type not accepted; `processing_failed`: any other processing error.","enum":["page_limit_exceeded","encrypted","corrupt","unsupported","processing_failed"],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.answer.oneOf.0.documents.items.[INDEX].failure_reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.answer.oneOf.0.documents.items.[INDEX].failure_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.answer.oneOf.0.documents.items.[INDEX].failure_reason","typeLabel":"enum\u003cstring> | null"},"filename":{"description":"Original filename shown to users.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.answer.oneOf.0.documents.items.[INDEX].filename","typeLabel":"string"},"id":{"description":"Stable identifier for this resource.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.answer.oneOf.0.documents.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"mime_type":{"oneOf":[{"description":"Detected media type of the document.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.answer.oneOf.0.documents.items.[INDEX].mime_type.oneOf.0","typeLabel":"string"},{"description":"Detected media type of the document.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.answer.oneOf.0.documents.items.[INDEX].mime_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.answer.oneOf.0.documents.items.[INDEX].mime_type","typeLabel":"string | null"},"parent":{"type":"object","description":"Resource that owns the document.","required":["id","type"],"properties":{"id":{"description":"Identifier of the resource that owns the document.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.answer.oneOf.0.documents.items.[INDEX].parent.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","description":"Kind of resource that owns the document.\n\n* `claim` - claim\n* `message` - message\n* `request_to_client_answer` - request_to_client_answer\n* `rental_agreement` - rental_agreement\n* `enforceable_title` - enforceable_title","enum":["claim","message","request_to_client_answer","rental_agreement","enforceable_title"],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.answer.oneOf.0.documents.items.[INDEX].parent.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.answer.oneOf.0.documents.items.[INDEX].parent","typeLabel":"object"},"status":{"type":"string","description":"Document availability: `pending` while scanning or processing is incomplete; `ready` when processing permits download; `failed` when scanning or processing failed; `rejected` when the malware check rejected the file.","enum":["pending","ready","failed","rejected"],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.answer.oneOf.0.documents.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"type":{"type":"string","description":"Business purpose of the document.","enum":["bank_statement","claim_statement","correspondence","enforceable_title","invoice","other","payment_proof","reminder","rental_agreement"],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.answer.oneOf.0.documents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updated_at":{"description":"Time at which document processing last changed.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.answer.oneOf.0.documents.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"}},"required":["created_at","download_url","failure_reason","filename","id","mime_type","parent","status","type","updated_at"],"type":"object","uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.answer.oneOf.0.documents.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.answer.oneOf.0.documents","typeLabel":"object[]"},"id":{"description":"Stable identifier of this answer.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.answer.oneOf.0.id","typeLabel":"string\u003cuuid>"},"text":{"oneOf":[{"description":"Selected choice (`yes`, `no`, or `dontknow`) or free-text answer. Empty for an API answer supplied with documents only; legacy answers may use null.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.answer.oneOf.0.text.oneOf.0","typeLabel":"string"},{"description":"Selected choice (`yes`, `no`, or `dontknow`) or free-text answer. Empty for an API answer supplied with documents only; legacy answers may use null.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.answer.oneOf.0.text.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.answer.oneOf.0.text","typeLabel":"string | null"},"updated_at":{"description":"Time at which the answer was last updated.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.answer.oneOf.0.updated_at","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.answer.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.answer.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.answer","typeLabel":"object | null"},"answered":{"description":"Whether an answer has already been submitted.","readOnly":true,"type":"boolean","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.answered","typeLabel":"boolean"},"answered_at":{"oneOf":[{"description":"Time at which the answer was submitted, when answered.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.answered_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Time at which the answer was submitted, when answered.","format":"date-time","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.answered_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.answered_at","typeLabel":"string\u003cdate-time> | null"},"created_at":{"description":"Time at which the request was created.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.created_at","typeLabel":"string\u003cdate-time>"},"description":{"oneOf":[{"description":"Question or explanation describing what paywise needs.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.description.oneOf.0","typeLabel":"string"},{"description":"Question or explanation describing what paywise needs.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.description","typeLabel":"string | null"},"href":{"description":"API URL of this client request.","format":"uri","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.href","typeLabel":"string\u003curi>"},"id":{"description":"Stable identifier of this client request.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.id","typeLabel":"string\u003cuuid>"},"mandate":{"type":"object","description":"Accepted case for which paywise needs information.","properties":{"href":{"oneOf":[{"description":"API URL of the accepted case.","format":"uri","type":"string","uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.mandate.href.oneOf.0","typeLabel":"string\u003curi>"},{"description":"API URL of the accepted case.","format":"uri","type":"null","uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.mandate.href.oneOf.1","typeLabel":"null"}],"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.mandate.href","typeLabel":"string\u003curi> | null"},"id":{"description":"Identifier of the accepted case.","format":"uuid","type":"string","uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.mandate.id","typeLabel":"string\u003cuuid>"},"reference_number":{"oneOf":[{"description":"paywise case-file reference number.","type":"string","uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.mandate.reference_number.oneOf.0","typeLabel":"string"},{"description":"paywise case-file reference number.","type":"null","uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.mandate.reference_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.mandate.reference_number","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.mandate","typeLabel":"object"},"question_attachments":{"description":"Files paywise attached to the question.","items":{"properties":{"download_url":{"oneOf":[{"description":"Authenticated API URL for downloading the question attachment; null when no downloadable file is available.","format":"uri","type":"string","uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.question_attachments.items.[INDEX].download_url.oneOf.0","typeLabel":"string\u003curi>"},{"description":"Authenticated API URL for downloading the question attachment; null when no downloadable file is available.","format":"uri","type":"null","uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.question_attachments.items.[INDEX].download_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.question_attachments.items.[INDEX].download_url","typeLabel":"string\u003curi> | null"},"filename":{"oneOf":[{"description":"Original filename of the attachment.","type":"string","uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.question_attachments.items.[INDEX].filename.oneOf.0","typeLabel":"string"},{"description":"Original filename of the attachment.","type":"null","uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.question_attachments.items.[INDEX].filename.oneOf.1","typeLabel":"null"}],"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.question_attachments.items.[INDEX].filename","typeLabel":"string | null"},"id":{"description":"Stable identifier of the attachment.","format":"uuid","type":"string","uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.question_attachments.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"mime_type":{"oneOf":[{"description":"Media type of the attachment.","type":"string","uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.question_attachments.items.[INDEX].mime_type.oneOf.0","typeLabel":"string"},{"description":"Media type of the attachment.","type":"null","uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.question_attachments.items.[INDEX].mime_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.question_attachments.items.[INDEX].mime_type","typeLabel":"string | null"}},"type":"object","uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.question_attachments.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.question_attachments","typeLabel":"object[]"},"title":{"description":"Short subject of the requested information.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.title","typeLabel":"string"},"updated_at":{"description":"Time at which the request was last updated.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body.updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0.body","typeLabel":"object"}},"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.0","typeLabel":"Client request · object"},{"type":"object","title":"Message","required":["id","type","url"],"properties":{"id":{"description":"Identifier of the related resource.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.1.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","description":"Related resource kind.\n\n* `message` - message","enum":["message"],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"url":{"description":"Authenticated API URL of the related resource.","format":"uri","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.1.url","typeLabel":"string\u003curi>"},"body":{"type":"object","description":"Message, included when explicitly expanded and authorized.","required":["author","body","created_at","documents","editable","href","id","parent","response_to","sender","state","title","updated_at"],"properties":{"author":{"type":"object","description":"Channel through which the message was authored.","required":["type"],"properties":{"type":{"type":"string","description":"Authorship channel: `api` for a client message created through current Case Management API, `user` for another client-authored message, or `paywise` for a message sent by paywise.","enum":["api","user","paywise"],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.1.body.author.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.1.body.author","typeLabel":"object"},"body":{"oneOf":[{"description":"Message content exchanged with paywise.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.1.body.body.oneOf.0","typeLabel":"string"},{"description":"Message content exchanged with paywise.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.1.body.body.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.1.body.body","typeLabel":"string | null"},"created_at":{"description":"Time at which the message was created.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.1.body.created_at","typeLabel":"string\u003cdate-time>"},"documents":{"description":"Documents attached to the message.","items":{"description":"Resource representation with a native UUID `id`.","properties":{"created_at":{"description":"Time at which the document was submitted.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.1.body.documents.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"download_url":{"oneOf":[{"description":"Authenticated API URL for downloading the document; null while its status is not `ready`.","format":"uri","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.1.body.documents.items.[INDEX].download_url.oneOf.0","typeLabel":"string\u003curi>"},{"description":"Authenticated API URL for downloading the document; null while its status is not `ready`.","format":"uri","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.1.body.documents.items.[INDEX].download_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.1.body.documents.items.[INDEX].download_url","typeLabel":"string\u003curi> | null"},"failure_reason":{"oneOf":[{"type":"string","description":"Why processing failed when status is `failed`; `null` otherwise. `page_limit_exceeded`: PDF above the 100-page ceiling; `encrypted`: password-protected PDF; `corrupt`: bytes could not be parsed; `unsupported`: content type not accepted; `processing_failed`: any other processing error.","enum":["page_limit_exceeded","encrypted","corrupt","unsupported","processing_failed"],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.1.body.documents.items.[INDEX].failure_reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.1.body.documents.items.[INDEX].failure_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.1.body.documents.items.[INDEX].failure_reason","typeLabel":"enum\u003cstring> | null"},"filename":{"description":"Original filename shown to users.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.1.body.documents.items.[INDEX].filename","typeLabel":"string"},"id":{"description":"Stable identifier for this resource.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.1.body.documents.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"mime_type":{"oneOf":[{"description":"Detected media type of the document.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.1.body.documents.items.[INDEX].mime_type.oneOf.0","typeLabel":"string"},{"description":"Detected media type of the document.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.1.body.documents.items.[INDEX].mime_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.1.body.documents.items.[INDEX].mime_type","typeLabel":"string | null"},"parent":{"type":"object","description":"Resource that owns the document.","required":["id","type"],"properties":{"id":{"description":"Identifier of the resource that owns the document.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.1.body.documents.items.[INDEX].parent.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","description":"Kind of resource that owns the document.\n\n* `claim` - claim\n* `message` - message\n* `request_to_client_answer` - request_to_client_answer\n* `rental_agreement` - rental_agreement\n* `enforceable_title` - enforceable_title","enum":["claim","message","request_to_client_answer","rental_agreement","enforceable_title"],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.1.body.documents.items.[INDEX].parent.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.1.body.documents.items.[INDEX].parent","typeLabel":"object"},"status":{"type":"string","description":"Document availability: `pending` while scanning or processing is incomplete; `ready` when processing permits download; `failed` when scanning or processing failed; `rejected` when the malware check rejected the file.","enum":["pending","ready","failed","rejected"],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.1.body.documents.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"type":{"type":"string","description":"Business purpose of the document.","enum":["bank_statement","claim_statement","correspondence","enforceable_title","invoice","other","payment_proof","reminder","rental_agreement"],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.1.body.documents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updated_at":{"description":"Time at which document processing last changed.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.1.body.documents.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"}},"required":["created_at","download_url","failure_reason","filename","id","mime_type","parent","status","type","updated_at"],"type":"object","uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.1.body.documents.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.1.body.documents","typeLabel":"object[]"},"editable":{"description":"Whether this message can be edited through the API. True only for a client message created through current Case Management API for the calling company while it is under review and no review task has started.","readOnly":true,"type":"boolean","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.1.body.editable","typeLabel":"boolean"},"href":{"description":"API URL of this message.","format":"uri","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.1.body.href","typeLabel":"string\u003curi>"},"id":{"description":"Stable identifier for this resource.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.1.body.id","typeLabel":"string\u003cuuid>"},"parent":{"type":"object","description":"Order or accepted case to which the message belongs.","required":["id","type"],"properties":{"id":{"description":"Identifier of the order or accepted case owning the message.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.1.body.parent.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","description":"Whether the message belongs to an order (`order`) or an accepted case (`mandate`).","enum":["order","mandate"],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.1.body.parent.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.1.body.parent","typeLabel":"object"},"response_to":{"oneOf":[{"description":"Message to which this message responds, when applicable.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.1.body.response_to.oneOf.0","typeLabel":"string\u003cuuid>"},{"description":"Message to which this message responds, when applicable.","format":"uuid","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.1.body.response_to.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.1.body.response_to","typeLabel":"string\u003cuuid> | null"},"sender":{"type":"string","description":"Party that sent the message.","enum":["client","paywise"],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.1.body.sender","typeLabel":"enum\u003cstring>"},"state":{"type":"string","description":"Review/publication state: `under_review` for a client message awaiting review, `handled` after handling, or `published` for a published message. Check `editable` before offering edits.","enum":["under_review","handled","published"],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.1.body.state","typeLabel":"enum\u003cstring>"},"title":{"oneOf":[{"description":"Short subject of the message.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.1.body.title.oneOf.0","typeLabel":"string"},{"description":"Short subject of the message.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.1.body.title.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.1.body.title","typeLabel":"string | null"},"updated_at":{"description":"Time at which the message was last updated.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.1.body.updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.1.body","typeLabel":"object"}},"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.1","typeLabel":"Message · object"},{"type":"object","title":"Email","required":["id","type","url"],"properties":{"id":{"description":"Identifier of the related resource.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.2.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","description":"Related resource kind.\n\n* `email` - email","enum":["email"],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"url":{"oneOf":[{"description":"Authenticated URL of the correspondence item that carries this email's text, PDF and attachments (`case:correspondence:read`); null when the email has no stored copy.","format":"uri","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.2.url.oneOf.0","typeLabel":"string\u003curi>"},{"description":"Authenticated URL of the correspondence item that carries this email's text, PDF and attachments (`case:correspondence:read`); null when the email has no stored copy.","format":"uri","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.2.url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.2.url","typeLabel":"string\u003curi> | null"},"body":{"type":"object","description":"Expanded email metadata. Text and attachments are read through `url`.","required":["correspondence_url","date","direction","subject"],"properties":{"correspondence_url":{"oneOf":[{"description":"Authenticated URL of the full correspondence item (text, PDF, attachments); null when the email has no stored copy.","format":"uri","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.2.body.correspondence_url.oneOf.0","typeLabel":"string\u003curi>"},{"description":"Authenticated URL of the full correspondence item (text, PDF, attachments); null when the email has no stored copy.","format":"uri","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.2.body.correspondence_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.2.body.correspondence_url","typeLabel":"string\u003curi> | null"},"date":{"description":"Time the email record was created.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.2.body.date","typeLabel":"string\u003cdate-time>"},"direction":{"type":"string","description":"Whether paywise received or sent the email.","enum":["inbound","outbound"],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.2.body.direction","typeLabel":"enum\u003cstring>"},"subject":{"oneOf":[{"description":"Subject of the email published through this history entry.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.2.body.subject.oneOf.0","typeLabel":"string"},{"description":"Subject of the email published through this history entry.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.2.body.subject.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.2.body.subject","typeLabel":"string | null"}},"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.2.body","typeLabel":"object"}},"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.2","typeLabel":"Email · object"},{"type":"object","title":"Case statement","required":["id","type","url"],"properties":{"id":{"description":"Identifier of the related resource.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","description":"Related resource kind.\n\n* `single_mandate_statement` - single_mandate_statement","enum":["single_mandate_statement"],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"url":{"description":"Authenticated API URL of the related resource.","format":"uri","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.url","typeLabel":"string\u003curi>"},"body":{"type":"object","description":"Case statement, included when explicitly expanded and authorized.","required":["booking_date","cancelled_at","clearing_no","comment","created_at","file","financials","id","invoice_no","mandate","payout_method","period_end","period_start","pre_tax_deductible","reference_number","statement_type","status","updated_at","your_reference"],"properties":{"booking_date":{"description":"Date on which the case statement was booked.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.booking_date","typeLabel":"string\u003cdate>"},"cancelled_at":{"oneOf":[{"description":"Time at which the case statement was cancelled.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.cancelled_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Time at which the case statement was cancelled.","format":"date-time","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.cancelled_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.cancelled_at","typeLabel":"string\u003cdate-time> | null"},"clearing_no":{"description":"Clearing number of the case statement.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.clearing_no","typeLabel":"string"},"comment":{"oneOf":[{"description":"Additional notes supplied with the case statement.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.comment.oneOf.0","typeLabel":"string"},{"description":"Additional notes supplied with the case statement.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.comment.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.comment","typeLabel":"string | null"},"created_at":{"description":"Time at which the case statement was created.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.created_at","typeLabel":"string\u003cdate-time>"},"file":{"oneOf":[{"type":"object","description":"Downloadable statement document, when available.","required":["download_url","filename","media_type"],"properties":{"download_url":{"description":"Authenticated URL for downloading this file.","format":"uri","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.file.oneOf.0.download_url","typeLabel":"string\u003curi>"},"filename":{"description":"Descriptive filename for this download.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.file.oneOf.0.filename","typeLabel":"string"},"media_type":{"description":"Media type of this download.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.file.oneOf.0.media_type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.file.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.file.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.file","typeLabel":"object | null"},"financials":{"type":"object","description":"Principal claims, payment allocation, and settlement balance.","required":["cost_burden","open_principal_claim","principal_claims","principal_claims_total","total_balance","vat_entries"],"properties":{"cost_burden":{"oneOf":[{"type":"object","description":"What you owe paywise on this case, when applicable.","required":["fee","fee_vat","items","tax_free_expenses","taxable_expenses","taxable_expenses_vat","total_amount","total_net","total_vat","vat_rate"],"properties":{"fee":{"oneOf":[{"type":"object","description":"Collection fee charged to you.","required":["currency","value"],"properties":{"currency":{"description":"Currency of the amount.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.fee.oneOf.0.currency","typeLabel":"string"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.fee.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.fee.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.fee.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.fee","typeLabel":"object | null"},"fee_vat":{"oneOf":[{"type":"object","description":"VAT on the collection fee charged to you.","required":["currency","value"],"properties":{"currency":{"description":"Currency of the amount.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.fee_vat.oneOf.0.currency","typeLabel":"string"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.fee_vat.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.fee_vat.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.fee_vat.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.fee_vat","typeLabel":"object | null"},"items":{"description":"Itemized positions making up the cost burden.","items":{"description":"One account line of a Kostenbelastung.","properties":{"account_code":{"description":"Account code of this cost position.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.\\items.items.[INDEX].account_code","typeLabel":"string"},"designation":{"description":"Human-readable designation of the cost position.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.\\items.items.[INDEX].designation","typeLabel":"string"},"gross_amount":{"oneOf":[{"type":"object","description":"Gross amount of this cost position.","required":["currency","value"],"properties":{"currency":{"description":"Currency of the amount.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.\\items.items.[INDEX].gross_amount.oneOf.0.currency","typeLabel":"string"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.\\items.items.[INDEX].gross_amount.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.\\items.items.[INDEX].gross_amount.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.\\items.items.[INDEX].gross_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.\\items.items.[INDEX].gross_amount","typeLabel":"object | null"},"main_account_code":{"oneOf":[{"description":"Main account into which this position is grouped.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.\\items.items.[INDEX].main_account_code.oneOf.0","typeLabel":"string"},{"description":"Main account into which this position is grouped.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.\\items.items.[INDEX].main_account_code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.\\items.items.[INDEX].main_account_code","typeLabel":"string | null"},"net_amount":{"oneOf":[{"type":"object","description":"Net amount of this cost position.","required":["currency","value"],"properties":{"currency":{"description":"Currency of the amount.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.\\items.items.[INDEX].net_amount.oneOf.0.currency","typeLabel":"string"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.\\items.items.[INDEX].net_amount.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.\\items.items.[INDEX].net_amount.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.\\items.items.[INDEX].net_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.\\items.items.[INDEX].net_amount","typeLabel":"object | null"},"vat_amount":{"oneOf":[{"type":"object","description":"VAT amount of this cost position.","required":["currency","value"],"properties":{"currency":{"description":"Currency of the amount.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.\\items.items.[INDEX].vat_amount.oneOf.0.currency","typeLabel":"string"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.\\items.items.[INDEX].vat_amount.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.\\items.items.[INDEX].vat_amount.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.\\items.items.[INDEX].vat_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.\\items.items.[INDEX].vat_amount","typeLabel":"object | null"}},"required":["account_code","designation","gross_amount","main_account_code","net_amount","vat_amount"],"type":"object","uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.\\items.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.\\items","typeLabel":"object[]"},"tax_free_expenses":{"oneOf":[{"type":"object","description":"Tax-free expenses charged to you.","required":["currency","value"],"properties":{"currency":{"description":"Currency of the amount.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.tax_free_expenses.oneOf.0.currency","typeLabel":"string"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.tax_free_expenses.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.tax_free_expenses.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.tax_free_expenses.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.tax_free_expenses","typeLabel":"object | null"},"taxable_expenses":{"oneOf":[{"type":"object","description":"Taxable expenses charged to you.","required":["currency","value"],"properties":{"currency":{"description":"Currency of the amount.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.taxable_expenses.oneOf.0.currency","typeLabel":"string"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.taxable_expenses.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.taxable_expenses.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.taxable_expenses.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.taxable_expenses","typeLabel":"object | null"},"taxable_expenses_vat":{"oneOf":[{"type":"object","description":"VAT on taxable expenses charged to you.","required":["currency","value"],"properties":{"currency":{"description":"Currency of the amount.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.taxable_expenses_vat.oneOf.0.currency","typeLabel":"string"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.taxable_expenses_vat.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.taxable_expenses_vat.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.taxable_expenses_vat.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.taxable_expenses_vat","typeLabel":"object | null"},"total_amount":{"oneOf":[{"type":"object","description":"Total gross amount of the cost burden.","required":["currency","value"],"properties":{"currency":{"description":"Currency of the amount.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.total_amount.oneOf.0.currency","typeLabel":"string"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.total_amount.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.total_amount.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.total_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.total_amount","typeLabel":"object | null"},"total_net":{"oneOf":[{"type":"object","description":"Total net amount of the cost burden.","required":["currency","value"],"properties":{"currency":{"description":"Currency of the amount.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.total_net.oneOf.0.currency","typeLabel":"string"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.total_net.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.total_net.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.total_net.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.total_net","typeLabel":"object | null"},"total_vat":{"oneOf":[{"type":"object","description":"Total VAT included in the cost burden.","required":["currency","value"],"properties":{"currency":{"description":"Currency of the amount.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.total_vat.oneOf.0.currency","typeLabel":"string"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.total_vat.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.total_vat.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.total_vat.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.total_vat","typeLabel":"object | null"},"vat_rate":{"description":"VAT rate as a decimal fraction, for example 0.19 for 19%. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,3}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0.vat_rate","typeLabel":"string"}},"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.cost_burden","typeLabel":"object | null"},"open_principal_claim":{"oneOf":[{"type":"object","description":"Principal claim still open after this settlement.","required":["currency","value"],"properties":{"currency":{"description":"Currency of the amount.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.open_principal_claim.oneOf.0.currency","typeLabel":"string"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.open_principal_claim.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.open_principal_claim.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.open_principal_claim.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.open_principal_claim","typeLabel":"object | null"},"principal_claims":{"description":"Invoices settled by this statement.","items":{"description":"One invoice (Hauptforderung) settled by this Aktenabrechnung.","properties":{"amount":{"oneOf":[{"type":"object","description":"Invoiced amount of the principal claim.","required":["currency","value"],"properties":{"currency":{"description":"Currency of the amount.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.principal_claims.items.[INDEX].amount.oneOf.0.currency","typeLabel":"string"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.principal_claims.items.[INDEX].amount.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.principal_claims.items.[INDEX].amount.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.principal_claims.items.[INDEX].amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.principal_claims.items.[INDEX].amount","typeLabel":"object | null"},"voucher_date":{"oneOf":[{"description":"Date of the invoice or voucher.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.principal_claims.items.[INDEX].voucher_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Date of the invoice or voucher.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.principal_claims.items.[INDEX].voucher_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.principal_claims.items.[INDEX].voucher_date","typeLabel":"string\u003cdate> | null"},"voucher_no":{"oneOf":[{"description":"Your invoice or voucher number for the settled claim.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.principal_claims.items.[INDEX].voucher_no.oneOf.0","typeLabel":"string"},{"description":"Your invoice or voucher number for the settled claim.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.principal_claims.items.[INDEX].voucher_no.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.principal_claims.items.[INDEX].voucher_no","typeLabel":"string | null"}},"required":["amount","voucher_date","voucher_no"],"type":"object","uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.principal_claims.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.principal_claims","typeLabel":"object[]"},"principal_claims_total":{"oneOf":[{"type":"object","description":"Total of all principal claims settled by this statement.","required":["currency","value"],"properties":{"currency":{"description":"Currency of the amount.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.principal_claims_total.oneOf.0.currency","typeLabel":"string"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.principal_claims_total.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.principal_claims_total.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.principal_claims_total.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.principal_claims_total","typeLabel":"object | null"},"total_balance":{"oneOf":[{"type":"object","description":"Settlement balance: positive pays you, negative is owed by you.","required":["currency","value"],"properties":{"currency":{"description":"Currency of the amount.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.total_balance.oneOf.0.currency","typeLabel":"string"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.total_balance.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.total_balance.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.total_balance.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.total_balance","typeLabel":"object | null"},"vat_entries":{"description":"Payments and their allocation grouped by VAT rate.","items":{"description":"Payments and their allocation for one VAT rate.\n\n`vat_rate` is a decimal fraction (`0.19`) — the Aktenabrechnung\nconvention, preserved verbatim. It deliberately differs from the percent\nrepresentation on `/v2/statements/`: that resource inherited its shape\nfrom the Sammelabrechnung model, this one from the Aktenabrechnung.","properties":{"allocation_to_client_costs":{"oneOf":[{"type":"object","description":"Amount allocated to your costs.","required":["currency","value"],"properties":{"currency":{"description":"Currency of the amount.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_client_costs.oneOf.0.currency","typeLabel":"string"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_client_costs.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_client_costs.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_client_costs.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_client_costs","typeLabel":"object | null"},"allocation_to_client_expenses":{"oneOf":[{"type":"object","description":"Amount allocated to your expenses.","required":["currency","value"],"properties":{"currency":{"description":"Currency of the amount.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_client_expenses.oneOf.0.currency","typeLabel":"string"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_client_expenses.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_client_expenses.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_client_expenses.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_client_expenses","typeLabel":"object | null"},"allocation_to_default_interest":{"oneOf":[{"type":"object","description":"Amount allocated to default interest.","required":["currency","value"],"properties":{"currency":{"description":"Currency of the amount.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_default_interest.oneOf.0.currency","typeLabel":"string"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_default_interest.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_default_interest.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_default_interest.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_default_interest","typeLabel":"object | null"},"allocation_to_fee":{"oneOf":[{"type":"object","description":"Amount allocated to the collection fee.","required":["currency","value"],"properties":{"currency":{"description":"Currency of the amount.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_fee.oneOf.0.currency","typeLabel":"string"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_fee.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_fee.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_fee.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_fee","typeLabel":"object | null"},"allocation_to_fee_vat":{"oneOf":[{"type":"object","description":"Amount allocated to VAT on the collection fee.","required":["currency","value"],"properties":{"currency":{"description":"Currency of the amount.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_fee_vat.oneOf.0.currency","typeLabel":"string"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_fee_vat.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_fee_vat.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_fee_vat.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_fee_vat","typeLabel":"object | null"},"allocation_to_main_claim":{"oneOf":[{"type":"object","description":"Amount allocated to the principal claim.","required":["currency","value"],"properties":{"currency":{"description":"Currency of the amount.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_main_claim.oneOf.0.currency","typeLabel":"string"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_main_claim.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_main_claim.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_main_claim.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_main_claim","typeLabel":"object | null"},"allocation_to_overpayment":{"oneOf":[{"type":"object","description":"Amount allocated to an overpayment.","required":["currency","value"],"properties":{"currency":{"description":"Currency of the amount.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_overpayment.oneOf.0.currency","typeLabel":"string"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_overpayment.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_overpayment.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_overpayment.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_overpayment","typeLabel":"object | null"},"allocation_to_success_commission":{"oneOf":[{"type":"object","description":"Amount allocated to the success commission.","required":["currency","value"],"properties":{"currency":{"description":"Currency of the amount.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_success_commission.oneOf.0.currency","typeLabel":"string"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_success_commission.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_success_commission.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_success_commission.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_success_commission","typeLabel":"object | null"},"allocation_to_success_commission_vat":{"oneOf":[{"type":"object","description":"Amount allocated to VAT on the success commission.","required":["currency","value"],"properties":{"currency":{"description":"Currency of the amount.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_success_commission_vat.oneOf.0.currency","typeLabel":"string"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_success_commission_vat.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_success_commission_vat.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_success_commission_vat.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_success_commission_vat","typeLabel":"object | null"},"allocation_to_tax_free_expenses":{"oneOf":[{"type":"object","description":"Amount allocated to tax-free expenses.","required":["currency","value"],"properties":{"currency":{"description":"Currency of the amount.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_tax_free_expenses.oneOf.0.currency","typeLabel":"string"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_tax_free_expenses.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_tax_free_expenses.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_tax_free_expenses.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_tax_free_expenses","typeLabel":"object | null"},"allocation_to_taxable_expenses":{"oneOf":[{"type":"object","description":"Amount allocated to taxable expenses.","required":["currency","value"],"properties":{"currency":{"description":"Currency of the amount.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_taxable_expenses.oneOf.0.currency","typeLabel":"string"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_taxable_expenses.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_taxable_expenses.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_taxable_expenses.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_taxable_expenses","typeLabel":"object | null"},"allocation_to_taxable_expenses_vat":{"oneOf":[{"type":"object","description":"Amount allocated to VAT on taxable expenses.","required":["currency","value"],"properties":{"currency":{"description":"Currency of the amount.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_taxable_expenses_vat.oneOf.0.currency","typeLabel":"string"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_taxable_expenses_vat.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_taxable_expenses_vat.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_taxable_expenses_vat.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].allocation_to_taxable_expenses_vat","typeLabel":"object | null"},"instalment_payments_to_client":{"oneOf":[{"type":"object","description":"Instalment payments already passed on to you.","required":["currency","value"],"properties":{"currency":{"description":"Currency of the amount.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].instalment_payments_to_client.oneOf.0.currency","typeLabel":"string"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].instalment_payments_to_client.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].instalment_payments_to_client.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].instalment_payments_to_client.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].instalment_payments_to_client","typeLabel":"object | null"},"payments_to_client":{"oneOf":[{"type":"object","description":"Debtor payments made directly to you.","required":["currency","value"],"properties":{"currency":{"description":"Currency of the amount.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].payments_to_client.oneOf.0.currency","typeLabel":"string"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].payments_to_client.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].payments_to_client.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].payments_to_client.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].payments_to_client","typeLabel":"object | null"},"payments_to_dca":{"oneOf":[{"type":"object","description":"Debtor payments received by paywise.","required":["currency","value"],"properties":{"currency":{"description":"Currency of the amount.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].payments_to_dca.oneOf.0.currency","typeLabel":"string"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].payments_to_dca.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].payments_to_dca.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].payments_to_dca.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].payments_to_dca","typeLabel":"object | null"},"payout":{"oneOf":[{"type":"object","description":"Balance for this VAT rate.","required":["currency","value"],"properties":{"currency":{"description":"Currency of the amount.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].payout.oneOf.0.currency","typeLabel":"string"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].payout.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].payout.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].payout.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].payout","typeLabel":"object | null"},"total_payments":{"oneOf":[{"type":"object","description":"Total debtor payments at this VAT rate.","required":["currency","value"],"properties":{"currency":{"description":"Currency of the amount.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].total_payments.oneOf.0.currency","typeLabel":"string"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].total_payments.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].total_payments.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].total_payments.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].total_payments","typeLabel":"object | null"},"vat_rate":{"description":"VAT rate as a decimal fraction, for example 0.19 for 19%. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,3}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX].vat_rate","typeLabel":"string"}},"required":["allocation_to_client_costs","allocation_to_client_expenses","allocation_to_default_interest","allocation_to_fee","allocation_to_fee_vat","allocation_to_main_claim","allocation_to_overpayment","allocation_to_success_commission","allocation_to_success_commission_vat","allocation_to_tax_free_expenses","allocation_to_taxable_expenses","allocation_to_taxable_expenses_vat","instalment_payments_to_client","payments_to_client","payments_to_dca","payout","total_payments","vat_rate"],"type":"object","uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials.vat_entries","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.financials","typeLabel":"object"},"id":{"description":"Stable identifier of this case statement.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.id","typeLabel":"string\u003cuuid>"},"invoice_no":{"oneOf":[{"description":"Invoice number, when this settlement produces an invoice.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.invoice_no.oneOf.0","typeLabel":"string"},{"description":"Invoice number, when this settlement produces an invoice.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.invoice_no.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.invoice_no","typeLabel":"string | null"},"mandate":{"oneOf":[{"type":"object","description":"Accepted case settled by this statement, when still linked.","required":["id","reference_number"],"properties":{"id":{"description":"Identifier of the accepted case settled by this statement.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.mandate.oneOf.0.id","typeLabel":"string\u003cuuid>"},"reference_number":{"description":"paywise case-file reference number.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.mandate.oneOf.0.reference_number","typeLabel":"string"}},"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.mandate.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.mandate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.mandate","typeLabel":"object | null"},"payout_method":{"oneOf":[{"type":"string","description":"Whether the balance is settled by transfer or direct debit.\n\n* `transfer` - Überweisung\n* `direct_debit` - Lastschrift","enum":["transfer","direct_debit"],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.payout_method.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.payout_method.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.payout_method","typeLabel":"enum\u003cstring> | null"},"period_end":{"description":"End of the settled period.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.period_end","typeLabel":"string\u003cdate>"},"period_start":{"oneOf":[{"description":"Start of the settled period, or null for the full case history.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.period_start.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Start of the settled period, or null for the full case history.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.period_start.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.period_start","typeLabel":"string\u003cdate> | null"},"pre_tax_deductible":{"description":"Whether you may deduct input VAT for this settlement.","readOnly":true,"type":"boolean","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.pre_tax_deductible","typeLabel":"boolean"},"reference_number":{"description":"paywise case-file reference number of the settled case.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.reference_number","typeLabel":"string"},"statement_type":{"type":"string","description":"Kind of interim, final, expense, or monitoring settlement.\n\n* `interim` - Zwischenabrechnung\n* `final` - Endabrechnung\n* `expenses_invoice` - Auslagenrechnung\n* `transition_to_longtime_monitoring` - Übergabe Überwachungsverfahren\n* `negative_closing` - Negativabschluss","enum":["interim","final","expenses_invoice","transition_to_longtime_monitoring","negative_closing"],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.statement_type","typeLabel":"enum\u003cstring>"},"status":{"type":"string","description":"Whether the case statement is published or cancelled.","enum":["published","cancelled"],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.status","typeLabel":"enum\u003cstring>"},"updated_at":{"description":"Time at which the case statement was last updated.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.updated_at","typeLabel":"string\u003cdate-time>"},"your_reference":{"oneOf":[{"description":"Your customer number for the debtor on the settled case.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.your_reference.oneOf.0","typeLabel":"string"},{"description":"Your customer number for the debtor on the settled case.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body.your_reference","typeLabel":"string | null"}},"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3.body","typeLabel":"object"}},"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX].oneOf.3","typeLabel":"Case statement · object"}],"uniqueKey":"history.items.[INDEX].related_resources.items.[INDEX]","typeLabel":"Client request · object | Message · object | Email · object | Case statement · object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"history.items.[INDEX].related_resources","typeLabel":"(Client request · object | Message · object | Email · object | Case statement · object)[]"},"source_mandate":{"type":"object","description":"Main case or subcase that produced the entry.","required":["id","reference_number","relation"],"properties":{"id":{"description":"Identifier of the case that produced the entry.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].source_mandate.id","typeLabel":"string\u003cuuid>"},"reference_number":{"description":"paywise reference number of the source case.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].source_mandate.reference_number","typeLabel":"string"},"relation":{"type":"string","description":"Main-case or subcase attribution.\n\n* `main_case` - main_case\n* `subcase` - subcase","enum":["main_case","subcase"],"isRequired":true,"uniqueKey":"history.items.[INDEX].source_mandate.relation","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"history.items.[INDEX].source_mandate","typeLabel":"object"},"state":{"type":"object","description":"Workflow values recorded on this status. Blank dimensions were not recorded; this is not a complete state snapshot.","required":["legal_stage","payment","processing"],"properties":{"legal_stage":{"type":"object","description":"Current legal collection stage.","required":["code","label","label_key"],"properties":{"code":{"description":"Stable machine-readable state code; an empty string when that state has not been set.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].state.legal_stage.code","typeLabel":"string"},"label":{"description":"Current human-readable state label; an empty string when its code is unset.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].state.legal_stage.label","typeLabel":"string"},"label_key":{"description":"Stable translation key for the state; an empty string when its code is unset.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].state.legal_stage.label_key","typeLabel":"string"}},"isRequired":true,"uniqueKey":"history.items.[INDEX].state.legal_stage","typeLabel":"object"},"payment":{"type":"object","description":"Current payment or settlement state.","required":["code","label","label_key"],"properties":{"code":{"description":"Stable machine-readable state code; an empty string when that state has not been set.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].state.payment.code","typeLabel":"string"},"label":{"description":"Current human-readable state label; an empty string when its code is unset.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].state.payment.label","typeLabel":"string"},"label_key":{"description":"Stable translation key for the state; an empty string when its code is unset.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].state.payment.label_key","typeLabel":"string"}},"isRequired":true,"uniqueKey":"history.items.[INDEX].state.payment","typeLabel":"object"},"processing":{"type":"object","description":"Current operational processing state.","required":["code","label","label_key"],"properties":{"code":{"description":"Stable machine-readable state code; an empty string when that state has not been set.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].state.processing.code","typeLabel":"string"},"label":{"description":"Current human-readable state label; an empty string when its code is unset.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].state.processing.label","typeLabel":"string"},"label_key":{"description":"Stable translation key for the state; an empty string when its code is unset.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].state.processing.label_key","typeLabel":"string"}},"isRequired":true,"uniqueKey":"history.items.[INDEX].state.processing","typeLabel":"object"}},"isRequired":true,"uniqueKey":"history.items.[INDEX].state","typeLabel":"object"},"text":{"oneOf":[{"description":"Compatibility alias of the event description.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].text.oneOf.0","typeLabel":"string"},{"description":"Compatibility alias of the event description.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"history.items.[INDEX].text.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"history.items.[INDEX].text","typeLabel":"string | null"},"title":{"description":"Short title of the published event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].title","typeLabel":"string"},"type":{"type":"string","description":"Business category of the history entry.","enum":["status_update"],"isRequired":true,"uniqueKey":"history.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updated_at":{"description":"Latest change to this entry or its published related content; use for incremental synchronization.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"history.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"}},"required":["advance_type","attachments","description","id","is_advance_request","occurred_at","related_resources","source_mandate","state","text","title","type","updated_at"],"type":"object","uniqueKey":"history.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"history","typeLabel":"object[]"}},"required":["archived","claims","created_at","debtor","id","legal_balance","main_case","previous_reference_numbers","reference_number","state","subcases","total_amount","updated_at"],"type":"object","uniqueKey":"","typeLabel":"object"},"exampleType":"examples"}},"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":"examples"},"21d23399-5b98-4d73-95dc-b031267df514":{"description":"Not modified: the `If-None-Match` validator still matches.","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"}}},"content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"7574a124-94fb-48c9-b48d-6a4a4ecbf276":{"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"},"b46e266c-1c8c-45db-a904-e44f3464c014":{"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"},"51a7f002-11d4-4a89-862d-49c6164d2bf2":{"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"},"e0d6a9a9-ebca-42d5-b97f-ac5f9df6eccf":{"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"},"7121775a-d4a1-4e14-876f-ab92d38496d2":{"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"},"678071ea-6bdf-405e-b871-1116ee509320":{"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":{"25c2f2d8-676c-4ad4-9790-4f6ecbb59259":{"caseBearerAuth":{"description":"Company-bound Case Management API key — the standard credential for this API.","scheme":"bearer","type":"http","scopes":[],"schemeName":"caseBearerAuth"}},"1b34f359-5912-49bc-978d-836313486b96":{"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":"Get mandate - paywise Knowledge Center","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"de":{"href":"/user-docs/overview","matchLevel":4},"en":{"href":"/api-docs/case-management-api/reference/mandates/get-mandate","matchLevel":0}}},"lastModified":"2026-10-16T12:47:30.871Z","originalFileLocation":"api-docs/case-management-api/reference/mandates/get-mandate.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=\"Accepted cases (Aktenzeichen). Main-case-centric: the list returns main cases only. Sub-cases are reachable through the main case detail representation and direct detail/subresource URLs, not a flat list expansion. Tenant-scoped by the authenticated company. Sub-resources of one mandate: payments — the reported, non-ignored payments documents — claim-document metadata and a proxy-stream download * history — published client activity, related resources, and attachments. A main case includes its subcases; a subcase includes only itself. The sub-resource operations resolve the mandate including sub-cases — unlike the list, which hides sub-cases — so an individually-addressable sub-case\u0026#x27;s own track stays reachable. These public mandate operations are reads.\">\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=\"Get mandate - paywise Knowledge Center\">\u003cmeta data-mint-head property=\"og:description\" content=\"Accepted cases (Aktenzeichen). Main-case-centric: the list returns main cases only. Sub-cases are reachable through the main case detail representation and direct detail/subresource URLs, not a flat list expansion. Tenant-scoped by the authenticated company. Sub-resources of one mandate: payments — the reported, non-ignored payments documents — claim-document metadata and a proxy-stream download * history — published client activity, related resources, and attachments. A main case includes its subcases; a subcase includes only itself. The sub-resource operations resolve the mandate including sub-cases — unlike the list, which hides sub-cases — so an individually-addressable sub-case\u0026#x27;s own track stays reachable. These public mandate operations are reads.\">\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/mandates/get-mandate\">\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=Mandates\u0026amp;title=Get+mandate\u0026amp;description=Accepted+cases+%28Aktenzeichen%29.%0A%0AMain-case-centric%3A+the+list+returns+**main+cases+only**.%0ASub-cases+are+reachable+through+the+main+case+detail+representation+and\u0026amp;theme=bad878af30f1dee220dabe6f\u0026amp;signature=35fdcda4f7503923567afc689a75b2b74f9e6484500322a804ec77cd579cf688\">\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=\"Get mandate - paywise Knowledge Center\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Accepted cases (Aktenzeichen). Main-case-centric: the list returns main cases only. Sub-cases are reachable through the main case detail representation and direct detail/subresource URLs, not a flat list expansion. Tenant-scoped by the authenticated company. Sub-resources of one mandate: payments — the reported, non-ignored payments documents — claim-document metadata and a proxy-stream download * history — published client activity, related resources, and attachments. A main case includes its subcases; a subcase includes only itself. The sub-resource operations resolve the mandate including sub-cases — unlike the list, which hides sub-cases — so an individually-addressable sub-case\u0026#x27;s own track stays reachable. These public mandate operations are reads.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://paywisegmbh.mintlify.site/_mintlify/api/og/v2?division=Mandates\u0026amp;title=Get+mandate\u0026amp;description=Accepted+cases+%28Aktenzeichen%29.%0A%0AMain-case-centric%3A+the+list+returns+**main+cases+only**.%0ASub-cases+are+reachable+through+the+main+case+detail+representation+and\u0026amp;theme=bad878af30f1dee220dabe6f\u0026amp;signature=35fdcda4f7503923567afc689a75b2b74f9e6484500322a804ec77cd579cf688\">\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/mandates/get-mandate\">\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/mandates/get-mandate.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/mandates/get-mandate#webpage\",\"url\":\"https://docs.paywise.de/api-docs/case-management-api/reference/mandates/get-mandate\",\"name\":\"Get mandate\",\"description\":\"Accepted cases (Aktenzeichen). Main-case-centric: the list returns main cases only. Sub-cases are reachable through the main case detail representation and direct detail/subresource URLs, not a flat list expansion. Tenant-scoped by the authenticated company. Sub-resources of one mandate: payments — the reported, non-ignored payments documents — claim-document metadata and a proxy-stream download * history — published client activity, related resources, and attachments. A main case includes its subcases; a subcase includes only itself. The sub-resource operations resolve the mandate including sub-cases — unlike the list, which hides sub-cases — so an individually-addressable sub-case's own track stays reachable. These public mandate operations are reads.\",\"dateModified\":\"2026-10-16T12:47:30.871Z\",\"isPartOf\":{\"@id\":\"https://docs.paywise.de#website\"},\"breadcrumb\":{\"@id\":\"https://docs.paywise.de/api-docs/case-management-api/reference/mandates/get-mandate#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.paywise.de/api-docs/case-management-api/reference/mandates/get-mandate#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\":\"Mandates\",\"item\":\"https://docs.paywise.de/api-docs/case-management-api/reference/mandates/list-mandates\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Get mandate\",\"item\":\"https://docs.paywise.de/api-docs/case-management-api/reference/mandates/get-mandate\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.paywise.de/api-docs/case-management-api/reference/mandates/get-mandate#apireference\",\"headline\":\"Get mandate\",\"name\":\"Get mandate\",\"description\":\"Accepted cases (Aktenzeichen). Main-case-centric: the list returns main cases only. Sub-cases are reachable through the main case detail representation and direct detail/subresource URLs, not a flat list expansion. Tenant-scoped by the authenticated company. Sub-resources of one mandate: payments — the reported, non-ignored payments documents — claim-document metadata and a proxy-stream download * history — published client activity, related resources, and attachments. A main case includes its subcases; a subcase includes only itself. The sub-resource operations resolve the mandate including sub-cases — unlike the list, which hides sub-cases — so an individually-addressable sub-case's own track stays reachable. These public mandate operations are reads.\",\"url\":\"https://docs.paywise.de/api-docs/case-management-api/reference/mandates/get-mandate\",\"mainEntityOfPage\":{\"@id\":\"https://docs.paywise.de/api-docs/case-management-api/reference/mandates/get-mandate#webpage\"},\"dateModified\":\"2026-10-16T12:47:30.871Z\",\"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/mandates/get-mandate.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","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","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/{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":"Get mandate - paywise Knowledge Center","deploymentId":"dpl_2pTxFtyBudBMYZiCw1MyvoA1wxpd","buildId":"dpl_2pTxFtyBudBMYZiCw1MyvoA1wxpd","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BtG4DSkw.js","snippetPresets-C1k1xDhp.js","utils-PMJoEt4Y.js","style-to-object-BY3JEAdk.js","utils-DW3Pr7Jq.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-DIISLO2w.js","conditional-requirements-CFM0id0Q.js","cloneDeep-BErNCZCm.js","_Uint8Array-f0PCu9f_.js","isObject-FP1Yky1u.js","ApiExamples-OjY-8mqu.js","usePlaygroundInputsStore-B2HS2hUb.js","shallow-DVFuuIDQ.js","isEqual-DG0UKiQC.js","CodeSnippets-Cy6FBgwN.js","CodeSnippet-D1PtG8ed.js","getApiPlaygroundDisplay-Dkx2eNtL.js","Page-C8Cg25if.js","DynamicMarkdown-BvJIe00T.js","SectionHeading-B0rKYV8d.js","icon-yclzBff4.js","MethodPill-DxA11cCF.js","getPastedJson-CpkIDpMk.js","DuplicateIcon-CFCQNJ-D.js","axios-CsQoIw0U.js","Markdown-CK5C-fmV.js","AssistantPageLink-Cw134Dd-.js","dist-3xM3Qrc7.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}