using RestSharp;
var options = new RestClientOptions("https://api.paywise.de/v2/claims/{id}/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{}", false);
var response = await client.PatchAsync(request);
Console.WriteLine("{0}", response.Content);
Claims addressed by their stable UUID and current relationships.
Read claims throughout their lifecycle using URLs that remain valid after
internal order moves. Standalone creation requires a draft order_id;
the relationship is read-only thereafter. Create, PATCH, and DELETE require
a draft order and otherwise return 409 claim_not_editable. An expired
draft instead returns 409 order_expired. Tenant-scoped by the
authenticated company.
using RestSharp;
var options = new RestClientOptions("https://api.paywise.de/v2/claims/{id}/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{}", false);
var response = await client.PatchAsync(request);
Console.WriteLine("{0}", response.Content);
Company-bound Case Management API key — the standard credential for this API.
Headers
X-On-Behalf-Of-Company
string<uuid>
Required when a Partner key calls the Case Management API; rejected for direct Case keys. Contains the entitled paywise company UUID.
If-Match
string
Apply the change only while the current ETag matches one of the supplied validators (or *); otherwise the request fails with 412 precondition_failed and nothing is written.
Path Parameters
id
string<uuid>
required
UUID of the claim in this request.
Body
application/json
Partial update of a claim while its order is a draft.
One flat schema: a claim's type is immutable, so type is not a
writable field here and title ownership changes only through the
claim-owned enforceable-title route.
additional_charges
object[]
Itemized incidental charges for a receivable claim, such as reminder or bank fees. This array replaces all existing charges; [] clears them and omission preserves them. Maximum 50 entries per claim.
Maximum array length: 50
Show child attributes
delay_date
string<date> | null
Payment-default date for a receivable claim. For H17/H19 rent, an explicit date overrides the derived day after due_date and null restores derivation. For other receivables, null clears it; changing document_date, due_date, or reminders without supplying delay_date recalculates it. An explicit date must follow the applicable due or reminder date.
dispute_reason
string | null
Debtor's stated reason for disputing the claim. The resulting disputed claim must have a non-blank reason; an existing reason satisfies this requirement when omitted from PATCH. Setting is_disputed to false clears the existing reason unless you supply this field, which must then be empty or null.
Maximum string length: 2500
document_date
string<date> | null
Date of the invoice, contract, or other claim document. For H17/H19 rent, supply the first day of the rental month; only one rental claim per calendar month is allowed. Only valid for receivable claims. Required and cannot be in the future at finalization.
document_reference
string | null
Invoice, contract, or other source-document number.
Maximum string length: 255
due_date
string<date> | null
Date on which a receivable claim became due. For H17/H19 rent, an explicit date overrides the agreement rule, null restores derivation, and omission preserves the current date or its existing derivation. For other receivables it cannot precede document_date.
is_disputed
boolean
Whether the debtor disputes the claim. Setting false also clears the existing dispute_reason unless you supply that field explicitly.
items
object[]
Invoice or contract lines for a receivable claim. This array replaces all existing lines; [] clears them and omission preserves them. Supply principal_amount separately when the principal changes. Maximum 100 entries per claim.
Maximum array length: 100
Show child attributes
legal_basis
object
Contract or obligation establishing a receivable claim. Supplied properties update the existing legal basis; omitted properties stay unchanged. Not valid on titled claims or on receivable enforcement costs in titled orders, which always use K014.
Show child attributes
principal_amount
object
Replacement principal amount including VAT, before charges and payments. Only valid for receivable claims; titled claims use their enforceable-title amount. Changing items does not update this amount. The principal must be positive before finalization.
Show child attributes
reminders
object[]
Payment reminders for a receivable claim, in chronological order starting no earlier than its due date (or document date when due_date is absent). This array replaces all reminders; [] clears them and omission preserves them. Retain existing entries with their id. Maximum 50 entries per claim.
Maximum array length: 50
Show child attributes
subject_matter
string | null
Goods, services, or other obligation underlying the claim. Before finalization, a receivable claim must have non-blank subject_matter or at least one claim document. Maximum 2000 characters.
Maximum string length: 2000
your_reference
string | null
Your reference for this claim.
Maximum string length: 255
Response
Receivable claim
Titled claim
A receivable claim based on an invoice, rent, or another obligation. Its principal amount, dates, charges, and documents belong to the claim.
additional_charges
object[]
required
read-only
Itemized incidental claims such as reminder or bank fees. API submissions are limited to 50 entries.
Show child attributes
additional_charges_amount
object
required
Sum of all itemized additional charges.
Show child attributes
additional_debtor_ids
string<uuid>[]
required
read-only
Read-only additional debtor identifiers projected from the current order.
created_at
string<date-time>
required
read-only
Time at which the claim was created.
debtor_id
string<uuid> | null
required
read-only
Read-only primary debtor identifier projected from the current order. Change party membership only on a draft order; debtor details use the debtor resource.
delay_date
string<date> | null
required
read-only
Date from which the debtor is considered in payment default.
dispute_reason
string | null
required
read-only
Debtor's stated reason for disputing the claim.
document_date
string<date> | null
required
read-only
Date of the invoice, contract, or other claim document.
document_reference
string | null
required
read-only
Invoice, contract, or other source-document number.
documents
object[]
required
read-only
Documents relevant to processing the claim.
Show child attributes
due_date
string<date> | null
required
read-only
Date on which payment of the principal claim became due.
events
object[]
required
read-only
Stored contextual events associated with this resource.
Show child attributes
id
string<uuid>
required
read-only
Stable identifier of this claim.
is_disputed
boolean
required
read-only
Whether the debtor disputes the claim.
items
object[]
required
read-only
Invoice or contract lines that make up the principal claim. API submissions are limited to 100 entries.
Show child attributes
legal_basis
object
required
Contract or obligation that establishes the principal claim.
Show child attributes
mandate_id
string<uuid> | null
required
read-only
Read-only accepted mandate identifier, or null before acceptance.
metadata
object[]
required
read-only
Stored metadata entries; duplicate types remain separate entries.
Show child attributes
order_id
string<uuid>
required
read-only
Read-only current order identifier. Internal review may change this relationship while the claim identifier and all claim-specific URLs remain stable.
payments
object[]
required
read-only
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.
Show child attributes
principal_amount
object | null
required
Original principal amount including VAT, before charges and payments.
Show child attributes
reminders
object[]
required
read-only
Payment reminders issued for this claim in chronological order. API submissions are limited to 50 entries.
Show child attributes
status
enum<string>
required
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.
Available options:
draft,
submitted,
awaiting_client_response,
accepted,
rejected,
withdrawn
subject_matter
string | null
required
read-only
Goods, services, or other obligation underlying the claim. API submissions are limited to 2000 characters.
total_amount
object | null
required
Current open amount after charges and reported payments.
Show child attributes
type
enum<string>
required
Literal receivable claim discriminator.
Available options:
receivable
updated_at
string<date-time>
required
read-only
Time at which the claim was last updated.
your_reference
string | null
required
read-only
Your reference for this claim.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"paywise Knowledge Center","colors":{"primary":"#fd7e14","light":"#6a9bf4","dark":"#37384e"},"logo":{"light":"https://mintcdn.com/paywisegmbh/NM1UIIld1WRHivnS/logo/paywise-logo.svg?fit=max\u0026auto=format\u0026n=NM1UIIld1WRHivnS\u0026q=85\u0026s=0d1a1b06e878f9d25ef70b19e3df50cc","dark":"https://mintcdn.com/paywisegmbh/NM1UIIld1WRHivnS/logo/paywise-logo-light.png?fit=max\u0026auto=format\u0026n=NM1UIIld1WRHivnS\u0026q=85\u0026s=ab0f73c7353586d673c947dc946db86b"},"favicon":"https://mintcdn.com/paywisegmbh/NM1UIIld1WRHivnS/favicon-32x32.png?fit=max\u0026auto=format\u0026n=NM1UIIld1WRHivnS\u0026q=85\u0026s=f1eaf1b6461ee62ec891fd1a5309f891","api":{"examples":{"defaults":"required","languages":["python","javascript","java","csharp","curl"],"prefill":true,"autogenerate":true}},"navbar":{"links":[{"href":"mailto:[email protected]","label":"Kontakt"}],"primary":{"type":"button","label":"Login","href":"https://app.paywise.de/account/"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/paywise-gmbh","github":"https://github.com/paywise-gmbh"}},"contextual":{"options":["copy","view","chatgpt","claude","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"languages":[{"language":"de","default":true,"href":"user-docs/overview"},{"language":"en","href":"en/user-docs/overview"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"paywisegmbh","hasAudioNarration":false,"actualSubdomain":"paywisegmbh","customDomains":["docs.paywise.de"],"gitSource":{"type":"github","owner":"paywise-gmbh","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{},"buildId":"6af19bb3e7b89d498acbc16f","clientVersion":"0.0.4227","searchFilterCounts":[{"language":"en","tag":"Technical documentation","count":287},{"language":"en","tag":"Case Management API","count":135},{"language":"en","tag":"Case Management API reference","count":112},{"language":"en","tag":"Legacy APIs (v1)","count":68},{"language":"en","tag":"Frozen Case Management API","count":50},{"language":"en","tag":"Partner API","count":42},{"language":"en","tag":"Frozen Case Management API reference","count":40},{"language":"en","tag":"Mahnservice API","count":28},{"language":"en","tag":"Mandates","count":28},{"language":"en","tag":"Partner API reference","count":27},{"language":"de","tag":"Integrationen","count":20},{"language":"de","tag":"Buchhaltungs-Integrationen","count":15},{"language":"de","tag":"Anwenderdokumentation","count":12},{"language":"de","tag":"Mahnservice","count":10},{"language":"de","tag":"DATEV","count":5},{"language":"de","tag":"Technische Dokumentation","count":1},{"language":"de","tag":"Verwaltung","count":1}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"svg[data-pw-icon]{color:#fd7e14}html.dark svg[data-pw-icon]{color:#6a9bf4}img.sidebar-group-icon[src$=\"case-api.svg\"],img.sidebar-group-icon[src$=\"partner-api.svg\"],img.sidebar-group-icon[src$=\"mahnservice-api.svg\"]{content:url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'%3E%3C/svg%3E\");background-color:#fd7e14!important;-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;-webkit-mask-size:contain;mask-repeat:no-repeat;mask-position:center;mask-size:contain}img.sidebar-group-icon[src$=\"case-api.svg\"]{-webkit-mask-image:url(\"/images/icons/case-api.svg\");mask-image:url(\"/images/icons/case-api.svg\")}img.sidebar-group-icon[src$=\"partner-api.svg\"]{-webkit-mask-image:url(\"/images/icons/partner-api.svg\");mask-image:url(\"/images/icons/partner-api.svg\")}img.sidebar-group-icon[src$=\"mahnservice-api.svg\"]{-webkit-mask-image:url(\"/images/icons/mahnservice-api.svg\");mask-image:url(\"/images/icons/mahnservice-api.svg\")}html.dark img.sidebar-group-icon[src$=\"case-api.svg\"],html.dark img.sidebar-group-icon[src$=\"partner-api.svg\"],html.dark img.sidebar-group-icon[src$=\"mahnservice-api.svg\"]{background-color:#6a9bf4!important}.pw-download-button{background-color:#fd7e14;color:#fff}html.dark .pw-download-button{background-color:#6a9bf4;color:#111}.mermaid .edgeLabel,.mermaid .edgeLabel rect,.mermaid .edgeLabel .label-container{background-color:transparent!important;fill:transparent!important}"}]}
{"page":{"pagePath":"api-docs/case-management-api/reference/claims/update-claim","slug":"/api-docs/case-management-api/reference/claims/update-claim","pageMetadata":{"title":"Update claim","description":"Claims addressed by their stable UUID and current relationships.\n\nRead claims throughout their lifecycle using URLs that remain valid after\ninternal order moves. Standalone creation requires a draft `order_id`;\nthe relationship is read-only thereafter. Create, PATCH, and DELETE require\na draft order and otherwise return `409 claim_not_editable`. An expired\ndraft instead returns `409 order_expired`. Tenant-scoped by the\nauthenticated company.","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","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Claims addressed by their stable UUID and current relationships.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Read claims throughout their lifecycle using URLs that remain valid after\\ninternal order moves. Standalone creation requires a draft \", _jsx(_components.code, {\n children: \"order_id\"\n }), \";\\nthe relationship is read-only thereafter. Create, PATCH, and DELETE require\\na draft order and otherwise return \", _jsx(_components.code, {\n children: \"409 claim_not_editable\"\n }), \". An expired\\ndraft instead returns \", _jsx(_components.code, {\n children: \"409 order_expired\"\n }), \". Tenant-scoped by the\\nauthenticated company.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Update claim","description":"Claims addressed by their stable UUID and current relationships.\n\nRead claims throughout their lifecycle using URLs that remain valid after\ninternal order moves. Standalone creation requires a draft `order_id`;\nthe relationship is read-only thereafter. Create, PATCH, and DELETE require\na draft order and otherwise return `409 claim_not_editable`. An expired\ndraft instead returns `409 order_expired`. Tenant-scoped by the\nauthenticated company.","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","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/paywisegmbh/c0e4bbe3e0c9277e/api-field-anchors.js"],"openApiReferenceData":{"operation":{"description":"Claims addressed by their stable UUID and current relationships.\n\nRead claims throughout their lifecycle using URLs that remain valid after\ninternal order moves. Standalone creation requires a draft `order_id`;\nthe relationship is read-only thereafter. Create, PATCH, and DELETE require\na draft order and otherwise return `409 claim_not_editable`. An expired\ndraft instead returns `409 order_expired`. Tenant-scoped by the\nauthenticated company.","operationId":"update-claim","parameters":["a99d8785-c5e4-41c7-9c72-fb2e16ba21c7","be45bca6-6270-4817-be38-fa844a1ec8ed","5668df9b-e934-4090-bde4-161dd377bb0a"],"requestBody":"cac9aeb2-0d6c-4965-bd13-03f6835fe2ec","responses":{"200":"4c136c0d-384f-4587-b551-50e5756e9ab5","400":"b66b5b7c-d676-43b7-beef-7827f3c8f1a9","401":"2dd635d9-e72b-4b3b-9616-9140ab1d1fc0","403":"61433b95-15ce-409a-8b55-b4834fb93a61","404":"bbddc867-9e18-496c-b8ff-9632253429be","409":"0eaa8ce5-a8e3-4276-8cda-5b0c1a6a1402","412":"a95080d5-0cca-4ddc-bf6f-8fef338bc49c","429":"7f4157be-078f-43a9-ae2a-b2da317a3515","500":"16ee13fd-937e-4c94-baa6-1a1d0515c93b"},"security":["14fc16e6-f154-4a98-a1f4-322e47a176bf","61098663-dc10-473b-adc7-84f53a845da0"],"summary":"Update claim","tags":["Claims"],"x-required-scopes":["case:orders:write"],"method":"patch","type":"path","servers":["8c8f8cc6-b41f-4cad-9749-5ef9c02d1396","554ab33b-0043-40a7-a452-cca88c2fcfe6"],"path":"/v2/claims/{id}/","baseUrlOptions":["https://api.paywise.de","https://api-sandbox.paywise.de"],"title":"Update claim","codeSamples":[],"requestExampleLanguages":["python","javascript","java","csharp","bash"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.due_date.oneOf.0":"2026-06-26","body.subject_matter.oneOf.0":"Website accessibility consulting in June 2026 (rev. 2)"}]},"dependencies":{"parameters":{"a99d8785-c5e4-41c7-9c72-fb2e16ba21c7":{"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>"}},"be45bca6-6270-4817-be38-fa844a1ec8ed":{"description":"UUID of the claim in this request.","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string","isRequired":true,"description":"UUID of the claim in this request.","uniqueKey":"","typeLabel":"string\u003cuuid>"}},"5668df9b-e934-4090-bde4-161dd377bb0a":{"description":"Apply the change only while the current `ETag` matches one of the supplied validators (or `*`); otherwise the request fails with `412 precondition_failed` and nothing is written.","in":"header","name":"If-Match","required":false,"schema":{"type":"string","isRequired":false,"description":"Apply the change only while the current `ETag` matches one of the supplied validators (or `*`); otherwise the request fails with `412 precondition_failed` and nothing is written.","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"examples":{"claim-draft-patch":{"title":"claim-draft-patch","value":{"due_date":"2026-06-26","subject_matter":"Website accessibility consulting in June 2026 (rev. 2)"}}},"schema":{"description":"Partial update of a claim while its order is a draft.\n\nOne flat schema: a claim's type is immutable, so `type` is not a\nwritable field here and title ownership changes only through the\nclaim-owned `enforceable-title` route.","properties":{"additional_charges":{"description":"Itemized incidental charges for a receivable claim, such as reminder or bank fees. This array replaces all existing charges; [] clears them and omission preserves them. Maximum 50 entries per claim.","items":{"description":"An additional charge / incidental claim (Nebenforderung).","properties":{"amount":{"type":"object","description":"Amount of the additional charge. Zero is accepted while drafting, but the amount must be positive before finalization.","required":["value"],"properties":{"value":{"description":"Non-negative monetary value in major currency units, with at most two decimal places; for EUR, 100.00 means 100 euros. 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":"additional_charges.items.[INDEX].amount.value","typeLabel":"string"},"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","default":"EUR","enum":["EUR"],"uniqueKey":"additional_charges.items.[INDEX].amount.currency","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"additional_charges.items.[INDEX].amount","typeLabel":"object"},"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":"additional_charges.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"events":{"description":"Contextual events for this new charge.","items":{"description":"A contextual event supplied when creating a debtor, claim, or additional charge.","properties":{"occurence":{"description":"Time at which the event occurred; the historical field spelling is intentional.","format":"date-time","type":"string","isRequired":true,"uniqueKey":"additional_charges.items.[INDEX].events.items.[INDEX].occurence","typeLabel":"string\u003cdate-time>"},"title":{"description":"Human-readable title of the event.","maxLength":255,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"additional_charges.items.[INDEX].events.items.[INDEX].title","typeLabel":"string"},"type":{"type":"string","description":"Additional-charge event type.\n\n* `invoice` - invoice\n* `transaction` - transaction","enum":["invoice","transaction"],"isRequired":true,"uniqueKey":"additional_charges.items.[INDEX].events.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"description":{"oneOf":[{"description":"Optional description of the event.","maxLength":255,"type":"string","uniqueKey":"additional_charges.items.[INDEX].events.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"description":"Optional description of the event.","maxLength":255,"type":"null","uniqueKey":"additional_charges.items.[INDEX].events.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"additional_charges.items.[INDEX].events.items.[INDEX].description","typeLabel":"string | null"},"location":{"oneOf":[{"description":"Optional location associated with the event.","maxLength":255,"type":"string","uniqueKey":"additional_charges.items.[INDEX].events.items.[INDEX].location.oneOf.0","typeLabel":"string"},{"description":"Optional location associated with the event.","maxLength":255,"type":"null","uniqueKey":"additional_charges.items.[INDEX].events.items.[INDEX].location.oneOf.1","typeLabel":"null"}],"uniqueKey":"additional_charges.items.[INDEX].events.items.[INDEX].location","typeLabel":"string | null"},"your_reference":{"oneOf":[{"description":"Your optional reference for the event.","maxLength":255,"type":"string","uniqueKey":"additional_charges.items.[INDEX].events.items.[INDEX].your_reference.oneOf.0","typeLabel":"string"},{"description":"Your optional reference for the event.","maxLength":255,"type":"null","uniqueKey":"additional_charges.items.[INDEX].events.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"uniqueKey":"additional_charges.items.[INDEX].events.items.[INDEX].your_reference","typeLabel":"string | null"}},"required":["occurence","title","type"],"type":"object","uniqueKey":"additional_charges.items.[INDEX].events.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"additional_charges.items.[INDEX].events","typeLabel":"object[]"},"metadata":{"description":"Metadata for this new charge; duplicate types are allowed.","items":{"description":"One creation-time metadata row; duplicate types are intentional.","properties":{"type":{"type":"string","description":"Claim or additional-charge metadata type.\n\n* `comment` - comment\n* `invoice:reference` - invoice:reference\n* `invoice:date` - invoice:date\n* `invoice:address_line_1` - invoice:address_line_1\n* `invoice:address_line_2` - invoice:address_line_2\n* `invoice:address_city` - invoice:address_city\n* `invoice:address_country` - invoice:address_country\n* `invoice:address_zip` - invoice:address_zip\n* `invoice:amount` - invoice:amount\n* `transaction:reference` - transaction:reference\n* `transaction:source_ip_address` - transaction:source_ip_address\n* `contract:reference` - contract:reference\n* `report:reference` - report:reference\n* `account:reference` - account:reference\n* `claim:holder:address:country` - claim:holder:address:country\n* `claim:holder:address:city` - claim:holder:address:city\n* `claim:holder:name` - claim:holder:name\n* `dunning:level` - dunning:level\n* `reminder:date` - reminder:date\n* `reminder:amount:value` - reminder:amount:value\n* `reminder:amount:currency` - reminder:amount:currency\n* `notification:date` - notification:date\n* `confirmation:email` - confirmation:email\n* `order:rate` - order:rate\n* `order:deposit` - order:deposit\n* `order:cashback` - order:cashback\n* `order:prepaid` - order:prepaid\n* `order:type` - order:type\n* `rental:pickup:date` - rental:pickup:date\n* `rental:pickup:time` - rental:pickup:time\n* `rental:pickup:city` - rental:pickup:city\n* `rental:dropoff:date` - rental:dropoff:date\n* `rental:dropoff:time` - rental:dropoff:time\n* `rental:dropoff:city` - rental:dropoff:city\n* `rental:gps_tracking` - rental:gps_tracking\n* `rental:charged_items` - rental:charged_items\n* `payment:method` - payment:method\n* `import:csv:filename` - import:csv:filename\n* `insurance:bonus_malus_system` - insurance:bonus_malus_system\n* `insurance:contribution_rate` - insurance:contribution_rate\n* `insurance:regional_class_liability_insurance` - insurance:regional_class_liability_insurance\n* `insurance:regional_class_partial_coverage` - insurance:regional_class_partial_coverage\n* `payment:frequency` - payment:frequency\n* `language` - language\n* `tax:id` - tax:id\n* `notification_delivery:date` - notification_delivery:date\n* `merchant:address_line1` - merchant:address_line1\n* `merchant:address_city` - merchant:address_city\n* `merchant:address_zip` - merchant:address_zip\n* `merchant:address_country` - merchant:address_country\n* `merchant:company_name` - merchant:company_name\n* `merchant:company_type` - merchant:company_type\n* `merchant:representative_firstname` - merchant:representative_firstname\n* `merchant:representative_secondname` - merchant:representative_secondname\n* `merchant:website_url` - merchant:website_url\n* `chargeback:reason` - chargeback:reason\n* `shop:website_url` - shop:website_url\n* `subscription:overdue_period` - subscription:overdue_period\n* `subscription:duration` - subscription:duration\n* `subscription:start` - subscription:start\n* `subscription:delivery:address` - subscription:delivery:address\n* `subscription:reference` - subscription:reference\n* `subscription:renewal` - subscription:renewal\n* `subscription:last_login` - subscription:last_login\n* `subscription:photo_available` - subscription:photo_available\n* `subscription:type` - subscription:type\n* `subscription:termination` - subscription:termination\n* `medical:patient` - medical:patient\n* `debtor:file_id` - debtor:file_id\n* `email:seller` - email:seller\n* `name:seller` - name:seller\n* `addressline:seller` - addressline:seller\n* `zip:seller` - zip:seller\n* `city:seller` - city:seller\n* `name:ditsributor` - name:ditsributor\n* `email:distributor` - email:distributor\n* `addressline:distributor` - addressline:distributor\n* `zip:distributor` - zip:distributor\n* `city:distributor` - city:distributor\n* `logo:distributor_pdf` - logo:distributor_pdf\n* `logo:distributor_email` - logo:distributor_email\n* `account:beneficiary` - account:beneficiary\n* `purchase:price` - purchase:price\n* `conditional:purchase_price` - conditional:purchase_price\n* `direct:payments` - direct:payments\n* `VAT` - VAT\n* `product:type` - product:type","enum":["comment","invoice:reference","invoice:date","invoice:address_line_1","invoice:address_line_2","invoice:address_city","invoice:address_country","invoice:address_zip","invoice:amount","transaction:reference","transaction:source_ip_address","contract:reference","report:reference","account:reference","claim:holder:address:country","claim:holder:address:city","claim:holder:name","dunning:level","reminder:date","reminder:amount:value","reminder:amount:currency","notification:date","confirmation:email","order:rate","order:deposit","order:cashback","order:prepaid","order:type","rental:pickup:date","rental:pickup:time","rental:pickup:city","rental:dropoff:date","rental:dropoff:time","rental:dropoff:city","rental:gps_tracking","rental:charged_items","payment:method","import:csv:filename","insurance:bonus_malus_system","insurance:contribution_rate","insurance:regional_class_liability_insurance","insurance:regional_class_partial_coverage","payment:frequency","language","tax:id","notification_delivery:date","merchant:address_line1","merchant:address_city","merchant:address_zip","merchant:address_country","merchant:company_name","merchant:company_type","merchant:representative_firstname","merchant:representative_secondname","merchant:website_url","chargeback:reason","shop:website_url","subscription:overdue_period","subscription:duration","subscription:start","subscription:delivery:address","subscription:reference","subscription:renewal","subscription:last_login","subscription:photo_available","subscription:type","subscription:termination","medical:patient","debtor:file_id","email:seller","name:seller","addressline:seller","zip:seller","city:seller","name:ditsributor","email:distributor","addressline:distributor","zip:distributor","city:distributor","logo:distributor_pdf","logo:distributor_email","account:beneficiary","purchase:price","conditional:purchase_price","direct:payments","VAT","product:type"],"isRequired":true,"uniqueKey":"additional_charges.items.[INDEX].metadata.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"value":{"description":"Metadata value; duplicate types remain separate entries.","maxLength":255,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"additional_charges.items.[INDEX].metadata.items.[INDEX].value","typeLabel":"string"}},"required":["type","value"],"type":"object","uniqueKey":"additional_charges.items.[INDEX].metadata.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"additional_charges.items.[INDEX].metadata","typeLabel":"object[]"},"occurrence_date":{"oneOf":[{"description":"Date on which the additional charge arose; required before the order can be finalized.","format":"date","type":"string","uniqueKey":"additional_charges.items.[INDEX].occurrence_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Date on which the additional charge arose; required before the order can be finalized.","format":"date","type":"null","uniqueKey":"additional_charges.items.[INDEX].occurrence_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"additional_charges.items.[INDEX].occurrence_date","typeLabel":"string\u003cdate> | null"},"subject_matter":{"oneOf":[{"description":"Reason or subject of the additional charge. Maximum 2000 characters.","maxLength":2000,"type":"string","uniqueKey":"additional_charges.items.[INDEX].subject_matter.oneOf.0","typeLabel":"string"},{"description":"Reason or subject of the additional charge. Maximum 2000 characters.","maxLength":2000,"type":"null","uniqueKey":"additional_charges.items.[INDEX].subject_matter.oneOf.1","typeLabel":"null"}],"uniqueKey":"additional_charges.items.[INDEX].subject_matter","typeLabel":"string | null"},"your_reference":{"oneOf":[{"description":"Your reference for this additional charge.","maxLength":255,"type":"string","uniqueKey":"additional_charges.items.[INDEX].your_reference.oneOf.0","typeLabel":"string"},{"description":"Your reference for this additional charge.","maxLength":255,"type":"null","uniqueKey":"additional_charges.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"uniqueKey":"additional_charges.items.[INDEX].your_reference","typeLabel":"string | null"}},"required":["amount","type"],"type":"object","uniqueKey":"additional_charges.items.[INDEX]","typeLabel":"object"},"maxItems":50,"type":"array","uniqueKey":"additional_charges","typeLabel":"object[]"},"delay_date":{"oneOf":[{"description":"Payment-default date for a receivable claim. For H17/H19 rent, an explicit date overrides the derived day after due_date and null restores derivation. For other receivables, null clears it; changing document_date, due_date, or reminders without supplying delay_date recalculates it. An explicit date must follow the applicable due or reminder date.","format":"date","type":"string","uniqueKey":"delay_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Payment-default date for a receivable claim. For H17/H19 rent, an explicit date overrides the derived day after due_date and null restores derivation. For other receivables, null clears it; changing document_date, due_date, or reminders without supplying delay_date recalculates it. An explicit date must follow the applicable due or reminder date.","format":"date","type":"null","uniqueKey":"delay_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"delay_date","typeLabel":"string\u003cdate> | null"},"dispute_reason":{"oneOf":[{"description":"Debtor's stated reason for disputing the claim. The resulting disputed claim must have a non-blank reason; an existing reason satisfies this requirement when omitted from PATCH. Setting is_disputed to false clears the existing reason unless you supply this field, which must then be empty or null.","maxLength":2500,"type":"string","uniqueKey":"dispute_reason.oneOf.0","typeLabel":"string"},{"description":"Debtor's stated reason for disputing the claim. The resulting disputed claim must have a non-blank reason; an existing reason satisfies this requirement when omitted from PATCH. Setting is_disputed to false clears the existing reason unless you supply this field, which must then be empty or null.","maxLength":2500,"type":"null","uniqueKey":"dispute_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"dispute_reason","typeLabel":"string | null"},"document_date":{"oneOf":[{"description":"Date of the invoice, contract, or other claim document. For H17/H19 rent, supply the first day of the rental month; only one rental claim per calendar month is allowed. Only valid for receivable claims. Required and cannot be in the future at finalization.","format":"date","type":"string","uniqueKey":"document_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Date of the invoice, contract, or other claim document. For H17/H19 rent, supply the first day of the rental month; only one rental claim per calendar month is allowed. Only valid for receivable claims. Required and cannot be in the future at finalization.","format":"date","type":"null","uniqueKey":"document_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"document_date","typeLabel":"string\u003cdate> | null"},"document_reference":{"oneOf":[{"description":"Invoice, contract, or other source-document number.","maxLength":255,"type":"string","uniqueKey":"document_reference.oneOf.0","typeLabel":"string"},{"description":"Invoice, contract, or other source-document number.","maxLength":255,"type":"null","uniqueKey":"document_reference.oneOf.1","typeLabel":"null"}],"uniqueKey":"document_reference","typeLabel":"string | null"},"due_date":{"oneOf":[{"description":"Date on which a receivable claim became due. For H17/H19 rent, an explicit date overrides the agreement rule, null restores derivation, and omission preserves the current date or its existing derivation. For other receivables it cannot precede document_date.","format":"date","type":"string","uniqueKey":"due_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Date on which a receivable claim became due. For H17/H19 rent, an explicit date overrides the agreement rule, null restores derivation, and omission preserves the current date or its existing derivation. For other receivables it cannot precede document_date.","format":"date","type":"null","uniqueKey":"due_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"due_date","typeLabel":"string\u003cdate> | null"},"is_disputed":{"description":"Whether the debtor disputes the claim. Setting false also clears the existing dispute_reason unless you supply that field explicitly.","type":"boolean","uniqueKey":"is_disputed","typeLabel":"boolean"},"items":{"description":"Invoice or contract lines for a receivable claim. This array replaces all existing lines; [] clears them and omission preserves them. Supply principal_amount separately when the principal changes. Maximum 100 entries per claim.","items":{"description":"A line item on a claim (Rechnungsposten).","properties":{"description":{"description":"Goods or service represented by this invoice or contract line.","maxLength":1000,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"\\items.items.[INDEX].description","typeLabel":"string"},"quantity":{"description":"Non-negative number of units represented by this line; up to six decimal places are supported. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,10}(?:\\.[0-9]{1,6})?$","type":"string","isRequired":true,"uniqueKey":"\\items.items.[INDEX].quantity","typeLabel":"string"},"unit_price":{"type":"object","description":"Price of one unit before multiplying by quantity.","required":["value"],"properties":{"value":{"description":"Price for one unit; a negative value represents a credit. 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":"\\items.items.[INDEX].unit_price.value","typeLabel":"string"},"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","default":"EUR","enum":["EUR"],"uniqueKey":"\\items.items.[INDEX].unit_price.currency","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].unit_price","typeLabel":"object"},"unit":{"oneOf":[{"description":"Unit of measure for the quantity, when applicable.","maxLength":255,"type":"string","uniqueKey":"\\items.items.[INDEX].unit.oneOf.0","typeLabel":"string"},{"description":"Unit of measure for the quantity, when applicable.","maxLength":255,"type":"null","uniqueKey":"\\items.items.[INDEX].unit.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].unit","typeLabel":"string | null"}},"required":["description","quantity","unit_price"],"type":"object","uniqueKey":"\\items.items.[INDEX]","typeLabel":"object"},"maxItems":100,"type":"array","uniqueKey":"\\items","typeLabel":"object[]"},"legal_basis":{"type":"object","description":"Contract or obligation establishing a receivable claim. Supplied properties update the existing legal basis; omitted properties stay unchanged. Not valid on titled claims or on receivable enforcement costs in titled orders, which always use K014.","properties":{"claim_type_code":{"type":"string","description":"Public claim code. H17 (commercial rent) and H19 (residential rent) are valid only in rental orders and cannot be mixed in one order. Receivable enforcement costs in a titled order derive K014; do not supply a code for them. For other receivables, omission on creation or an empty string uses the company default when configured; omission on PATCH preserves the current code. 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.","enum":["H01","H02","H03","H04","H05","H06","H07","H08","H09","H10","H11","H12","H13","H14","H15","H16","H17","H18","H19","H20","H21","H22","H23","H24","H25","H26","H27","H28","H29","H30","H31","H32","H33","H34","H35","H36","H37","H38","H39","H40","H41","H42","H43","H44","H45","H46","H61","H70","H75","H76","H77","H78","H79","H80","H90","H95"],"uniqueKey":"legal_basis.claim_type_code","typeLabel":"enum\u003cstring>"},"contract_date":{"oneOf":[{"description":"Date the underlying contract was concluded. For H17/H19 rent it is derived from the rental agreement and a supplied value must match. For other receivables it cannot follow document_date; when omitted during creation it defaults to document_date.","format":"date","type":"string","uniqueKey":"legal_basis.contract_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Date the underlying contract was concluded. For H17/H19 rent it is derived from the rental agreement and a supplied value must match. For other receivables it cannot follow document_date; when omitted during creation it defaults to document_date.","format":"date","type":"null","uniqueKey":"legal_basis.contract_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"legal_basis.contract_date","typeLabel":"string\u003cdate> | null"},"description":{"oneOf":[{"description":"Terms or circumstances establishing the principal claim. Omission during creation, null, or an empty string uses the company default when configured; an omitted PATCH property keeps its current value. Maximum 2000 characters.","maxLength":2000,"type":"string","uniqueKey":"legal_basis.description.oneOf.0","typeLabel":"string"},{"description":"Terms or circumstances establishing the principal claim. Omission during creation, null, or an empty string uses the company default when configured; an omitted PATCH property keeps its current value. Maximum 2000 characters.","maxLength":2000,"type":"null","uniqueKey":"legal_basis.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"legal_basis.description","typeLabel":"string | null"}},"uniqueKey":"legal_basis","typeLabel":"object"},"principal_amount":{"type":"object","description":"Replacement principal amount including VAT, before charges and payments. Only valid for receivable claims; titled claims use their enforceable-title amount. Changing items does not update this amount. The principal must be positive before finalization.","required":["value"],"properties":{"value":{"description":"Principal amount including VAT, at least 0.01. 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":"principal_amount.value","typeLabel":"string"},"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","default":"EUR","enum":["EUR"],"uniqueKey":"principal_amount.currency","typeLabel":"enum\u003cstring>"}},"uniqueKey":"principal_amount","typeLabel":"object"},"reminders":{"description":"Payment reminders for a receivable claim, in chronological order starting no earlier than its due date (or document date when due_date is absent). This array replaces all reminders; [] clears them and omission preserves them. Retain existing entries with their id. Maximum 50 entries per claim.","items":{"description":"Writable reminder; ids retain rows only during PATCH replacement.","properties":{"date":{"description":"Date on which the payment reminder was issued.","format":"date","type":"string","isRequired":true,"uniqueKey":"reminders.items.[INDEX].date","typeLabel":"string\u003cdate>"},"due_date":{"oneOf":[{"description":"Payment deadline stated in the reminder, when present; cannot precede the reminder date.","format":"date","type":"string","uniqueKey":"reminders.items.[INDEX].due_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Payment deadline stated in the reminder, when present; cannot precede the reminder date.","format":"date","type":"null","uniqueKey":"reminders.items.[INDEX].due_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"reminders.items.[INDEX].due_date","typeLabel":"string\u003cdate> | null"},"id":{"description":"Existing reminder identifier to retain during PATCH replacement. Omit for a new reminder; identifiers cannot be supplied when creating a claim and must belong to this claim.","format":"uuid","type":"string","uniqueKey":"reminders.items.[INDEX].id","typeLabel":"string\u003cuuid>"}},"required":["date"],"type":"object","uniqueKey":"reminders.items.[INDEX]","typeLabel":"object"},"maxItems":50,"type":"array","uniqueKey":"reminders","typeLabel":"object[]"},"subject_matter":{"oneOf":[{"description":"Goods, services, or other obligation underlying the claim. Before finalization, a receivable claim must have non-blank subject_matter or at least one claim document. Maximum 2000 characters.","maxLength":2000,"type":"string","uniqueKey":"subject_matter.oneOf.0","typeLabel":"string"},{"description":"Goods, services, or other obligation underlying the claim. Before finalization, a receivable claim must have non-blank subject_matter or at least one claim document. Maximum 2000 characters.","maxLength":2000,"type":"null","uniqueKey":"subject_matter.oneOf.1","typeLabel":"null"}],"uniqueKey":"subject_matter","typeLabel":"string | null"},"your_reference":{"oneOf":[{"description":"Your reference for this claim.","maxLength":255,"type":"string","uniqueKey":"your_reference.oneOf.0","typeLabel":"string"},{"description":"Your reference for this claim.","maxLength":255,"type":"null","uniqueKey":"your_reference.oneOf.1","typeLabel":"null"}],"uniqueKey":"your_reference","typeLabel":"string | null"}},"type":"object","uniqueKey":"","typeLabel":"object"},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"4c136c0d-384f-4587-b551-50e5756e9ab5":{"content":{"application/json":{"examples":{"receivable":{"title":"receivable","summary":"Receivable claim","value":{"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":null,"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":"draft","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"}},"titled":{"title":"titled","summary":"Titled claim","value":{"additional_debtor_ids":[],"created_at":"2026-07-18T10:00:00Z","debtor_id":"40000000-0000-4000-8000-000000000001","dispute_reason":null,"document_reference":null,"enforceable_title":{"amount":{"currency":"EUR","value":"2500.00"},"created_at":"2026-07-18T10:00:00Z","documents":[],"file_number":"12-3456789-0-1","id":"31000000-0000-4000-8000-000000000001","issued_on":"2026-01-15","issuing_authority":"Amtsgericht Berlin","legally_binding_since":"2026-02-01","served_on":"2026-01-20","title_type":"enforcement_order","updated_at":"2026-07-18T10:00:00Z"},"events":[],"id":"30000000-0000-4000-8000-000000000001","is_disputed":false,"mandate_id":null,"metadata":[],"order_id":"20000000-0000-4000-8000-000000000001","payments":[],"principal_amount":null,"status":"draft","subject_matter":"Enforcement title","total_amount":{"currency":"EUR","value":"2500.00"},"type":"titled","updated_at":"2026-07-18T10:00:00Z","your_reference":"TITLE-2026-0042"}}},"schema":{"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":"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":"oneOf.0.additional_charges.items.[INDEX].amount.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"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":"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":"oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"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":"oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].location.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"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":"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":"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":"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":"oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"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":"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":"oneOf.0.additional_charges.items.[INDEX].metadata.items.[INDEX].type","typeLabel":"string"},"value":{"description":"Stored metadata value.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.additional_charges.items.[INDEX].metadata.items.[INDEX].value","typeLabel":"string"}},"required":["type","value"],"type":"object","uniqueKey":"oneOf.0.additional_charges.items.[INDEX].metadata.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"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":"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":"oneOf.0.additional_charges.items.[INDEX].occurrence_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"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":"oneOf.0.additional_charges.items.[INDEX].subject_matter.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"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":"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":"oneOf.0.additional_charges.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"oneOf.0.additional_charges.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"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":"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":"oneOf.0.additional_charges_amount.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"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":"oneOf.0.additional_debtor_ids.items.[INDEX]","typeLabel":"string\u003cuuid>"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"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":"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":"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":"oneOf.0.debtor_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"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":"oneOf.0.delay_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"oneOf.0.dispute_reason.oneOf.0","typeLabel":"string"},{"description":"Debtor's stated reason for disputing the claim.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.dispute_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"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":"oneOf.0.document_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"oneOf.0.document_reference.oneOf.0","typeLabel":"string"},{"description":"Invoice, contract, or other source-document number.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.document_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"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":"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":"oneOf.0.documents.items.[INDEX].download_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"oneOf.0.documents.items.[INDEX].failure_reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.0.documents.items.[INDEX].failure_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"oneOf.0.documents.items.[INDEX].filename","typeLabel":"string"},"id":{"description":"Stable identifier for this resource.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"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":"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":"oneOf.0.documents.items.[INDEX].mime_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"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":"oneOf.0.documents.items.[INDEX].parent.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"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":"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":"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":"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":"oneOf.0.documents.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"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":"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":"oneOf.0.due_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"oneOf.0.events.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"description":"Optional description of the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.events.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"oneOf.0.events.items.[INDEX].location.oneOf.0","typeLabel":"string"},{"description":"Optional location associated with the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.events.items.[INDEX].location.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"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":"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":"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":"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":"oneOf.0.events.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.events.items.[INDEX].your_reference","typeLabel":"string | null"}},"required":["description","location","occurence","title","type","your_reference"],"type":"object","uniqueKey":"oneOf.0.events.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.0.events","typeLabel":"object[]"},"id":{"description":"Stable identifier of this claim.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.id","typeLabel":"string\u003cuuid>"},"is_disputed":{"description":"Whether the debtor disputes the claim.","readOnly":true,"type":"boolean","isRequired":true,"uniqueKey":"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":"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":"oneOf.0.\\items.items.[INDEX].amount.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"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":"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":"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":"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":"oneOf.0.\\items.items.[INDEX].unit.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"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":"oneOf.0.\\items.items.[INDEX].unit_price.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.0.\\items.items.[INDEX].unit_price","typeLabel":"object"}},"required":["amount","description","quantity","unit","unit_price"],"type":"object","uniqueKey":"oneOf.0.\\items.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"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":"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":"oneOf.0.legal_basis.claim_type_code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"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":"oneOf.0.legal_basis.contract_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"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":"oneOf.0.legal_basis.description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.legal_basis.description","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"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":"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":"oneOf.0.mandate_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"oneOf.0.metadata.items.[INDEX].type","typeLabel":"string"},"value":{"description":"Stored metadata value.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.metadata.items.[INDEX].value","typeLabel":"string"}},"required":["type","value"],"type":"object","uniqueKey":"oneOf.0.metadata.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"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":"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":"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":"oneOf.0.payments.items.[INDEX].amount.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.0.payments.items.[INDEX].amount.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.0.payments.items.[INDEX].amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"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":"oneOf.0.payments.items.[INDEX].claim.oneOf.0.document_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"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":"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":"oneOf.0.payments.items.[INDEX].claim.oneOf.0.your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.payments.items.[INDEX].claim.oneOf.0.your_reference","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"oneOf.0.payments.items.[INDEX].claim.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.0.payments.items.[INDEX].claim.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"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":"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":"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":"oneOf.0.payments.items.[INDEX].mandate.oneOf.0.reference_number","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.0.payments.items.[INDEX].mandate.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.0.payments.items.[INDEX].mandate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"oneOf.0.payments.items.[INDEX].metadata.items.[INDEX].type","typeLabel":"string"},"value":{"description":"Stored metadata value.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.payments.items.[INDEX].metadata.items.[INDEX].value","typeLabel":"string"}},"required":["type","value"],"type":"object","uniqueKey":"oneOf.0.payments.items.[INDEX].metadata.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"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":"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":"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":"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":"oneOf.0.payments.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"oneOf.0.payments.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"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":"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":"oneOf.0.principal_amount.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.0.principal_amount.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.0.principal_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"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":"oneOf.0.reminders.items.[INDEX].date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"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":"oneOf.0.reminders.items.[INDEX].due_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"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":"oneOf.0.reminders.items.[INDEX].id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.reminders.items.[INDEX].id","typeLabel":"string\u003cuuid> | null"}},"required":["date","due_date","id"],"type":"object","uniqueKey":"oneOf.0.reminders.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"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":"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":"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":"oneOf.0.subject_matter.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"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":"oneOf.0.total_amount.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.0.total_amount.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.0.total_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.total_amount","typeLabel":"object | null"},"type":{"type":"string","description":"Literal receivable claim discriminator.","enum":["receivable"],"isRequired":true,"uniqueKey":"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":"oneOf.0.updated_at","typeLabel":"string\u003cdate-time>"},"your_reference":{"oneOf":[{"description":"Your reference for this claim.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.your_reference.oneOf.0","typeLabel":"string"},{"description":"Your reference for this claim.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.your_reference","typeLabel":"string | null"}},"uniqueKey":"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":"oneOf.1.additional_debtor_ids.items.[INDEX]","typeLabel":"string\u003cuuid>"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"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":"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":"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":"oneOf.1.debtor_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"oneOf.1.dispute_reason.oneOf.0","typeLabel":"string"},{"description":"Debtor's stated reason for disputing the claim.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.dispute_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"oneOf.1.document_reference.oneOf.0","typeLabel":"string"},{"description":"Invoice, contract, or other source-document number.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.document_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"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":"oneOf.1.enforceable_title.oneOf.0.amount.oneOf.0.currency","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"oneOf.1.enforceable_title.oneOf.0.amount.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.1.enforceable_title.oneOf.0.amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"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":"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":"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":"oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].download_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].failure_reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].failure_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"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":"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":"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":"oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].mime_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"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":"oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].parent.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"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":"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":"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":"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":"oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"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":"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":"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":"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":"oneOf.1.enforceable_title.oneOf.0.issued_on.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"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":"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":"oneOf.1.enforceable_title.oneOf.0.legally_binding_since.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"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":"oneOf.1.enforceable_title.oneOf.0.served_on.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"oneOf.1.enforceable_title.oneOf.0.title_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.1.enforceable_title.oneOf.0.title_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"oneOf.1.enforceable_title.oneOf.0.updated_at","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"oneOf.1.enforceable_title.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.1.enforceable_title.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"oneOf.1.events.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"description":"Optional description of the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.events.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"oneOf.1.events.items.[INDEX].location.oneOf.0","typeLabel":"string"},{"description":"Optional location associated with the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.events.items.[INDEX].location.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"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":"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":"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":"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":"oneOf.1.events.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.events.items.[INDEX].your_reference","typeLabel":"string | null"}},"required":["description","location","occurence","title","type","your_reference"],"type":"object","uniqueKey":"oneOf.1.events.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.1.events","typeLabel":"object[]"},"id":{"description":"Stable identifier of this claim.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.id","typeLabel":"string\u003cuuid>"},"is_disputed":{"description":"Whether the debtor disputes the claim.","readOnly":true,"type":"boolean","isRequired":true,"uniqueKey":"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":"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":"oneOf.1.mandate_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"oneOf.1.metadata.items.[INDEX].type","typeLabel":"string"},"value":{"description":"Stored metadata value.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.metadata.items.[INDEX].value","typeLabel":"string"}},"required":["type","value"],"type":"object","uniqueKey":"oneOf.1.metadata.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"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":"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":"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":"oneOf.1.payments.items.[INDEX].amount.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.1.payments.items.[INDEX].amount.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.1.payments.items.[INDEX].amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"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":"oneOf.1.payments.items.[INDEX].claim.oneOf.0.document_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"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":"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":"oneOf.1.payments.items.[INDEX].claim.oneOf.0.your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.payments.items.[INDEX].claim.oneOf.0.your_reference","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"oneOf.1.payments.items.[INDEX].claim.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.1.payments.items.[INDEX].claim.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"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":"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":"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":"oneOf.1.payments.items.[INDEX].mandate.oneOf.0.reference_number","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.1.payments.items.[INDEX].mandate.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.1.payments.items.[INDEX].mandate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"oneOf.1.payments.items.[INDEX].metadata.items.[INDEX].type","typeLabel":"string"},"value":{"description":"Stored metadata value.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.payments.items.[INDEX].metadata.items.[INDEX].value","typeLabel":"string"}},"required":["type","value"],"type":"object","uniqueKey":"oneOf.1.payments.items.[INDEX].metadata.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"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":"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":"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":"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":"oneOf.1.payments.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"oneOf.1.payments.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"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":"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":"oneOf.1.principal_amount.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.1.principal_amount.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.1.principal_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"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":"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":"oneOf.1.subject_matter.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"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":"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":"oneOf.1.total_amount.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.1.total_amount.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.1.total_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.total_amount","typeLabel":"object | null"},"type":{"type":"string","description":"Literal titled claim discriminator.","enum":["titled"],"isRequired":true,"uniqueKey":"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":"oneOf.1.updated_at","typeLabel":"string\u003cdate-time>"},"your_reference":{"oneOf":[{"description":"Your reference for this claim.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.your_reference.oneOf.0","typeLabel":"string"},{"description":"Your reference for this claim.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.your_reference","typeLabel":"string | null"}},"uniqueKey":"oneOf.1","typeLabel":"Titled claim · object"}],"uniqueKey":"","typeLabel":"Receivable claim · object | Titled claim · 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"},"b66b5b7c-d676-43b7-beef-7827f3c8f1a9":{"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"},"2dd635d9-e72b-4b3b-9616-9140ab1d1fc0":{"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"},"61433b95-15ce-409a-8b55-b4834fb93a61":{"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"},"bbddc867-9e18-496c-b8ff-9632253429be":{"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"},"0eaa8ce5-a8e3-4276-8cda-5b0c1a6a1402":{"content":{"application/json":{"examples":{"conflict-error":{"title":"conflict-error","value":{"code":"conflict","detail":"The resource changed state and cannot accept this command."}},"order-expired":{"title":"order-expired","value":{"code":"order_expired","detail":"The draft order has expired and can no longer be changed."}}},"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":"","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"},"a95080d5-0cca-4ddc-bf6f-8fef338bc49c":{"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"},"7f4157be-078f-43a9-ae2a-b2da317a3515":{"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"},"16ee13fd-937e-4c94-baa6-1a1d0515c93b":{"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":{"14fc16e6-f154-4a98-a1f4-322e47a176bf":{"caseBearerAuth":{"description":"Company-bound Case Management API key — the standard credential for this API.","scheme":"bearer","type":"http","scopes":[],"schemeName":"caseBearerAuth"}},"61098663-dc10-473b-adc7-84f53a845da0":{"partnerBearerAuth":{"description":"Partner API key acting for one entitled company; every Case request must then also carry the X-On-Behalf-Of-Company header.","scheme":"bearer","type":"http","scopes":[],"schemeName":"partnerBearerAuth"}}},"servers":{"8c8f8cc6-b41f-4cad-9749-5ef9c02d1396":{"description":"Production environment","url":"https://api.paywise.de"},"554ab33b-0043-40a7-a452-cca88c2fcfe6":{"description":"Sandbox environment","url":"https://api-sandbox.paywise.de"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"description":"Company-bound Case Management API key — the standard credential for this API.","scheme":"bearer","type":"http","scopes":[],"schemeName":"caseBearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Company-bound Case Management API key — the standard credential for this API.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"caseBearerAuth","name":"Authorization"}],"title":"caseBearerAuth"},{"schemes":[{"scheme":{"description":"Partner API key acting for one entitled company; every Case request must then also carry the X-On-Behalf-Of-Company header.","scheme":"bearer","type":"http","scopes":[],"schemeName":"partnerBearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Partner API key acting for one entitled company; every Case request must then also carry the X-On-Behalf-Of-Company header.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"partnerBearerAuth","name":"Authorization"}],"title":"partnerBearerAuth"}]},"originalFileLocation":"api-docs/case-management-api/openapi.json"},"subdomain":"paywisegmbh","siteName":"paywise Knowledge Center","title":"Update claim - paywise Knowledge Center","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"de":{"href":"/user-docs/overview","matchLevel":4},"en":{"href":"/api-docs/case-management-api/reference/claims/update-claim","matchLevel":0}}},"lastModified":"2026-10-16T12:47:30.512Z","originalFileLocation":"api-docs/case-management-api/reference/claims/update-claim.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=\"Claims addressed by their stable UUID and current relationships. Read claims throughout their lifecycle using URLs that remain valid after internal order moves. Standalone creation requires a draft order_id; the relationship is read-only thereafter. Create, PATCH, and DELETE require a draft order and otherwise return 409 claim_not_editable. An expired draft instead returns 409 order_expired. Tenant-scoped by the authenticated company.\">\u003cmeta data-mint-head name=\"application-name\" content=\"paywise Knowledge Center\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/paywisegmbh/pNaPPB2tJ3SHoGQC/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/paywisegmbh/pNaPPB2tJ3SHoGQC/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/paywisegmbh/pNaPPB2tJ3SHoGQC/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/paywisegmbh/pNaPPB2tJ3SHoGQC/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/paywisegmbh/pNaPPB2tJ3SHoGQC/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/paywisegmbh/pNaPPB2tJ3SHoGQC/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/paywisegmbh/pNaPPB2tJ3SHoGQC/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/paywisegmbh/pNaPPB2tJ3SHoGQC/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/paywisegmbh/pNaPPB2tJ3SHoGQC/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update claim - paywise Knowledge Center\">\u003cmeta data-mint-head property=\"og:description\" content=\"Claims addressed by their stable UUID and current relationships. Read claims throughout their lifecycle using URLs that remain valid after internal order moves. Standalone creation requires a draft order_id; the relationship is read-only thereafter. Create, PATCH, and DELETE require a draft order and otherwise return 409 claim_not_editable. An expired draft instead returns 409 order_expired. Tenant-scoped by the authenticated company.\">\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/claims/update-claim\">\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=Claims\u0026amp;title=Update+claim\u0026amp;description=Claims+addressed+by+their+stable+UUID+and+current+relationships.%0A%0ARead+claims+throughout+their+lifecycle+using+URLs+that+remain+valid+after%0Ainternal+order+moves\u0026amp;theme=bad878af30f1dee220dabe6f\u0026amp;signature=d8a2fa585f81a54e6dff302f1e5af1087bd693b31023b7e971befeea78bf799e\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Update claim - paywise Knowledge Center\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Claims addressed by their stable UUID and current relationships. Read claims throughout their lifecycle using URLs that remain valid after internal order moves. Standalone creation requires a draft order_id; the relationship is read-only thereafter. Create, PATCH, and DELETE require a draft order and otherwise return 409 claim_not_editable. An expired draft instead returns 409 order_expired. Tenant-scoped by the authenticated company.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://paywisegmbh.mintlify.site/_mintlify/api/og/v2?division=Claims\u0026amp;title=Update+claim\u0026amp;description=Claims+addressed+by+their+stable+UUID+and+current+relationships.%0A%0ARead+claims+throughout+their+lifecycle+using+URLs+that+remain+valid+after%0Ainternal+order+moves\u0026amp;theme=bad878af30f1dee220dabe6f\u0026amp;signature=d8a2fa585f81a54e6dff302f1e5af1087bd693b31023b7e971befeea78bf799e\">\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/claims/update-claim\">\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/claims/update-claim.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/claims/update-claim#webpage\",\"url\":\"https://docs.paywise.de/api-docs/case-management-api/reference/claims/update-claim\",\"name\":\"Update claim\",\"description\":\"Claims addressed by their stable UUID and current relationships. Read claims throughout their lifecycle using URLs that remain valid after internal order moves. Standalone creation requires a draft order_id; the relationship is read-only thereafter. Create, PATCH, and DELETE require a draft order and otherwise return 409 claim_not_editable. An expired draft instead returns 409 order_expired. Tenant-scoped by the authenticated company.\",\"dateModified\":\"2026-10-16T12:47:30.512Z\",\"isPartOf\":{\"@id\":\"https://docs.paywise.de#website\"},\"breadcrumb\":{\"@id\":\"https://docs.paywise.de/api-docs/case-management-api/reference/claims/update-claim#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.paywise.de/api-docs/case-management-api/reference/claims/update-claim#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\":\"Claims\",\"item\":\"https://docs.paywise.de/api-docs/case-management-api/reference/claims/list-claims\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Update claim\",\"item\":\"https://docs.paywise.de/api-docs/case-management-api/reference/claims/update-claim\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.paywise.de/api-docs/case-management-api/reference/claims/update-claim#apireference\",\"headline\":\"Update claim\",\"name\":\"Update claim\",\"description\":\"Claims addressed by their stable UUID and current relationships. Read claims throughout their lifecycle using URLs that remain valid after internal order moves. Standalone creation requires a draft order_id; the relationship is read-only thereafter. Create, PATCH, and DELETE require a draft order and otherwise return 409 claim_not_editable. An expired draft instead returns 409 order_expired. Tenant-scoped by the authenticated company.\",\"url\":\"https://docs.paywise.de/api-docs/case-management-api/reference/claims/update-claim\",\"mainEntityOfPage\":{\"@id\":\"https://docs.paywise.de/api-docs/case-management-api/reference/claims/update-claim#webpage\"},\"dateModified\":\"2026-10-16T12:47:30.512Z\",\"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/claims/update-claim.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","description":"Claims addressed by their stable UUID and current relationships.\n\nRead claims throughout their lifecycle using URLs that remain valid after\ninternal order moves. Standalone creation requires a draft `order_id`;\nthe relationship is read-only thereafter. Create, PATCH, and DELETE require\na draft order and otherwise return `409 claim_not_editable`. An expired\ndraft instead returns `409 order_expired`. Tenant-scoped by the\nauthenticated company.","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","description":"Claims addressed by their stable UUID and current relationships.\n\nRead claims throughout their lifecycle using URLs that remain valid after\ninternal order moves. Standalone creation requires a draft `order_id`;\nthe relationship is read-only thereafter. Create, PATCH, and DELETE require\na draft order and otherwise return `409 claim_not_editable`. An expired\ndraft instead returns `409 order_expired`. Tenant-scoped by the\nauthenticated company.","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","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/mandates/","href":"/api-docs/case-management-api/reference/mandates/list-mandates"},{"title":"Get mandate","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/mandates/{id}/","href":"/api-docs/case-management-api/reference/mandates/get-mandate"},{"title":"Get mandate documents","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/mandates/{id}/documents/","href":"/api-docs/case-management-api/reference/mandates/get-mandate-documents"},{"title":"Download mandate document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/mandates/{id}/documents/{doc_id}/download/","href":"/api-docs/case-management-api/reference/mandates/download-mandate-document"},{"title":"Get mandate history","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/mandates/{id}/history/","href":"/api-docs/case-management-api/reference/mandates/get-mandate-history"},{"title":"Download mandate history attachment","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/mandates/{id}/history/{entry_id}/attachments/{file_id}/download/","href":"/api-docs/case-management-api/reference/mandates/download-mandate-history-attachment"},{"title":"List mandate correspondence","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/mandates/{mandate_id}/correspondence/","href":"/api-docs/case-management-api/reference/mandates/list-mandate-correspondence"},{"title":"Get mandate correspondence item","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/mandates/{mandate_id}/correspondence/{id}/","href":"/api-docs/case-management-api/reference/mandates/get-mandate-correspondence-item"},{"title":"Download mandate correspondence attachment","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/mandates/{mandate_id}/correspondence/{id}/attachments/{attachment_id}/download/","href":"/api-docs/case-management-api/reference/mandates/download-mandate-correspondence-attachment"},{"title":"Download mandate correspondence PDF","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/mandates/{mandate_id}/correspondence/{id}/pdf/","href":"/api-docs/case-management-api/reference/mandates/download-mandate-correspondence-pdf"},{"group":"Messages","icon":"comments","pages":[{"title":"List mandate messages","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/mandates/{mandate_id}/messages/","href":"/api-docs/case-management-api/reference/mandates/list-mandate-messages"},{"title":"Create mandate message","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/mandates/{mandate_id}/messages/","href":"/api-docs/case-management-api/reference/mandates/create-mandate-message"},{"title":"Get mandate message","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/mandates/{mandate_id}/messages/{id}/","href":"/api-docs/case-management-api/reference/mandates/get-mandate-message"},{"title":"Update mandate message","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json patch /v2/mandates/{mandate_id}/messages/{id}/","href":"/api-docs/case-management-api/reference/mandates/update-mandate-message"},{"title":"List mandate message documents","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/mandates/{mandate_id}/messages/{message_id}/documents/","href":"/api-docs/case-management-api/reference/mandates/list-mandate-message-documents"},{"title":"Create mandate message document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/mandates/{mandate_id}/messages/{message_id}/documents/","href":"/api-docs/case-management-api/reference/mandates/create-mandate-message-document"},{"title":"Get mandate message document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/mandates/{mandate_id}/messages/{message_id}/documents/{id}/","href":"/api-docs/case-management-api/reference/mandates/get-mandate-message-document"},{"title":"Delete mandate message document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json delete /v2/mandates/{mandate_id}/messages/{message_id}/documents/{id}/","href":"/api-docs/case-management-api/reference/mandates/delete-mandate-message-document"},{"title":"Download mandate message document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/mandates/{mandate_id}/messages/{message_id}/documents/{id}/download/","href":"/api-docs/case-management-api/reference/mandates/download-mandate-message-document"}]},{"group":"Requests to client","icon":"inbox","pages":[{"title":"List mandate requests to client","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/mandates/{mandate_id}/requests-to-client/","href":"/api-docs/case-management-api/reference/mandates/list-mandate-requests-to-client"},{"title":"Get mandate request to client","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/mandates/{mandate_id}/requests-to-client/{id}/","href":"/api-docs/case-management-api/reference/mandates/get-mandate-request-to-client"},{"title":"Answer mandate request to client","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/mandates/{mandate_id}/requests-to-client/{id}/answer/","href":"/api-docs/case-management-api/reference/mandates/answer-mandate-request-to-client"},{"title":"Download mandate request to client attachment","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/mandates/{mandate_id}/requests-to-client/{id}/attachments/{attachment_id}/download/","href":"/api-docs/case-management-api/reference/mandates/download-mandate-request-to-client-attachment"},{"title":"List mandate request to client answer documents","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/mandates/{mandate_id}/requests-to-client/{request_id}/answer/documents/","href":"/api-docs/case-management-api/reference/mandates/list-mandate-request-to-client-answer-documents"},{"title":"Create mandate request to client answer document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/mandates/{mandate_id}/requests-to-client/{request_id}/answer/documents/","href":"/api-docs/case-management-api/reference/mandates/create-mandate-request-to-client-answer-document"},{"title":"Get mandate request to client answer document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/mandates/{mandate_id}/requests-to-client/{request_id}/answer/documents/{id}/","href":"/api-docs/case-management-api/reference/mandates/get-mandate-request-to-client-answer-document"},{"title":"Delete mandate request to client answer document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json delete /v2/mandates/{mandate_id}/requests-to-client/{request_id}/answer/documents/{id}/","href":"/api-docs/case-management-api/reference/mandates/delete-mandate-request-to-client-answer-document"},{"title":"Download mandate request to client answer document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/mandates/{mandate_id}/requests-to-client/{request_id}/answer/documents/{id}/download/","href":"/api-docs/case-management-api/reference/mandates/download-mandate-request-to-client-answer-document"}]}]},{"group":"Payments","icon":"credit-card","pages":[{"title":"List payments","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/payments/","href":"/api-docs/case-management-api/reference/payments/list-payments"},{"title":"Get payment","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/payments/{id}/","href":"/api-docs/case-management-api/reference/payments/get-payment"},{"title":"List mandate payments","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/mandates/{mandate_id}/payments/","href":"/api-docs/case-management-api/reference/mandates/list-mandate-payments"},{"title":"Create mandate payment","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/mandates/{mandate_id}/payments/","href":"/api-docs/case-management-api/reference/mandates/create-mandate-payment"}]},{"group":"Statements","icon":"chart-pie","pages":[{"title":"List statements","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/statements/","href":"/api-docs/case-management-api/reference/statements/list-statements"},{"title":"Get statement","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/statements/{id}/","href":"/api-docs/case-management-api/reference/statements/get-statement"},{"title":"Download statement","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/statements/{id}/download/","href":"/api-docs/case-management-api/reference/statements/download-statement"},{"title":"List statement cases","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/statements/{id}/mandates/","href":"/api-docs/case-management-api/reference/statements/list-statement-cases"}]},{"group":"Single mandate statements","icon":"file-invoice","pages":[{"title":"List single mandate statements","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/single-mandate-statements/","href":"/api-docs/case-management-api/reference/single-mandate-statements/list-single-mandate-statements"},{"title":"Get single mandate statement","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/single-mandate-statements/{id}/","href":"/api-docs/case-management-api/reference/single-mandate-statements/get-single-mandate-statement"},{"title":"Download single mandate statement PDF","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/single-mandate-statements/{id}/download/","href":"/api-docs/case-management-api/reference/single-mandate-statements/download-single-mandate-statement-pdf"}]},{"group":"Webhooks","icon":"bell","pages":[{"title":"List webhooks","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/webhooks/","href":"/api-docs/case-management-api/reference/webhooks/list-webhooks"},{"title":"Create webhook","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/webhooks/","href":"/api-docs/case-management-api/reference/webhooks/create-webhook"},{"title":"Get webhook","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/webhooks/{id}/","href":"/api-docs/case-management-api/reference/webhooks/get-webhook"},{"title":"Update webhook","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json patch /v2/webhooks/{id}/","href":"/api-docs/case-management-api/reference/webhooks/update-webhook"},{"title":"Delete webhook","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json delete /v2/webhooks/{id}/","href":"/api-docs/case-management-api/reference/webhooks/delete-webhook"},{"title":"Rotate webhook secret","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/webhooks/{id}/rotate-secret/","href":"/api-docs/case-management-api/reference/webhooks/rotate-webhook-secret"},{"title":"Test webhook","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/webhooks/{id}/test/","href":"/api-docs/case-management-api/reference/webhooks/test-webhook"}]},{"group":"Webhook deliveries","icon":"paper-plane","pages":[{"title":"List webhook deliveries","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/webhook-deliveries/","href":"/api-docs/case-management-api/reference/webhook-deliveries/list-webhook-deliveries"},{"title":"Get webhook delivery","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/webhook-deliveries/{id}/","href":"/api-docs/case-management-api/reference/webhook-deliveries/get-webhook-delivery"},{"title":"Redeliver webhook delivery","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/webhook-deliveries/{id}/redeliver/","href":"/api-docs/case-management-api/reference/webhook-deliveries/redeliver-webhook-delivery"}]},{"group":"Events","icon":"list-timeline","pages":[{"title":"List events","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/events/","href":"/api-docs/case-management-api/reference/events/list-events"}]},{"group":"Reference and status","icon":"circle-info","pages":[{"title":"List legal forms","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/legal-forms/","href":"/api-docs/case-management-api/reference/legal-forms/list-legal-forms"},{"title":"Get Case credential context","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/info/","href":"/api-docs/case-management-api/reference/info/get-case-credential-context"},{"title":"Get rate-limit headroom","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/usage/","href":"/api-docs/case-management-api/reference/usage/get-rate-limit-headroom"},{"title":"Health check","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/health/","href":"/api-docs/case-management-api/reference/health/health-check"}]}]}]},{"group":"Partner API","icon":"/images/icons/partner-api.svg","pages":[{"title":"Partner API","href":"/api-docs/partner-api/introduction"},{"title":"Partner quickstart","href":"/api-docs/partner-api/quickstart"},{"group":"Concepts","pages":[{"title":"Companies and users","href":"/api-docs/partner-api/concepts/resources-and-memberships"},{"title":"Readiness and access","href":"/api-docs/partner-api/concepts/readiness-and-access"},{"title":"Calling the Case Management API","href":"/api-docs/partner-api/concepts/calling-the-case-api"},{"title":"Webhooks","href":"/api-docs/partner-api/concepts/webhook-ownership"}]},{"group":"Workflows","pages":[{"title":"API-only onboarding","href":"/api-docs/partner-api/workflows/api-only-onboarding"},{"title":"Hosted onboarding","href":"/api-docs/partner-api/workflows/hosted-onboarding"},{"title":"Manage memberships","href":"/api-docs/partner-api/workflows/manage-memberships"},{"title":"Resolve readiness","href":"/api-docs/partner-api/workflows/resolve-readiness"},{"title":"Submit cases for a company","href":"/api-docs/partner-api/workflows/submit-cases-for-a-company"},{"title":"Handle access changes","href":"/api-docs/partner-api/workflows/handle-access-changes"},{"title":"Release a company","href":"/api-docs/partner-api/workflows/release-a-company"},{"title":"Consume Partner webhooks","href":"/api-docs/partner-api/workflows/consume-webhooks"}]},{"title":"Migrate from Partner API v1","href":"/api-docs/partner-api/migrate-from-v1"},{"group":"Partner API reference","pages":[{"group":"Companies","icon":"building","pages":[{"title":"List managed companies","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json get /partner/v2/companies/","href":"/api-docs/partner-api/reference/companies/list-managed-companies"},{"title":"Onboard a company","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json post /partner/v2/companies/","href":"/api-docs/partner-api/reference/companies/onboard-a-company"},{"title":"Get a managed company","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json get /partner/v2/companies/{id}/","href":"/api-docs/partner-api/reference/companies/get-a-managed-company"},{"title":"Update a company","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json patch /partner/v2/companies/{id}/","href":"/api-docs/partner-api/reference/companies/update-a-company-patch"},{"title":"Release a company","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json post /partner/v2/companies/{id}/release/","href":"/api-docs/partner-api/reference/companies/release-a-company"}]},{"group":"Company memberships","icon":"users","pages":[{"title":"List company memberships","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json get /partner/v2/companies/{company_id}/users/","href":"/api-docs/partner-api/reference/company-users/list-company-memberships"},{"title":"Add a company membership","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json post /partner/v2/companies/{company_id}/users/","href":"/api-docs/partner-api/reference/company-users/add-a-company-membership"},{"title":"Get a company membership","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json get /partner/v2/companies/{company_id}/users/{membership_id}/","href":"/api-docs/partner-api/reference/company-users/get-a-company-membership"},{"title":"Change a pending membership role","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json patch /partner/v2/companies/{company_id}/users/{membership_id}/","href":"/api-docs/partner-api/reference/company-users/change-a-pending-membership-role"},{"title":"Cancel a pending company membership","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json post /partner/v2/companies/{company_id}/users/{membership_id}/cancel/","href":"/api-docs/partner-api/reference/company-users/cancel-a-pending-company-membership"},{"title":"Replace and resend a pending setup token","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json post /partner/v2/companies/{company_id}/users/{membership_id}/resend/","href":"/api-docs/partner-api/reference/company-users/replace-and-resend-a-pending-setup-token"},{"title":"Revoke an active company membership","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json post /partner/v2/companies/{company_id}/users/{membership_id}/revoke/","href":"/api-docs/partner-api/reference/company-users/revoke-an-active-company-membership"}]},{"group":"Webhooks","icon":"bell","pages":[{"title":"List webhooks","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json get /partner/v2/webhooks/","href":"/api-docs/partner-api/reference/webhooks/list-webhooks"},{"title":"Create webhook","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json post /partner/v2/webhooks/","href":"/api-docs/partner-api/reference/webhooks/create-webhook"},{"title":"Get webhook","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json get /partner/v2/webhooks/{id}/","href":"/api-docs/partner-api/reference/webhooks/get-webhook"},{"title":"Update webhook","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json patch /partner/v2/webhooks/{id}/","href":"/api-docs/partner-api/reference/webhooks/update-webhook"},{"title":"Delete webhook","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json delete /partner/v2/webhooks/{id}/","href":"/api-docs/partner-api/reference/webhooks/delete-webhook"},{"title":"Rotate webhook secret","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json post /partner/v2/webhooks/{id}/rotate-secret/","href":"/api-docs/partner-api/reference/webhooks/rotate-webhook-secret"},{"title":"Test webhook","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json post /partner/v2/webhooks/{id}/test/","href":"/api-docs/partner-api/reference/webhooks/test-webhook"}]},{"group":"Webhook deliveries","icon":"paper-plane","pages":[{"title":"List webhook deliveries","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json get /partner/v2/webhook-deliveries/","href":"/api-docs/partner-api/reference/webhook-deliveries/list-webhook-deliveries"},{"title":"Get webhook delivery","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json get /partner/v2/webhook-deliveries/{id}/","href":"/api-docs/partner-api/reference/webhook-deliveries/get-webhook-delivery"},{"title":"Redeliver webhook delivery","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json post /partner/v2/webhook-deliveries/{id}/redeliver/","href":"/api-docs/partner-api/reference/webhook-deliveries/redeliver-webhook-delivery"}]},{"group":"Events","icon":"list-timeline","pages":[{"title":"List events","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json get /partner/v2/events/","href":"/api-docs/partner-api/reference/events/list-events"}]},{"group":"Reference and status","icon":"circle-info","pages":[{"title":"List legal forms","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json get /partner/v2/legal-forms/","href":"/api-docs/partner-api/reference/legal-forms/list-legal-forms"},{"title":"Health check","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json get /partner/v2/health/","href":"/api-docs/partner-api/reference/meta/health-check"},{"title":"Get partner token info","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json get /partner/v2/info/","href":"/api-docs/partner-api/reference/meta/get-partner-token-info"},{"title":"Get rate-limit headroom","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json get /partner/v2/usage/","href":"/api-docs/partner-api/reference/usage/get-rate-limit-headroom"}]}]}]},{"group":"Mahnservice API","icon":"/images/icons/mahnservice-api.svg","pages":[{"title":"Mahnservice API","href":"/api-docs/mahnservice-api/introduction"},{"title":"Mahnservice quickstart","href":"/api-docs/mahnservice-api/quickstart"},{"group":"Concepts","pages":[{"title":"Invoice lifecycle","href":"/api-docs/mahnservice-api/concepts/invoice-lifecycle"},{"title":"Invoice documents","href":"/api-docs/mahnservice-api/concepts/documents"},{"title":"Ownership and access","href":"/api-docs/mahnservice-api/concepts/ownership-and-access"},{"title":"Invoice groups — implementation plan","href":"/api-docs/mahnservice-api/concepts/invoice-groups"}]},{"group":"Mahnservice API reference","pages":[{"group":"Invoices","icon":"file-invoice","pages":[{"title":"List invoices","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json get /mahnservice/v1/invoices/","href":"/api-docs/mahnservice-api/reference/invoices/list-invoices"},{"title":"Submit an invoice","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json post /mahnservice/v1/invoices/","href":"/api-docs/mahnservice-api/reference/invoices/submit-an-invoice"},{"title":"Get an invoice","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json get /mahnservice/v1/invoices/{uuid}/","href":"/api-docs/mahnservice-api/reference/invoices/get-an-invoice"},{"title":"Correct a held invoice","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json patch /mahnservice/v1/invoices/{uuid}/","href":"/api-docs/mahnservice-api/reference/invoices/correct-a-held-invoice"},{"title":"Cancel an invoice (Storno)","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json post /mahnservice/v1/invoices/{uuid}/cancel/","href":"/api-docs/mahnservice-api/reference/invoices/cancel-an-invoice-storno"},{"title":"List the invoice documents","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json get /mahnservice/v1/invoices/{uuid}/documents/","href":"/api-docs/mahnservice-api/reference/invoices/list-the-invoice-documents"},{"title":"Attach the invoice PDF","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json post /mahnservice/v1/invoices/{uuid}/documents/","href":"/api-docs/mahnservice-api/reference/invoices/attach-the-invoice-pdf"},{"title":"Get an invoice document","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json get /mahnservice/v1/invoices/{uuid}/documents/{document_uuid}/","href":"/api-docs/mahnservice-api/reference/invoices/get-an-invoice-document"},{"title":"Download the invoice document","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json get /mahnservice/v1/invoices/{uuid}/documents/{document_uuid}/download/","href":"/api-docs/mahnservice-api/reference/invoices/download-the-invoice-document"},{"title":"Get the dunning state","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json get /mahnservice/v1/invoices/{uuid}/dunning/","href":"/api-docs/mahnservice-api/reference/invoices/get-the-dunning-state"},{"title":"Pause the dunning process","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json post /mahnservice/v1/invoices/{uuid}/dunning/pause/","href":"/api-docs/mahnservice-api/reference/invoices/pause-the-dunning-process"},{"title":"Resume the dunning process","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json post /mahnservice/v1/invoices/{uuid}/dunning/resume/","href":"/api-docs/mahnservice-api/reference/invoices/resume-the-dunning-process"},{"title":"List reported payments","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json get /mahnservice/v1/invoices/{uuid}/payments/","href":"/api-docs/mahnservice-api/reference/invoices/list-reported-payments"},{"title":"Report a payment","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json post /mahnservice/v1/invoices/{uuid}/payments/","href":"/api-docs/mahnservice-api/reference/invoices/report-a-payment"},{"title":"Release a held invoice for dunning","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json post /mahnservice/v1/invoices/{uuid}/release/","href":"/api-docs/mahnservice-api/reference/invoices/release-a-held-invoice-for-dunning"},{"title":"Write off an invoice (Ausbuchung)","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json post /mahnservice/v1/invoices/{uuid}/write-off/","href":"/api-docs/mahnservice-api/reference/invoices/write-off-an-invoice-ausbuchung"}]},{"group":"Debtors","icon":"users","pages":[{"title":"List debtors","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json get /mahnservice/v1/debtors/","href":"/api-docs/mahnservice-api/reference/debtors/list-debtors"},{"title":"Create a debtor","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json post /mahnservice/v1/debtors/","href":"/api-docs/mahnservice-api/reference/debtors/create-a-debtor"},{"title":"Get a debtor","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json get /mahnservice/v1/debtors/{uuid}/","href":"/api-docs/mahnservice-api/reference/debtors/get-a-debtor"}]},{"group":"Dunning flows","icon":"list-check","pages":[{"title":"List dunning flows","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json get /mahnservice/v1/dunning-flows/","href":"/api-docs/mahnservice-api/reference/dunning-flows/list-dunning-flows"},{"title":"Get a dunning flow","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json get /mahnservice/v1/dunning-flows/{uuid}/","href":"/api-docs/mahnservice-api/reference/dunning-flows/get-a-dunning-flow"}]},{"group":"Reference and status","icon":"circle-info","pages":[{"title":"Get token info","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json get /mahnservice/v1/info/","href":"/api-docs/mahnservice-api/reference/info/get-token-info"}]}]}]},{"group":"SDKs","icon":"code","pages":[{"title":"SDKs","href":"/sdks/overview"}]},{"group":"Integrations","icon":"plug","pages":[{"title":"Introduction","href":"/integrations/introduction"},{"title":"Make","href":"/integrations/make"},{"title":"n8n","href":"/integrations/n8n-node"},{"title":"Zapier","href":"/integrations/zapier"}]},{"group":"Legacy APIs (v1)","icon":"box-archive","pages":[{"title":"Legacy API v1 snapshot","href":"/api-docs/legacy/overview"},{"group":"Frozen Case Management API","pages":[{"title":"Introduction","href":"/api-docs/legacy/case-management/introduction"},{"group":"Statements guides","pages":[{"title":"Statements Overview","href":"/api-docs/legacy/case-management/statements/overview"},{"title":"Single Mandate Statements Overview","href":"/api-docs/legacy/case-management/single-mandate-statements/overview"}]},{"group":"Status update guides","pages":[{"title":"Search status updates","href":"/api-docs/legacy/case-management/status-updates/overview"}]},{"group":"Webhook guides","pages":[{"title":"Webhooks","href":"/api-docs/legacy/case-management/webhooks/overview"},{"title":"Event Types","href":"/api-docs/legacy/case-management/webhooks/event-types"},{"title":"Manage Endpoints","href":"/api-docs/legacy/case-management/webhooks/manage-endpoints"},{"title":"Signature Verification","href":"/api-docs/legacy/case-management/webhooks/signature-verification"},{"title":"Delivery \u0026 Retries","href":"/api-docs/legacy/case-management/webhooks/delivery-and-retries"}]},{"title":"Release Notes","href":"/api-docs/legacy/case-management/releasenotes"},{"group":"Frozen Case Management API reference","pages":[{"group":"claims","pages":[{"title":"List claims","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/claims/","href":"/api-docs/legacy/case-management/reference/claims/list-claims"},{"title":"Create a claim","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json post /v1/claims/","href":"/api-docs/legacy/case-management/reference/claims/create-a-claim"},{"title":"Retrieve a claim","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/claims/{id}/","href":"/api-docs/legacy/case-management/reference/claims/retrieve-a-claim"},{"title":"Delete an unreleased claim","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json delete /v1/claims/{id}/","href":"/api-docs/legacy/case-management/reference/claims/delete-an-unreleased-claim"},{"title":"Release claim for processing","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json patch /v1/claims/{id}/","href":"/api-docs/legacy/case-management/reference/claims/release-claim-for-processing"},{"title":"Upload a document to a claim","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json post /v1/claims/{id}/documents/","href":"/api-docs/legacy/case-management/reference/claims/upload-a-document-to-a-claim"}]},{"group":"debtors","pages":[{"title":"List debtors","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/debtors/","href":"/api-docs/legacy/case-management/reference/debtors/list-debtors"},{"title":"Create a debtor","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json post /v1/debtors/","href":"/api-docs/legacy/case-management/reference/debtors/create-a-debtor"},{"title":"Retrieve a debtor","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/debtors/{id}/","href":"/api-docs/legacy/case-management/reference/debtors/retrieve-a-debtor"},{"title":"Add address to a debtor","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json post /v1/debtors/{id}/addresses/","href":"/api-docs/legacy/case-management/reference/debtors/add-address-to-a-debtor"},{"title":"Add bank account to a debtor","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json post /v1/debtors/{id}/bankaccounts/","href":"/api-docs/legacy/case-management/reference/debtors/add-bank-account-to-a-debtor"},{"title":"Add debtor Communication Channel","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json post /v1/debtors/{id}/communicationchannels/","href":"/api-docs/legacy/case-management/reference/debtors/add-debtor-communication-channel"}]},{"group":"info","pages":[{"title":"Get v1info","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/info/","href":"/api-docs/legacy/case-management/reference/info/get-v1info"}]},{"group":"mandates","pages":[{"title":"List mandates","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/mandates/","href":"/api-docs/legacy/case-management/reference/mandates/list-mandates"},{"title":"Retrieve a mandate","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/mandates/{id}/","href":"/api-docs/legacy/case-management/reference/mandates/retrieve-a-mandate"},{"title":"Archive a mandate","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json patch /v1/mandates/{id}/","href":"/api-docs/legacy/case-management/reference/mandates/archive-a-mandate"},{"title":"List status updates","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/mandates/{id}/statusupdates/","href":"/api-docs/legacy/case-management/reference/mandates/list-status-updates"},{"title":"List requests to client for a mandate","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/mandates/{mandate_id}/requests-to-client/","href":"/api-docs/legacy/case-management/reference/mandates/list-requests-to-client-for-a-mandate"},{"title":"Get request to client details","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/mandates/{mandate_id}/requests-to-client/{request_id}/","href":"/api-docs/legacy/case-management/reference/mandates/get-request-to-client-details"},{"title":"Submit request to client answer","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json post /v1/mandates/{mandate_id}/requests-to-client/{request_id}/answer/","href":"/api-docs/legacy/case-management/reference/mandates/submit-request-to-client-answer"},{"title":"Upload document to request to client answer","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json post /v1/mandates/{mandate_id}/requests-to-client/{request_id}/answer/documents/","href":"/api-docs/legacy/case-management/reference/mandates/upload-document-to-request-to-client-answer"}]},{"group":"payments","pages":[{"title":"List payments","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/payments/","href":"/api-docs/legacy/case-management/reference/payments/list-payments"},{"title":"Create a payment","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json post /v1/payments/","href":"/api-docs/legacy/case-management/reference/payments/create-a-payment"},{"title":"Retrieve a payment","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/payments/{id}/","href":"/api-docs/legacy/case-management/reference/payments/retrieve-a-payment"}]},{"group":"single-mandate-statements","pages":[{"title":"List Aktenabrechnungen","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/single-mandate-statements/","href":"/api-docs/legacy/case-management/reference/single-mandate-statements/list-aktenabrechnungen"},{"title":"Retrieve an Aktenabrechnung","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/single-mandate-statements/{id}/","href":"/api-docs/legacy/case-management/reference/single-mandate-statements/retrieve-an-aktenabrechnung"}]},{"group":"statements","pages":[{"title":"List statements","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/statements/","href":"/api-docs/legacy/case-management/reference/statements/list-statements"},{"title":"Retrieve a statement","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/statements/{id}/","href":"/api-docs/legacy/case-management/reference/statements/retrieve-a-statement"},{"title":"List mandate details for statement","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/statements/{statement_id}/mandate-details/","href":"/api-docs/legacy/case-management/reference/statements/list-mandate-details-for-statement"}]},{"group":"statusupdates","pages":[{"title":"Search status updates across mandates","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/statusupdates/","href":"/api-docs/legacy/case-management/reference/statusupdates/search-status-updates-across-mandates"}]},{"group":"webhook-deliveries","pages":[{"title":"List all webhook deliveries","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/webhook-deliveries/","href":"/api-docs/legacy/case-management/reference/webhook-deliveries/list-all-webhook-deliveries"},{"title":"Retrieve a webhook delivery","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/webhook-deliveries/{id}/","href":"/api-docs/legacy/case-management/reference/webhook-deliveries/retrieve-a-webhook-delivery"}]},{"group":"webhooks","pages":[{"title":"List webhook endpoints","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/webhooks/","href":"/api-docs/legacy/case-management/reference/webhooks/list-webhook-endpoints"},{"title":"Create a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json post /v1/webhooks/","href":"/api-docs/legacy/case-management/reference/webhooks/create-a-webhook-endpoint"},{"title":"Retrieve a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/webhooks/{id}/","href":"/api-docs/legacy/case-management/reference/webhooks/retrieve-a-webhook-endpoint"},{"title":"Put v1webhooks ","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json put /v1/webhooks/{id}/","href":"/api-docs/legacy/case-management/reference/webhooks/put-v1webhooks-"},{"title":"Delete a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json delete /v1/webhooks/{id}/","href":"/api-docs/legacy/case-management/reference/webhooks/delete-a-webhook-endpoint"},{"title":"Update a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json patch /v1/webhooks/{id}/","href":"/api-docs/legacy/case-management/reference/webhooks/update-a-webhook-endpoint"},{"title":"List deliveries for a webhook","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/webhooks/{id}/deliveries/","href":"/api-docs/legacy/case-management/reference/webhooks/list-deliveries-for-a-webhook"},{"title":"Send a test event to webhook","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json post /v1/webhooks/{id}/test/","href":"/api-docs/legacy/case-management/reference/webhooks/send-a-test-event-to-webhook"}]}]}]},{"group":"Frozen Partner API","pages":[{"title":"Introduction","href":"/api-docs/legacy/partner/introduction"},{"title":"Get Started","href":"/api-docs/legacy/partner/getstarted"},{"title":"Entities","href":"/api-docs/legacy/partner/entities"},{"title":"API-Only Onboarding","href":"/api-docs/legacy/partner/onboarding-api-only"},{"title":"Web Flow Onboarding","href":"/api-docs/legacy/partner/onboarding-web-flow"},{"title":"Release Notes","href":"/api-docs/legacy/partner/releasenotes"},{"group":"Frozen Partner API reference","pages":[{"group":"companies","pages":[{"title":"List Companies","deprecated":null,"version":null,"openapi":"/api-docs/legacy/partner/openapi.json get /partner/v1/companies/","href":"/api-docs/legacy/partner/reference/companies/list-companies"},{"title":"Create Company","deprecated":null,"version":null,"openapi":"/api-docs/legacy/partner/openapi.json post /partner/v1/companies/","href":"/api-docs/legacy/partner/reference/companies/create-company"},{"title":"Get Company","deprecated":null,"version":null,"openapi":"/api-docs/legacy/partner/openapi.json get /partner/v1/companies/{id}/","href":"/api-docs/legacy/partner/reference/companies/get-company"},{"title":"Update Company","deprecated":null,"version":null,"openapi":"/api-docs/legacy/partner/openapi.json patch /partner/v1/companies/{id}/","href":"/api-docs/legacy/partner/reference/companies/update-company"}]},{"group":"info","pages":[{"title":"Get Token Info","deprecated":null,"version":null,"openapi":"/api-docs/legacy/partner/openapi.json get /partner/v1/info/","href":"/api-docs/legacy/partner/reference/info/get-token-info"}]},{"group":"userinvites","pages":[{"title":"Create User Invite","deprecated":null,"version":null,"openapi":"/api-docs/legacy/partner/openapi.json post /partner/v1/userinvites/","href":"/api-docs/legacy/partner/reference/userinvites/create-user-invite"},{"title":"Get User Invite","deprecated":null,"version":null,"openapi":"/api-docs/legacy/partner/openapi.json get /partner/v1/userinvites/{id}/","href":"/api-docs/legacy/partner/reference/userinvites/get-user-invite"},{"title":"Get Onboarded User","deprecated":null,"version":null,"openapi":"/api-docs/legacy/partner/openapi.json get /partner/v1/userinvites/{id}/get-onboarded-user/","href":"/api-docs/legacy/partner/reference/userinvites/get-onboarded-user"}]},{"group":"users","pages":[{"title":"List Users","deprecated":null,"version":null,"openapi":"/api-docs/legacy/partner/openapi.json get /partner/v1/users/","href":"/api-docs/legacy/partner/reference/users/list-users"},{"title":"Create user","deprecated":null,"version":null,"openapi":"/api-docs/legacy/partner/openapi.json post /partner/v1/users/","href":"/api-docs/legacy/partner/reference/users/create-user"},{"title":"Get User","deprecated":null,"version":null,"openapi":"/api-docs/legacy/partner/openapi.json get /partner/v1/users/{id}/","href":"/api-docs/legacy/partner/reference/users/get-user"}]}]}]}]}]}]}]},"basePath":"","title":"Update claim - paywise Knowledge Center","deploymentId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","buildId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CrDfRf61.js","snippetPresets-Dv-cOUrx.js","utils-BUTreAgv.js","style-to-object-BY3JEAdk.js","utils-wsznt9RM.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-DEsMlaPy.js","conditional-requirements-CFM0id0Q.js","cloneDeep-DontW4xJ.js","_Uint8Array-pP7X6_RM.js","isObject-FP1Yky1u.js","ApiExamples-CU_aGGP0.js","usePlaygroundInputsStore-7dNmUIbS.js","shallow-fTtruD8x.js","isEqual-BRfNFpSD.js","CodeSnippets-52884wUJ.js","CodeSnippet-eoRjC4Le.js","getApiPlaygroundDisplay-CZyAPlR2.js","Page-Cr9IwkK7.js","DynamicMarkdown-NFqqduU7.js","SectionHeading-DQ-mJoAt.js","icon-DXTBUt6s.js","MethodPill-2v-b3js5.js","getPastedJson-v_8Y1_4v.js","DuplicateIcon-DXIkhZIo.js","createIcon-DRpYuPZs.js","axios-CsQoIw0U.js","Markdown-CwtoSfEf.js","AssistantPageLink-CTqa3eoi.js","dist-DIfYWxfm.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}