Create a draft with a referenced debtor and embedded claims,
edit it while it is a draft, finalize it for review, and follow it to
acceptance. Tenant-scoped by the authenticated company.
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.
Idempotency-Key
string
required
Required client-supplied command key scoped to the selected Case company or Partner owner, method, operation and path. An exact retry replays the original response while it is retained, including after credential rotation or replacement. Current permissions are required.
Maximum string length: 255
Body
application/json
Create an order with a referenced debtor and embedded
claims in one API call. Returns the created order in its read
representation.
debtor_id
string<uuid>
required
Existing primary debtor in the selected company.
additional_debtor_ids
string<uuid>[]
Other debtors, each supplied by an existing UUID from the active company. The primary debtor cannot also appear here, and each referenced additional debtor may appear only once. Maximum 10 entries.
Claims to create in this draft; each must specify type. Invoice and rental orders accept receivable claims. Titled orders accept titled claims and receivable enforcement costs (K014); at least one complete claim, including one titled claim for titled orders, is required before finalization. Maximum 50 entries. The 50-claim limit applies to the complete order, including claims added later through the claim endpoint; exceeding it returns 400 validation_error.
Maximum array length: 50
Create a receivable claim: the amount is stated on the claim itself.
Receivable claim input
Titled claim input
Show child attributes
confirmation_email
string<email> | null
Address that receives the order entry confirmation (Eingangsbestätigung) when the order is finalized. Omit or set null for no confirmation email.
Required string length: 1 - 255
creditor_obligation_fulfilled
boolean | null
Whether you have fully performed your obligation to the debtor. For invoice and rental orders, supply true or false before finalization; null leaves the decision unset. Omit for titled orders.
rental_agreement
object
Rental-agreement singleton supplied only for a rental order.
Show child attributes
starting_approach
enum<string> | null
Initial route for invoice and rental orders: extrajudicial starts with out-of-court collection; judicial starts by applying for a payment order (Mahnbescheid). Required before finalization; omit for titled orders, where enforcement is implicit.
Available options:
extrajudicial,
judicial
success_fee_confirmed
boolean
Only valid for titled orders. Confirmation of the titled-order success-fee arrangement; it must be true before finalization. See the paywise General Terms and Conditions (AGB) for the exact conditions for titled orders.
type
enum<string>
default:invoice
Order type discriminator: invoice, rental, or titled. Defaults to invoice when omitted.
Available options:
invoice,
rental,
titled
Response
Invoice order
Rental order
Titled order
An invoice order contains receivable claims and exposes starting_approach and creditor_obligation_fulfilled.
Read representation of an order.
status is derived from the order's submission and review progress;
mandate names the
created mandate once the order is accepted; merged_into names the
surviving order when this order was merged away during review.
additional_debtors
object[]
required
read-only
Inline summaries of the additional debtors. Retrieve each debtor's full details with GET /v2/debtors/{id}/ using its id. Replace membership through PATCH /v2/orders/{id}/ while the order is a draft. API submissions are limited to 10 additional debtors.
Receivable claims belonging to this order, including their itemized charges and documents. Titled claims are accepted only in titled orders. API submissions are limited to 50 claims per order.
A receivable claim based on an invoice, rent, or another obligation. Its principal amount, dates, charges, and documents belong to the claim.
Receivable claim
Titled claim
Show child attributes
confirmation_email
string<email> | null
required
read-only
Address receiving the order-entry confirmation, when requested.
created_at
string<date-time>
required
read-only
Time at which the order was created.
creditor_obligation_fulfilled
boolean | null
required
read-only
Whether you fully performed your obligation to the debtor.
debtor
object
required
Inline summary of the primary debtor. Retrieve full details with GET /v2/debtors/{id}/ using its id.
Show child attributes
expires_at
string<date-time> | null
required
read-only
Time at which this API-created draft expires: updated_at plus 90 days, refreshed by every successful draft change. Once it has passed, the order reads expired and every change answers 409 order_expired until the daily cleanup deletes it. Null once the order is finalized and for orders created in the portal.
id
string<uuid>
required
read-only
Stable identifier of this order.
mandate
string<uuid> | null
required
read-only
Accepted case created from this order, when available.
merged_into
string<uuid> | null
required
read-only
Surviving order when this order was merged during review.
rejection
object | null
required
Why paywise declined the order: reason, time, notified recipients, and the standard reason's key. Null unless status is rejected.
Show child attributes
starting_approach
enum<string> | null
required
Initial collection route: extrajudicial starts out of court; judicial starts by applying for a payment order (Mahnbescheid). Null while this decision is unset.
Available options:
extrajudicial,
judicial
status
enum<string>
required
Order lifecycle state: draft is editable; submitted awaits processing; awaiting_client_response requires client input; accepted has entered case processing; rejected was declined; withdrawn was cancelled by the client; expired passed its draft deadline and accepts no further changes (409 order_expired) until the daily cleanup deletes it; merged points to the surviving order in merged_into.
Available options:
draft,
submitted,
awaiting_client_response,
accepted,
rejected,
withdrawn,
expired,
merged
totals
object
required
Financial totals calculated across the order's claims.
Show child attributes
type
enum<string>
required
Literal invoice order discriminator.
Available options:
invoice
updated_at
string<date-time>
required
read-only
Time at which the order was last updated.
{"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":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"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/orders/create-order","slug":"/api-docs/case-management-api/reference/orders/create-order","pageMetadata":{"title":"Create order","description":"The collection orders of your company.\n\nCreate a draft with a referenced debtor and embedded claims,\nedit it while it is a draft, finalize it for review, and follow it to\nacceptance. Tenant-scoped by the authenticated company.","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","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 p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"The collection orders of your company.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Create a draft with a referenced debtor and embedded claims,\\nedit it while it is a draft, finalize it for review, and follow it to\\nacceptance. Tenant-scoped by the authenticated 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":"Create order","description":"The collection orders of your company.\n\nCreate a draft with a referenced debtor and embedded claims,\nedit it while it is a draft, finalize it for review, and follow it to\nacceptance. Tenant-scoped by the authenticated company.","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","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/paywisegmbh/c0e4bbe3e0c9277e/api-field-anchors.js"],"openApiReferenceData":{"operation":{"description":"The collection orders of your company.\n\nCreate a draft with a referenced debtor and embedded claims,\nedit it while it is a draft, finalize it for review, and follow it to\nacceptance. Tenant-scoped by the authenticated company.","operationId":"create-order","parameters":["7427f68f-4f07-49d6-9931-8b4f5d31fab7","e0526701-4a53-4a5d-bf59-5db8632ca498"],"requestBody":"075fd32e-24a7-47ec-aa31-7246aa922bff","responses":{"201":"a6fe8f92-2c57-42db-a9da-e76a292c5cbb","400":"f38689b7-363d-43f7-b7af-9f9655d73a01","401":"86402ae8-9e16-4d6f-bdab-c46bf3858457","403":"6eee3a80-f4d6-46ec-945d-2324309feccd","409":"e6a9bc35-7408-4833-8e5d-643faf100aed","429":"b936896b-3cf9-4be0-8c99-bac20d10ca5e","500":"283fae73-1435-4724-98c4-fd95dfa63b89"},"security":["5d748241-3de9-48f0-933b-c42fa8fbefa3","9dbe94c7-1d53-4df9-ac3d-a470f6cab86e"],"summary":"Create order","tags":["Orders"],"x-paywise-request-example-by-response-example":{"invoice":"order-create-debtor-reference","rental":"rental-order-inline","titled":"titled-order-inline"},"x-required-scopes":["case:orders:write"],"method":"post","type":"path","servers":["8c8f8cc6-b41f-4cad-9749-5ef9c02d1396","554ab33b-0043-40a7-a452-cca88c2fcfe6"],"path":"/v2/orders/","baseUrlOptions":["https://api.paywise.de","https://api-sandbox.paywise.de"],"title":"Create order","codeSamples":[],"requestExampleLanguages":["python","javascript","java","csharp","bash"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.debtor_id":"40000000-0000-4000-8000-000000000001","body.claims.items.0.oneOf.0.is_disputed":false,"body.claims.items.0.oneOf.0.principal_amount.value":"100.00","body.claims.items.0.oneOf.0.principal_amount.currency":"EUR","body.claims.items.0.oneOf.0.type":"receivable","body.claims.items.0.oneOf.0.document_date.oneOf.0":"2026-06-05","body.claims.items.0.oneOf.0.document_reference.oneOf.0":"2026-0042","body.claims.items.0.oneOf.0.due_date.oneOf.0":"2026-06-19","body.claims.items.0.oneOf.0.events.items.0.occurence":"2026-06-05T09:00:00Z","body.claims.items.0.oneOf.0.events.items.0.title":"Invoice issued","body.claims.items.0.oneOf.0.events.items.0.type":"claim","body.claims.items.0.oneOf.0.events.items.0.your_reference.oneOf.0":"2026-0042","body.claims.items.0.oneOf.0.\\items.items.0.description":"Accessibility review","body.claims.items.0.oneOf.0.\\items.items.0.quantity":"2.5","body.claims.items.0.oneOf.0.\\items.items.0.unit_price.value":"40.00","body.claims.items.0.oneOf.0.\\items.items.0.unit_price.currency":"EUR","body.claims.items.0.oneOf.0.\\items.items.0.unit.oneOf.0":"hours","body.claims.items.0.oneOf.0.legal_basis.claim_type_code":"H11","body.claims.items.0.oneOf.0.legal_basis.description.oneOf.0":"Consulting agreement of 2026-05-01","body.claims.items.0.oneOf.0.metadata.items.0.type":"comment","body.claims.items.0.oneOf.0.metadata.items.0.value":"Consulting invoice from the customer portal","body.claims.items.0.oneOf.0.reminders.items.0.date":"2026-07-01","body.claims.items.0.oneOf.0.reminders.items.0.due_date.oneOf.0":"2026-07-08","body.claims.items.0.oneOf.0.subject_matter.oneOf.0":"Website accessibility consulting in June 2026","body.claims.items.0.oneOf.0.your_reference.oneOf.0":"INV-2026-0042","body.creditor_obligation_fulfilled.oneOf.0":true,"body.starting_approach.oneOf.0":"extrajudicial"},{"body.debtor_id":"40000000-0000-4000-8000-000000000001","body.claims.items.0.oneOf.0.is_disputed":false,"body.claims.items.0.oneOf.0.principal_amount.value":"1200.00","body.claims.items.0.oneOf.0.principal_amount.currency":"EUR","body.claims.items.0.oneOf.0.type":"receivable","body.claims.items.0.oneOf.0.document_date.oneOf.0":"2026-02-01","body.claims.items.0.oneOf.0.documents.items.0.base64":"JVBERi0xLjQKMSAwIG9iago8PCAvVHlwZSAvQ2F0YWxvZyAvUGFnZXMgMiAwIFIgPj4KZW5kb2JqCjIgMCBvYmoKPDwgL1R5cGUgL1BhZ2VzIC9LaWRzIFszIDAgUl0gL0NvdW50IDEgPj4KZW5kb2JqCjMgMCBvYmoKPDwgL1R5cGUgL1BhZ2UgL1BhcmVudCAyIDAgUiAvTWVkaWFCb3ggWzAgMCAyMDAgMTAwXSA+PgplbmRvYmoKeHJlZgowIDQKMDAwMDAwMDAwMCA2NTUzNSBmIAowMDAwMDAwMDA5IDAwMDAwIG4gCjAwMDAwMDAwNTggMDAwMDAgbiAKMDAwMDAwMDExNSAwMDAwMCBuIAp0cmFpbGVyCjw8IC9TaXplIDQgL1Jvb3QgMSAwIFIgPj4Kc3RhcnR4cmVmCjE4NgolJUVPRgo=","body.claims.items.0.oneOf.0.documents.items.0.type":"claim_statement","body.claims.items.0.oneOf.0.documents.items.0.filename":"rent-February-2026.pdf","body.claims.items.0.oneOf.0.legal_basis.claim_type_code":"H19","body.claims.items.0.oneOf.0.subject_matter.oneOf.0":"Residential rent for February 2026","body.claims.items.0.oneOf.0.your_reference.oneOf.0":"RENT-2026-02","body.creditor_obligation_fulfilled.oneOf.0":true,"body.rental_agreement.contract_date.oneOf.0":"2026-01-10","body.rental_agreement.documents.items.0.base64":"JVBERi0xLjQKMSAwIG9iago8PCAvVHlwZSAvQ2F0YWxvZyAvUGFnZXMgMiAwIFIgPj4KZW5kb2JqCjIgMCBvYmoKPDwgL1R5cGUgL1BhZ2VzIC9LaWRzIFszIDAgUl0gL0NvdW50IDEgPj4KZW5kb2JqCjMgMCBvYmoKPDwgL1R5cGUgL1BhZ2UgL1BhcmVudCAyIDAgUiAvTWVkaWFCb3ggWzAgMCAyMDAgMTAwXSA+PgplbmRvYmoKeHJlZgowIDQKMDAwMDAwMDAwMCA2NTUzNSBmIAowMDAwMDAwMDA5IDAwMDAwIG4gCjAwMDAwMDAwNTggMDAwMDAgbiAKMDAwMDAwMDExNSAwMDAwMCBuIAp0cmFpbGVyCjw8IC9TaXplIDQgL1Jvb3QgMSAwIFIgPj4Kc3RhcnR4cmVmCjE4NgolJUVPRgo=","body.rental_agreement.documents.items.0.type":"rental_agreement","body.rental_agreement.documents.items.0.filename":"rental-agreement.pdf","body.rental_agreement.monthly_rent.oneOf.0.value":"1200.00","body.rental_agreement.monthly_rent.oneOf.0.currency":"EUR","body.rental_agreement.property_address.oneOf.0.city":"Berlin","body.rental_agreement.property_address.oneOf.0.country":"DE","body.rental_agreement.property_address.oneOf.0.postal_code":"10115","body.rental_agreement.property_address.oneOf.0.street":"Rental Example Street 8","body.starting_approach.oneOf.0":"extrajudicial","body.type":"rental"},{"body.debtor_id":"40000000-0000-4000-8000-000000000001","body.creditor_obligation_fulfilled.oneOf.0":true,"body.rental_agreement.contract_date.oneOf.0":"2026-01-10","body.rental_agreement.monthly_rent.oneOf.0.value":"2400.00","body.rental_agreement.monthly_rent.oneOf.0.currency":"EUR","body.rental_agreement.property_address.oneOf.0.city":"Hamburg","body.rental_agreement.property_address.oneOf.0.country":"DE","body.rental_agreement.property_address.oneOf.0.postal_code":"20095","body.rental_agreement.property_address.oneOf.0.street":"Commercial Example Avenue 3","body.starting_approach.oneOf.0":"extrajudicial","body.type":"rental"},{"body.debtor_id":"40000000-0000-4000-8000-000000000001","body.claims.items.0.oneOf.1.enforceable_title.amount.oneOf.0.value":"2500.00","body.claims.items.0.oneOf.1.enforceable_title.amount.oneOf.0.currency":"EUR","body.claims.items.0.oneOf.1.enforceable_title.documents.items.0.base64":"JVBERi0xLjQKMSAwIG9iago8PCAvVHlwZSAvQ2F0YWxvZyAvUGFnZXMgMiAwIFIgPj4KZW5kb2JqCjIgMCBvYmoKPDwgL1R5cGUgL1BhZ2VzIC9LaWRzIFszIDAgUl0gL0NvdW50IDEgPj4KZW5kb2JqCjMgMCBvYmoKPDwgL1R5cGUgL1BhZ2UgL1BhcmVudCAyIDAgUiAvTWVkaWFCb3ggWzAgMCAyMDAgMTAwXSA+PgplbmRvYmoKeHJlZgowIDQKMDAwMDAwMDAwMCA2NTUzNSBmIAowMDAwMDAwMDA5IDAwMDAwIG4gCjAwMDAwMDAwNTggMDAwMDAgbiAKMDAwMDAwMDExNSAwMDAwMCBuIAp0cmFpbGVyCjw8IC9TaXplIDQgL1Jvb3QgMSAwIFIgPj4Kc3RhcnR4cmVmCjE4NgolJUVPRgo=","body.claims.items.0.oneOf.1.enforceable_title.documents.items.0.type":"enforceable_title","body.claims.items.0.oneOf.1.enforceable_title.documents.items.0.filename":"enforcement-order.pdf","body.claims.items.0.oneOf.1.enforceable_title.file_number.oneOf.0":"12-3456789-0-1","body.claims.items.0.oneOf.1.enforceable_title.issued_on.oneOf.0":"2026-01-15","body.claims.items.0.oneOf.1.enforceable_title.issuing_authority.oneOf.0":"Amtsgericht Berlin","body.claims.items.0.oneOf.1.enforceable_title.legally_binding_since.oneOf.0":"2026-02-01","body.claims.items.0.oneOf.1.enforceable_title.served_on.oneOf.0":"2026-01-20","body.claims.items.0.oneOf.1.enforceable_title.title_type.oneOf.0":"enforcement_order","body.claims.items.0.oneOf.1.is_disputed":false,"body.claims.items.0.oneOf.1.type":"titled","body.claims.items.0.oneOf.1.subject_matter.oneOf.0":"Enforcement title","body.claims.items.0.oneOf.1.your_reference.oneOf.0":"TITLE-2026-0042","body.success_fee_confirmed":true,"body.type":"titled"},{"body.debtor_id":"40000000-0000-4000-8000-000000000001","body.success_fee_confirmed":false,"body.type":"titled"}]},"dependencies":{"parameters":{"7427f68f-4f07-49d6-9931-8b4f5d31fab7":{"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>"}},"e0526701-4a53-4a5d-bf59-5db8632ca498":{"description":"Required client-supplied command key scoped to the selected Case company or Partner owner, method, operation and path. An exact retry replays the original response while it is retained, including after credential rotation or replacement. Current permissions are required.","in":"header","name":"Idempotency-Key","required":true,"schema":{"maxLength":255,"type":"string","isRequired":true,"description":"Required client-supplied command key scoped to the selected Case company or Partner owner, method, operation and path. An exact retry replays the original response while it is retained, including after credential rotation or replacement. Current permissions are required.","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"examples":{"order-create-debtor-reference":{"title":"order-create-debtor-reference","value":{"additional_debtor_ids":[],"claims":[{"additional_charges":[],"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"}],"is_disputed":false,"items":[{"description":"Accessibility review","quantity":"2.5","unit":"hours","unit_price":{"currency":"EUR","value":"40.00"}}],"legal_basis":{"claim_type_code":"H11","description":"Consulting agreement of 2026-05-01"},"metadata":[{"type":"comment","value":"Consulting invoice from the customer portal"}],"principal_amount":{"currency":"EUR","value":"100.00"},"reminders":[{"date":"2026-07-01","due_date":"2026-07-08"}],"subject_matter":"Website accessibility consulting in June 2026","type":"receivable","your_reference":"INV-2026-0042"}],"creditor_obligation_fulfilled":true,"debtor_id":"40000000-0000-4000-8000-000000000001","starting_approach":"extrajudicial"}},"rental-order-inline":{"title":"rental-order-inline","value":{"additional_debtor_ids":[],"claims":[{"document_date":"2026-02-01","documents":[{"base64":"JVBERi0xLjQKMSAwIG9iago8PCAvVHlwZSAvQ2F0YWxvZyAvUGFnZXMgMiAwIFIgPj4KZW5kb2JqCjIgMCBvYmoKPDwgL1R5cGUgL1BhZ2VzIC9LaWRzIFszIDAgUl0gL0NvdW50IDEgPj4KZW5kb2JqCjMgMCBvYmoKPDwgL1R5cGUgL1BhZ2UgL1BhcmVudCAyIDAgUiAvTWVkaWFCb3ggWzAgMCAyMDAgMTAwXSA+PgplbmRvYmoKeHJlZgowIDQKMDAwMDAwMDAwMCA2NTUzNSBmIAowMDAwMDAwMDA5IDAwMDAwIG4gCjAwMDAwMDAwNTggMDAwMDAgbiAKMDAwMDAwMDExNSAwMDAwMCBuIAp0cmFpbGVyCjw8IC9TaXplIDQgL1Jvb3QgMSAwIFIgPj4Kc3RhcnR4cmVmCjE4NgolJUVPRgo=","filename":"rent-February-2026.pdf","type":"claim_statement"}],"is_disputed":false,"legal_basis":{"claim_type_code":"H19"},"principal_amount":{"currency":"EUR","value":"1200.00"},"subject_matter":"Residential rent for February 2026","type":"receivable","your_reference":"RENT-2026-02"}],"creditor_obligation_fulfilled":true,"debtor_id":"40000000-0000-4000-8000-000000000001","rental_agreement":{"contract_date":"2026-01-10","documents":[{"base64":"JVBERi0xLjQKMSAwIG9iago8PCAvVHlwZSAvQ2F0YWxvZyAvUGFnZXMgMiAwIFIgPj4KZW5kb2JqCjIgMCBvYmoKPDwgL1R5cGUgL1BhZ2VzIC9LaWRzIFszIDAgUl0gL0NvdW50IDEgPj4KZW5kb2JqCjMgMCBvYmoKPDwgL1R5cGUgL1BhZ2UgL1BhcmVudCAyIDAgUiAvTWVkaWFCb3ggWzAgMCAyMDAgMTAwXSA+PgplbmRvYmoKeHJlZgowIDQKMDAwMDAwMDAwMCA2NTUzNSBmIAowMDAwMDAwMDA5IDAwMDAwIG4gCjAwMDAwMDAwNTggMDAwMDAgbiAKMDAwMDAwMDExNSAwMDAwMCBuIAp0cmFpbGVyCjw8IC9TaXplIDQgL1Jvb3QgMSAwIFIgPj4Kc3RhcnR4cmVmCjE4NgolJUVPRgo=","filename":"rental-agreement.pdf","type":"rental_agreement"}],"monthly_rent":{"currency":"EUR","value":"1200.00"},"property_address":{"city":"Berlin","country":"DE","postal_code":"10115","street":"Rental Example Street 8"}},"starting_approach":"extrajudicial","type":"rental"}},"rental-order-staged":{"title":"rental-order-staged","value":{"additional_debtor_ids":[],"claims":[],"creditor_obligation_fulfilled":true,"debtor_id":"40000000-0000-4000-8000-000000000001","rental_agreement":{"contract_date":"2026-01-10","monthly_rent":{"currency":"EUR","value":"2400.00"},"property_address":{"city":"Hamburg","country":"DE","postal_code":"20095","street":"Commercial Example Avenue 3"}},"starting_approach":"extrajudicial","type":"rental"}},"titled-order-inline":{"title":"titled-order-inline","value":{"additional_debtor_ids":[],"claims":[{"enforceable_title":{"amount":{"currency":"EUR","value":"2500.00"},"documents":[{"base64":"JVBERi0xLjQKMSAwIG9iago8PCAvVHlwZSAvQ2F0YWxvZyAvUGFnZXMgMiAwIFIgPj4KZW5kb2JqCjIgMCBvYmoKPDwgL1R5cGUgL1BhZ2VzIC9LaWRzIFszIDAgUl0gL0NvdW50IDEgPj4KZW5kb2JqCjMgMCBvYmoKPDwgL1R5cGUgL1BhZ2UgL1BhcmVudCAyIDAgUiAvTWVkaWFCb3ggWzAgMCAyMDAgMTAwXSA+PgplbmRvYmoKeHJlZgowIDQKMDAwMDAwMDAwMCA2NTUzNSBmIAowMDAwMDAwMDA5IDAwMDAwIG4gCjAwMDAwMDAwNTggMDAwMDAgbiAKMDAwMDAwMDExNSAwMDAwMCBuIAp0cmFpbGVyCjw8IC9TaXplIDQgL1Jvb3QgMSAwIFIgPj4Kc3RhcnR4cmVmCjE4NgolJUVPRgo=","filename":"enforcement-order.pdf","type":"enforceable_title"}],"file_number":"12-3456789-0-1","issued_on":"2026-01-15","issuing_authority":"Amtsgericht Berlin","legally_binding_since":"2026-02-01","served_on":"2026-01-20","title_type":"enforcement_order"},"is_disputed":false,"subject_matter":"Enforcement title","type":"titled","your_reference":"TITLE-2026-0042"}],"debtor_id":"40000000-0000-4000-8000-000000000001","success_fee_confirmed":true,"type":"titled"}},"titled-order-staged":{"title":"titled-order-staged","value":{"additional_debtor_ids":[],"claims":[],"debtor_id":"40000000-0000-4000-8000-000000000001","success_fee_confirmed":false,"type":"titled"}}},"schema":{"description":"Create an order with a referenced debtor and embedded\nclaims in one API call. Returns the created order in its read\nrepresentation.","properties":{"debtor_id":{"description":"Existing primary debtor in the selected company.","format":"uuid","type":"string","isRequired":true,"uniqueKey":"debtor_id","typeLabel":"string\u003cuuid>"},"additional_debtor_ids":{"description":"Other debtors, each supplied by an existing UUID from the active company. The primary debtor cannot also appear here, and each referenced additional debtor may appear only once. Maximum 10 entries.","items":{"format":"uuid","type":"string","uniqueKey":"additional_debtor_ids.items.[INDEX]","typeLabel":"string\u003cuuid>"},"maxItems":10,"type":"array","uniqueKey":"additional_debtor_ids","typeLabel":"string\u003cuuid>[]"},"claims":{"description":"Claims to create in this draft; each must specify type. Invoice and rental orders accept receivable claims. Titled orders accept titled claims and receivable enforcement costs (K014); at least one complete claim, including one titled claim for titled orders, is required before finalization. Maximum 50 entries. The 50-claim limit applies to the complete order, including claims added later through the claim endpoint; exceeding it returns 400 validation_error.","items":{"oneOf":[{"type":"object","title":"Receivable claim input","description":"Create a receivable claim: the amount is stated on the claim itself.","required":["is_disputed","principal_amount","type"],"properties":{"is_disputed":{"description":"Whether the debtor disputes the claim.","type":"boolean","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.is_disputed","typeLabel":"boolean"},"principal_amount":{"type":"object","description":"Original principal amount including VAT, before charges and payments. Required even when items are supplied; line items do not calculate this value for you. 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":"claims.items.[INDEX].oneOf.0.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":"claims.items.[INDEX].oneOf.0.principal_amount.currency","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.principal_amount","typeLabel":"object"},"type":{"type":"string","description":"Literal receivable claim discriminator.","enum":["receivable"],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"additional_charges":{"description":"Itemized incidental claims such as reminder or bank fees. 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":"claims.items.[INDEX].oneOf.0.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":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].amount.currency","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.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":"claims.items.[INDEX].oneOf.0.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":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].occurence","typeLabel":"string\u003cdate-time>"},"title":{"description":"Human-readable title of the event.","maxLength":255,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.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":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"description":{"oneOf":[{"description":"Optional description of the event.","maxLength":255,"type":"string","uniqueKey":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"description":"Optional description of the event.","maxLength":255,"type":"null","uniqueKey":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].description","typeLabel":"string | null"},"location":{"oneOf":[{"description":"Optional location associated with the event.","maxLength":255,"type":"string","uniqueKey":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].location.oneOf.0","typeLabel":"string"},{"description":"Optional location associated with the event.","maxLength":255,"type":"null","uniqueKey":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].location.oneOf.1","typeLabel":"null"}],"uniqueKey":"claims.items.[INDEX].oneOf.0.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":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].your_reference.oneOf.0","typeLabel":"string"},{"description":"Your optional reference for the event.","maxLength":255,"type":"null","uniqueKey":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"uniqueKey":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].your_reference","typeLabel":"string | null"}},"required":["occurence","title","type"],"type":"object","uniqueKey":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"claims.items.[INDEX].oneOf.0.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":"claims.items.[INDEX].oneOf.0.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":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].metadata.items.[INDEX].value","typeLabel":"string"}},"required":["type","value"],"type":"object","uniqueKey":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].metadata.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"claims.items.[INDEX].oneOf.0.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":"claims.items.[INDEX].oneOf.0.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":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].occurrence_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].occurrence_date","typeLabel":"string\u003cdate> | null"},"subject_matter":{"oneOf":[{"description":"Reason or subject of the additional charge. Maximum 2000 characters.","maxLength":2000,"type":"string","uniqueKey":"claims.items.[INDEX].oneOf.0.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":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].subject_matter.oneOf.1","typeLabel":"null"}],"uniqueKey":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].subject_matter","typeLabel":"string | null"},"your_reference":{"oneOf":[{"description":"Your reference for this additional charge.","maxLength":255,"type":"string","uniqueKey":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].your_reference.oneOf.0","typeLabel":"string"},{"description":"Your reference for this additional charge.","maxLength":255,"type":"null","uniqueKey":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"uniqueKey":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].your_reference","typeLabel":"string | null"}},"required":["amount","type"],"type":"object","uniqueKey":"claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX]","typeLabel":"object"},"maxItems":50,"type":"array","uniqueKey":"claims.items.[INDEX].oneOf.0.additional_charges","typeLabel":"object[]"},"delay_date":{"oneOf":[{"description":"Date from which the debtor is considered in payment default. For H17/H19 rent, omission on creation derives the day after due_date, an explicit date overrides it, and null restores derivation. For other receivables, omission allows automatic calculation from available dates; null explicitly clears the date. An explicit date must follow the applicable due or reminder date.","format":"date","type":"string","uniqueKey":"claims.items.[INDEX].oneOf.0.delay_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Date from which the debtor is considered in payment default. For H17/H19 rent, omission on creation derives the day after due_date, an explicit date overrides it, and null restores derivation. For other receivables, omission allows automatic calculation from available dates; null explicitly clears the date. An explicit date must follow the applicable due or reminder date.","format":"date","type":"null","uniqueKey":"claims.items.[INDEX].oneOf.0.delay_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"claims.items.[INDEX].oneOf.0.delay_date","typeLabel":"string\u003cdate> | null"},"dispute_reason":{"oneOf":[{"description":"Debtor's stated reason for disputing the claim. Required and non-blank when is_disputed is true; must be empty or null when it is false.","maxLength":2500,"type":"string","uniqueKey":"claims.items.[INDEX].oneOf.0.dispute_reason.oneOf.0","typeLabel":"string"},{"description":"Debtor's stated reason for disputing the claim. Required and non-blank when is_disputed is true; must be empty or null when it is false.","maxLength":2500,"type":"null","uniqueKey":"claims.items.[INDEX].oneOf.0.dispute_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"claims.items.[INDEX].oneOf.0.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. Required and cannot be in the future at finalization.","format":"date","type":"string","uniqueKey":"claims.items.[INDEX].oneOf.0.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. Required and cannot be in the future at finalization.","format":"date","type":"null","uniqueKey":"claims.items.[INDEX].oneOf.0.document_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"claims.items.[INDEX].oneOf.0.document_date","typeLabel":"string\u003cdate> | null"},"document_reference":{"oneOf":[{"description":"Invoice, contract, or other source-document number.","maxLength":255,"type":"string","uniqueKey":"claims.items.[INDEX].oneOf.0.document_reference.oneOf.0","typeLabel":"string"},{"description":"Invoice, contract, or other source-document number.","maxLength":255,"type":"null","uniqueKey":"claims.items.[INDEX].oneOf.0.document_reference.oneOf.1","typeLabel":"null"}],"uniqueKey":"claims.items.[INDEX].oneOf.0.document_reference","typeLabel":"string | null"},"documents":{"description":"Documents attached to this receivable claim. A command may contain at most 20 documents in total across all nested claims, titles, and rental agreements. The combined decoded document content across the command must not exceed 50 MiB; each file is limited to 10 MiB and each PDF to 100 pages. Exceeding a limit rejects the command with 400.","items":{"additionalProperties":false,"description":"Document embedded inline in a claim, message, or answer payload.","properties":{"base64":{"description":"Required base64-encoded PDF, JPEG, or PNG content. Maximum decoded file size: 10 MiB (10,485,760 bytes); maximum PDF length: 100 pages. Across the entire command, at most 20 documents and 50 MiB of decoded content are allowed, including documents nested under other parents. Exceeding a limit returns 400; too many PDF pages uses page_limit_exceeded.","maxLength":15029589,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.documents.items.[INDEX].base64","typeLabel":"string"},"type":{"type":"string","description":"Business purpose of the document.\n\n* `bank_statement` - bank_statement\n* `claim_statement` - claim_statement\n* `correspondence` - correspondence\n* `invoice` - invoice\n* `other` - other\n* `payment_proof` - payment_proof\n* `reminder` - reminder","enum":["bank_statement","claim_statement","correspondence","invoice","other","payment_proof","reminder"],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.documents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"filename":{"description":"Original filename shown to users. Path components and control characters are removed and the extension always follows the detected content type.","maxLength":255,"minLength":1,"type":"string","uniqueKey":"claims.items.[INDEX].oneOf.0.documents.items.[INDEX].filename","typeLabel":"string"}},"required":["base64","type"],"type":"object","uniqueKey":"claims.items.[INDEX].oneOf.0.documents.items.[INDEX]","typeLabel":"object"},"maxItems":20,"type":"array","uniqueKey":"claims.items.[INDEX].oneOf.0.documents","typeLabel":"object[]"},"due_date":{"oneOf":[{"description":"Date on which the principal became due. For H17/H19 rent, omission on creation derives it from the agreement; an explicit date overrides that rule and null restores derivation. For other receivables it cannot precede document_date.","format":"date","type":"string","uniqueKey":"claims.items.[INDEX].oneOf.0.due_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Date on which the principal became due. For H17/H19 rent, omission on creation derives it from the agreement; an explicit date overrides that rule and null restores derivation. For other receivables it cannot precede document_date.","format":"date","type":"null","uniqueKey":"claims.items.[INDEX].oneOf.0.due_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"claims.items.[INDEX].oneOf.0.due_date","typeLabel":"string\u003cdate> | null"},"events":{"description":"Contextual events supplied when creating the claim.","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":"claims.items.[INDEX].oneOf.0.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":"claims.items.[INDEX].oneOf.0.events.items.[INDEX].title","typeLabel":"string"},"type":{"type":"string","description":"Claim event type.\n\n* `claim` - claim\n* `delivery` - delivery","enum":["claim","delivery"],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.events.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"description":{"oneOf":[{"description":"Optional description of the event.","maxLength":255,"type":"string","uniqueKey":"claims.items.[INDEX].oneOf.0.events.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"description":"Optional description of the event.","maxLength":255,"type":"null","uniqueKey":"claims.items.[INDEX].oneOf.0.events.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"claims.items.[INDEX].oneOf.0.events.items.[INDEX].description","typeLabel":"string | null"},"location":{"oneOf":[{"description":"Optional location associated with the event.","maxLength":255,"type":"string","uniqueKey":"claims.items.[INDEX].oneOf.0.events.items.[INDEX].location.oneOf.0","typeLabel":"string"},{"description":"Optional location associated with the event.","maxLength":255,"type":"null","uniqueKey":"claims.items.[INDEX].oneOf.0.events.items.[INDEX].location.oneOf.1","typeLabel":"null"}],"uniqueKey":"claims.items.[INDEX].oneOf.0.events.items.[INDEX].location","typeLabel":"string | null"},"your_reference":{"oneOf":[{"description":"Your optional reference for the event.","maxLength":255,"type":"string","uniqueKey":"claims.items.[INDEX].oneOf.0.events.items.[INDEX].your_reference.oneOf.0","typeLabel":"string"},{"description":"Your optional reference for the event.","maxLength":255,"type":"null","uniqueKey":"claims.items.[INDEX].oneOf.0.events.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"uniqueKey":"claims.items.[INDEX].oneOf.0.events.items.[INDEX].your_reference","typeLabel":"string | null"}},"required":["occurence","title","type"],"type":"object","uniqueKey":"claims.items.[INDEX].oneOf.0.events.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"claims.items.[INDEX].oneOf.0.events","typeLabel":"object[]"},"items":{"description":"Optional invoice or contract lines supporting the principal claim. Supply principal_amount separately; these lines do not calculate it. 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":"claims.items.[INDEX].oneOf.0.\\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":"claims.items.[INDEX].oneOf.0.\\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":"claims.items.[INDEX].oneOf.0.\\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":"claims.items.[INDEX].oneOf.0.\\items.items.[INDEX].unit_price.currency","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.\\items.items.[INDEX].unit_price","typeLabel":"object"},"unit":{"oneOf":[{"description":"Unit of measure for the quantity, when applicable.","maxLength":255,"type":"string","uniqueKey":"claims.items.[INDEX].oneOf.0.\\items.items.[INDEX].unit.oneOf.0","typeLabel":"string"},{"description":"Unit of measure for the quantity, when applicable.","maxLength":255,"type":"null","uniqueKey":"claims.items.[INDEX].oneOf.0.\\items.items.[INDEX].unit.oneOf.1","typeLabel":"null"}],"uniqueKey":"claims.items.[INDEX].oneOf.0.\\items.items.[INDEX].unit","typeLabel":"string | null"}},"required":["description","quantity","unit_price"],"type":"object","uniqueKey":"claims.items.[INDEX].oneOf.0.\\items.items.[INDEX]","typeLabel":"object"},"maxItems":100,"type":"array","uniqueKey":"claims.items.[INDEX].oneOf.0.\\items","typeLabel":"object[]"},"legal_basis":{"type":"object","description":"Legal basis for a receivable claim; titled enforcement costs derive K014 and therefore omit this field.","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":"claims.items.[INDEX].oneOf.0.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":"claims.items.[INDEX].oneOf.0.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":"claims.items.[INDEX].oneOf.0.legal_basis.contract_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"claims.items.[INDEX].oneOf.0.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":"claims.items.[INDEX].oneOf.0.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":"claims.items.[INDEX].oneOf.0.legal_basis.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"claims.items.[INDEX].oneOf.0.legal_basis.description","typeLabel":"string | null"}},"uniqueKey":"claims.items.[INDEX].oneOf.0.legal_basis","typeLabel":"object"},"metadata":{"description":"Metadata supplied when creating the claim; 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":"claims.items.[INDEX].oneOf.0.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":"claims.items.[INDEX].oneOf.0.metadata.items.[INDEX].value","typeLabel":"string"}},"required":["type","value"],"type":"object","uniqueKey":"claims.items.[INDEX].oneOf.0.metadata.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"claims.items.[INDEX].oneOf.0.metadata","typeLabel":"object[]"},"payments":{"description":"Payments already received for this claim. Maximum 50 entries per claim during creation; report later payments through the payment endpoints.","example":[{"amount":{"currency":"EUR","value":"50.00"},"value_date":"2026-07-17","your_reference":"BANK-TRANSACTION-99812"}],"items":{"description":"Payment input; the target is supplied exclusively by the URL.","properties":{"amount":{"type":"object","description":"Amount received.","required":["value"],"properties":{"value":{"description":"Amount received in major currency units, with at most two decimal places; must be 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":"claims.items.[INDEX].oneOf.0.payments.items.[INDEX].amount.value","typeLabel":"string"},"currency":{"type":"string","description":"Currency of the payment; currently always EUR.\n\n* `EUR` - EUR","default":"EUR","enum":["EUR"],"uniqueKey":"claims.items.[INDEX].oneOf.0.payments.items.[INDEX].amount.currency","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.payments.items.[INDEX].amount","typeLabel":"object"},"value_date":{"description":"Date on which the payment was credited; must not be in the future.","format":"date","type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.payments.items.[INDEX].value_date","typeLabel":"string\u003cdate>"},"metadata":{"description":"Metadata supplied when reporting the payment; duplicate types are allowed.","items":{"description":"One creation-time metadata row; duplicate types are intentional.","properties":{"type":{"type":"string","description":"Payment metadata type.\n\n* `comment` - comment\n* `invoice:reference` - invoice:reference\n* `invoice:update_and_capture` - invoice:update_and_capture\n* `transaction:reference` - transaction:reference\n* `contract:reference` - contract:reference\n* `report:reference` - report:reference\n* `contravention:reference` - contravention:reference","enum":["comment","invoice:reference","invoice:update_and_capture","transaction:reference","contract:reference","report:reference","contravention:reference"],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.0.payments.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":"claims.items.[INDEX].oneOf.0.payments.items.[INDEX].metadata.items.[INDEX].value","typeLabel":"string"}},"required":["type","value"],"type":"object","uniqueKey":"claims.items.[INDEX].oneOf.0.payments.items.[INDEX].metadata.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"claims.items.[INDEX].oneOf.0.payments.items.[INDEX].metadata","typeLabel":"object[]"},"your_reference":{"oneOf":[{"description":"Your reference for reconciling this payment.","maxLength":255,"type":"string","uniqueKey":"claims.items.[INDEX].oneOf.0.payments.items.[INDEX].your_reference.oneOf.0","typeLabel":"string"},{"description":"Your reference for reconciling this payment.","maxLength":255,"type":"null","uniqueKey":"claims.items.[INDEX].oneOf.0.payments.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"uniqueKey":"claims.items.[INDEX].oneOf.0.payments.items.[INDEX].your_reference","typeLabel":"string | null"}},"required":["amount","value_date"],"type":"object","uniqueKey":"claims.items.[INDEX].oneOf.0.payments.items.[INDEX]","typeLabel":"object"},"maxItems":50,"type":"array","uniqueKey":"claims.items.[INDEX].oneOf.0.payments","typeLabel":"object[]"},"reminders":{"description":"Payment reminders in chronological order. The first reminder cannot precede the claim due date, or document date when no due date is set; later reminders cannot precede an earlier reminder or its payment deadline. 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":"claims.items.[INDEX].oneOf.0.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":"claims.items.[INDEX].oneOf.0.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":"claims.items.[INDEX].oneOf.0.reminders.items.[INDEX].due_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"claims.items.[INDEX].oneOf.0.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":"claims.items.[INDEX].oneOf.0.reminders.items.[INDEX].id","typeLabel":"string\u003cuuid>"}},"required":["date"],"type":"object","uniqueKey":"claims.items.[INDEX].oneOf.0.reminders.items.[INDEX]","typeLabel":"object"},"maxItems":50,"type":"array","uniqueKey":"claims.items.[INDEX].oneOf.0.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":"claims.items.[INDEX].oneOf.0.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":"claims.items.[INDEX].oneOf.0.subject_matter.oneOf.1","typeLabel":"null"}],"uniqueKey":"claims.items.[INDEX].oneOf.0.subject_matter","typeLabel":"string | null"},"your_reference":{"oneOf":[{"description":"Your reference for this claim.","maxLength":255,"type":"string","uniqueKey":"claims.items.[INDEX].oneOf.0.your_reference.oneOf.0","typeLabel":"string"},{"description":"Your reference for this claim.","maxLength":255,"type":"null","uniqueKey":"claims.items.[INDEX].oneOf.0.your_reference.oneOf.1","typeLabel":"null"}],"uniqueKey":"claims.items.[INDEX].oneOf.0.your_reference","typeLabel":"string | null"}},"uniqueKey":"claims.items.[INDEX].oneOf.0","typeLabel":"Receivable claim input · object"},{"type":"object","title":"Titled claim input","description":"Create a titled claim: the enforceable title owns amount and dates.","required":["enforceable_title","is_disputed","type"],"properties":{"enforceable_title":{"type":"object","description":"Claim-owned enforceable title; required for a titled claim, which only a titled order accepts.","properties":{"amount":{"oneOf":[{"type":"object","description":"Gross amount confirmed by the client and owned by the enforceable title. May be absent or null while drafting; must be positive before finalization.","required":["value"],"properties":{"value":{"description":"Gross title amount in major currency units, with at most two decimal places. Zero is accepted while drafting; the amount must be positive before finalization. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.amount.oneOf.0.value","typeLabel":"string"},"currency":{"type":"string","description":"Currency of the title amount; only EUR is supported.","default":"EUR","enum":["EUR"],"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.amount.oneOf.0.currency","typeLabel":"enum\u003cstring>"}},"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.amount.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.amount","typeLabel":"object | null"},"documents":{"description":"Documents attached to the enforceable title during inline creation. A command may contain at most 20 documents in total across all nested claims, titles, and rental agreements. The combined decoded document content across the command must not exceed 50 MiB; each file is limited to 10 MiB and each PDF to 100 pages. Exceeding a limit rejects the command with 400.","items":{"additionalProperties":false,"description":"Document embedded inline in a claim, message, or answer payload.","properties":{"base64":{"description":"Required base64-encoded PDF, JPEG, or PNG content. Maximum decoded file size: 10 MiB (10,485,760 bytes); maximum PDF length: 100 pages. Across the entire command, at most 20 documents and 50 MiB of decoded content are allowed, including documents nested under other parents. Exceeding a limit returns 400; too many PDF pages uses page_limit_exceeded.","maxLength":15029589,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.documents.items.[INDEX].base64","typeLabel":"string"},"type":{"type":"string","description":"Title document purpose: enforceable_title is the single primary title document, required before finalization; other supplies a supporting document and may be used multiple times.","enum":["enforceable_title","other"],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.documents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"filename":{"description":"Original filename shown to users. Path components and control characters are removed and the extension always follows the detected content type.","maxLength":255,"minLength":1,"type":"string","uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.documents.items.[INDEX].filename","typeLabel":"string"}},"required":["base64","type"],"type":"object","uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.documents.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.documents","typeLabel":"object[]"},"file_number":{"oneOf":[{"description":"Official file or reference number shown on the title. Required before finalization.","maxLength":255,"type":"string","uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.file_number.oneOf.0","typeLabel":"string"},{"description":"Official file or reference number shown on the title. Required before finalization.","maxLength":255,"type":"null","uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.file_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.file_number","typeLabel":"string | null"},"issued_on":{"oneOf":[{"description":"Date on which the enforceable title was issued. Required before finalization.","format":"date","type":"string","uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.issued_on.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Date on which the enforceable title was issued. Required before finalization.","format":"date","type":"null","uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.issued_on.oneOf.1","typeLabel":"null"}],"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.issued_on","typeLabel":"string\u003cdate> | null"},"issuing_authority":{"oneOf":[{"description":"Court, notary, or other authority that issued the title. Required before finalization.","maxLength":255,"type":"string","uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.issuing_authority.oneOf.0","typeLabel":"string"},{"description":"Court, notary, or other authority that issued the title. Required before finalization.","maxLength":255,"type":"null","uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.issuing_authority.oneOf.1","typeLabel":"null"}],"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.issuing_authority","typeLabel":"string | null"},"legally_binding_since":{"oneOf":[{"description":"Optional date from which the title is legally binding; it cannot precede issued_on.","format":"date","type":"string","uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.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","type":"null","uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.legally_binding_since.oneOf.1","typeLabel":"null"}],"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.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","type":"string","uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.served_on.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Optional date on which the title was served; it cannot precede issued_on.","format":"date","type":"null","uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.served_on.oneOf.1","typeLabel":"null"}],"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.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. Required before finalization.","enum":["enforcement_order","default_judgment","final_judgment","acknowledgment_judgment","reservation_judgment","court_settlement","enforceable_notarial_deed","cost_assessment_order","other"],"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.title_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.title_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title.title_type","typeLabel":"enum\u003cstring> | null"}},"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.enforceable_title","typeLabel":"object"},"is_disputed":{"description":"Whether the debtor disputes the claim.","type":"boolean","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.is_disputed","typeLabel":"boolean"},"type":{"type":"string","description":"Literal titled claim discriminator.","enum":["titled"],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"dispute_reason":{"oneOf":[{"description":"Debtor's stated reason for disputing the claim. Required and non-blank when is_disputed is true; must be empty or null when it is false.","maxLength":2500,"type":"string","uniqueKey":"claims.items.[INDEX].oneOf.1.dispute_reason.oneOf.0","typeLabel":"string"},{"description":"Debtor's stated reason for disputing the claim. Required and non-blank when is_disputed is true; must be empty or null when it is false.","maxLength":2500,"type":"null","uniqueKey":"claims.items.[INDEX].oneOf.1.dispute_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"claims.items.[INDEX].oneOf.1.dispute_reason","typeLabel":"string | null"},"document_reference":{"oneOf":[{"description":"Invoice, contract, or other source-document number.","maxLength":255,"type":"string","uniqueKey":"claims.items.[INDEX].oneOf.1.document_reference.oneOf.0","typeLabel":"string"},{"description":"Invoice, contract, or other source-document number.","maxLength":255,"type":"null","uniqueKey":"claims.items.[INDEX].oneOf.1.document_reference.oneOf.1","typeLabel":"null"}],"uniqueKey":"claims.items.[INDEX].oneOf.1.document_reference","typeLabel":"string | null"},"events":{"description":"Contextual events supplied when creating the claim.","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":"claims.items.[INDEX].oneOf.1.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":"claims.items.[INDEX].oneOf.1.events.items.[INDEX].title","typeLabel":"string"},"type":{"type":"string","description":"Claim event type.\n\n* `claim` - claim\n* `delivery` - delivery","enum":["claim","delivery"],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.events.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"description":{"oneOf":[{"description":"Optional description of the event.","maxLength":255,"type":"string","uniqueKey":"claims.items.[INDEX].oneOf.1.events.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"description":"Optional description of the event.","maxLength":255,"type":"null","uniqueKey":"claims.items.[INDEX].oneOf.1.events.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"claims.items.[INDEX].oneOf.1.events.items.[INDEX].description","typeLabel":"string | null"},"location":{"oneOf":[{"description":"Optional location associated with the event.","maxLength":255,"type":"string","uniqueKey":"claims.items.[INDEX].oneOf.1.events.items.[INDEX].location.oneOf.0","typeLabel":"string"},{"description":"Optional location associated with the event.","maxLength":255,"type":"null","uniqueKey":"claims.items.[INDEX].oneOf.1.events.items.[INDEX].location.oneOf.1","typeLabel":"null"}],"uniqueKey":"claims.items.[INDEX].oneOf.1.events.items.[INDEX].location","typeLabel":"string | null"},"your_reference":{"oneOf":[{"description":"Your optional reference for the event.","maxLength":255,"type":"string","uniqueKey":"claims.items.[INDEX].oneOf.1.events.items.[INDEX].your_reference.oneOf.0","typeLabel":"string"},{"description":"Your optional reference for the event.","maxLength":255,"type":"null","uniqueKey":"claims.items.[INDEX].oneOf.1.events.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"uniqueKey":"claims.items.[INDEX].oneOf.1.events.items.[INDEX].your_reference","typeLabel":"string | null"}},"required":["occurence","title","type"],"type":"object","uniqueKey":"claims.items.[INDEX].oneOf.1.events.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"claims.items.[INDEX].oneOf.1.events","typeLabel":"object[]"},"metadata":{"description":"Metadata supplied when creating the claim; 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":"claims.items.[INDEX].oneOf.1.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":"claims.items.[INDEX].oneOf.1.metadata.items.[INDEX].value","typeLabel":"string"}},"required":["type","value"],"type":"object","uniqueKey":"claims.items.[INDEX].oneOf.1.metadata.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"claims.items.[INDEX].oneOf.1.metadata","typeLabel":"object[]"},"payments":{"description":"Payments already received for this claim. Maximum 50 entries per claim during creation; report later payments through the payment endpoints.","example":[{"amount":{"currency":"EUR","value":"50.00"},"value_date":"2026-07-17","your_reference":"BANK-TRANSACTION-99812"}],"items":{"description":"Payment input; the target is supplied exclusively by the URL.","properties":{"amount":{"type":"object","description":"Amount received.","required":["value"],"properties":{"value":{"description":"Amount received in major currency units, with at most two decimal places; must be 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":"claims.items.[INDEX].oneOf.1.payments.items.[INDEX].amount.value","typeLabel":"string"},"currency":{"type":"string","description":"Currency of the payment; currently always EUR.\n\n* `EUR` - EUR","default":"EUR","enum":["EUR"],"uniqueKey":"claims.items.[INDEX].oneOf.1.payments.items.[INDEX].amount.currency","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.payments.items.[INDEX].amount","typeLabel":"object"},"value_date":{"description":"Date on which the payment was credited; must not be in the future.","format":"date","type":"string","isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.payments.items.[INDEX].value_date","typeLabel":"string\u003cdate>"},"metadata":{"description":"Metadata supplied when reporting the payment; duplicate types are allowed.","items":{"description":"One creation-time metadata row; duplicate types are intentional.","properties":{"type":{"type":"string","description":"Payment metadata type.\n\n* `comment` - comment\n* `invoice:reference` - invoice:reference\n* `invoice:update_and_capture` - invoice:update_and_capture\n* `transaction:reference` - transaction:reference\n* `contract:reference` - contract:reference\n* `report:reference` - report:reference\n* `contravention:reference` - contravention:reference","enum":["comment","invoice:reference","invoice:update_and_capture","transaction:reference","contract:reference","report:reference","contravention:reference"],"isRequired":true,"uniqueKey":"claims.items.[INDEX].oneOf.1.payments.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":"claims.items.[INDEX].oneOf.1.payments.items.[INDEX].metadata.items.[INDEX].value","typeLabel":"string"}},"required":["type","value"],"type":"object","uniqueKey":"claims.items.[INDEX].oneOf.1.payments.items.[INDEX].metadata.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"claims.items.[INDEX].oneOf.1.payments.items.[INDEX].metadata","typeLabel":"object[]"},"your_reference":{"oneOf":[{"description":"Your reference for reconciling this payment.","maxLength":255,"type":"string","uniqueKey":"claims.items.[INDEX].oneOf.1.payments.items.[INDEX].your_reference.oneOf.0","typeLabel":"string"},{"description":"Your reference for reconciling this payment.","maxLength":255,"type":"null","uniqueKey":"claims.items.[INDEX].oneOf.1.payments.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"uniqueKey":"claims.items.[INDEX].oneOf.1.payments.items.[INDEX].your_reference","typeLabel":"string | null"}},"required":["amount","value_date"],"type":"object","uniqueKey":"claims.items.[INDEX].oneOf.1.payments.items.[INDEX]","typeLabel":"object"},"maxItems":50,"type":"array","uniqueKey":"claims.items.[INDEX].oneOf.1.payments","typeLabel":"object[]"},"subject_matter":{"oneOf":[{"description":"Goods, services, or other obligation underlying the claim. Maximum 2000 characters.","maxLength":2000,"type":"string","uniqueKey":"claims.items.[INDEX].oneOf.1.subject_matter.oneOf.0","typeLabel":"string"},{"description":"Goods, services, or other obligation underlying the claim. Maximum 2000 characters.","maxLength":2000,"type":"null","uniqueKey":"claims.items.[INDEX].oneOf.1.subject_matter.oneOf.1","typeLabel":"null"}],"uniqueKey":"claims.items.[INDEX].oneOf.1.subject_matter","typeLabel":"string | null"},"your_reference":{"oneOf":[{"description":"Your reference for this claim.","maxLength":255,"type":"string","uniqueKey":"claims.items.[INDEX].oneOf.1.your_reference.oneOf.0","typeLabel":"string"},{"description":"Your reference for this claim.","maxLength":255,"type":"null","uniqueKey":"claims.items.[INDEX].oneOf.1.your_reference.oneOf.1","typeLabel":"null"}],"uniqueKey":"claims.items.[INDEX].oneOf.1.your_reference","typeLabel":"string | null"}},"uniqueKey":"claims.items.[INDEX].oneOf.1","typeLabel":"Titled claim input · object"}],"uniqueKey":"claims.items.[INDEX]","typeLabel":"Receivable claim input · object | Titled claim input · object"},"maxItems":50,"type":"array","uniqueKey":"claims","typeLabel":"(Receivable claim input · object | Titled claim input · object)[]"},"confirmation_email":{"oneOf":[{"description":"Address that receives the order entry confirmation (Eingangsbestätigung) when the order is finalized. Omit or set null for no confirmation email.","format":"email","maxLength":255,"minLength":1,"type":"string","uniqueKey":"confirmation_email.oneOf.0","typeLabel":"string\u003cemail>"},{"description":"Address that receives the order entry confirmation (Eingangsbestätigung) when the order is finalized. Omit or set null for no confirmation email.","format":"email","maxLength":255,"minLength":1,"type":"null","uniqueKey":"confirmation_email.oneOf.1","typeLabel":"null"}],"uniqueKey":"confirmation_email","typeLabel":"string\u003cemail> | null"},"creditor_obligation_fulfilled":{"oneOf":[{"description":"Whether you have fully performed your obligation to the debtor. For invoice and rental orders, supply true or false before finalization; null leaves the decision unset. Omit for titled orders.","type":"boolean","uniqueKey":"creditor_obligation_fulfilled.oneOf.0","typeLabel":"boolean"},{"description":"Whether you have fully performed your obligation to the debtor. For invoice and rental orders, supply true or false before finalization; null leaves the decision unset. Omit for titled orders.","type":"null","uniqueKey":"creditor_obligation_fulfilled.oneOf.1","typeLabel":"null"}],"uniqueKey":"creditor_obligation_fulfilled","typeLabel":"boolean | null"},"rental_agreement":{"description":"Rental-agreement singleton supplied only for a rental order.","properties":{"contract_date":{"oneOf":[{"description":"Date on which the rental contract was concluded; this is not the tenancy start or move-in date. Required before finalization.","format":"date","type":"string","uniqueKey":"rental_agreement.contract_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Date on which the rental contract was concluded; this is not the tenancy start or move-in date. Required before finalization.","format":"date","type":"null","uniqueKey":"rental_agreement.contract_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"rental_agreement.contract_date","typeLabel":"string\u003cdate> | null"},"documents":{"description":"Documents attached to the rental agreement during inline creation. A command may contain at most 20 documents in total across all nested claims, titles, and rental agreements. The combined decoded document content across the command must not exceed 50 MiB; each file is limited to 10 MiB and each PDF to 100 pages. Exceeding a limit rejects the command with 400.","items":{"additionalProperties":false,"description":"Document embedded inline in a claim, message, or answer payload.","properties":{"base64":{"description":"Required base64-encoded PDF, JPEG, or PNG content. Maximum decoded file size: 10 MiB (10,485,760 bytes); maximum PDF length: 100 pages. Across the entire command, at most 20 documents and 50 MiB of decoded content are allowed, including documents nested under other parents. Exceeding a limit returns 400; too many PDF pages uses page_limit_exceeded.","maxLength":15029589,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"rental_agreement.documents.items.[INDEX].base64","typeLabel":"string"},"type":{"type":"string","description":"Agreement document purpose: rental_agreement and claim_statement each occupy a single optional document slot; other supplies supporting documents and may be used multiple times.","enum":["rental_agreement","claim_statement","other"],"isRequired":true,"uniqueKey":"rental_agreement.documents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"filename":{"description":"Original filename shown to users. Path components and control characters are removed and the extension always follows the detected content type.","maxLength":255,"minLength":1,"type":"string","uniqueKey":"rental_agreement.documents.items.[INDEX].filename","typeLabel":"string"}},"required":["base64","type"],"type":"object","uniqueKey":"rental_agreement.documents.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"rental_agreement.documents","typeLabel":"object[]"},"due_rule":{"oneOf":[{"type":"object","description":"Optional rental due-date rule. Omit or set null to use the third German business day of the rental month for H17/H19 claims; explicit claim-level dates override the derived result.","required":["day","kind"],"properties":{"day":{"description":"Day number from 1 to 31 within the rental month: calendar day for calendar_day, or ordinal business day for business_day. If the month has fewer such days, the last applicable day is used.","maximum":31,"minimum":1,"type":"integer","isRequired":true,"uniqueKey":"rental_agreement.due_rule.oneOf.0.day","typeLabel":"integer"},"kind":{"description":"How to interpret day: calendar_day counts all dates; business_day counts Monday through Friday excluding German federal public holidays. State-specific holidays are not considered.","enum":["calendar_day","business_day"],"type":"string","isRequired":true,"uniqueKey":"rental_agreement.due_rule.oneOf.0.kind","typeLabel":"enum\u003cstring>"}},"uniqueKey":"rental_agreement.due_rule.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"rental_agreement.due_rule.oneOf.1","typeLabel":"null"}],"uniqueKey":"rental_agreement.due_rule","typeLabel":"object | null"},"monthly_rent":{"oneOf":[{"type":"object","description":"Total recurring Warmmiete, including ancillary-cost prepayments; it does not constrain an individual claim amount. May be absent or null while drafting; must be positive before finalization.","required":["value"],"properties":{"value":{"description":"Monthly rent expressed with two decimal places (up to 8 digits before the point). Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,8}(?:\\.[0-9]{1,2})?$","type":"string","isRequired":true,"uniqueKey":"rental_agreement.monthly_rent.oneOf.0.value","typeLabel":"string"},"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","default":"EUR","enum":["EUR"],"uniqueKey":"rental_agreement.monthly_rent.oneOf.0.currency","typeLabel":"enum\u003cstring>"}},"uniqueKey":"rental_agreement.monthly_rent.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"rental_agreement.monthly_rent.oneOf.1","typeLabel":"null"}],"uniqueKey":"rental_agreement.monthly_rent","typeLabel":"object | null"},"property_address":{"oneOf":[{"type":"object","description":"Complete address of the rented property, even when it matches the debtor address. Supply street, postal_code, city, and country; this creates a separate property address and does not reuse a debtor address id or primary flag. A complete property address is required before finalization.","required":["city","country","postal_code","street"],"properties":{"city":{"description":"City of the rented property.","maxLength":100,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"rental_agreement.property_address.oneOf.0.city","typeLabel":"string"},"country":{"type":"string","description":"ISO 3166-1 alpha-2 country code of the rented property.","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","CV","KH","CM","CA","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","SZ","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","XK","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","KP","MK","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","KR","SS","ES","LK","SD","SR","SJ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","US","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"isRequired":true,"uniqueKey":"rental_agreement.property_address.oneOf.0.country","typeLabel":"enum\u003cstring>"},"postal_code":{"description":"Postal code of the rented property.","maxLength":100,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"rental_agreement.property_address.oneOf.0.postal_code","typeLabel":"string"},"street":{"description":"Street and house number of the rented property.","maxLength":255,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"rental_agreement.property_address.oneOf.0.street","typeLabel":"string"}},"uniqueKey":"rental_agreement.property_address.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"rental_agreement.property_address.oneOf.1","typeLabel":"null"}],"uniqueKey":"rental_agreement.property_address","typeLabel":"object | null"}},"type":"object","uniqueKey":"rental_agreement","typeLabel":"object"},"starting_approach":{"oneOf":[{"type":"string","description":"Initial route for invoice and rental orders: extrajudicial starts with out-of-court collection; judicial starts by applying for a payment order (Mahnbescheid). Required before finalization; omit for titled orders, where enforcement is implicit.","enum":["extrajudicial","judicial"],"uniqueKey":"starting_approach.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"starting_approach.oneOf.1","typeLabel":"null"}],"uniqueKey":"starting_approach","typeLabel":"enum\u003cstring> | null"},"success_fee_confirmed":{"description":"Only valid for titled orders. Confirmation of the titled-order success-fee arrangement; it must be true before finalization. See the [paywise General Terms and Conditions (AGB)](https://paywise.de/agb/) for the exact conditions for titled orders.","type":"boolean","uniqueKey":"success_fee_confirmed","typeLabel":"boolean"},"type":{"type":"string","description":"Order type discriminator: invoice, rental, or titled. Defaults to invoice when omitted.","default":"invoice","enum":["invoice","rental","titled"],"uniqueKey":"type","typeLabel":"enum\u003cstring>"}},"required":["debtor_id"],"type":"object","uniqueKey":"","typeLabel":"object"},"exampleType":"examples"}},"required":true,"exampleType":"examples"},"responses":{"a6fe8f92-2c57-42db-a9da-e76a292c5cbb":{"content":{"application/json":{"examples":{"invoice":{"title":"invoice","summary":"Invoice order","value":{"additional_debtors":[],"claims":[{"additional_charges":[],"additional_charges_amount":{"currency":"EUR","value":"0.00"},"additional_debtor_ids":[],"created_at":"2026-07-18T10:00:00Z","debtor_id":"40000000-0000-4000-8000-000000000001","delay_date":"2026-07-09","dispute_reason":null,"document_date":"2026-06-05","document_reference":"2026-0042","documents":[],"due_date":"2026-06-19","events":[{"description":null,"location":null,"occurence":"2026-06-05T09:00:00Z","title":"Invoice issued","type":"claim","your_reference":"2026-0042"}],"id":"30000000-0000-4000-8000-000000000001","is_disputed":false,"items":[],"legal_basis":{"claim_type_code":null,"contract_date":null,"description":null},"mandate_id":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"}],"confirmation_email":null,"created_at":"2026-07-18T10:00:00Z","creditor_obligation_fulfilled":true,"debtor":{"acting_as":"consumer","events":[{"description":null,"location":null,"occurence":"2026-05-01T09:00:00Z","title":"Customer registered","type":"registration","your_reference":null}],"id":"40000000-0000-4000-8000-000000000001","legal_form":null,"metadata":[{"type":"user:reference","value":"CUSTOMER-1001"}],"organization":null,"person":{"birth_date":null,"first_name":"Alex","last_name":"Example","salutation":"mx"},"your_reference":"CUSTOMER-1001"},"expires_at":"2026-10-16T10:00:00Z","id":"20000000-0000-4000-8000-000000000001","mandate":null,"merged_into":null,"rejection":null,"starting_approach":"extrajudicial","status":"draft","totals":{"charges":{"currency":"EUR","value":"0.00"},"main_claims":{"currency":"EUR","value":"100.00"},"order_value":{"currency":"EUR","value":"100.00"},"payments":{"currency":"EUR","value":"0.00"}},"type":"invoice","updated_at":"2026-07-18T10:00:00Z"}},"rental":{"title":"rental","summary":"Rental order","value":{"additional_debtors":[],"claims":[{"additional_charges":[],"additional_charges_amount":{"currency":"EUR","value":"0.00"},"additional_debtor_ids":[],"created_at":"2026-07-18T10:00:00Z","debtor_id":"40000000-0000-4000-8000-000000000001","delay_date":"2026-02-05","dispute_reason":null,"document_date":"2026-02-01","document_reference":null,"documents":[],"due_date":"2026-02-04","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":"H19","contract_date":"2026-01-10","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":"1200.00"},"reminders":[],"status":"draft","subject_matter":"Residential rent for February 2026","total_amount":{"currency":"EUR","value":"1200.00"},"type":"receivable","updated_at":"2026-07-18T10:00:00Z","your_reference":"RENT-2026-02"}],"confirmation_email":null,"created_at":"2026-07-18T10:00:00Z","creditor_obligation_fulfilled":true,"debtor":{"acting_as":"consumer","events":[{"description":null,"location":null,"occurence":"2026-05-01T09:00:00Z","title":"Customer registered","type":"registration","your_reference":null}],"id":"40000000-0000-4000-8000-000000000001","legal_form":null,"metadata":[{"type":"user:reference","value":"CUSTOMER-1001"}],"organization":null,"person":{"birth_date":null,"first_name":"Alex","last_name":"Example","salutation":"mx"},"your_reference":"CUSTOMER-1001"},"expires_at":"2026-10-16T10:00:00Z","id":"20000000-0000-4000-8000-000000000001","mandate":null,"merged_into":null,"rejection":null,"rental_agreement":{"contract_date":"2026-01-10","created_at":"2026-07-18T10:00:00Z","documents":[],"due_rule":null,"id":"21000000-0000-4000-8000-000000000001","monthly_rent":{"currency":"EUR","value":"1200.00"},"property_address":{"city":"Berlin","country":"DE","postal_code":"10115","street":"Rental Example Street 8"},"updated_at":"2026-07-18T10:00:00Z"},"starting_approach":"extrajudicial","status":"draft","totals":{"charges":{"currency":"EUR","value":"0.00"},"main_claims":{"currency":"EUR","value":"1200.00"},"order_value":{"currency":"EUR","value":"1200.00"},"payments":{"currency":"EUR","value":"0.00"}},"type":"rental","updated_at":"2026-07-18T10:00:00Z"}},"titled":{"title":"titled","summary":"Titled order","value":{"additional_debtors":[],"claims":[{"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"}],"confirmation_email":null,"created_at":"2026-07-18T10:00:00Z","debtor":{"acting_as":"consumer","events":[{"description":null,"location":null,"occurence":"2026-05-01T09:00:00Z","title":"Customer registered","type":"registration","your_reference":null}],"id":"40000000-0000-4000-8000-000000000001","legal_form":null,"metadata":[{"type":"user:reference","value":"CUSTOMER-1001"}],"organization":null,"person":{"birth_date":null,"first_name":"Alex","last_name":"Example","salutation":"mx"},"your_reference":"CUSTOMER-1001"},"expires_at":"2026-10-16T10:00:00Z","id":"20000000-0000-4000-8000-000000000001","mandate":null,"merged_into":null,"rejection":null,"status":"draft","success_fee_confirmed":true,"totals":{"charges":{"currency":"EUR","value":"0.00"},"main_claims":{"currency":"EUR","value":"2500.00"},"order_value":{"currency":"EUR","value":"2500.00"},"payments":{"currency":"EUR","value":"0.00"}},"type":"titled","updated_at":"2026-07-18T10:00:00Z"}}},"schema":{"oneOf":[{"type":"object","title":"Invoice order","description":"An invoice order contains receivable claims and exposes `starting_approach` and `creditor_obligation_fulfilled`.\n\nRead representation of an order.\n\n`status` is derived from the order's submission and review progress;\n`mandate` names the\ncreated mandate once the order is accepted; `merged_into` names the\nsurviving order when this order was merged away during review.","required":["additional_debtors","claims","confirmation_email","created_at","creditor_obligation_fulfilled","debtor","expires_at","id","mandate","merged_into","rejection","starting_approach","status","totals","type","updated_at"],"properties":{"additional_debtors":{"description":"Inline summaries of the additional debtors. Retrieve each debtor's full details with GET /v2/debtors/{id}/ using its id. Replace membership through PATCH /v2/orders/{id}/ while the order is a draft. API submissions are limited to 10 additional debtors.","items":{"properties":{"acting_as":{"type":"string","description":"Whether the debtor incurred the obligation as a consumer or in a business capacity.\n\n* `consumer` - consumer\n* `business` - business","enum":["consumer","business"],"isRequired":true,"uniqueKey":"oneOf.0.additional_debtors.items.[INDEX].acting_as","typeLabel":"enum\u003cstring>"},"events":{"description":"Stored contextual events associated with this resource.","items":{"description":"Stored events may likewise use retired or internal type values.","properties":{"description":{"oneOf":[{"description":"Optional description of the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.additional_debtors.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_debtors.items.[INDEX].events.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.additional_debtors.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_debtors.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_debtors.items.[INDEX].events.items.[INDEX].location.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.additional_debtors.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_debtors.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_debtors.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_debtors.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_debtors.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_debtors.items.[INDEX].events.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.additional_debtors.items.[INDEX].events.items.[INDEX].your_reference","typeLabel":"string | null"}},"required":["description","location","occurence","title","type","your_reference"],"type":"object","uniqueKey":"oneOf.0.additional_debtors.items.[INDEX].events.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.0.additional_debtors.items.[INDEX].events","typeLabel":"object[]"},"id":{"description":"Stable identifier of this debtor.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.additional_debtors.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"legal_form":{"oneOf":[{"description":"Permanent public legal-form code; look up its label and representation rules with GET /v2/legal-forms/. Null for consumers.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.additional_debtors.items.[INDEX].legal_form.oneOf.0","typeLabel":"string"},{"description":"Permanent public legal-form code; look up its label and representation rules with GET /v2/legal-forms/. Null for consumers.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.additional_debtors.items.[INDEX].legal_form.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.additional_debtors.items.[INDEX].legal_form","typeLabel":"string | null"},"metadata":{"description":"Stored metadata entries; duplicate types remain separate entries.","items":{"description":"Stored types may predate today's resource-specific input choices.","properties":{"type":{"description":"Stored metadata type; historical values may be outside today's input enum.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.additional_debtors.items.[INDEX].metadata.items.[INDEX].type","typeLabel":"string"},"value":{"description":"Stored metadata value.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.additional_debtors.items.[INDEX].metadata.items.[INDEX].value","typeLabel":"string"}},"required":["type","value"],"type":"object","uniqueKey":"oneOf.0.additional_debtors.items.[INDEX].metadata.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.0.additional_debtors.items.[INDEX].metadata","typeLabel":"object[]"},"organization":{"oneOf":[{"type":"object","description":"Organization identity for a business debtor.","required":["commercial_register","commercial_registration_number","name"],"properties":{"commercial_register":{"oneOf":[{"description":"Register court or authority holding the registration.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.additional_debtors.items.[INDEX].organization.oneOf.0.commercial_register.oneOf.0","typeLabel":"string"},{"description":"Register court or authority holding the registration.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.additional_debtors.items.[INDEX].organization.oneOf.0.commercial_register.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.additional_debtors.items.[INDEX].organization.oneOf.0.commercial_register","typeLabel":"string | null"},"commercial_registration_number":{"oneOf":[{"description":"Commercial, association, or partnership register number.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.additional_debtors.items.[INDEX].organization.oneOf.0.commercial_registration_number.oneOf.0","typeLabel":"string"},{"description":"Commercial, association, or partnership register number.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.additional_debtors.items.[INDEX].organization.oneOf.0.commercial_registration_number.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.additional_debtors.items.[INDEX].organization.oneOf.0.commercial_registration_number","typeLabel":"string | null"},"name":{"description":"Registered or trading name of the organization.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.additional_debtors.items.[INDEX].organization.oneOf.0.name","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.0.additional_debtors.items.[INDEX].organization.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.0.additional_debtors.items.[INDEX].organization.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.additional_debtors.items.[INDEX].organization","typeLabel":"object | null"},"person":{"oneOf":[{"type":"object","description":"Natural-person identity for a consumer or sole proprietor.","required":["birth_date","first_name","last_name","salutation"],"properties":{"birth_date":{"oneOf":[{"description":"Date of birth used to identify the natural person.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.additional_debtors.items.[INDEX].person.oneOf.0.birth_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Date of birth used to identify the natural person.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.additional_debtors.items.[INDEX].person.oneOf.0.birth_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.additional_debtors.items.[INDEX].person.oneOf.0.birth_date","typeLabel":"string\u003cdate> | null"},"first_name":{"description":"Given name of the natural person.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.additional_debtors.items.[INDEX].person.oneOf.0.first_name","typeLabel":"string"},"last_name":{"description":"Family name of the natural person.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.additional_debtors.items.[INDEX].person.oneOf.0.last_name","typeLabel":"string"},"salutation":{"oneOf":[{"type":"string","description":"Salutation of the natural person; null if no supported salutation is stored.","enum":["mr","ms","mx"],"isRequired":true,"uniqueKey":"oneOf.0.additional_debtors.items.[INDEX].person.oneOf.0.salutation.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.0.additional_debtors.items.[INDEX].person.oneOf.0.salutation.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.additional_debtors.items.[INDEX].person.oneOf.0.salutation","typeLabel":"enum\u003cstring> | null"}},"isRequired":true,"uniqueKey":"oneOf.0.additional_debtors.items.[INDEX].person.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.0.additional_debtors.items.[INDEX].person.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.additional_debtors.items.[INDEX].person","typeLabel":"object | null"},"your_reference":{"oneOf":[{"description":"Your reference for this debtor.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.additional_debtors.items.[INDEX].your_reference.oneOf.0","typeLabel":"string"},{"description":"Your reference for this debtor.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.additional_debtors.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.additional_debtors.items.[INDEX].your_reference","typeLabel":"string | null"}},"required":["acting_as","events","id","legal_form","metadata","organization","person","your_reference"],"type":"object","uniqueKey":"oneOf.0.additional_debtors.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.0.additional_debtors","typeLabel":"object[]"},"claims":{"description":"Receivable claims belonging to this order, including their itemized charges and documents. Titled claims are accepted only in titled orders. API submissions are limited to 50 claims per order.","items":{"oneOf":[{"type":"object","title":"Receivable claim","description":"A receivable claim based on an invoice, rent, or another obligation. Its principal amount, dates, charges, and documents belong to the claim.","required":["additional_charges","additional_charges_amount","additional_debtor_ids","created_at","debtor_id","delay_date","dispute_reason","document_date","document_reference","documents","due_date","events","id","is_disputed","items","legal_basis","mandate_id","metadata","order_id","payments","principal_amount","reminders","status","subject_matter","total_amount","type","updated_at","your_reference"],"properties":{"additional_charges":{"description":"Itemized incidental claims such as reminder or bank fees. API submissions are limited to 50 entries.","items":{"description":"Read representation of one canonical additional charge.","properties":{"amount":{"type":"object","description":"Amount of the additional charge.","required":["currency","value"],"properties":{"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","enum":["EUR"],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].amount.currency","typeLabel":"enum\u003cstring>"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].amount.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].amount","typeLabel":"object"},"events":{"description":"Stored contextual events associated with this resource.","items":{"description":"Stored events may likewise use retired or internal type values.","properties":{"description":{"oneOf":[{"description":"Optional description of the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"description":"Optional description of the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].description","typeLabel":"string | null"},"location":{"oneOf":[{"description":"Optional location associated with the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].location.oneOf.0","typeLabel":"string"},{"description":"Optional location associated with the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].location.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].location","typeLabel":"string | null"},"occurence":{"description":"Time at which the event occurred; the historical field spelling is intentional.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].occurence","typeLabel":"string\u003cdate-time>"},"title":{"description":"Human-readable title of the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].title","typeLabel":"string"},"type":{"description":"Stored event type; historical values may be outside today's input enum.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].type","typeLabel":"string"},"your_reference":{"oneOf":[{"description":"Your optional reference for the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].your_reference.oneOf.0","typeLabel":"string"},{"description":"Your optional reference for the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].your_reference","typeLabel":"string | null"}},"required":["description","location","occurence","title","type","your_reference"],"type":"object","uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events","typeLabel":"object[]"},"id":{"description":"Stable identifier of this additional charge.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"metadata":{"description":"Stored metadata entries; duplicate types remain separate entries.","items":{"description":"Stored types may predate today's resource-specific input choices.","properties":{"type":{"description":"Stored metadata type; historical values may be outside today's input enum.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].metadata.items.[INDEX].type","typeLabel":"string"},"value":{"description":"Stored metadata value.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].metadata.items.[INDEX].value","typeLabel":"string"}},"required":["type","value"],"type":"object","uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].metadata.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].metadata","typeLabel":"object[]"},"occurrence_date":{"oneOf":[{"description":"Date on which the additional charge arose.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].occurrence_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Date on which the additional charge arose.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].occurrence_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].occurrence_date","typeLabel":"string\u003cdate> | null"},"subject_matter":{"oneOf":[{"description":"Reason or subject of the additional charge.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].subject_matter.oneOf.0","typeLabel":"string"},{"description":"Reason or subject of the additional charge.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].subject_matter.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].subject_matter","typeLabel":"string | null"},"type":{"type":"string","description":"Business category of the additional charge.\n\n* `reminder_fee` - reminder_fee\n* `bank_charge` - bank_charge\n* `research_costs` - research_costs","enum":["reminder_fee","bank_charge","research_costs"],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"your_reference":{"oneOf":[{"description":"Your reference for this additional charge.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].your_reference.oneOf.0","typeLabel":"string"},{"description":"Your reference for this additional charge.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].your_reference","typeLabel":"string | null"}},"required":["amount","events","id","metadata","occurrence_date","subject_matter","type","your_reference"],"type":"object","uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.additional_charges","typeLabel":"object[]"},"additional_charges_amount":{"type":"object","description":"Sum of all itemized additional charges.","required":["currency","value"],"properties":{"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","enum":["EUR"],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.additional_charges_amount.currency","typeLabel":"enum\u003cstring>"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.additional_charges_amount.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.additional_charges_amount","typeLabel":"object"},"additional_debtor_ids":{"description":"Read-only additional debtor identifiers projected from the current order.","items":{"format":"uuid","type":"string","uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.additional_debtor_ids.items.[INDEX]","typeLabel":"string\u003cuuid>"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.additional_debtor_ids","typeLabel":"string\u003cuuid>[]"},"created_at":{"description":"Time at which the claim was created.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.created_at","typeLabel":"string\u003cdate-time>"},"debtor_id":{"oneOf":[{"description":"Read-only primary debtor identifier projected from the current order. Change party membership only on a draft order; debtor details use the debtor resource.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.debtor_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"description":"Read-only primary debtor identifier projected from the current order. Change party membership only on a draft order; debtor details use the debtor resource.","format":"uuid","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.debtor_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.debtor_id","typeLabel":"string\u003cuuid> | null"},"delay_date":{"oneOf":[{"description":"Date from which the debtor is considered in payment default.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.delay_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Date from which the debtor is considered in payment default.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.delay_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.delay_date","typeLabel":"string\u003cdate> | null"},"dispute_reason":{"oneOf":[{"description":"Debtor's stated reason for disputing the claim.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.dispute_reason.oneOf.0","typeLabel":"string"},{"description":"Debtor's stated reason for disputing the claim.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.dispute_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.dispute_reason","typeLabel":"string | null"},"document_date":{"oneOf":[{"description":"Date of the invoice, contract, or other claim document.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.document_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Date of the invoice, contract, or other claim document.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.document_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.document_date","typeLabel":"string\u003cdate> | null"},"document_reference":{"oneOf":[{"description":"Invoice, contract, or other source-document number.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.document_reference.oneOf.0","typeLabel":"string"},{"description":"Invoice, contract, or other source-document number.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.document_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.document_reference","typeLabel":"string | null"},"documents":{"description":"Documents relevant to processing the claim.","items":{"description":"Resource representation with a native UUID `id`.","properties":{"created_at":{"description":"Time at which the document was submitted.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"download_url":{"oneOf":[{"description":"Authenticated API URL for downloading the document; null while its status is not `ready`.","format":"uri","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].download_url.oneOf.0","typeLabel":"string\u003curi>"},{"description":"Authenticated API URL for downloading the document; null while its status is not `ready`.","format":"uri","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].download_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].download_url","typeLabel":"string\u003curi> | null"},"failure_reason":{"oneOf":[{"type":"string","description":"Why processing failed when status is `failed`; `null` otherwise. `page_limit_exceeded`: PDF above the 100-page ceiling; `encrypted`: password-protected PDF; `corrupt`: bytes could not be parsed; `unsupported`: content type not accepted; `processing_failed`: any other processing error.","enum":["page_limit_exceeded","encrypted","corrupt","unsupported","processing_failed"],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].failure_reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].failure_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].failure_reason","typeLabel":"enum\u003cstring> | null"},"filename":{"description":"Original filename shown to users.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].filename","typeLabel":"string"},"id":{"description":"Stable identifier for this resource.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"mime_type":{"oneOf":[{"description":"Detected media type of the document.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].mime_type.oneOf.0","typeLabel":"string"},{"description":"Detected media type of the document.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].mime_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].mime_type","typeLabel":"string | null"},"parent":{"type":"object","description":"Resource that owns the document.","required":["id","type"],"properties":{"id":{"description":"Identifier of the resource that owns the document.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].parent.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","description":"Kind of resource that owns the document.\n\n* `claim` - claim\n* `message` - message\n* `request_to_client_answer` - request_to_client_answer\n* `rental_agreement` - rental_agreement\n* `enforceable_title` - enforceable_title","enum":["claim","message","request_to_client_answer","rental_agreement","enforceable_title"],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].parent.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].parent","typeLabel":"object"},"status":{"type":"string","description":"Document availability: `pending` while scanning or processing is incomplete; `ready` when processing permits download; `failed` when scanning or processing failed; `rejected` when the malware check rejected the file.","enum":["pending","ready","failed","rejected"],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"type":{"type":"string","description":"Business purpose of the document.","enum":["bank_statement","claim_statement","correspondence","enforceable_title","invoice","other","payment_proof","reminder","rental_agreement"],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updated_at":{"description":"Time at which document processing last changed.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"}},"required":["created_at","download_url","failure_reason","filename","id","mime_type","parent","status","type","updated_at"],"type":"object","uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.documents.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.documents","typeLabel":"object[]"},"due_date":{"oneOf":[{"description":"Date on which payment of the principal claim became due.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.due_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Date on which payment of the principal claim became due.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.due_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.due_date","typeLabel":"string\u003cdate> | null"},"events":{"description":"Stored contextual events associated with this resource.","items":{"description":"Stored events may likewise use retired or internal type values.","properties":{"description":{"oneOf":[{"description":"Optional description of the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.events.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"description":"Optional description of the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.events.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.events.items.[INDEX].description","typeLabel":"string | null"},"location":{"oneOf":[{"description":"Optional location associated with the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.events.items.[INDEX].location.oneOf.0","typeLabel":"string"},{"description":"Optional location associated with the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.events.items.[INDEX].location.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.events.items.[INDEX].location","typeLabel":"string | null"},"occurence":{"description":"Time at which the event occurred; the historical field spelling is intentional.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.events.items.[INDEX].occurence","typeLabel":"string\u003cdate-time>"},"title":{"description":"Human-readable title of the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.events.items.[INDEX].title","typeLabel":"string"},"type":{"description":"Stored event type; historical values may be outside today's input enum.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.events.items.[INDEX].type","typeLabel":"string"},"your_reference":{"oneOf":[{"description":"Your optional reference for the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.events.items.[INDEX].your_reference.oneOf.0","typeLabel":"string"},{"description":"Your optional reference for the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.events.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.events.items.[INDEX].your_reference","typeLabel":"string | null"}},"required":["description","location","occurence","title","type","your_reference"],"type":"object","uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.events.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.events","typeLabel":"object[]"},"id":{"description":"Stable identifier of this claim.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.id","typeLabel":"string\u003cuuid>"},"is_disputed":{"description":"Whether the debtor disputes the claim.","readOnly":true,"type":"boolean","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.is_disputed","typeLabel":"boolean"},"items":{"description":"Invoice or contract lines that make up the principal claim. API submissions are limited to 100 entries.","items":{"description":"Read representation of one invoice line.","properties":{"amount":{"type":"object","description":"Calculated line total: quantity multiplied by unit price.","required":["currency","value"],"properties":{"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","enum":["EUR"],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.\\items.items.[INDEX].amount.currency","typeLabel":"enum\u003cstring>"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.\\items.items.[INDEX].amount.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.\\items.items.[INDEX].amount","typeLabel":"object"},"description":{"description":"Goods or service represented by this invoice or contract line.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.\\items.items.[INDEX].description","typeLabel":"string"},"quantity":{"description":"Number of units represented by this line. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,10}(?:\\.[0-9]{1,6})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.\\items.items.[INDEX].quantity","typeLabel":"string"},"unit":{"oneOf":[{"description":"Unit of measure for the quantity, when applicable.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.\\items.items.[INDEX].unit.oneOf.0","typeLabel":"string"},{"description":"Unit of measure for the quantity, when applicable.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.\\items.items.[INDEX].unit.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.\\items.items.[INDEX].unit","typeLabel":"string | null"},"unit_price":{"type":"object","description":"Price of one unit before multiplying by quantity.","required":["currency","value"],"properties":{"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","enum":["EUR"],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.\\items.items.[INDEX].unit_price.currency","typeLabel":"enum\u003cstring>"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.\\items.items.[INDEX].unit_price.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.\\items.items.[INDEX].unit_price","typeLabel":"object"}},"required":["amount","description","quantity","unit","unit_price"],"type":"object","uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.\\items.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.\\items","typeLabel":"object[]"},"legal_basis":{"type":"object","description":"Contract or obligation that establishes the principal claim.","required":["claim_type_code","contract_date","description"],"properties":{"claim_type_code":{"oneOf":[{"description":"Code identifying the contract or transaction underlying the claim. H17 is commercial rent, H19 is residential rent, and K014 identifies receivable enforcement costs in titled orders. See [legal basis codes](https://docs.paywise.de/api-docs/case-management-api/concepts/claims#legal-basis-codes) for the full code-to-meaning table.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.legal_basis.claim_type_code.oneOf.0","typeLabel":"string"},{"description":"Code identifying the contract or transaction underlying the claim. H17 is commercial rent, H19 is residential rent, and K014 identifies receivable enforcement costs in titled orders. See [legal basis codes](https://docs.paywise.de/api-docs/case-management-api/concepts/claims#legal-basis-codes) for the full code-to-meaning table.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.legal_basis.claim_type_code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.legal_basis.claim_type_code","typeLabel":"string | null"},"contract_date":{"oneOf":[{"description":"Date on which the underlying contract or obligation arose.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.legal_basis.contract_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Date on which the underlying contract or obligation arose.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.legal_basis.contract_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.legal_basis.contract_date","typeLabel":"string\u003cdate> | null"},"description":{"oneOf":[{"description":"Terms or circumstances establishing the principal claim. API submissions are limited to 2000 characters.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.legal_basis.description.oneOf.0","typeLabel":"string"},{"description":"Terms or circumstances establishing the principal claim. API submissions are limited to 2000 characters.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.legal_basis.description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.legal_basis.description","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.legal_basis","typeLabel":"object"},"mandate_id":{"oneOf":[{"description":"Read-only accepted mandate identifier, or null before acceptance.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.mandate_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"description":"Read-only accepted mandate identifier, or null before acceptance.","format":"uuid","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.mandate_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.mandate_id","typeLabel":"string\u003cuuid> | null"},"metadata":{"description":"Stored metadata entries; duplicate types remain separate entries.","items":{"description":"Stored types may predate today's resource-specific input choices.","properties":{"type":{"description":"Stored metadata type; historical values may be outside today's input enum.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.metadata.items.[INDEX].type","typeLabel":"string"},"value":{"description":"Stored metadata value.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.metadata.items.[INDEX].value","typeLabel":"string"}},"required":["type","value"],"type":"object","uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.metadata.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.metadata","typeLabel":"object[]"},"order_id":{"description":"Read-only current order identifier. Internal review may change this relationship while the claim identifier and all claim-specific URLs remain stable.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.order_id","typeLabel":"string\u003cuuid>"},"payments":{"description":"Read-only payments attributed to this claim. Report subsequent payments through the stable claim payments URL, including after acceptance or an internal order move. Reporting requires case:payments:write.","items":{"description":"Read representation of one reported payment.","properties":{"amount":{"oneOf":[{"type":"object","description":"Amount received.","required":["currency","value"],"properties":{"currency":{"description":"Currency of the payment.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].amount.oneOf.0.currency","typeLabel":"string"},"value":{"description":"Amount received, expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].amount.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].amount.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].amount","typeLabel":"object | null"},"claim":{"oneOf":[{"type":"object","description":"Claim to which the payment was reported.","required":["document_reference","id","your_reference"],"properties":{"document_reference":{"oneOf":[{"description":"Invoice, contract, or source-document number of the claim.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].claim.oneOf.0.document_reference.oneOf.0","typeLabel":"string"},{"description":"Invoice, contract, or source-document number of the claim.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].claim.oneOf.0.document_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].claim.oneOf.0.document_reference","typeLabel":"string | null"},"id":{"description":"Identifier of the claim receiving the payment.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].claim.oneOf.0.id","typeLabel":"string\u003cuuid>"},"your_reference":{"oneOf":[{"description":"Your reference for the claim.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].claim.oneOf.0.your_reference.oneOf.0","typeLabel":"string"},{"description":"Your reference for the claim.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].claim.oneOf.0.your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].claim.oneOf.0.your_reference","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].claim.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].claim.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].claim","typeLabel":"object | null"},"created_at":{"description":"Time at which the payment was reported.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"id":{"description":"Stable identifier of this reported payment.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"mandate":{"oneOf":[{"type":"object","description":"Accepted case containing the claim.","required":["id","reference_number"],"properties":{"id":{"description":"Identifier of the accepted case receiving the payment.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].mandate.oneOf.0.id","typeLabel":"string\u003cuuid>"},"reference_number":{"description":"paywise case-file reference number.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].mandate.oneOf.0.reference_number","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].mandate.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].mandate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].mandate","typeLabel":"object | null"},"metadata":{"description":"Stored metadata entries; duplicate types remain separate entries.","items":{"description":"Stored types may predate today's resource-specific input choices.","properties":{"type":{"description":"Stored metadata type; historical values may be outside today's input enum.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].metadata.items.[INDEX].type","typeLabel":"string"},"value":{"description":"Stored metadata value.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].metadata.items.[INDEX].value","typeLabel":"string"}},"required":["type","value"],"type":"object","uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].metadata.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].metadata","typeLabel":"object[]"},"updated_at":{"description":"Time at which the payment record was last updated.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"},"value_date":{"description":"Date on which the payment was credited.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].value_date","typeLabel":"string\u003cdate>"},"your_reference":{"oneOf":[{"description":"Your reference for reconciling this payment.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].your_reference.oneOf.0","typeLabel":"string"},{"description":"Your reference for reconciling this payment.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].your_reference","typeLabel":"string | null"}},"required":["amount","claim","created_at","id","mandate","metadata","updated_at","value_date","your_reference"],"type":"object","uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.payments.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.payments","typeLabel":"object[]"},"principal_amount":{"oneOf":[{"type":"object","description":"Original principal amount including VAT, before charges and payments.","required":["currency","value"],"properties":{"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","enum":["EUR"],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.principal_amount.oneOf.0.currency","typeLabel":"enum\u003cstring>"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.principal_amount.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.principal_amount.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.principal_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.principal_amount","typeLabel":"object | null"},"reminders":{"description":"Payment reminders issued for this claim in chronological order. API submissions are limited to 50 entries.","items":{"description":"Read representation of one normalized reminder.","properties":{"date":{"oneOf":[{"description":"Date on which the payment reminder was issued.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.reminders.items.[INDEX].date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Date on which the payment reminder was issued.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.reminders.items.[INDEX].date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.reminders.items.[INDEX].date","typeLabel":"string\u003cdate> | null"},"due_date":{"oneOf":[{"description":"Payment deadline stated in the reminder, when present.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.reminders.items.[INDEX].due_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Payment deadline stated in the reminder, when present.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.reminders.items.[INDEX].due_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.reminders.items.[INDEX].due_date","typeLabel":"string\u003cdate> | null"},"id":{"oneOf":[{"description":"Stable identifier of this reminder.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.reminders.items.[INDEX].id.oneOf.0","typeLabel":"string\u003cuuid>"},{"description":"Stable identifier of this reminder.","format":"uuid","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.reminders.items.[INDEX].id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.reminders.items.[INDEX].id","typeLabel":"string\u003cuuid> | null"}},"required":["date","due_date","id"],"type":"object","uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.reminders.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.reminders","typeLabel":"object[]"},"status":{"type":"string","description":"Read-only effective claim lifecycle. Draft-only commands return 409 claim_not_editable after submission and 409 order_expired once the draft has passed its expires_at; payment and title commands retain their specific lifecycle conflict codes.","enum":["draft","submitted","awaiting_client_response","accepted","rejected","withdrawn"],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.status","typeLabel":"enum\u003cstring>"},"subject_matter":{"oneOf":[{"description":"Goods, services, or other obligation underlying the claim. API submissions are limited to 2000 characters.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.subject_matter.oneOf.0","typeLabel":"string"},{"description":"Goods, services, or other obligation underlying the claim. API submissions are limited to 2000 characters.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.subject_matter.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.subject_matter","typeLabel":"string | null"},"total_amount":{"oneOf":[{"type":"object","description":"Current open amount after charges and reported payments.","required":["currency","value"],"properties":{"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","enum":["EUR"],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.total_amount.oneOf.0.currency","typeLabel":"enum\u003cstring>"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.total_amount.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.total_amount.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.total_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.total_amount","typeLabel":"object | null"},"type":{"type":"string","description":"Literal receivable claim discriminator.","enum":["receivable"],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"updated_at":{"description":"Time at which the claim was last updated.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.updated_at","typeLabel":"string\u003cdate-time>"},"your_reference":{"oneOf":[{"description":"Your reference for this claim.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.your_reference.oneOf.0","typeLabel":"string"},{"description":"Your reference for this claim.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0.your_reference","typeLabel":"string | null"}},"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.0","typeLabel":"Receivable claim · object"},{"type":"object","title":"Titled claim","description":"A claim backed by an enforceable title. The title's amount, dates, and documents belong to `enforceable_title`.","required":["additional_debtor_ids","created_at","debtor_id","dispute_reason","document_reference","enforceable_title","events","id","is_disputed","mandate_id","metadata","order_id","payments","principal_amount","status","subject_matter","total_amount","type","updated_at","your_reference"],"properties":{"additional_debtor_ids":{"description":"Read-only additional debtor identifiers projected from the current order.","items":{"format":"uuid","type":"string","uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.additional_debtor_ids.items.[INDEX]","typeLabel":"string\u003cuuid>"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.additional_debtor_ids","typeLabel":"string\u003cuuid>[]"},"created_at":{"description":"Time at which the claim was created.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.created_at","typeLabel":"string\u003cdate-time>"},"debtor_id":{"oneOf":[{"description":"Read-only primary debtor identifier projected from the current order. Change party membership only on a draft order; debtor details use the debtor resource.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.debtor_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"description":"Read-only primary debtor identifier projected from the current order. Change party membership only on a draft order; debtor details use the debtor resource.","format":"uuid","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.debtor_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.debtor_id","typeLabel":"string\u003cuuid> | null"},"dispute_reason":{"oneOf":[{"description":"Debtor's stated reason for disputing the claim.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.dispute_reason.oneOf.0","typeLabel":"string"},{"description":"Debtor's stated reason for disputing the claim.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.dispute_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.dispute_reason","typeLabel":"string | null"},"document_reference":{"oneOf":[{"description":"Invoice, contract, or other source-document number.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.document_reference.oneOf.0","typeLabel":"string"},{"description":"Invoice, contract, or other source-document number.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.document_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.document_reference","typeLabel":"string | null"},"enforceable_title":{"oneOf":[{"type":"object","description":"Enforceable title that owns this claim's gross amount, legal metadata, and title documents.","required":["amount","created_at","documents","file_number","id","issued_on","issuing_authority","legally_binding_since","served_on","title_type","updated_at"],"properties":{"amount":{"oneOf":[{"type":"object","description":"Gross amount confirmed by the client and owned by the enforceable title.","required":["value"],"properties":{"value":{"description":"Gross title amount in major currency units, with at most two decimal places. Zero is accepted while drafting; the amount must be positive before finalization. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.amount.oneOf.0.value","typeLabel":"string"},"currency":{"type":"string","description":"Currency of the title amount; only EUR is supported.","default":"EUR","enum":["EUR"],"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.amount.oneOf.0.currency","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.amount.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.amount","typeLabel":"object | null"},"created_at":{"description":"Time at which the enforceable title was created.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.created_at","typeLabel":"string\u003cdate-time>"},"documents":{"description":"Documents owned by the title; one primary enforceable-title document is required before finalization.","items":{"description":"Resource representation with a native UUID `id`.","properties":{"created_at":{"description":"Time at which the document was submitted.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"download_url":{"oneOf":[{"description":"Authenticated API URL for downloading the document; null while its status is not `ready`.","format":"uri","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].download_url.oneOf.0","typeLabel":"string\u003curi>"},{"description":"Authenticated API URL for downloading the document; null while its status is not `ready`.","format":"uri","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].download_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].download_url","typeLabel":"string\u003curi> | null"},"failure_reason":{"oneOf":[{"type":"string","description":"Why processing failed when status is `failed`; `null` otherwise. `page_limit_exceeded`: PDF above the 100-page ceiling; `encrypted`: password-protected PDF; `corrupt`: bytes could not be parsed; `unsupported`: content type not accepted; `processing_failed`: any other processing error.","enum":["page_limit_exceeded","encrypted","corrupt","unsupported","processing_failed"],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].failure_reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].failure_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].failure_reason","typeLabel":"enum\u003cstring> | null"},"filename":{"description":"Original filename shown to users.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].filename","typeLabel":"string"},"id":{"description":"Stable identifier for this resource.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"mime_type":{"oneOf":[{"description":"Detected media type of the document.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].mime_type.oneOf.0","typeLabel":"string"},{"description":"Detected media type of the document.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].mime_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].mime_type","typeLabel":"string | null"},"parent":{"type":"object","description":"Resource that owns the document.","required":["id","type"],"properties":{"id":{"description":"Identifier of the resource that owns the document.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].parent.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","description":"Kind of resource that owns the document.\n\n* `claim` - claim\n* `message` - message\n* `request_to_client_answer` - request_to_client_answer\n* `rental_agreement` - rental_agreement\n* `enforceable_title` - enforceable_title","enum":["claim","message","request_to_client_answer","rental_agreement","enforceable_title"],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].parent.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].parent","typeLabel":"object"},"status":{"type":"string","description":"Document availability: `pending` while scanning or processing is incomplete; `ready` when processing permits download; `failed` when scanning or processing failed; `rejected` when the malware check rejected the file.","enum":["pending","ready","failed","rejected"],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"type":{"type":"string","description":"Business purpose of the document.","enum":["bank_statement","claim_statement","correspondence","enforceable_title","invoice","other","payment_proof","reminder","rental_agreement"],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updated_at":{"description":"Time at which document processing last changed.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"}},"required":["created_at","download_url","failure_reason","filename","id","mime_type","parent","status","type","updated_at"],"type":"object","uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents","typeLabel":"object[]"},"file_number":{"description":"Official file or reference number shown on the title.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.file_number","typeLabel":"string"},"id":{"description":"Stable identifier of the enforceable title.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.id","typeLabel":"string\u003cuuid>"},"issued_on":{"oneOf":[{"description":"Date on which the enforceable title was issued.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.issued_on.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Date on which the enforceable title was issued.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.issued_on.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.issued_on","typeLabel":"string\u003cdate> | null"},"issuing_authority":{"description":"Court, notary, or other authority that issued the title.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.issuing_authority","typeLabel":"string"},"legally_binding_since":{"oneOf":[{"description":"Optional date from which the title is legally binding; it cannot precede issued_on.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.legally_binding_since.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Optional date from which the title is legally binding; it cannot precede issued_on.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.legally_binding_since.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.legally_binding_since","typeLabel":"string\u003cdate> | null"},"served_on":{"oneOf":[{"description":"Optional date on which the title was served; it cannot precede issued_on.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.served_on.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Optional date on which the title was served; it cannot precede issued_on.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.served_on.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.served_on","typeLabel":"string\u003cdate> | null"},"title_type":{"oneOf":[{"type":"string","description":"Legal title category: enforcement_order = Vollstreckungsbescheid; default_judgment = Versäumnisurteil; final_judgment = Endurteil; acknowledgment_judgment = Anerkenntnisurteil; reservation_judgment = Vorbehaltsurteil; court_settlement = Gerichtlicher Vergleich; enforceable_notarial_deed = Vollstreckbare notarielle Urkunde; cost_assessment_order = Kostenfestsetzungsbeschluss; other = Sonstiger Titel.","enum":["enforcement_order","default_judgment","final_judgment","acknowledgment_judgment","reservation_judgment","court_settlement","enforceable_notarial_deed","cost_assessment_order","other"],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.title_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.title_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.title_type","typeLabel":"enum\u003cstring> | null"},"updated_at":{"description":"Time at which the enforceable title last changed.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.updated_at","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.enforceable_title","typeLabel":"object | null"},"events":{"description":"Stored contextual events associated with this resource.","items":{"description":"Stored events may likewise use retired or internal type values.","properties":{"description":{"oneOf":[{"description":"Optional description of the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.events.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"description":"Optional description of the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.events.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.events.items.[INDEX].description","typeLabel":"string | null"},"location":{"oneOf":[{"description":"Optional location associated with the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.events.items.[INDEX].location.oneOf.0","typeLabel":"string"},{"description":"Optional location associated with the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.events.items.[INDEX].location.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.events.items.[INDEX].location","typeLabel":"string | null"},"occurence":{"description":"Time at which the event occurred; the historical field spelling is intentional.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.events.items.[INDEX].occurence","typeLabel":"string\u003cdate-time>"},"title":{"description":"Human-readable title of the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.events.items.[INDEX].title","typeLabel":"string"},"type":{"description":"Stored event type; historical values may be outside today's input enum.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.events.items.[INDEX].type","typeLabel":"string"},"your_reference":{"oneOf":[{"description":"Your optional reference for the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.events.items.[INDEX].your_reference.oneOf.0","typeLabel":"string"},{"description":"Your optional reference for the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.events.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.events.items.[INDEX].your_reference","typeLabel":"string | null"}},"required":["description","location","occurence","title","type","your_reference"],"type":"object","uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.events.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.events","typeLabel":"object[]"},"id":{"description":"Stable identifier of this claim.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.id","typeLabel":"string\u003cuuid>"},"is_disputed":{"description":"Whether the debtor disputes the claim.","readOnly":true,"type":"boolean","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.is_disputed","typeLabel":"boolean"},"mandate_id":{"oneOf":[{"description":"Read-only accepted mandate identifier, or null before acceptance.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.mandate_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"description":"Read-only accepted mandate identifier, or null before acceptance.","format":"uuid","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.mandate_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.mandate_id","typeLabel":"string\u003cuuid> | null"},"metadata":{"description":"Stored metadata entries; duplicate types remain separate entries.","items":{"description":"Stored types may predate today's resource-specific input choices.","properties":{"type":{"description":"Stored metadata type; historical values may be outside today's input enum.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.metadata.items.[INDEX].type","typeLabel":"string"},"value":{"description":"Stored metadata value.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.metadata.items.[INDEX].value","typeLabel":"string"}},"required":["type","value"],"type":"object","uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.metadata.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.metadata","typeLabel":"object[]"},"order_id":{"description":"Read-only current order identifier. Internal review may change this relationship while the claim identifier and all claim-specific URLs remain stable.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.order_id","typeLabel":"string\u003cuuid>"},"payments":{"description":"Read-only payments attributed to this claim. Report subsequent payments through the stable claim payments URL, including after acceptance or an internal order move. Reporting requires case:payments:write.","items":{"description":"Read representation of one reported payment.","properties":{"amount":{"oneOf":[{"type":"object","description":"Amount received.","required":["currency","value"],"properties":{"currency":{"description":"Currency of the payment.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].amount.oneOf.0.currency","typeLabel":"string"},"value":{"description":"Amount received, expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].amount.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].amount.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].amount","typeLabel":"object | null"},"claim":{"oneOf":[{"type":"object","description":"Claim to which the payment was reported.","required":["document_reference","id","your_reference"],"properties":{"document_reference":{"oneOf":[{"description":"Invoice, contract, or source-document number of the claim.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].claim.oneOf.0.document_reference.oneOf.0","typeLabel":"string"},{"description":"Invoice, contract, or source-document number of the claim.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].claim.oneOf.0.document_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].claim.oneOf.0.document_reference","typeLabel":"string | null"},"id":{"description":"Identifier of the claim receiving the payment.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].claim.oneOf.0.id","typeLabel":"string\u003cuuid>"},"your_reference":{"oneOf":[{"description":"Your reference for the claim.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].claim.oneOf.0.your_reference.oneOf.0","typeLabel":"string"},{"description":"Your reference for the claim.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].claim.oneOf.0.your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].claim.oneOf.0.your_reference","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].claim.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].claim.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].claim","typeLabel":"object | null"},"created_at":{"description":"Time at which the payment was reported.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"id":{"description":"Stable identifier of this reported payment.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"mandate":{"oneOf":[{"type":"object","description":"Accepted case containing the claim.","required":["id","reference_number"],"properties":{"id":{"description":"Identifier of the accepted case receiving the payment.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].mandate.oneOf.0.id","typeLabel":"string\u003cuuid>"},"reference_number":{"description":"paywise case-file reference number.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].mandate.oneOf.0.reference_number","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].mandate.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].mandate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].mandate","typeLabel":"object | null"},"metadata":{"description":"Stored metadata entries; duplicate types remain separate entries.","items":{"description":"Stored types may predate today's resource-specific input choices.","properties":{"type":{"description":"Stored metadata type; historical values may be outside today's input enum.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].metadata.items.[INDEX].type","typeLabel":"string"},"value":{"description":"Stored metadata value.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].metadata.items.[INDEX].value","typeLabel":"string"}},"required":["type","value"],"type":"object","uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].metadata.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].metadata","typeLabel":"object[]"},"updated_at":{"description":"Time at which the payment record was last updated.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"},"value_date":{"description":"Date on which the payment was credited.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].value_date","typeLabel":"string\u003cdate>"},"your_reference":{"oneOf":[{"description":"Your reference for reconciling this payment.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].your_reference.oneOf.0","typeLabel":"string"},{"description":"Your reference for reconciling this payment.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].your_reference","typeLabel":"string | null"}},"required":["amount","claim","created_at","id","mandate","metadata","updated_at","value_date","your_reference"],"type":"object","uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.payments.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.payments","typeLabel":"object[]"},"principal_amount":{"oneOf":[{"type":"object","description":"Always null for a titled claim; use enforceable_title.amount for the authoritative gross amount.","required":["currency","value"],"properties":{"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","enum":["EUR"],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.principal_amount.oneOf.0.currency","typeLabel":"enum\u003cstring>"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.principal_amount.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.principal_amount.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.principal_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.principal_amount","typeLabel":"object | null"},"status":{"type":"string","description":"Read-only effective claim lifecycle. Draft-only commands return 409 claim_not_editable after submission and 409 order_expired once the draft has passed its expires_at; payment and title commands retain their specific lifecycle conflict codes.","enum":["draft","submitted","awaiting_client_response","accepted","rejected","withdrawn"],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.status","typeLabel":"enum\u003cstring>"},"subject_matter":{"oneOf":[{"description":"Goods, services, or other obligation underlying the claim. API submissions are limited to 2000 characters.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.subject_matter.oneOf.0","typeLabel":"string"},{"description":"Goods, services, or other obligation underlying the claim. API submissions are limited to 2000 characters.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.subject_matter.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.subject_matter","typeLabel":"string | null"},"total_amount":{"oneOf":[{"type":"object","description":"Authoritative gross enforceable-title amount; reported payments are exposed separately and do not reduce it.","required":["currency","value"],"properties":{"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","enum":["EUR"],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.total_amount.oneOf.0.currency","typeLabel":"enum\u003cstring>"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.total_amount.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.total_amount.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.total_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.total_amount","typeLabel":"object | null"},"type":{"type":"string","description":"Literal titled claim discriminator.","enum":["titled"],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"updated_at":{"description":"Time at which the claim was last updated.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.updated_at","typeLabel":"string\u003cdate-time>"},"your_reference":{"oneOf":[{"description":"Your reference for this claim.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.your_reference.oneOf.0","typeLabel":"string"},{"description":"Your reference for this claim.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1.your_reference","typeLabel":"string | null"}},"uniqueKey":"oneOf.0.claims.items.[INDEX].oneOf.1","typeLabel":"Titled claim · object"}],"uniqueKey":"oneOf.0.claims.items.[INDEX]","typeLabel":"Receivable claim · object | Titled claim · object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.0.claims","typeLabel":"(Receivable claim · object | Titled claim · object)[]"},"confirmation_email":{"oneOf":[{"description":"Address receiving the order-entry confirmation, when requested.","format":"email","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.confirmation_email.oneOf.0","typeLabel":"string\u003cemail>"},{"description":"Address receiving the order-entry confirmation, when requested.","format":"email","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.confirmation_email.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.confirmation_email","typeLabel":"string\u003cemail> | null"},"created_at":{"description":"Time at which the order was created.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.created_at","typeLabel":"string\u003cdate-time>"},"creditor_obligation_fulfilled":{"oneOf":[{"description":"Whether you fully performed your obligation to the debtor.","readOnly":true,"type":"boolean","isRequired":true,"uniqueKey":"oneOf.0.creditor_obligation_fulfilled.oneOf.0","typeLabel":"boolean"},{"description":"Whether you fully performed your obligation to the debtor.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.creditor_obligation_fulfilled.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.creditor_obligation_fulfilled","typeLabel":"boolean | null"},"debtor":{"type":"object","description":"Inline summary of the primary debtor. Retrieve full details with GET /v2/debtors/{id}/ using its id.","required":["acting_as","events","id","legal_form","metadata","organization","person","your_reference"],"properties":{"acting_as":{"type":"string","description":"Whether the debtor incurred the obligation as a consumer or in a business capacity.\n\n* `consumer` - consumer\n* `business` - business","enum":["consumer","business"],"isRequired":true,"uniqueKey":"oneOf.0.debtor.acting_as","typeLabel":"enum\u003cstring>"},"events":{"description":"Stored contextual events associated with this resource.","items":{"description":"Stored events may likewise use retired or internal type values.","properties":{"description":{"oneOf":[{"description":"Optional description of the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.debtor.events.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"description":"Optional description of the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.debtor.events.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.debtor.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.debtor.events.items.[INDEX].location.oneOf.0","typeLabel":"string"},{"description":"Optional location associated with the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.debtor.events.items.[INDEX].location.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.debtor.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.debtor.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.debtor.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.debtor.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.debtor.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.debtor.events.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.debtor.events.items.[INDEX].your_reference","typeLabel":"string | null"}},"required":["description","location","occurence","title","type","your_reference"],"type":"object","uniqueKey":"oneOf.0.debtor.events.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.0.debtor.events","typeLabel":"object[]"},"id":{"description":"Stable identifier of this debtor.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.debtor.id","typeLabel":"string\u003cuuid>"},"legal_form":{"oneOf":[{"description":"Permanent public legal-form code; look up its label and representation rules with GET /v2/legal-forms/. Null for consumers.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.debtor.legal_form.oneOf.0","typeLabel":"string"},{"description":"Permanent public legal-form code; look up its label and representation rules with GET /v2/legal-forms/. Null for consumers.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.debtor.legal_form.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.debtor.legal_form","typeLabel":"string | null"},"metadata":{"description":"Stored metadata entries; duplicate types remain separate entries.","items":{"description":"Stored types may predate today's resource-specific input choices.","properties":{"type":{"description":"Stored metadata type; historical values may be outside today's input enum.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.debtor.metadata.items.[INDEX].type","typeLabel":"string"},"value":{"description":"Stored metadata value.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.debtor.metadata.items.[INDEX].value","typeLabel":"string"}},"required":["type","value"],"type":"object","uniqueKey":"oneOf.0.debtor.metadata.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.0.debtor.metadata","typeLabel":"object[]"},"organization":{"oneOf":[{"type":"object","description":"Organization identity for a business debtor.","required":["commercial_register","commercial_registration_number","name"],"properties":{"commercial_register":{"oneOf":[{"description":"Register court or authority holding the registration.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.debtor.organization.oneOf.0.commercial_register.oneOf.0","typeLabel":"string"},{"description":"Register court or authority holding the registration.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.debtor.organization.oneOf.0.commercial_register.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.debtor.organization.oneOf.0.commercial_register","typeLabel":"string | null"},"commercial_registration_number":{"oneOf":[{"description":"Commercial, association, or partnership register number.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.debtor.organization.oneOf.0.commercial_registration_number.oneOf.0","typeLabel":"string"},{"description":"Commercial, association, or partnership register number.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.debtor.organization.oneOf.0.commercial_registration_number.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.debtor.organization.oneOf.0.commercial_registration_number","typeLabel":"string | null"},"name":{"description":"Registered or trading name of the organization.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.debtor.organization.oneOf.0.name","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.0.debtor.organization.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.0.debtor.organization.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.debtor.organization","typeLabel":"object | null"},"person":{"oneOf":[{"type":"object","description":"Natural-person identity for a consumer or sole proprietor.","required":["birth_date","first_name","last_name","salutation"],"properties":{"birth_date":{"oneOf":[{"description":"Date of birth used to identify the natural person.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.debtor.person.oneOf.0.birth_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Date of birth used to identify the natural person.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.debtor.person.oneOf.0.birth_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.debtor.person.oneOf.0.birth_date","typeLabel":"string\u003cdate> | null"},"first_name":{"description":"Given name of the natural person.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.debtor.person.oneOf.0.first_name","typeLabel":"string"},"last_name":{"description":"Family name of the natural person.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.debtor.person.oneOf.0.last_name","typeLabel":"string"},"salutation":{"oneOf":[{"type":"string","description":"Salutation of the natural person; null if no supported salutation is stored.","enum":["mr","ms","mx"],"isRequired":true,"uniqueKey":"oneOf.0.debtor.person.oneOf.0.salutation.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.0.debtor.person.oneOf.0.salutation.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.debtor.person.oneOf.0.salutation","typeLabel":"enum\u003cstring> | null"}},"isRequired":true,"uniqueKey":"oneOf.0.debtor.person.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.0.debtor.person.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.debtor.person","typeLabel":"object | null"},"your_reference":{"oneOf":[{"description":"Your reference for this debtor.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.debtor.your_reference.oneOf.0","typeLabel":"string"},{"description":"Your reference for this debtor.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.debtor.your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.debtor.your_reference","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"oneOf.0.debtor","typeLabel":"object"},"expires_at":{"oneOf":[{"description":"Time at which this API-created draft expires: updated_at plus 90 days, refreshed by every successful draft change. Once it has passed, the order reads expired and every change answers 409 order_expired until the daily cleanup deletes it. Null once the order is finalized and for orders created in the portal.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Time at which this API-created draft expires: updated_at plus 90 days, refreshed by every successful draft change. Once it has passed, the order reads expired and every change answers 409 order_expired until the daily cleanup deletes it. Null once the order is finalized and for orders created in the portal.","format":"date-time","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.expires_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.expires_at","typeLabel":"string\u003cdate-time> | null"},"id":{"description":"Stable identifier of this order.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.id","typeLabel":"string\u003cuuid>"},"mandate":{"oneOf":[{"description":"Accepted case created from this order, when available.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.mandate.oneOf.0","typeLabel":"string\u003cuuid>"},{"description":"Accepted case created from this order, when available.","format":"uuid","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.mandate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.mandate","typeLabel":"string\u003cuuid> | null"},"merged_into":{"oneOf":[{"description":"Surviving order when this order was merged during review.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.merged_into.oneOf.0","typeLabel":"string\u003cuuid>"},{"description":"Surviving order when this order was merged during review.","format":"uuid","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.merged_into.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.merged_into","typeLabel":"string\u003cuuid> | null"},"rejection":{"oneOf":[{"type":"object","description":"Why paywise declined the order: reason, time, notified recipients, and the standard reason's key. Null unless status is rejected.","required":["code","notified_to","reason","rejected_at"],"properties":{"code":{"oneOf":[{"description":"Stable machine-readable key of the standard rejection reason when the rejection used one; null for an individually worded rejection.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.rejection.oneOf.0.code.oneOf.0","typeLabel":"string"},{"description":"Stable machine-readable key of the standard rejection reason when the rejection used one; null for an individually worded rejection.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.rejection.oneOf.0.code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.rejection.oneOf.0.code","typeLabel":"string | null"},"notified_to":{"description":"E-mail addresses of your company's status-update recipients the rejection notice was delivered to. Empty when no notice was sent.","items":{"format":"email","type":"string","uniqueKey":"oneOf.0.rejection.oneOf.0.notified_to.items.[INDEX]","typeLabel":"string\u003cemail>"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.0.rejection.oneOf.0.notified_to","typeLabel":"string\u003cemail>[]"},"reason":{"oneOf":[{"description":"Plain-text reason paywise gave for rejecting the order: the wording of the rejection notice with formatting removed.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.rejection.oneOf.0.reason.oneOf.0","typeLabel":"string"},{"description":"Plain-text reason paywise gave for rejecting the order: the wording of the rejection notice with formatting removed.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.0.rejection.oneOf.0.reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.rejection.oneOf.0.reason","typeLabel":"string | null"},"rejected_at":{"description":"Time at which paywise rejected the order.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.rejection.oneOf.0.rejected_at","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"oneOf.0.rejection.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.0.rejection.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.rejection","typeLabel":"object | null"},"starting_approach":{"oneOf":[{"type":"string","description":"Initial collection route: extrajudicial starts out of court; judicial starts by applying for a payment order (Mahnbescheid). Null while this decision is unset.","enum":["extrajudicial","judicial"],"isRequired":true,"uniqueKey":"oneOf.0.starting_approach.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.0.starting_approach.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.starting_approach","typeLabel":"enum\u003cstring> | null"},"status":{"type":"string","description":"Order lifecycle state: draft is editable; submitted awaits processing; awaiting_client_response requires client input; accepted has entered case processing; rejected was declined; withdrawn was cancelled by the client; expired passed its draft deadline and accepts no further changes (409 order_expired) until the daily cleanup deletes it; merged points to the surviving order in merged_into.","enum":["draft","submitted","awaiting_client_response","accepted","rejected","withdrawn","expired","merged"],"isRequired":true,"uniqueKey":"oneOf.0.status","typeLabel":"enum\u003cstring>"},"totals":{"type":"object","description":"Financial totals calculated across the order's claims.","required":["charges","main_claims","order_value","payments"],"properties":{"charges":{"type":"object","description":"Sum of itemized additional charges on receivable claims.","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.totals.charges.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.totals.charges.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.0.totals.charges","typeLabel":"object"},"main_claims":{"type":"object","description":"Sum of receivable-claim principal amounts plus gross enforceable-title amounts.","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.totals.main_claims.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.totals.main_claims.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.0.totals.main_claims","typeLabel":"object"},"order_value":{"type":"object","description":"Current open value for invoice and rental orders; for titled orders, gross main_claims plus charges, with payments reported separately.","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.totals.order_value.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.totals.order_value.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.0.totals.order_value","typeLabel":"object"},"payments":{"type":"object","description":"Sum of payments already reported for the order's claims.","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.totals.payments.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.totals.payments.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.0.totals.payments","typeLabel":"object"}},"isRequired":true,"uniqueKey":"oneOf.0.totals","typeLabel":"object"},"type":{"type":"string","description":"Literal invoice order discriminator.","enum":["invoice"],"isRequired":true,"uniqueKey":"oneOf.0.type","typeLabel":"enum\u003cstring>"},"updated_at":{"description":"Time at which the order was last updated.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"oneOf.0","typeLabel":"Invoice order · object"},{"type":"object","title":"Rental order","description":"A rental order contains receivable claims and one `rental_agreement`, alongside `starting_approach` and `creditor_obligation_fulfilled`.\n\nRead representation of an order.\n\n`status` is derived from the order's submission and review progress;\n`mandate` names the\ncreated mandate once the order is accepted; `merged_into` names the\nsurviving order when this order was merged away during review.","required":["additional_debtors","claims","confirmation_email","created_at","creditor_obligation_fulfilled","debtor","expires_at","id","mandate","merged_into","rejection","rental_agreement","starting_approach","status","totals","type","updated_at"],"properties":{"additional_debtors":{"description":"Inline summaries of the additional debtors. Retrieve each debtor's full details with GET /v2/debtors/{id}/ using its id. Replace membership through PATCH /v2/orders/{id}/ while the order is a draft. API submissions are limited to 10 additional debtors.","items":{"properties":{"acting_as":{"type":"string","description":"Whether the debtor incurred the obligation as a consumer or in a business capacity.\n\n* `consumer` - consumer\n* `business` - business","enum":["consumer","business"],"isRequired":true,"uniqueKey":"oneOf.1.additional_debtors.items.[INDEX].acting_as","typeLabel":"enum\u003cstring>"},"events":{"description":"Stored contextual events associated with this resource.","items":{"description":"Stored events may likewise use retired or internal type values.","properties":{"description":{"oneOf":[{"description":"Optional description of the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.additional_debtors.items.[INDEX].events.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"description":"Optional description of the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.additional_debtors.items.[INDEX].events.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.additional_debtors.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.1.additional_debtors.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.1.additional_debtors.items.[INDEX].events.items.[INDEX].location.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.additional_debtors.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.1.additional_debtors.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.1.additional_debtors.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.1.additional_debtors.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.1.additional_debtors.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.1.additional_debtors.items.[INDEX].events.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.additional_debtors.items.[INDEX].events.items.[INDEX].your_reference","typeLabel":"string | null"}},"required":["description","location","occurence","title","type","your_reference"],"type":"object","uniqueKey":"oneOf.1.additional_debtors.items.[INDEX].events.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.1.additional_debtors.items.[INDEX].events","typeLabel":"object[]"},"id":{"description":"Stable identifier of this debtor.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.additional_debtors.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"legal_form":{"oneOf":[{"description":"Permanent public legal-form code; look up its label and representation rules with GET /v2/legal-forms/. Null for consumers.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.additional_debtors.items.[INDEX].legal_form.oneOf.0","typeLabel":"string"},{"description":"Permanent public legal-form code; look up its label and representation rules with GET /v2/legal-forms/. Null for consumers.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.additional_debtors.items.[INDEX].legal_form.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.additional_debtors.items.[INDEX].legal_form","typeLabel":"string | null"},"metadata":{"description":"Stored metadata entries; duplicate types remain separate entries.","items":{"description":"Stored types may predate today's resource-specific input choices.","properties":{"type":{"description":"Stored metadata type; historical values may be outside today's input enum.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.additional_debtors.items.[INDEX].metadata.items.[INDEX].type","typeLabel":"string"},"value":{"description":"Stored metadata value.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.additional_debtors.items.[INDEX].metadata.items.[INDEX].value","typeLabel":"string"}},"required":["type","value"],"type":"object","uniqueKey":"oneOf.1.additional_debtors.items.[INDEX].metadata.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.1.additional_debtors.items.[INDEX].metadata","typeLabel":"object[]"},"organization":{"oneOf":[{"type":"object","description":"Organization identity for a business debtor.","required":["commercial_register","commercial_registration_number","name"],"properties":{"commercial_register":{"oneOf":[{"description":"Register court or authority holding the registration.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.additional_debtors.items.[INDEX].organization.oneOf.0.commercial_register.oneOf.0","typeLabel":"string"},{"description":"Register court or authority holding the registration.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.additional_debtors.items.[INDEX].organization.oneOf.0.commercial_register.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.additional_debtors.items.[INDEX].organization.oneOf.0.commercial_register","typeLabel":"string | null"},"commercial_registration_number":{"oneOf":[{"description":"Commercial, association, or partnership register number.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.additional_debtors.items.[INDEX].organization.oneOf.0.commercial_registration_number.oneOf.0","typeLabel":"string"},{"description":"Commercial, association, or partnership register number.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.additional_debtors.items.[INDEX].organization.oneOf.0.commercial_registration_number.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.additional_debtors.items.[INDEX].organization.oneOf.0.commercial_registration_number","typeLabel":"string | null"},"name":{"description":"Registered or trading name of the organization.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.additional_debtors.items.[INDEX].organization.oneOf.0.name","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.1.additional_debtors.items.[INDEX].organization.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.1.additional_debtors.items.[INDEX].organization.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.additional_debtors.items.[INDEX].organization","typeLabel":"object | null"},"person":{"oneOf":[{"type":"object","description":"Natural-person identity for a consumer or sole proprietor.","required":["birth_date","first_name","last_name","salutation"],"properties":{"birth_date":{"oneOf":[{"description":"Date of birth used to identify the natural person.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.additional_debtors.items.[INDEX].person.oneOf.0.birth_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Date of birth used to identify the natural person.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.additional_debtors.items.[INDEX].person.oneOf.0.birth_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.additional_debtors.items.[INDEX].person.oneOf.0.birth_date","typeLabel":"string\u003cdate> | null"},"first_name":{"description":"Given name of the natural person.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.additional_debtors.items.[INDEX].person.oneOf.0.first_name","typeLabel":"string"},"last_name":{"description":"Family name of the natural person.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.additional_debtors.items.[INDEX].person.oneOf.0.last_name","typeLabel":"string"},"salutation":{"oneOf":[{"type":"string","description":"Salutation of the natural person; null if no supported salutation is stored.","enum":["mr","ms","mx"],"isRequired":true,"uniqueKey":"oneOf.1.additional_debtors.items.[INDEX].person.oneOf.0.salutation.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.1.additional_debtors.items.[INDEX].person.oneOf.0.salutation.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.additional_debtors.items.[INDEX].person.oneOf.0.salutation","typeLabel":"enum\u003cstring> | null"}},"isRequired":true,"uniqueKey":"oneOf.1.additional_debtors.items.[INDEX].person.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.1.additional_debtors.items.[INDEX].person.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.additional_debtors.items.[INDEX].person","typeLabel":"object | null"},"your_reference":{"oneOf":[{"description":"Your reference for this debtor.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.additional_debtors.items.[INDEX].your_reference.oneOf.0","typeLabel":"string"},{"description":"Your reference for this debtor.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.additional_debtors.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.additional_debtors.items.[INDEX].your_reference","typeLabel":"string | null"}},"required":["acting_as","events","id","legal_form","metadata","organization","person","your_reference"],"type":"object","uniqueKey":"oneOf.1.additional_debtors.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.1.additional_debtors","typeLabel":"object[]"},"claims":{"description":"Receivable claims belonging to this order, including their itemized charges and documents. Titled claims are accepted only in titled orders. API submissions are limited to 50 claims per order.","items":{"oneOf":[{"type":"object","title":"Receivable claim","description":"A receivable claim based on an invoice, rent, or another obligation. Its principal amount, dates, charges, and documents belong to the claim.","required":["additional_charges","additional_charges_amount","additional_debtor_ids","created_at","debtor_id","delay_date","dispute_reason","document_date","document_reference","documents","due_date","events","id","is_disputed","items","legal_basis","mandate_id","metadata","order_id","payments","principal_amount","reminders","status","subject_matter","total_amount","type","updated_at","your_reference"],"properties":{"additional_charges":{"description":"Itemized incidental claims such as reminder or bank fees. API submissions are limited to 50 entries.","items":{"description":"Read representation of one canonical additional charge.","properties":{"amount":{"type":"object","description":"Amount of the additional charge.","required":["currency","value"],"properties":{"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","enum":["EUR"],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].amount.currency","typeLabel":"enum\u003cstring>"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].amount.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].amount","typeLabel":"object"},"events":{"description":"Stored contextual events associated with this resource.","items":{"description":"Stored events may likewise use retired or internal type values.","properties":{"description":{"oneOf":[{"description":"Optional description of the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"description":"Optional description of the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].description","typeLabel":"string | null"},"location":{"oneOf":[{"description":"Optional location associated with the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].location.oneOf.0","typeLabel":"string"},{"description":"Optional location associated with the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].location.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].location","typeLabel":"string | null"},"occurence":{"description":"Time at which the event occurred; the historical field spelling is intentional.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].occurence","typeLabel":"string\u003cdate-time>"},"title":{"description":"Human-readable title of the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].title","typeLabel":"string"},"type":{"description":"Stored event type; historical values may be outside today's input enum.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].type","typeLabel":"string"},"your_reference":{"oneOf":[{"description":"Your optional reference for the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].your_reference.oneOf.0","typeLabel":"string"},{"description":"Your optional reference for the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].your_reference","typeLabel":"string | null"}},"required":["description","location","occurence","title","type","your_reference"],"type":"object","uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events","typeLabel":"object[]"},"id":{"description":"Stable identifier of this additional charge.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"metadata":{"description":"Stored metadata entries; duplicate types remain separate entries.","items":{"description":"Stored types may predate today's resource-specific input choices.","properties":{"type":{"description":"Stored metadata type; historical values may be outside today's input enum.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].metadata.items.[INDEX].type","typeLabel":"string"},"value":{"description":"Stored metadata value.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].metadata.items.[INDEX].value","typeLabel":"string"}},"required":["type","value"],"type":"object","uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].metadata.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].metadata","typeLabel":"object[]"},"occurrence_date":{"oneOf":[{"description":"Date on which the additional charge arose.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].occurrence_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Date on which the additional charge arose.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].occurrence_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].occurrence_date","typeLabel":"string\u003cdate> | null"},"subject_matter":{"oneOf":[{"description":"Reason or subject of the additional charge.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].subject_matter.oneOf.0","typeLabel":"string"},{"description":"Reason or subject of the additional charge.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].subject_matter.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].subject_matter","typeLabel":"string | null"},"type":{"type":"string","description":"Business category of the additional charge.\n\n* `reminder_fee` - reminder_fee\n* `bank_charge` - bank_charge\n* `research_costs` - research_costs","enum":["reminder_fee","bank_charge","research_costs"],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"your_reference":{"oneOf":[{"description":"Your reference for this additional charge.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].your_reference.oneOf.0","typeLabel":"string"},{"description":"Your reference for this additional charge.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].your_reference","typeLabel":"string | null"}},"required":["amount","events","id","metadata","occurrence_date","subject_matter","type","your_reference"],"type":"object","uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.additional_charges","typeLabel":"object[]"},"additional_charges_amount":{"type":"object","description":"Sum of all itemized additional charges.","required":["currency","value"],"properties":{"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","enum":["EUR"],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.additional_charges_amount.currency","typeLabel":"enum\u003cstring>"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.additional_charges_amount.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.additional_charges_amount","typeLabel":"object"},"additional_debtor_ids":{"description":"Read-only additional debtor identifiers projected from the current order.","items":{"format":"uuid","type":"string","uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.additional_debtor_ids.items.[INDEX]","typeLabel":"string\u003cuuid>"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.additional_debtor_ids","typeLabel":"string\u003cuuid>[]"},"created_at":{"description":"Time at which the claim was created.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.created_at","typeLabel":"string\u003cdate-time>"},"debtor_id":{"oneOf":[{"description":"Read-only primary debtor identifier projected from the current order. Change party membership only on a draft order; debtor details use the debtor resource.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.debtor_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"description":"Read-only primary debtor identifier projected from the current order. Change party membership only on a draft order; debtor details use the debtor resource.","format":"uuid","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.debtor_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.debtor_id","typeLabel":"string\u003cuuid> | null"},"delay_date":{"oneOf":[{"description":"Date from which the debtor is considered in payment default.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.delay_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Date from which the debtor is considered in payment default.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.delay_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.delay_date","typeLabel":"string\u003cdate> | null"},"dispute_reason":{"oneOf":[{"description":"Debtor's stated reason for disputing the claim.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.dispute_reason.oneOf.0","typeLabel":"string"},{"description":"Debtor's stated reason for disputing the claim.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.dispute_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.dispute_reason","typeLabel":"string | null"},"document_date":{"oneOf":[{"description":"Date of the invoice, contract, or other claim document.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.document_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Date of the invoice, contract, or other claim document.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.document_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.document_date","typeLabel":"string\u003cdate> | null"},"document_reference":{"oneOf":[{"description":"Invoice, contract, or other source-document number.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.document_reference.oneOf.0","typeLabel":"string"},{"description":"Invoice, contract, or other source-document number.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.document_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.document_reference","typeLabel":"string | null"},"documents":{"description":"Documents relevant to processing the claim.","items":{"description":"Resource representation with a native UUID `id`.","properties":{"created_at":{"description":"Time at which the document was submitted.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"download_url":{"oneOf":[{"description":"Authenticated API URL for downloading the document; null while its status is not `ready`.","format":"uri","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].download_url.oneOf.0","typeLabel":"string\u003curi>"},{"description":"Authenticated API URL for downloading the document; null while its status is not `ready`.","format":"uri","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].download_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].download_url","typeLabel":"string\u003curi> | null"},"failure_reason":{"oneOf":[{"type":"string","description":"Why processing failed when status is `failed`; `null` otherwise. `page_limit_exceeded`: PDF above the 100-page ceiling; `encrypted`: password-protected PDF; `corrupt`: bytes could not be parsed; `unsupported`: content type not accepted; `processing_failed`: any other processing error.","enum":["page_limit_exceeded","encrypted","corrupt","unsupported","processing_failed"],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].failure_reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].failure_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].failure_reason","typeLabel":"enum\u003cstring> | null"},"filename":{"description":"Original filename shown to users.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].filename","typeLabel":"string"},"id":{"description":"Stable identifier for this resource.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"mime_type":{"oneOf":[{"description":"Detected media type of the document.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].mime_type.oneOf.0","typeLabel":"string"},{"description":"Detected media type of the document.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].mime_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].mime_type","typeLabel":"string | null"},"parent":{"type":"object","description":"Resource that owns the document.","required":["id","type"],"properties":{"id":{"description":"Identifier of the resource that owns the document.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].parent.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","description":"Kind of resource that owns the document.\n\n* `claim` - claim\n* `message` - message\n* `request_to_client_answer` - request_to_client_answer\n* `rental_agreement` - rental_agreement\n* `enforceable_title` - enforceable_title","enum":["claim","message","request_to_client_answer","rental_agreement","enforceable_title"],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].parent.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].parent","typeLabel":"object"},"status":{"type":"string","description":"Document availability: `pending` while scanning or processing is incomplete; `ready` when processing permits download; `failed` when scanning or processing failed; `rejected` when the malware check rejected the file.","enum":["pending","ready","failed","rejected"],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"type":{"type":"string","description":"Business purpose of the document.","enum":["bank_statement","claim_statement","correspondence","enforceable_title","invoice","other","payment_proof","reminder","rental_agreement"],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updated_at":{"description":"Time at which document processing last changed.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"}},"required":["created_at","download_url","failure_reason","filename","id","mime_type","parent","status","type","updated_at"],"type":"object","uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.documents.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.documents","typeLabel":"object[]"},"due_date":{"oneOf":[{"description":"Date on which payment of the principal claim became due.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.due_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Date on which payment of the principal claim became due.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.due_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.due_date","typeLabel":"string\u003cdate> | null"},"events":{"description":"Stored contextual events associated with this resource.","items":{"description":"Stored events may likewise use retired or internal type values.","properties":{"description":{"oneOf":[{"description":"Optional description of the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.events.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"description":"Optional description of the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.events.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.events.items.[INDEX].description","typeLabel":"string | null"},"location":{"oneOf":[{"description":"Optional location associated with the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.events.items.[INDEX].location.oneOf.0","typeLabel":"string"},{"description":"Optional location associated with the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.events.items.[INDEX].location.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.events.items.[INDEX].location","typeLabel":"string | null"},"occurence":{"description":"Time at which the event occurred; the historical field spelling is intentional.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.events.items.[INDEX].occurence","typeLabel":"string\u003cdate-time>"},"title":{"description":"Human-readable title of the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.events.items.[INDEX].title","typeLabel":"string"},"type":{"description":"Stored event type; historical values may be outside today's input enum.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.events.items.[INDEX].type","typeLabel":"string"},"your_reference":{"oneOf":[{"description":"Your optional reference for the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.events.items.[INDEX].your_reference.oneOf.0","typeLabel":"string"},{"description":"Your optional reference for the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.events.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.events.items.[INDEX].your_reference","typeLabel":"string | null"}},"required":["description","location","occurence","title","type","your_reference"],"type":"object","uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.events.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.events","typeLabel":"object[]"},"id":{"description":"Stable identifier of this claim.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.id","typeLabel":"string\u003cuuid>"},"is_disputed":{"description":"Whether the debtor disputes the claim.","readOnly":true,"type":"boolean","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.is_disputed","typeLabel":"boolean"},"items":{"description":"Invoice or contract lines that make up the principal claim. API submissions are limited to 100 entries.","items":{"description":"Read representation of one invoice line.","properties":{"amount":{"type":"object","description":"Calculated line total: quantity multiplied by unit price.","required":["currency","value"],"properties":{"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","enum":["EUR"],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.\\items.items.[INDEX].amount.currency","typeLabel":"enum\u003cstring>"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.\\items.items.[INDEX].amount.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.\\items.items.[INDEX].amount","typeLabel":"object"},"description":{"description":"Goods or service represented by this invoice or contract line.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.\\items.items.[INDEX].description","typeLabel":"string"},"quantity":{"description":"Number of units represented by this line. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,10}(?:\\.[0-9]{1,6})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.\\items.items.[INDEX].quantity","typeLabel":"string"},"unit":{"oneOf":[{"description":"Unit of measure for the quantity, when applicable.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.\\items.items.[INDEX].unit.oneOf.0","typeLabel":"string"},{"description":"Unit of measure for the quantity, when applicable.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.\\items.items.[INDEX].unit.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.\\items.items.[INDEX].unit","typeLabel":"string | null"},"unit_price":{"type":"object","description":"Price of one unit before multiplying by quantity.","required":["currency","value"],"properties":{"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","enum":["EUR"],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.\\items.items.[INDEX].unit_price.currency","typeLabel":"enum\u003cstring>"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.\\items.items.[INDEX].unit_price.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.\\items.items.[INDEX].unit_price","typeLabel":"object"}},"required":["amount","description","quantity","unit","unit_price"],"type":"object","uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.\\items.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.\\items","typeLabel":"object[]"},"legal_basis":{"type":"object","description":"Contract or obligation that establishes the principal claim.","required":["claim_type_code","contract_date","description"],"properties":{"claim_type_code":{"oneOf":[{"description":"Code identifying the contract or transaction underlying the claim. H17 is commercial rent, H19 is residential rent, and K014 identifies receivable enforcement costs in titled orders. See [legal basis codes](https://docs.paywise.de/api-docs/case-management-api/concepts/claims#legal-basis-codes) for the full code-to-meaning table.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.legal_basis.claim_type_code.oneOf.0","typeLabel":"string"},{"description":"Code identifying the contract or transaction underlying the claim. H17 is commercial rent, H19 is residential rent, and K014 identifies receivable enforcement costs in titled orders. See [legal basis codes](https://docs.paywise.de/api-docs/case-management-api/concepts/claims#legal-basis-codes) for the full code-to-meaning table.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.legal_basis.claim_type_code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.legal_basis.claim_type_code","typeLabel":"string | null"},"contract_date":{"oneOf":[{"description":"Date on which the underlying contract or obligation arose.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.legal_basis.contract_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Date on which the underlying contract or obligation arose.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.legal_basis.contract_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.legal_basis.contract_date","typeLabel":"string\u003cdate> | null"},"description":{"oneOf":[{"description":"Terms or circumstances establishing the principal claim. API submissions are limited to 2000 characters.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.legal_basis.description.oneOf.0","typeLabel":"string"},{"description":"Terms or circumstances establishing the principal claim. API submissions are limited to 2000 characters.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.legal_basis.description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.legal_basis.description","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.legal_basis","typeLabel":"object"},"mandate_id":{"oneOf":[{"description":"Read-only accepted mandate identifier, or null before acceptance.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.mandate_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"description":"Read-only accepted mandate identifier, or null before acceptance.","format":"uuid","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.mandate_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.mandate_id","typeLabel":"string\u003cuuid> | null"},"metadata":{"description":"Stored metadata entries; duplicate types remain separate entries.","items":{"description":"Stored types may predate today's resource-specific input choices.","properties":{"type":{"description":"Stored metadata type; historical values may be outside today's input enum.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.metadata.items.[INDEX].type","typeLabel":"string"},"value":{"description":"Stored metadata value.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.metadata.items.[INDEX].value","typeLabel":"string"}},"required":["type","value"],"type":"object","uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.metadata.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.metadata","typeLabel":"object[]"},"order_id":{"description":"Read-only current order identifier. Internal review may change this relationship while the claim identifier and all claim-specific URLs remain stable.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.order_id","typeLabel":"string\u003cuuid>"},"payments":{"description":"Read-only payments attributed to this claim. Report subsequent payments through the stable claim payments URL, including after acceptance or an internal order move. Reporting requires case:payments:write.","items":{"description":"Read representation of one reported payment.","properties":{"amount":{"oneOf":[{"type":"object","description":"Amount received.","required":["currency","value"],"properties":{"currency":{"description":"Currency of the payment.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].amount.oneOf.0.currency","typeLabel":"string"},"value":{"description":"Amount received, expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].amount.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].amount.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].amount","typeLabel":"object | null"},"claim":{"oneOf":[{"type":"object","description":"Claim to which the payment was reported.","required":["document_reference","id","your_reference"],"properties":{"document_reference":{"oneOf":[{"description":"Invoice, contract, or source-document number of the claim.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].claim.oneOf.0.document_reference.oneOf.0","typeLabel":"string"},{"description":"Invoice, contract, or source-document number of the claim.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].claim.oneOf.0.document_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].claim.oneOf.0.document_reference","typeLabel":"string | null"},"id":{"description":"Identifier of the claim receiving the payment.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].claim.oneOf.0.id","typeLabel":"string\u003cuuid>"},"your_reference":{"oneOf":[{"description":"Your reference for the claim.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].claim.oneOf.0.your_reference.oneOf.0","typeLabel":"string"},{"description":"Your reference for the claim.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].claim.oneOf.0.your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].claim.oneOf.0.your_reference","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].claim.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].claim.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].claim","typeLabel":"object | null"},"created_at":{"description":"Time at which the payment was reported.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"id":{"description":"Stable identifier of this reported payment.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"mandate":{"oneOf":[{"type":"object","description":"Accepted case containing the claim.","required":["id","reference_number"],"properties":{"id":{"description":"Identifier of the accepted case receiving the payment.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].mandate.oneOf.0.id","typeLabel":"string\u003cuuid>"},"reference_number":{"description":"paywise case-file reference number.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].mandate.oneOf.0.reference_number","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].mandate.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].mandate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].mandate","typeLabel":"object | null"},"metadata":{"description":"Stored metadata entries; duplicate types remain separate entries.","items":{"description":"Stored types may predate today's resource-specific input choices.","properties":{"type":{"description":"Stored metadata type; historical values may be outside today's input enum.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].metadata.items.[INDEX].type","typeLabel":"string"},"value":{"description":"Stored metadata value.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].metadata.items.[INDEX].value","typeLabel":"string"}},"required":["type","value"],"type":"object","uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].metadata.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].metadata","typeLabel":"object[]"},"updated_at":{"description":"Time at which the payment record was last updated.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"},"value_date":{"description":"Date on which the payment was credited.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].value_date","typeLabel":"string\u003cdate>"},"your_reference":{"oneOf":[{"description":"Your reference for reconciling this payment.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].your_reference.oneOf.0","typeLabel":"string"},{"description":"Your reference for reconciling this payment.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].your_reference","typeLabel":"string | null"}},"required":["amount","claim","created_at","id","mandate","metadata","updated_at","value_date","your_reference"],"type":"object","uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.payments.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.payments","typeLabel":"object[]"},"principal_amount":{"oneOf":[{"type":"object","description":"Original principal amount including VAT, before charges and payments.","required":["currency","value"],"properties":{"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","enum":["EUR"],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.principal_amount.oneOf.0.currency","typeLabel":"enum\u003cstring>"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.principal_amount.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.principal_amount.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.principal_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.principal_amount","typeLabel":"object | null"},"reminders":{"description":"Payment reminders issued for this claim in chronological order. API submissions are limited to 50 entries.","items":{"description":"Read representation of one normalized reminder.","properties":{"date":{"oneOf":[{"description":"Date on which the payment reminder was issued.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.reminders.items.[INDEX].date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Date on which the payment reminder was issued.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.reminders.items.[INDEX].date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.reminders.items.[INDEX].date","typeLabel":"string\u003cdate> | null"},"due_date":{"oneOf":[{"description":"Payment deadline stated in the reminder, when present.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.reminders.items.[INDEX].due_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Payment deadline stated in the reminder, when present.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.reminders.items.[INDEX].due_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.reminders.items.[INDEX].due_date","typeLabel":"string\u003cdate> | null"},"id":{"oneOf":[{"description":"Stable identifier of this reminder.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.reminders.items.[INDEX].id.oneOf.0","typeLabel":"string\u003cuuid>"},{"description":"Stable identifier of this reminder.","format":"uuid","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.reminders.items.[INDEX].id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.reminders.items.[INDEX].id","typeLabel":"string\u003cuuid> | null"}},"required":["date","due_date","id"],"type":"object","uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.reminders.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.reminders","typeLabel":"object[]"},"status":{"type":"string","description":"Read-only effective claim lifecycle. Draft-only commands return 409 claim_not_editable after submission and 409 order_expired once the draft has passed its expires_at; payment and title commands retain their specific lifecycle conflict codes.","enum":["draft","submitted","awaiting_client_response","accepted","rejected","withdrawn"],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.status","typeLabel":"enum\u003cstring>"},"subject_matter":{"oneOf":[{"description":"Goods, services, or other obligation underlying the claim. API submissions are limited to 2000 characters.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.subject_matter.oneOf.0","typeLabel":"string"},{"description":"Goods, services, or other obligation underlying the claim. API submissions are limited to 2000 characters.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.subject_matter.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.subject_matter","typeLabel":"string | null"},"total_amount":{"oneOf":[{"type":"object","description":"Current open amount after charges and reported payments.","required":["currency","value"],"properties":{"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","enum":["EUR"],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.total_amount.oneOf.0.currency","typeLabel":"enum\u003cstring>"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.total_amount.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.total_amount.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.total_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.total_amount","typeLabel":"object | null"},"type":{"type":"string","description":"Literal receivable claim discriminator.","enum":["receivable"],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"updated_at":{"description":"Time at which the claim was last updated.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.updated_at","typeLabel":"string\u003cdate-time>"},"your_reference":{"oneOf":[{"description":"Your reference for this claim.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.your_reference.oneOf.0","typeLabel":"string"},{"description":"Your reference for this claim.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0.your_reference","typeLabel":"string | null"}},"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.0","typeLabel":"Receivable claim · object"},{"type":"object","title":"Titled claim","description":"A claim backed by an enforceable title. The title's amount, dates, and documents belong to `enforceable_title`.","required":["additional_debtor_ids","created_at","debtor_id","dispute_reason","document_reference","enforceable_title","events","id","is_disputed","mandate_id","metadata","order_id","payments","principal_amount","status","subject_matter","total_amount","type","updated_at","your_reference"],"properties":{"additional_debtor_ids":{"description":"Read-only additional debtor identifiers projected from the current order.","items":{"format":"uuid","type":"string","uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.additional_debtor_ids.items.[INDEX]","typeLabel":"string\u003cuuid>"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.additional_debtor_ids","typeLabel":"string\u003cuuid>[]"},"created_at":{"description":"Time at which the claim was created.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.created_at","typeLabel":"string\u003cdate-time>"},"debtor_id":{"oneOf":[{"description":"Read-only primary debtor identifier projected from the current order. Change party membership only on a draft order; debtor details use the debtor resource.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.debtor_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"description":"Read-only primary debtor identifier projected from the current order. Change party membership only on a draft order; debtor details use the debtor resource.","format":"uuid","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.debtor_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.debtor_id","typeLabel":"string\u003cuuid> | null"},"dispute_reason":{"oneOf":[{"description":"Debtor's stated reason for disputing the claim.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.dispute_reason.oneOf.0","typeLabel":"string"},{"description":"Debtor's stated reason for disputing the claim.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.dispute_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.dispute_reason","typeLabel":"string | null"},"document_reference":{"oneOf":[{"description":"Invoice, contract, or other source-document number.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.document_reference.oneOf.0","typeLabel":"string"},{"description":"Invoice, contract, or other source-document number.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.document_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.document_reference","typeLabel":"string | null"},"enforceable_title":{"oneOf":[{"type":"object","description":"Enforceable title that owns this claim's gross amount, legal metadata, and title documents.","required":["amount","created_at","documents","file_number","id","issued_on","issuing_authority","legally_binding_since","served_on","title_type","updated_at"],"properties":{"amount":{"oneOf":[{"type":"object","description":"Gross amount confirmed by the client and owned by the enforceable title.","required":["value"],"properties":{"value":{"description":"Gross title amount in major currency units, with at most two decimal places. Zero is accepted while drafting; the amount must be positive before finalization. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.amount.oneOf.0.value","typeLabel":"string"},"currency":{"type":"string","description":"Currency of the title amount; only EUR is supported.","default":"EUR","enum":["EUR"],"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.amount.oneOf.0.currency","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.amount.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.amount","typeLabel":"object | null"},"created_at":{"description":"Time at which the enforceable title was created.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.created_at","typeLabel":"string\u003cdate-time>"},"documents":{"description":"Documents owned by the title; one primary enforceable-title document is required before finalization.","items":{"description":"Resource representation with a native UUID `id`.","properties":{"created_at":{"description":"Time at which the document was submitted.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"download_url":{"oneOf":[{"description":"Authenticated API URL for downloading the document; null while its status is not `ready`.","format":"uri","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].download_url.oneOf.0","typeLabel":"string\u003curi>"},{"description":"Authenticated API URL for downloading the document; null while its status is not `ready`.","format":"uri","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].download_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].download_url","typeLabel":"string\u003curi> | null"},"failure_reason":{"oneOf":[{"type":"string","description":"Why processing failed when status is `failed`; `null` otherwise. `page_limit_exceeded`: PDF above the 100-page ceiling; `encrypted`: password-protected PDF; `corrupt`: bytes could not be parsed; `unsupported`: content type not accepted; `processing_failed`: any other processing error.","enum":["page_limit_exceeded","encrypted","corrupt","unsupported","processing_failed"],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].failure_reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].failure_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].failure_reason","typeLabel":"enum\u003cstring> | null"},"filename":{"description":"Original filename shown to users.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].filename","typeLabel":"string"},"id":{"description":"Stable identifier for this resource.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"mime_type":{"oneOf":[{"description":"Detected media type of the document.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].mime_type.oneOf.0","typeLabel":"string"},{"description":"Detected media type of the document.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].mime_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].mime_type","typeLabel":"string | null"},"parent":{"type":"object","description":"Resource that owns the document.","required":["id","type"],"properties":{"id":{"description":"Identifier of the resource that owns the document.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].parent.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","description":"Kind of resource that owns the document.\n\n* `claim` - claim\n* `message` - message\n* `request_to_client_answer` - request_to_client_answer\n* `rental_agreement` - rental_agreement\n* `enforceable_title` - enforceable_title","enum":["claim","message","request_to_client_answer","rental_agreement","enforceable_title"],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].parent.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].parent","typeLabel":"object"},"status":{"type":"string","description":"Document availability: `pending` while scanning or processing is incomplete; `ready` when processing permits download; `failed` when scanning or processing failed; `rejected` when the malware check rejected the file.","enum":["pending","ready","failed","rejected"],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"type":{"type":"string","description":"Business purpose of the document.","enum":["bank_statement","claim_statement","correspondence","enforceable_title","invoice","other","payment_proof","reminder","rental_agreement"],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updated_at":{"description":"Time at which document processing last changed.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"}},"required":["created_at","download_url","failure_reason","filename","id","mime_type","parent","status","type","updated_at"],"type":"object","uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents","typeLabel":"object[]"},"file_number":{"description":"Official file or reference number shown on the title.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.file_number","typeLabel":"string"},"id":{"description":"Stable identifier of the enforceable title.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.id","typeLabel":"string\u003cuuid>"},"issued_on":{"oneOf":[{"description":"Date on which the enforceable title was issued.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.issued_on.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Date on which the enforceable title was issued.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.issued_on.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.issued_on","typeLabel":"string\u003cdate> | null"},"issuing_authority":{"description":"Court, notary, or other authority that issued the title.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.issuing_authority","typeLabel":"string"},"legally_binding_since":{"oneOf":[{"description":"Optional date from which the title is legally binding; it cannot precede issued_on.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.legally_binding_since.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Optional date from which the title is legally binding; it cannot precede issued_on.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.legally_binding_since.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.legally_binding_since","typeLabel":"string\u003cdate> | null"},"served_on":{"oneOf":[{"description":"Optional date on which the title was served; it cannot precede issued_on.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.served_on.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Optional date on which the title was served; it cannot precede issued_on.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.served_on.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.served_on","typeLabel":"string\u003cdate> | null"},"title_type":{"oneOf":[{"type":"string","description":"Legal title category: enforcement_order = Vollstreckungsbescheid; default_judgment = Versäumnisurteil; final_judgment = Endurteil; acknowledgment_judgment = Anerkenntnisurteil; reservation_judgment = Vorbehaltsurteil; court_settlement = Gerichtlicher Vergleich; enforceable_notarial_deed = Vollstreckbare notarielle Urkunde; cost_assessment_order = Kostenfestsetzungsbeschluss; other = Sonstiger Titel.","enum":["enforcement_order","default_judgment","final_judgment","acknowledgment_judgment","reservation_judgment","court_settlement","enforceable_notarial_deed","cost_assessment_order","other"],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.title_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.title_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.title_type","typeLabel":"enum\u003cstring> | null"},"updated_at":{"description":"Time at which the enforceable title last changed.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.updated_at","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.enforceable_title","typeLabel":"object | null"},"events":{"description":"Stored contextual events associated with this resource.","items":{"description":"Stored events may likewise use retired or internal type values.","properties":{"description":{"oneOf":[{"description":"Optional description of the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.events.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"description":"Optional description of the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.events.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.events.items.[INDEX].description","typeLabel":"string | null"},"location":{"oneOf":[{"description":"Optional location associated with the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.events.items.[INDEX].location.oneOf.0","typeLabel":"string"},{"description":"Optional location associated with the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.events.items.[INDEX].location.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.events.items.[INDEX].location","typeLabel":"string | null"},"occurence":{"description":"Time at which the event occurred; the historical field spelling is intentional.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.events.items.[INDEX].occurence","typeLabel":"string\u003cdate-time>"},"title":{"description":"Human-readable title of the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.events.items.[INDEX].title","typeLabel":"string"},"type":{"description":"Stored event type; historical values may be outside today's input enum.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.events.items.[INDEX].type","typeLabel":"string"},"your_reference":{"oneOf":[{"description":"Your optional reference for the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.events.items.[INDEX].your_reference.oneOf.0","typeLabel":"string"},{"description":"Your optional reference for the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.events.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.events.items.[INDEX].your_reference","typeLabel":"string | null"}},"required":["description","location","occurence","title","type","your_reference"],"type":"object","uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.events.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.events","typeLabel":"object[]"},"id":{"description":"Stable identifier of this claim.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.id","typeLabel":"string\u003cuuid>"},"is_disputed":{"description":"Whether the debtor disputes the claim.","readOnly":true,"type":"boolean","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.is_disputed","typeLabel":"boolean"},"mandate_id":{"oneOf":[{"description":"Read-only accepted mandate identifier, or null before acceptance.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.mandate_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"description":"Read-only accepted mandate identifier, or null before acceptance.","format":"uuid","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.mandate_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.mandate_id","typeLabel":"string\u003cuuid> | null"},"metadata":{"description":"Stored metadata entries; duplicate types remain separate entries.","items":{"description":"Stored types may predate today's resource-specific input choices.","properties":{"type":{"description":"Stored metadata type; historical values may be outside today's input enum.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.metadata.items.[INDEX].type","typeLabel":"string"},"value":{"description":"Stored metadata value.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.metadata.items.[INDEX].value","typeLabel":"string"}},"required":["type","value"],"type":"object","uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.metadata.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.metadata","typeLabel":"object[]"},"order_id":{"description":"Read-only current order identifier. Internal review may change this relationship while the claim identifier and all claim-specific URLs remain stable.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.order_id","typeLabel":"string\u003cuuid>"},"payments":{"description":"Read-only payments attributed to this claim. Report subsequent payments through the stable claim payments URL, including after acceptance or an internal order move. Reporting requires case:payments:write.","items":{"description":"Read representation of one reported payment.","properties":{"amount":{"oneOf":[{"type":"object","description":"Amount received.","required":["currency","value"],"properties":{"currency":{"description":"Currency of the payment.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].amount.oneOf.0.currency","typeLabel":"string"},"value":{"description":"Amount received, expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].amount.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].amount.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].amount","typeLabel":"object | null"},"claim":{"oneOf":[{"type":"object","description":"Claim to which the payment was reported.","required":["document_reference","id","your_reference"],"properties":{"document_reference":{"oneOf":[{"description":"Invoice, contract, or source-document number of the claim.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].claim.oneOf.0.document_reference.oneOf.0","typeLabel":"string"},{"description":"Invoice, contract, or source-document number of the claim.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].claim.oneOf.0.document_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].claim.oneOf.0.document_reference","typeLabel":"string | null"},"id":{"description":"Identifier of the claim receiving the payment.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].claim.oneOf.0.id","typeLabel":"string\u003cuuid>"},"your_reference":{"oneOf":[{"description":"Your reference for the claim.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].claim.oneOf.0.your_reference.oneOf.0","typeLabel":"string"},{"description":"Your reference for the claim.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].claim.oneOf.0.your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].claim.oneOf.0.your_reference","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].claim.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].claim.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].claim","typeLabel":"object | null"},"created_at":{"description":"Time at which the payment was reported.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"id":{"description":"Stable identifier of this reported payment.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"mandate":{"oneOf":[{"type":"object","description":"Accepted case containing the claim.","required":["id","reference_number"],"properties":{"id":{"description":"Identifier of the accepted case receiving the payment.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].mandate.oneOf.0.id","typeLabel":"string\u003cuuid>"},"reference_number":{"description":"paywise case-file reference number.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].mandate.oneOf.0.reference_number","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].mandate.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].mandate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].mandate","typeLabel":"object | null"},"metadata":{"description":"Stored metadata entries; duplicate types remain separate entries.","items":{"description":"Stored types may predate today's resource-specific input choices.","properties":{"type":{"description":"Stored metadata type; historical values may be outside today's input enum.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].metadata.items.[INDEX].type","typeLabel":"string"},"value":{"description":"Stored metadata value.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].metadata.items.[INDEX].value","typeLabel":"string"}},"required":["type","value"],"type":"object","uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].metadata.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].metadata","typeLabel":"object[]"},"updated_at":{"description":"Time at which the payment record was last updated.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"},"value_date":{"description":"Date on which the payment was credited.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].value_date","typeLabel":"string\u003cdate>"},"your_reference":{"oneOf":[{"description":"Your reference for reconciling this payment.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].your_reference.oneOf.0","typeLabel":"string"},{"description":"Your reference for reconciling this payment.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].your_reference","typeLabel":"string | null"}},"required":["amount","claim","created_at","id","mandate","metadata","updated_at","value_date","your_reference"],"type":"object","uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.payments.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.payments","typeLabel":"object[]"},"principal_amount":{"oneOf":[{"type":"object","description":"Always null for a titled claim; use enforceable_title.amount for the authoritative gross amount.","required":["currency","value"],"properties":{"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","enum":["EUR"],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.principal_amount.oneOf.0.currency","typeLabel":"enum\u003cstring>"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.principal_amount.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.principal_amount.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.principal_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.principal_amount","typeLabel":"object | null"},"status":{"type":"string","description":"Read-only effective claim lifecycle. Draft-only commands return 409 claim_not_editable after submission and 409 order_expired once the draft has passed its expires_at; payment and title commands retain their specific lifecycle conflict codes.","enum":["draft","submitted","awaiting_client_response","accepted","rejected","withdrawn"],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.status","typeLabel":"enum\u003cstring>"},"subject_matter":{"oneOf":[{"description":"Goods, services, or other obligation underlying the claim. API submissions are limited to 2000 characters.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.subject_matter.oneOf.0","typeLabel":"string"},{"description":"Goods, services, or other obligation underlying the claim. API submissions are limited to 2000 characters.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.subject_matter.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.subject_matter","typeLabel":"string | null"},"total_amount":{"oneOf":[{"type":"object","description":"Authoritative gross enforceable-title amount; reported payments are exposed separately and do not reduce it.","required":["currency","value"],"properties":{"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","enum":["EUR"],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.total_amount.oneOf.0.currency","typeLabel":"enum\u003cstring>"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.total_amount.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.total_amount.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.total_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.total_amount","typeLabel":"object | null"},"type":{"type":"string","description":"Literal titled claim discriminator.","enum":["titled"],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"updated_at":{"description":"Time at which the claim was last updated.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.updated_at","typeLabel":"string\u003cdate-time>"},"your_reference":{"oneOf":[{"description":"Your reference for this claim.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.your_reference.oneOf.0","typeLabel":"string"},{"description":"Your reference for this claim.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1.your_reference","typeLabel":"string | null"}},"uniqueKey":"oneOf.1.claims.items.[INDEX].oneOf.1","typeLabel":"Titled claim · object"}],"uniqueKey":"oneOf.1.claims.items.[INDEX]","typeLabel":"Receivable claim · object | Titled claim · object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.1.claims","typeLabel":"(Receivable claim · object | Titled claim · object)[]"},"confirmation_email":{"oneOf":[{"description":"Address receiving the order-entry confirmation, when requested.","format":"email","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.confirmation_email.oneOf.0","typeLabel":"string\u003cemail>"},{"description":"Address receiving the order-entry confirmation, when requested.","format":"email","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.confirmation_email.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.confirmation_email","typeLabel":"string\u003cemail> | null"},"created_at":{"description":"Time at which the order was created.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.created_at","typeLabel":"string\u003cdate-time>"},"creditor_obligation_fulfilled":{"oneOf":[{"description":"Whether you fully performed your obligation to the debtor.","readOnly":true,"type":"boolean","isRequired":true,"uniqueKey":"oneOf.1.creditor_obligation_fulfilled.oneOf.0","typeLabel":"boolean"},{"description":"Whether you fully performed your obligation to the debtor.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.creditor_obligation_fulfilled.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.creditor_obligation_fulfilled","typeLabel":"boolean | null"},"debtor":{"type":"object","description":"Inline summary of the primary debtor. Retrieve full details with GET /v2/debtors/{id}/ using its id.","required":["acting_as","events","id","legal_form","metadata","organization","person","your_reference"],"properties":{"acting_as":{"type":"string","description":"Whether the debtor incurred the obligation as a consumer or in a business capacity.\n\n* `consumer` - consumer\n* `business` - business","enum":["consumer","business"],"isRequired":true,"uniqueKey":"oneOf.1.debtor.acting_as","typeLabel":"enum\u003cstring>"},"events":{"description":"Stored contextual events associated with this resource.","items":{"description":"Stored events may likewise use retired or internal type values.","properties":{"description":{"oneOf":[{"description":"Optional description of the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.debtor.events.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"description":"Optional description of the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.debtor.events.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.debtor.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.debtor.events.items.[INDEX].location.oneOf.0","typeLabel":"string"},{"description":"Optional location associated with the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.debtor.events.items.[INDEX].location.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.debtor.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.debtor.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.debtor.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.debtor.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.debtor.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.debtor.events.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.debtor.events.items.[INDEX].your_reference","typeLabel":"string | null"}},"required":["description","location","occurence","title","type","your_reference"],"type":"object","uniqueKey":"oneOf.1.debtor.events.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.1.debtor.events","typeLabel":"object[]"},"id":{"description":"Stable identifier of this debtor.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.debtor.id","typeLabel":"string\u003cuuid>"},"legal_form":{"oneOf":[{"description":"Permanent public legal-form code; look up its label and representation rules with GET /v2/legal-forms/. Null for consumers.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.debtor.legal_form.oneOf.0","typeLabel":"string"},{"description":"Permanent public legal-form code; look up its label and representation rules with GET /v2/legal-forms/. Null for consumers.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.debtor.legal_form.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.debtor.legal_form","typeLabel":"string | null"},"metadata":{"description":"Stored metadata entries; duplicate types remain separate entries.","items":{"description":"Stored types may predate today's resource-specific input choices.","properties":{"type":{"description":"Stored metadata type; historical values may be outside today's input enum.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.debtor.metadata.items.[INDEX].type","typeLabel":"string"},"value":{"description":"Stored metadata value.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.debtor.metadata.items.[INDEX].value","typeLabel":"string"}},"required":["type","value"],"type":"object","uniqueKey":"oneOf.1.debtor.metadata.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.1.debtor.metadata","typeLabel":"object[]"},"organization":{"oneOf":[{"type":"object","description":"Organization identity for a business debtor.","required":["commercial_register","commercial_registration_number","name"],"properties":{"commercial_register":{"oneOf":[{"description":"Register court or authority holding the registration.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.debtor.organization.oneOf.0.commercial_register.oneOf.0","typeLabel":"string"},{"description":"Register court or authority holding the registration.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.debtor.organization.oneOf.0.commercial_register.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.debtor.organization.oneOf.0.commercial_register","typeLabel":"string | null"},"commercial_registration_number":{"oneOf":[{"description":"Commercial, association, or partnership register number.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.debtor.organization.oneOf.0.commercial_registration_number.oneOf.0","typeLabel":"string"},{"description":"Commercial, association, or partnership register number.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.debtor.organization.oneOf.0.commercial_registration_number.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.debtor.organization.oneOf.0.commercial_registration_number","typeLabel":"string | null"},"name":{"description":"Registered or trading name of the organization.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.debtor.organization.oneOf.0.name","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.1.debtor.organization.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.1.debtor.organization.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.debtor.organization","typeLabel":"object | null"},"person":{"oneOf":[{"type":"object","description":"Natural-person identity for a consumer or sole proprietor.","required":["birth_date","first_name","last_name","salutation"],"properties":{"birth_date":{"oneOf":[{"description":"Date of birth used to identify the natural person.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.debtor.person.oneOf.0.birth_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Date of birth used to identify the natural person.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.debtor.person.oneOf.0.birth_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.debtor.person.oneOf.0.birth_date","typeLabel":"string\u003cdate> | null"},"first_name":{"description":"Given name of the natural person.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.debtor.person.oneOf.0.first_name","typeLabel":"string"},"last_name":{"description":"Family name of the natural person.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.debtor.person.oneOf.0.last_name","typeLabel":"string"},"salutation":{"oneOf":[{"type":"string","description":"Salutation of the natural person; null if no supported salutation is stored.","enum":["mr","ms","mx"],"isRequired":true,"uniqueKey":"oneOf.1.debtor.person.oneOf.0.salutation.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.1.debtor.person.oneOf.0.salutation.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.debtor.person.oneOf.0.salutation","typeLabel":"enum\u003cstring> | null"}},"isRequired":true,"uniqueKey":"oneOf.1.debtor.person.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.1.debtor.person.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.debtor.person","typeLabel":"object | null"},"your_reference":{"oneOf":[{"description":"Your reference for this debtor.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.debtor.your_reference.oneOf.0","typeLabel":"string"},{"description":"Your reference for this debtor.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.debtor.your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.debtor.your_reference","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"oneOf.1.debtor","typeLabel":"object"},"expires_at":{"oneOf":[{"description":"Time at which this API-created draft expires: updated_at plus 90 days, refreshed by every successful draft change. Once it has passed, the order reads expired and every change answers 409 order_expired until the daily cleanup deletes it. Null once the order is finalized and for orders created in the portal.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Time at which this API-created draft expires: updated_at plus 90 days, refreshed by every successful draft change. Once it has passed, the order reads expired and every change answers 409 order_expired until the daily cleanup deletes it. Null once the order is finalized and for orders created in the portal.","format":"date-time","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.expires_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.expires_at","typeLabel":"string\u003cdate-time> | null"},"id":{"description":"Stable identifier of this order.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.id","typeLabel":"string\u003cuuid>"},"mandate":{"oneOf":[{"description":"Accepted case created from this order, when available.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.mandate.oneOf.0","typeLabel":"string\u003cuuid>"},{"description":"Accepted case created from this order, when available.","format":"uuid","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.mandate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.mandate","typeLabel":"string\u003cuuid> | null"},"merged_into":{"oneOf":[{"description":"Surviving order when this order was merged during review.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.merged_into.oneOf.0","typeLabel":"string\u003cuuid>"},{"description":"Surviving order when this order was merged during review.","format":"uuid","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.merged_into.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.merged_into","typeLabel":"string\u003cuuid> | null"},"rejection":{"oneOf":[{"type":"object","description":"Why paywise declined the order: reason, time, notified recipients, and the standard reason's key. Null unless status is rejected.","required":["code","notified_to","reason","rejected_at"],"properties":{"code":{"oneOf":[{"description":"Stable machine-readable key of the standard rejection reason when the rejection used one; null for an individually worded rejection.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.rejection.oneOf.0.code.oneOf.0","typeLabel":"string"},{"description":"Stable machine-readable key of the standard rejection reason when the rejection used one; null for an individually worded rejection.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.rejection.oneOf.0.code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.rejection.oneOf.0.code","typeLabel":"string | null"},"notified_to":{"description":"E-mail addresses of your company's status-update recipients the rejection notice was delivered to. Empty when no notice was sent.","items":{"format":"email","type":"string","uniqueKey":"oneOf.1.rejection.oneOf.0.notified_to.items.[INDEX]","typeLabel":"string\u003cemail>"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.1.rejection.oneOf.0.notified_to","typeLabel":"string\u003cemail>[]"},"reason":{"oneOf":[{"description":"Plain-text reason paywise gave for rejecting the order: the wording of the rejection notice with formatting removed.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.rejection.oneOf.0.reason.oneOf.0","typeLabel":"string"},{"description":"Plain-text reason paywise gave for rejecting the order: the wording of the rejection notice with formatting removed.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.rejection.oneOf.0.reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.rejection.oneOf.0.reason","typeLabel":"string | null"},"rejected_at":{"description":"Time at which paywise rejected the order.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.rejection.oneOf.0.rejected_at","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"oneOf.1.rejection.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.1.rejection.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.rejection","typeLabel":"object | null"},"rental_agreement":{"oneOf":[{"type":"object","description":"Rental-agreement singleton owned by this order.","required":["contract_date","created_at","documents","due_rule","id","monthly_rent","property_address","updated_at"],"properties":{"contract_date":{"oneOf":[{"description":"Date on which the rental contract was concluded; this is not the tenancy start or move-in date.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.rental_agreement.oneOf.0.contract_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Date on which the rental contract was concluded; this is not the tenancy start or move-in date.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.1.rental_agreement.oneOf.0.contract_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.rental_agreement.oneOf.0.contract_date","typeLabel":"string\u003cdate> | null"},"created_at":{"description":"Time at which the rental agreement was created.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.rental_agreement.oneOf.0.created_at","typeLabel":"string\u003cdate-time>"},"documents":{"description":"Documents owned by the agreement, including the optional rental-agreement and claim-statement primary slots.","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.rental_agreement.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.rental_agreement.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.rental_agreement.oneOf.0.documents.items.[INDEX].download_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.rental_agreement.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.rental_agreement.oneOf.0.documents.items.[INDEX].failure_reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.1.rental_agreement.oneOf.0.documents.items.[INDEX].failure_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.rental_agreement.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.rental_agreement.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.rental_agreement.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.rental_agreement.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.rental_agreement.oneOf.0.documents.items.[INDEX].mime_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.rental_agreement.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.rental_agreement.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.rental_agreement.oneOf.0.documents.items.[INDEX].parent.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"oneOf.1.rental_agreement.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.rental_agreement.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.rental_agreement.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.rental_agreement.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.rental_agreement.oneOf.0.documents.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.1.rental_agreement.oneOf.0.documents","typeLabel":"object[]"},"due_rule":{"oneOf":[{"type":"object","description":"Rule used to derive H17/H19 rental due dates. Null means the default third German business day of the rental month applies; explicit claim-level dates override the derived result.","required":["day","kind"],"properties":{"day":{"description":"Day number from 1 to 31 within the rental month: calendar day for calendar_day, or ordinal business day for business_day. If the month has fewer such days, the last applicable day is used.","maximum":31,"minimum":1,"type":"integer","isRequired":true,"uniqueKey":"oneOf.1.rental_agreement.oneOf.0.due_rule.oneOf.0.day","typeLabel":"integer"},"kind":{"description":"How to interpret day: calendar_day counts all dates; business_day counts Monday through Friday excluding German federal public holidays. State-specific holidays are not considered.","enum":["calendar_day","business_day"],"type":"string","isRequired":true,"uniqueKey":"oneOf.1.rental_agreement.oneOf.0.due_rule.oneOf.0.kind","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"oneOf.1.rental_agreement.oneOf.0.due_rule.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.1.rental_agreement.oneOf.0.due_rule.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.rental_agreement.oneOf.0.due_rule","typeLabel":"object | null"},"id":{"description":"Stable identifier of the rental agreement.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.rental_agreement.oneOf.0.id","typeLabel":"string\u003cuuid>"},"monthly_rent":{"oneOf":[{"type":"object","description":"Total recurring Warmmiete, including ancillary-cost prepayments; it does not constrain an individual claim 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.rental_agreement.oneOf.0.monthly_rent.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.rental_agreement.oneOf.0.monthly_rent.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.1.rental_agreement.oneOf.0.monthly_rent.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.1.rental_agreement.oneOf.0.monthly_rent.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.rental_agreement.oneOf.0.monthly_rent","typeLabel":"object | null"},"property_address":{"oneOf":[{"type":"object","description":"Complete address of the rented property, even when it matches the debtor address.","required":["city","country","postal_code","street"],"properties":{"city":{"description":"City of the rented property.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.rental_agreement.oneOf.0.property_address.oneOf.0.city","typeLabel":"string"},"country":{"description":"ISO 3166-1 alpha-2 country code of the rented property.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.rental_agreement.oneOf.0.property_address.oneOf.0.country","typeLabel":"string"},"postal_code":{"description":"Postal code of the rented property.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.rental_agreement.oneOf.0.property_address.oneOf.0.postal_code","typeLabel":"string"},"street":{"description":"Street and house number of the rented property.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.rental_agreement.oneOf.0.property_address.oneOf.0.street","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.1.rental_agreement.oneOf.0.property_address.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.1.rental_agreement.oneOf.0.property_address.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.rental_agreement.oneOf.0.property_address","typeLabel":"object | null"},"updated_at":{"description":"Time at which the rental agreement last changed.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.rental_agreement.oneOf.0.updated_at","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"oneOf.1.rental_agreement.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.1.rental_agreement.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.rental_agreement","typeLabel":"object | null"},"starting_approach":{"oneOf":[{"type":"string","description":"Initial collection route: extrajudicial starts out of court; judicial starts by applying for a payment order (Mahnbescheid). Null while this decision is unset.","enum":["extrajudicial","judicial"],"isRequired":true,"uniqueKey":"oneOf.1.starting_approach.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.1.starting_approach.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.starting_approach","typeLabel":"enum\u003cstring> | null"},"status":{"type":"string","description":"Order lifecycle state: draft is editable; submitted awaits processing; awaiting_client_response requires client input; accepted has entered case processing; rejected was declined; withdrawn was cancelled by the client; expired passed its draft deadline and accepts no further changes (409 order_expired) until the daily cleanup deletes it; merged points to the surviving order in merged_into.","enum":["draft","submitted","awaiting_client_response","accepted","rejected","withdrawn","expired","merged"],"isRequired":true,"uniqueKey":"oneOf.1.status","typeLabel":"enum\u003cstring>"},"totals":{"type":"object","description":"Financial totals calculated across the order's claims.","required":["charges","main_claims","order_value","payments"],"properties":{"charges":{"type":"object","description":"Sum of itemized additional charges on receivable claims.","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.totals.charges.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.totals.charges.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.1.totals.charges","typeLabel":"object"},"main_claims":{"type":"object","description":"Sum of receivable-claim principal amounts plus gross enforceable-title amounts.","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.totals.main_claims.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.totals.main_claims.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.1.totals.main_claims","typeLabel":"object"},"order_value":{"type":"object","description":"Current open value for invoice and rental orders; for titled orders, gross main_claims plus charges, with payments reported separately.","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.totals.order_value.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.totals.order_value.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.1.totals.order_value","typeLabel":"object"},"payments":{"type":"object","description":"Sum of payments already reported for the order's claims.","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.totals.payments.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.totals.payments.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.1.totals.payments","typeLabel":"object"}},"isRequired":true,"uniqueKey":"oneOf.1.totals","typeLabel":"object"},"type":{"type":"string","description":"Literal rental order discriminator.","enum":["rental"],"isRequired":true,"uniqueKey":"oneOf.1.type","typeLabel":"enum\u003cstring>"},"updated_at":{"description":"Time at which the order was last updated.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"oneOf.1","typeLabel":"Rental order · object"},{"type":"object","title":"Titled order","description":"A titled order contains titled claims and may include receivable claims for enforcement costs. It exposes `success_fee_confirmed` and omits `starting_approach` and `creditor_obligation_fulfilled`; enforcement is implicit.\n\nRead representation of an order.\n\n`status` is derived from the order's submission and review progress;\n`mandate` names the\ncreated mandate once the order is accepted; `merged_into` names the\nsurviving order when this order was merged away during review.","required":["additional_debtors","claims","confirmation_email","created_at","debtor","expires_at","id","mandate","merged_into","rejection","status","success_fee_confirmed","totals","type","updated_at"],"properties":{"additional_debtors":{"description":"Inline summaries of the additional debtors. Retrieve each debtor's full details with GET /v2/debtors/{id}/ using its id. Replace membership through PATCH /v2/orders/{id}/ while the order is a draft. API submissions are limited to 10 additional debtors.","items":{"properties":{"acting_as":{"type":"string","description":"Whether the debtor incurred the obligation as a consumer or in a business capacity.\n\n* `consumer` - consumer\n* `business` - business","enum":["consumer","business"],"isRequired":true,"uniqueKey":"oneOf.2.additional_debtors.items.[INDEX].acting_as","typeLabel":"enum\u003cstring>"},"events":{"description":"Stored contextual events associated with this resource.","items":{"description":"Stored events may likewise use retired or internal type values.","properties":{"description":{"oneOf":[{"description":"Optional description of the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.additional_debtors.items.[INDEX].events.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"description":"Optional description of the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.additional_debtors.items.[INDEX].events.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.additional_debtors.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.2.additional_debtors.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.2.additional_debtors.items.[INDEX].events.items.[INDEX].location.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.additional_debtors.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.2.additional_debtors.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.2.additional_debtors.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.2.additional_debtors.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.2.additional_debtors.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.2.additional_debtors.items.[INDEX].events.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.additional_debtors.items.[INDEX].events.items.[INDEX].your_reference","typeLabel":"string | null"}},"required":["description","location","occurence","title","type","your_reference"],"type":"object","uniqueKey":"oneOf.2.additional_debtors.items.[INDEX].events.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.2.additional_debtors.items.[INDEX].events","typeLabel":"object[]"},"id":{"description":"Stable identifier of this debtor.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.additional_debtors.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"legal_form":{"oneOf":[{"description":"Permanent public legal-form code; look up its label and representation rules with GET /v2/legal-forms/. Null for consumers.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.additional_debtors.items.[INDEX].legal_form.oneOf.0","typeLabel":"string"},{"description":"Permanent public legal-form code; look up its label and representation rules with GET /v2/legal-forms/. Null for consumers.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.additional_debtors.items.[INDEX].legal_form.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.additional_debtors.items.[INDEX].legal_form","typeLabel":"string | null"},"metadata":{"description":"Stored metadata entries; duplicate types remain separate entries.","items":{"description":"Stored types may predate today's resource-specific input choices.","properties":{"type":{"description":"Stored metadata type; historical values may be outside today's input enum.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.additional_debtors.items.[INDEX].metadata.items.[INDEX].type","typeLabel":"string"},"value":{"description":"Stored metadata value.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.additional_debtors.items.[INDEX].metadata.items.[INDEX].value","typeLabel":"string"}},"required":["type","value"],"type":"object","uniqueKey":"oneOf.2.additional_debtors.items.[INDEX].metadata.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.2.additional_debtors.items.[INDEX].metadata","typeLabel":"object[]"},"organization":{"oneOf":[{"type":"object","description":"Organization identity for a business debtor.","required":["commercial_register","commercial_registration_number","name"],"properties":{"commercial_register":{"oneOf":[{"description":"Register court or authority holding the registration.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.additional_debtors.items.[INDEX].organization.oneOf.0.commercial_register.oneOf.0","typeLabel":"string"},{"description":"Register court or authority holding the registration.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.additional_debtors.items.[INDEX].organization.oneOf.0.commercial_register.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.additional_debtors.items.[INDEX].organization.oneOf.0.commercial_register","typeLabel":"string | null"},"commercial_registration_number":{"oneOf":[{"description":"Commercial, association, or partnership register number.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.additional_debtors.items.[INDEX].organization.oneOf.0.commercial_registration_number.oneOf.0","typeLabel":"string"},{"description":"Commercial, association, or partnership register number.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.additional_debtors.items.[INDEX].organization.oneOf.0.commercial_registration_number.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.additional_debtors.items.[INDEX].organization.oneOf.0.commercial_registration_number","typeLabel":"string | null"},"name":{"description":"Registered or trading name of the organization.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.additional_debtors.items.[INDEX].organization.oneOf.0.name","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.2.additional_debtors.items.[INDEX].organization.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.2.additional_debtors.items.[INDEX].organization.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.additional_debtors.items.[INDEX].organization","typeLabel":"object | null"},"person":{"oneOf":[{"type":"object","description":"Natural-person identity for a consumer or sole proprietor.","required":["birth_date","first_name","last_name","salutation"],"properties":{"birth_date":{"oneOf":[{"description":"Date of birth used to identify the natural person.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.additional_debtors.items.[INDEX].person.oneOf.0.birth_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Date of birth used to identify the natural person.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.additional_debtors.items.[INDEX].person.oneOf.0.birth_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.additional_debtors.items.[INDEX].person.oneOf.0.birth_date","typeLabel":"string\u003cdate> | null"},"first_name":{"description":"Given name of the natural person.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.additional_debtors.items.[INDEX].person.oneOf.0.first_name","typeLabel":"string"},"last_name":{"description":"Family name of the natural person.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.additional_debtors.items.[INDEX].person.oneOf.0.last_name","typeLabel":"string"},"salutation":{"oneOf":[{"type":"string","description":"Salutation of the natural person; null if no supported salutation is stored.","enum":["mr","ms","mx"],"isRequired":true,"uniqueKey":"oneOf.2.additional_debtors.items.[INDEX].person.oneOf.0.salutation.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.2.additional_debtors.items.[INDEX].person.oneOf.0.salutation.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.additional_debtors.items.[INDEX].person.oneOf.0.salutation","typeLabel":"enum\u003cstring> | null"}},"isRequired":true,"uniqueKey":"oneOf.2.additional_debtors.items.[INDEX].person.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.2.additional_debtors.items.[INDEX].person.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.additional_debtors.items.[INDEX].person","typeLabel":"object | null"},"your_reference":{"oneOf":[{"description":"Your reference for this debtor.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.additional_debtors.items.[INDEX].your_reference.oneOf.0","typeLabel":"string"},{"description":"Your reference for this debtor.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.additional_debtors.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.additional_debtors.items.[INDEX].your_reference","typeLabel":"string | null"}},"required":["acting_as","events","id","legal_form","metadata","organization","person","your_reference"],"type":"object","uniqueKey":"oneOf.2.additional_debtors.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.2.additional_debtors","typeLabel":"object[]"},"claims":{"description":"Titled claims owning enforceable titles, plus any receivable claims for enforcement costs (K014). At least one complete titled claim is required before finalization. API submissions are limited to 50 claims per order.","items":{"oneOf":[{"type":"object","title":"Receivable claim","description":"A receivable claim based on an invoice, rent, or another obligation. Its principal amount, dates, charges, and documents belong to the claim.","required":["additional_charges","additional_charges_amount","additional_debtor_ids","created_at","debtor_id","delay_date","dispute_reason","document_date","document_reference","documents","due_date","events","id","is_disputed","items","legal_basis","mandate_id","metadata","order_id","payments","principal_amount","reminders","status","subject_matter","total_amount","type","updated_at","your_reference"],"properties":{"additional_charges":{"description":"Itemized incidental claims such as reminder or bank fees. API submissions are limited to 50 entries.","items":{"description":"Read representation of one canonical additional charge.","properties":{"amount":{"type":"object","description":"Amount of the additional charge.","required":["currency","value"],"properties":{"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","enum":["EUR"],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].amount.currency","typeLabel":"enum\u003cstring>"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].amount.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].amount","typeLabel":"object"},"events":{"description":"Stored contextual events associated with this resource.","items":{"description":"Stored events may likewise use retired or internal type values.","properties":{"description":{"oneOf":[{"description":"Optional description of the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"description":"Optional description of the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].description","typeLabel":"string | null"},"location":{"oneOf":[{"description":"Optional location associated with the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].location.oneOf.0","typeLabel":"string"},{"description":"Optional location associated with the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].location.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].location","typeLabel":"string | null"},"occurence":{"description":"Time at which the event occurred; the historical field spelling is intentional.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].occurence","typeLabel":"string\u003cdate-time>"},"title":{"description":"Human-readable title of the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].title","typeLabel":"string"},"type":{"description":"Stored event type; historical values may be outside today's input enum.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].type","typeLabel":"string"},"your_reference":{"oneOf":[{"description":"Your optional reference for the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].your_reference.oneOf.0","typeLabel":"string"},{"description":"Your optional reference for the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX].your_reference","typeLabel":"string | null"}},"required":["description","location","occurence","title","type","your_reference"],"type":"object","uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].events","typeLabel":"object[]"},"id":{"description":"Stable identifier of this additional charge.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"metadata":{"description":"Stored metadata entries; duplicate types remain separate entries.","items":{"description":"Stored types may predate today's resource-specific input choices.","properties":{"type":{"description":"Stored metadata type; historical values may be outside today's input enum.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].metadata.items.[INDEX].type","typeLabel":"string"},"value":{"description":"Stored metadata value.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].metadata.items.[INDEX].value","typeLabel":"string"}},"required":["type","value"],"type":"object","uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].metadata.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].metadata","typeLabel":"object[]"},"occurrence_date":{"oneOf":[{"description":"Date on which the additional charge arose.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].occurrence_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Date on which the additional charge arose.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].occurrence_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].occurrence_date","typeLabel":"string\u003cdate> | null"},"subject_matter":{"oneOf":[{"description":"Reason or subject of the additional charge.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].subject_matter.oneOf.0","typeLabel":"string"},{"description":"Reason or subject of the additional charge.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].subject_matter.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].subject_matter","typeLabel":"string | null"},"type":{"type":"string","description":"Business category of the additional charge.\n\n* `reminder_fee` - reminder_fee\n* `bank_charge` - bank_charge\n* `research_costs` - research_costs","enum":["reminder_fee","bank_charge","research_costs"],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"your_reference":{"oneOf":[{"description":"Your reference for this additional charge.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].your_reference.oneOf.0","typeLabel":"string"},{"description":"Your reference for this additional charge.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX].your_reference","typeLabel":"string | null"}},"required":["amount","events","id","metadata","occurrence_date","subject_matter","type","your_reference"],"type":"object","uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.additional_charges.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.additional_charges","typeLabel":"object[]"},"additional_charges_amount":{"type":"object","description":"Sum of all itemized additional charges.","required":["currency","value"],"properties":{"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","enum":["EUR"],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.additional_charges_amount.currency","typeLabel":"enum\u003cstring>"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.additional_charges_amount.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.additional_charges_amount","typeLabel":"object"},"additional_debtor_ids":{"description":"Read-only additional debtor identifiers projected from the current order.","items":{"format":"uuid","type":"string","uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.additional_debtor_ids.items.[INDEX]","typeLabel":"string\u003cuuid>"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.additional_debtor_ids","typeLabel":"string\u003cuuid>[]"},"created_at":{"description":"Time at which the claim was created.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.created_at","typeLabel":"string\u003cdate-time>"},"debtor_id":{"oneOf":[{"description":"Read-only primary debtor identifier projected from the current order. Change party membership only on a draft order; debtor details use the debtor resource.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.debtor_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"description":"Read-only primary debtor identifier projected from the current order. Change party membership only on a draft order; debtor details use the debtor resource.","format":"uuid","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.debtor_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.debtor_id","typeLabel":"string\u003cuuid> | null"},"delay_date":{"oneOf":[{"description":"Date from which the debtor is considered in payment default.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.delay_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Date from which the debtor is considered in payment default.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.delay_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.delay_date","typeLabel":"string\u003cdate> | null"},"dispute_reason":{"oneOf":[{"description":"Debtor's stated reason for disputing the claim.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.dispute_reason.oneOf.0","typeLabel":"string"},{"description":"Debtor's stated reason for disputing the claim.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.dispute_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.dispute_reason","typeLabel":"string | null"},"document_date":{"oneOf":[{"description":"Date of the invoice, contract, or other claim document.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.document_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Date of the invoice, contract, or other claim document.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.document_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.document_date","typeLabel":"string\u003cdate> | null"},"document_reference":{"oneOf":[{"description":"Invoice, contract, or other source-document number.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.document_reference.oneOf.0","typeLabel":"string"},{"description":"Invoice, contract, or other source-document number.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.document_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.document_reference","typeLabel":"string | null"},"documents":{"description":"Documents relevant to processing the claim.","items":{"description":"Resource representation with a native UUID `id`.","properties":{"created_at":{"description":"Time at which the document was submitted.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"download_url":{"oneOf":[{"description":"Authenticated API URL for downloading the document; null while its status is not `ready`.","format":"uri","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].download_url.oneOf.0","typeLabel":"string\u003curi>"},{"description":"Authenticated API URL for downloading the document; null while its status is not `ready`.","format":"uri","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].download_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].download_url","typeLabel":"string\u003curi> | null"},"failure_reason":{"oneOf":[{"type":"string","description":"Why processing failed when status is `failed`; `null` otherwise. `page_limit_exceeded`: PDF above the 100-page ceiling; `encrypted`: password-protected PDF; `corrupt`: bytes could not be parsed; `unsupported`: content type not accepted; `processing_failed`: any other processing error.","enum":["page_limit_exceeded","encrypted","corrupt","unsupported","processing_failed"],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].failure_reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].failure_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].failure_reason","typeLabel":"enum\u003cstring> | null"},"filename":{"description":"Original filename shown to users.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].filename","typeLabel":"string"},"id":{"description":"Stable identifier for this resource.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"mime_type":{"oneOf":[{"description":"Detected media type of the document.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].mime_type.oneOf.0","typeLabel":"string"},{"description":"Detected media type of the document.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].mime_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].mime_type","typeLabel":"string | null"},"parent":{"type":"object","description":"Resource that owns the document.","required":["id","type"],"properties":{"id":{"description":"Identifier of the resource that owns the document.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].parent.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","description":"Kind of resource that owns the document.\n\n* `claim` - claim\n* `message` - message\n* `request_to_client_answer` - request_to_client_answer\n* `rental_agreement` - rental_agreement\n* `enforceable_title` - enforceable_title","enum":["claim","message","request_to_client_answer","rental_agreement","enforceable_title"],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].parent.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].parent","typeLabel":"object"},"status":{"type":"string","description":"Document availability: `pending` while scanning or processing is incomplete; `ready` when processing permits download; `failed` when scanning or processing failed; `rejected` when the malware check rejected the file.","enum":["pending","ready","failed","rejected"],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"type":{"type":"string","description":"Business purpose of the document.","enum":["bank_statement","claim_statement","correspondence","enforceable_title","invoice","other","payment_proof","reminder","rental_agreement"],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updated_at":{"description":"Time at which document processing last changed.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.documents.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"}},"required":["created_at","download_url","failure_reason","filename","id","mime_type","parent","status","type","updated_at"],"type":"object","uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.documents.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.documents","typeLabel":"object[]"},"due_date":{"oneOf":[{"description":"Date on which payment of the principal claim became due.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.due_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Date on which payment of the principal claim became due.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.due_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.due_date","typeLabel":"string\u003cdate> | null"},"events":{"description":"Stored contextual events associated with this resource.","items":{"description":"Stored events may likewise use retired or internal type values.","properties":{"description":{"oneOf":[{"description":"Optional description of the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.events.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"description":"Optional description of the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.events.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.events.items.[INDEX].description","typeLabel":"string | null"},"location":{"oneOf":[{"description":"Optional location associated with the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.events.items.[INDEX].location.oneOf.0","typeLabel":"string"},{"description":"Optional location associated with the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.events.items.[INDEX].location.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.events.items.[INDEX].location","typeLabel":"string | null"},"occurence":{"description":"Time at which the event occurred; the historical field spelling is intentional.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.events.items.[INDEX].occurence","typeLabel":"string\u003cdate-time>"},"title":{"description":"Human-readable title of the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.events.items.[INDEX].title","typeLabel":"string"},"type":{"description":"Stored event type; historical values may be outside today's input enum.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.events.items.[INDEX].type","typeLabel":"string"},"your_reference":{"oneOf":[{"description":"Your optional reference for the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.events.items.[INDEX].your_reference.oneOf.0","typeLabel":"string"},{"description":"Your optional reference for the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.events.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.events.items.[INDEX].your_reference","typeLabel":"string | null"}},"required":["description","location","occurence","title","type","your_reference"],"type":"object","uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.events.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.events","typeLabel":"object[]"},"id":{"description":"Stable identifier of this claim.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.id","typeLabel":"string\u003cuuid>"},"is_disputed":{"description":"Whether the debtor disputes the claim.","readOnly":true,"type":"boolean","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.is_disputed","typeLabel":"boolean"},"items":{"description":"Invoice or contract lines that make up the principal claim. API submissions are limited to 100 entries.","items":{"description":"Read representation of one invoice line.","properties":{"amount":{"type":"object","description":"Calculated line total: quantity multiplied by unit price.","required":["currency","value"],"properties":{"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","enum":["EUR"],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.\\items.items.[INDEX].amount.currency","typeLabel":"enum\u003cstring>"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.\\items.items.[INDEX].amount.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.\\items.items.[INDEX].amount","typeLabel":"object"},"description":{"description":"Goods or service represented by this invoice or contract line.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.\\items.items.[INDEX].description","typeLabel":"string"},"quantity":{"description":"Number of units represented by this line. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,10}(?:\\.[0-9]{1,6})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.\\items.items.[INDEX].quantity","typeLabel":"string"},"unit":{"oneOf":[{"description":"Unit of measure for the quantity, when applicable.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.\\items.items.[INDEX].unit.oneOf.0","typeLabel":"string"},{"description":"Unit of measure for the quantity, when applicable.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.\\items.items.[INDEX].unit.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.\\items.items.[INDEX].unit","typeLabel":"string | null"},"unit_price":{"type":"object","description":"Price of one unit before multiplying by quantity.","required":["currency","value"],"properties":{"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","enum":["EUR"],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.\\items.items.[INDEX].unit_price.currency","typeLabel":"enum\u003cstring>"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.\\items.items.[INDEX].unit_price.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.\\items.items.[INDEX].unit_price","typeLabel":"object"}},"required":["amount","description","quantity","unit","unit_price"],"type":"object","uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.\\items.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.\\items","typeLabel":"object[]"},"legal_basis":{"type":"object","description":"Contract or obligation that establishes the principal claim.","required":["claim_type_code","contract_date","description"],"properties":{"claim_type_code":{"oneOf":[{"description":"Code identifying the contract or transaction underlying the claim. H17 is commercial rent, H19 is residential rent, and K014 identifies receivable enforcement costs in titled orders. See [legal basis codes](https://docs.paywise.de/api-docs/case-management-api/concepts/claims#legal-basis-codes) for the full code-to-meaning table.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.legal_basis.claim_type_code.oneOf.0","typeLabel":"string"},{"description":"Code identifying the contract or transaction underlying the claim. H17 is commercial rent, H19 is residential rent, and K014 identifies receivable enforcement costs in titled orders. See [legal basis codes](https://docs.paywise.de/api-docs/case-management-api/concepts/claims#legal-basis-codes) for the full code-to-meaning table.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.legal_basis.claim_type_code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.legal_basis.claim_type_code","typeLabel":"string | null"},"contract_date":{"oneOf":[{"description":"Date on which the underlying contract or obligation arose.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.legal_basis.contract_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Date on which the underlying contract or obligation arose.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.legal_basis.contract_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.legal_basis.contract_date","typeLabel":"string\u003cdate> | null"},"description":{"oneOf":[{"description":"Terms or circumstances establishing the principal claim. API submissions are limited to 2000 characters.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.legal_basis.description.oneOf.0","typeLabel":"string"},{"description":"Terms or circumstances establishing the principal claim. API submissions are limited to 2000 characters.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.legal_basis.description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.legal_basis.description","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.legal_basis","typeLabel":"object"},"mandate_id":{"oneOf":[{"description":"Read-only accepted mandate identifier, or null before acceptance.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.mandate_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"description":"Read-only accepted mandate identifier, or null before acceptance.","format":"uuid","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.mandate_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.mandate_id","typeLabel":"string\u003cuuid> | null"},"metadata":{"description":"Stored metadata entries; duplicate types remain separate entries.","items":{"description":"Stored types may predate today's resource-specific input choices.","properties":{"type":{"description":"Stored metadata type; historical values may be outside today's input enum.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.metadata.items.[INDEX].type","typeLabel":"string"},"value":{"description":"Stored metadata value.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.metadata.items.[INDEX].value","typeLabel":"string"}},"required":["type","value"],"type":"object","uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.metadata.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.metadata","typeLabel":"object[]"},"order_id":{"description":"Read-only current order identifier. Internal review may change this relationship while the claim identifier and all claim-specific URLs remain stable.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.order_id","typeLabel":"string\u003cuuid>"},"payments":{"description":"Read-only payments attributed to this claim. Report subsequent payments through the stable claim payments URL, including after acceptance or an internal order move. Reporting requires case:payments:write.","items":{"description":"Read representation of one reported payment.","properties":{"amount":{"oneOf":[{"type":"object","description":"Amount received.","required":["currency","value"],"properties":{"currency":{"description":"Currency of the payment.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].amount.oneOf.0.currency","typeLabel":"string"},"value":{"description":"Amount received, expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].amount.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].amount.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].amount","typeLabel":"object | null"},"claim":{"oneOf":[{"type":"object","description":"Claim to which the payment was reported.","required":["document_reference","id","your_reference"],"properties":{"document_reference":{"oneOf":[{"description":"Invoice, contract, or source-document number of the claim.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].claim.oneOf.0.document_reference.oneOf.0","typeLabel":"string"},{"description":"Invoice, contract, or source-document number of the claim.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].claim.oneOf.0.document_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].claim.oneOf.0.document_reference","typeLabel":"string | null"},"id":{"description":"Identifier of the claim receiving the payment.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].claim.oneOf.0.id","typeLabel":"string\u003cuuid>"},"your_reference":{"oneOf":[{"description":"Your reference for the claim.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].claim.oneOf.0.your_reference.oneOf.0","typeLabel":"string"},{"description":"Your reference for the claim.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].claim.oneOf.0.your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].claim.oneOf.0.your_reference","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].claim.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].claim.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].claim","typeLabel":"object | null"},"created_at":{"description":"Time at which the payment was reported.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"id":{"description":"Stable identifier of this reported payment.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"mandate":{"oneOf":[{"type":"object","description":"Accepted case containing the claim.","required":["id","reference_number"],"properties":{"id":{"description":"Identifier of the accepted case receiving the payment.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].mandate.oneOf.0.id","typeLabel":"string\u003cuuid>"},"reference_number":{"description":"paywise case-file reference number.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].mandate.oneOf.0.reference_number","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].mandate.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].mandate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].mandate","typeLabel":"object | null"},"metadata":{"description":"Stored metadata entries; duplicate types remain separate entries.","items":{"description":"Stored types may predate today's resource-specific input choices.","properties":{"type":{"description":"Stored metadata type; historical values may be outside today's input enum.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].metadata.items.[INDEX].type","typeLabel":"string"},"value":{"description":"Stored metadata value.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].metadata.items.[INDEX].value","typeLabel":"string"}},"required":["type","value"],"type":"object","uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].metadata.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].metadata","typeLabel":"object[]"},"updated_at":{"description":"Time at which the payment record was last updated.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"},"value_date":{"description":"Date on which the payment was credited.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].value_date","typeLabel":"string\u003cdate>"},"your_reference":{"oneOf":[{"description":"Your reference for reconciling this payment.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].your_reference.oneOf.0","typeLabel":"string"},{"description":"Your reference for reconciling this payment.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.payments.items.[INDEX].your_reference","typeLabel":"string | null"}},"required":["amount","claim","created_at","id","mandate","metadata","updated_at","value_date","your_reference"],"type":"object","uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.payments.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.payments","typeLabel":"object[]"},"principal_amount":{"oneOf":[{"type":"object","description":"Original principal amount including VAT, before charges and payments.","required":["currency","value"],"properties":{"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","enum":["EUR"],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.principal_amount.oneOf.0.currency","typeLabel":"enum\u003cstring>"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.principal_amount.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.principal_amount.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.principal_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.principal_amount","typeLabel":"object | null"},"reminders":{"description":"Payment reminders issued for this claim in chronological order. API submissions are limited to 50 entries.","items":{"description":"Read representation of one normalized reminder.","properties":{"date":{"oneOf":[{"description":"Date on which the payment reminder was issued.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.reminders.items.[INDEX].date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Date on which the payment reminder was issued.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.reminders.items.[INDEX].date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.reminders.items.[INDEX].date","typeLabel":"string\u003cdate> | null"},"due_date":{"oneOf":[{"description":"Payment deadline stated in the reminder, when present.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.reminders.items.[INDEX].due_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Payment deadline stated in the reminder, when present.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.reminders.items.[INDEX].due_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.reminders.items.[INDEX].due_date","typeLabel":"string\u003cdate> | null"},"id":{"oneOf":[{"description":"Stable identifier of this reminder.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.reminders.items.[INDEX].id.oneOf.0","typeLabel":"string\u003cuuid>"},{"description":"Stable identifier of this reminder.","format":"uuid","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.reminders.items.[INDEX].id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.reminders.items.[INDEX].id","typeLabel":"string\u003cuuid> | null"}},"required":["date","due_date","id"],"type":"object","uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.reminders.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.reminders","typeLabel":"object[]"},"status":{"type":"string","description":"Read-only effective claim lifecycle. Draft-only commands return 409 claim_not_editable after submission and 409 order_expired once the draft has passed its expires_at; payment and title commands retain their specific lifecycle conflict codes.","enum":["draft","submitted","awaiting_client_response","accepted","rejected","withdrawn"],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.status","typeLabel":"enum\u003cstring>"},"subject_matter":{"oneOf":[{"description":"Goods, services, or other obligation underlying the claim. API submissions are limited to 2000 characters.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.subject_matter.oneOf.0","typeLabel":"string"},{"description":"Goods, services, or other obligation underlying the claim. API submissions are limited to 2000 characters.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.subject_matter.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.subject_matter","typeLabel":"string | null"},"total_amount":{"oneOf":[{"type":"object","description":"Current open amount after charges and reported payments.","required":["currency","value"],"properties":{"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","enum":["EUR"],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.total_amount.oneOf.0.currency","typeLabel":"enum\u003cstring>"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.total_amount.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.total_amount.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.total_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.total_amount","typeLabel":"object | null"},"type":{"type":"string","description":"Literal receivable claim discriminator.","enum":["receivable"],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"updated_at":{"description":"Time at which the claim was last updated.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.updated_at","typeLabel":"string\u003cdate-time>"},"your_reference":{"oneOf":[{"description":"Your reference for this claim.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.your_reference.oneOf.0","typeLabel":"string"},{"description":"Your reference for this claim.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0.your_reference","typeLabel":"string | null"}},"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.0","typeLabel":"Receivable claim · object"},{"type":"object","title":"Titled claim","description":"A claim backed by an enforceable title. The title's amount, dates, and documents belong to `enforceable_title`.","required":["additional_debtor_ids","created_at","debtor_id","dispute_reason","document_reference","enforceable_title","events","id","is_disputed","mandate_id","metadata","order_id","payments","principal_amount","status","subject_matter","total_amount","type","updated_at","your_reference"],"properties":{"additional_debtor_ids":{"description":"Read-only additional debtor identifiers projected from the current order.","items":{"format":"uuid","type":"string","uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.additional_debtor_ids.items.[INDEX]","typeLabel":"string\u003cuuid>"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.additional_debtor_ids","typeLabel":"string\u003cuuid>[]"},"created_at":{"description":"Time at which the claim was created.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.created_at","typeLabel":"string\u003cdate-time>"},"debtor_id":{"oneOf":[{"description":"Read-only primary debtor identifier projected from the current order. Change party membership only on a draft order; debtor details use the debtor resource.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.debtor_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"description":"Read-only primary debtor identifier projected from the current order. Change party membership only on a draft order; debtor details use the debtor resource.","format":"uuid","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.debtor_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.debtor_id","typeLabel":"string\u003cuuid> | null"},"dispute_reason":{"oneOf":[{"description":"Debtor's stated reason for disputing the claim.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.dispute_reason.oneOf.0","typeLabel":"string"},{"description":"Debtor's stated reason for disputing the claim.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.dispute_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.dispute_reason","typeLabel":"string | null"},"document_reference":{"oneOf":[{"description":"Invoice, contract, or other source-document number.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.document_reference.oneOf.0","typeLabel":"string"},{"description":"Invoice, contract, or other source-document number.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.document_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.document_reference","typeLabel":"string | null"},"enforceable_title":{"oneOf":[{"type":"object","description":"Enforceable title that owns this claim's gross amount, legal metadata, and title documents.","required":["amount","created_at","documents","file_number","id","issued_on","issuing_authority","legally_binding_since","served_on","title_type","updated_at"],"properties":{"amount":{"oneOf":[{"type":"object","description":"Gross amount confirmed by the client and owned by the enforceable title.","required":["value"],"properties":{"value":{"description":"Gross title amount in major currency units, with at most two decimal places. Zero is accepted while drafting; the amount must be positive before finalization. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.amount.oneOf.0.value","typeLabel":"string"},"currency":{"type":"string","description":"Currency of the title amount; only EUR is supported.","default":"EUR","enum":["EUR"],"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.amount.oneOf.0.currency","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.amount.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.amount","typeLabel":"object | null"},"created_at":{"description":"Time at which the enforceable title was created.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.created_at","typeLabel":"string\u003cdate-time>"},"documents":{"description":"Documents owned by the title; one primary enforceable-title document is required before finalization.","items":{"description":"Resource representation with a native UUID `id`.","properties":{"created_at":{"description":"Time at which the document was submitted.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"download_url":{"oneOf":[{"description":"Authenticated API URL for downloading the document; null while its status is not `ready`.","format":"uri","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].download_url.oneOf.0","typeLabel":"string\u003curi>"},{"description":"Authenticated API URL for downloading the document; null while its status is not `ready`.","format":"uri","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].download_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].download_url","typeLabel":"string\u003curi> | null"},"failure_reason":{"oneOf":[{"type":"string","description":"Why processing failed when status is `failed`; `null` otherwise. `page_limit_exceeded`: PDF above the 100-page ceiling; `encrypted`: password-protected PDF; `corrupt`: bytes could not be parsed; `unsupported`: content type not accepted; `processing_failed`: any other processing error.","enum":["page_limit_exceeded","encrypted","corrupt","unsupported","processing_failed"],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].failure_reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].failure_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].failure_reason","typeLabel":"enum\u003cstring> | null"},"filename":{"description":"Original filename shown to users.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].filename","typeLabel":"string"},"id":{"description":"Stable identifier for this resource.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"mime_type":{"oneOf":[{"description":"Detected media type of the document.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].mime_type.oneOf.0","typeLabel":"string"},{"description":"Detected media type of the document.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].mime_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].mime_type","typeLabel":"string | null"},"parent":{"type":"object","description":"Resource that owns the document.","required":["id","type"],"properties":{"id":{"description":"Identifier of the resource that owns the document.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].parent.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","description":"Kind of resource that owns the document.\n\n* `claim` - claim\n* `message` - message\n* `request_to_client_answer` - request_to_client_answer\n* `rental_agreement` - rental_agreement\n* `enforceable_title` - enforceable_title","enum":["claim","message","request_to_client_answer","rental_agreement","enforceable_title"],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].parent.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].parent","typeLabel":"object"},"status":{"type":"string","description":"Document availability: `pending` while scanning or processing is incomplete; `ready` when processing permits download; `failed` when scanning or processing failed; `rejected` when the malware check rejected the file.","enum":["pending","ready","failed","rejected"],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"type":{"type":"string","description":"Business purpose of the document.","enum":["bank_statement","claim_statement","correspondence","enforceable_title","invoice","other","payment_proof","reminder","rental_agreement"],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"updated_at":{"description":"Time at which document processing last changed.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"}},"required":["created_at","download_url","failure_reason","filename","id","mime_type","parent","status","type","updated_at"],"type":"object","uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.documents","typeLabel":"object[]"},"file_number":{"description":"Official file or reference number shown on the title.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.file_number","typeLabel":"string"},"id":{"description":"Stable identifier of the enforceable title.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.id","typeLabel":"string\u003cuuid>"},"issued_on":{"oneOf":[{"description":"Date on which the enforceable title was issued.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.issued_on.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Date on which the enforceable title was issued.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.issued_on.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.issued_on","typeLabel":"string\u003cdate> | null"},"issuing_authority":{"description":"Court, notary, or other authority that issued the title.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.issuing_authority","typeLabel":"string"},"legally_binding_since":{"oneOf":[{"description":"Optional date from which the title is legally binding; it cannot precede issued_on.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.legally_binding_since.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Optional date from which the title is legally binding; it cannot precede issued_on.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.legally_binding_since.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.legally_binding_since","typeLabel":"string\u003cdate> | null"},"served_on":{"oneOf":[{"description":"Optional date on which the title was served; it cannot precede issued_on.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.served_on.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Optional date on which the title was served; it cannot precede issued_on.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.served_on.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.served_on","typeLabel":"string\u003cdate> | null"},"title_type":{"oneOf":[{"type":"string","description":"Legal title category: enforcement_order = Vollstreckungsbescheid; default_judgment = Versäumnisurteil; final_judgment = Endurteil; acknowledgment_judgment = Anerkenntnisurteil; reservation_judgment = Vorbehaltsurteil; court_settlement = Gerichtlicher Vergleich; enforceable_notarial_deed = Vollstreckbare notarielle Urkunde; cost_assessment_order = Kostenfestsetzungsbeschluss; other = Sonstiger Titel.","enum":["enforcement_order","default_judgment","final_judgment","acknowledgment_judgment","reservation_judgment","court_settlement","enforceable_notarial_deed","cost_assessment_order","other"],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.title_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.title_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.title_type","typeLabel":"enum\u003cstring> | null"},"updated_at":{"description":"Time at which the enforceable title last changed.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0.updated_at","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.enforceable_title.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.enforceable_title","typeLabel":"object | null"},"events":{"description":"Stored contextual events associated with this resource.","items":{"description":"Stored events may likewise use retired or internal type values.","properties":{"description":{"oneOf":[{"description":"Optional description of the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.events.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"description":"Optional description of the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.events.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.events.items.[INDEX].description","typeLabel":"string | null"},"location":{"oneOf":[{"description":"Optional location associated with the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.events.items.[INDEX].location.oneOf.0","typeLabel":"string"},{"description":"Optional location associated with the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.events.items.[INDEX].location.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.events.items.[INDEX].location","typeLabel":"string | null"},"occurence":{"description":"Time at which the event occurred; the historical field spelling is intentional.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.events.items.[INDEX].occurence","typeLabel":"string\u003cdate-time>"},"title":{"description":"Human-readable title of the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.events.items.[INDEX].title","typeLabel":"string"},"type":{"description":"Stored event type; historical values may be outside today's input enum.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.events.items.[INDEX].type","typeLabel":"string"},"your_reference":{"oneOf":[{"description":"Your optional reference for the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.events.items.[INDEX].your_reference.oneOf.0","typeLabel":"string"},{"description":"Your optional reference for the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.events.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.events.items.[INDEX].your_reference","typeLabel":"string | null"}},"required":["description","location","occurence","title","type","your_reference"],"type":"object","uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.events.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.events","typeLabel":"object[]"},"id":{"description":"Stable identifier of this claim.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.id","typeLabel":"string\u003cuuid>"},"is_disputed":{"description":"Whether the debtor disputes the claim.","readOnly":true,"type":"boolean","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.is_disputed","typeLabel":"boolean"},"mandate_id":{"oneOf":[{"description":"Read-only accepted mandate identifier, or null before acceptance.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.mandate_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"description":"Read-only accepted mandate identifier, or null before acceptance.","format":"uuid","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.mandate_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.mandate_id","typeLabel":"string\u003cuuid> | null"},"metadata":{"description":"Stored metadata entries; duplicate types remain separate entries.","items":{"description":"Stored types may predate today's resource-specific input choices.","properties":{"type":{"description":"Stored metadata type; historical values may be outside today's input enum.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.metadata.items.[INDEX].type","typeLabel":"string"},"value":{"description":"Stored metadata value.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.metadata.items.[INDEX].value","typeLabel":"string"}},"required":["type","value"],"type":"object","uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.metadata.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.metadata","typeLabel":"object[]"},"order_id":{"description":"Read-only current order identifier. Internal review may change this relationship while the claim identifier and all claim-specific URLs remain stable.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.order_id","typeLabel":"string\u003cuuid>"},"payments":{"description":"Read-only payments attributed to this claim. Report subsequent payments through the stable claim payments URL, including after acceptance or an internal order move. Reporting requires case:payments:write.","items":{"description":"Read representation of one reported payment.","properties":{"amount":{"oneOf":[{"type":"object","description":"Amount received.","required":["currency","value"],"properties":{"currency":{"description":"Currency of the payment.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].amount.oneOf.0.currency","typeLabel":"string"},"value":{"description":"Amount received, expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].amount.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].amount.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].amount","typeLabel":"object | null"},"claim":{"oneOf":[{"type":"object","description":"Claim to which the payment was reported.","required":["document_reference","id","your_reference"],"properties":{"document_reference":{"oneOf":[{"description":"Invoice, contract, or source-document number of the claim.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].claim.oneOf.0.document_reference.oneOf.0","typeLabel":"string"},{"description":"Invoice, contract, or source-document number of the claim.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].claim.oneOf.0.document_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].claim.oneOf.0.document_reference","typeLabel":"string | null"},"id":{"description":"Identifier of the claim receiving the payment.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].claim.oneOf.0.id","typeLabel":"string\u003cuuid>"},"your_reference":{"oneOf":[{"description":"Your reference for the claim.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].claim.oneOf.0.your_reference.oneOf.0","typeLabel":"string"},{"description":"Your reference for the claim.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].claim.oneOf.0.your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].claim.oneOf.0.your_reference","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].claim.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].claim.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].claim","typeLabel":"object | null"},"created_at":{"description":"Time at which the payment was reported.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"id":{"description":"Stable identifier of this reported payment.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"mandate":{"oneOf":[{"type":"object","description":"Accepted case containing the claim.","required":["id","reference_number"],"properties":{"id":{"description":"Identifier of the accepted case receiving the payment.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].mandate.oneOf.0.id","typeLabel":"string\u003cuuid>"},"reference_number":{"description":"paywise case-file reference number.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].mandate.oneOf.0.reference_number","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].mandate.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].mandate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].mandate","typeLabel":"object | null"},"metadata":{"description":"Stored metadata entries; duplicate types remain separate entries.","items":{"description":"Stored types may predate today's resource-specific input choices.","properties":{"type":{"description":"Stored metadata type; historical values may be outside today's input enum.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].metadata.items.[INDEX].type","typeLabel":"string"},"value":{"description":"Stored metadata value.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].metadata.items.[INDEX].value","typeLabel":"string"}},"required":["type","value"],"type":"object","uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].metadata.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].metadata","typeLabel":"object[]"},"updated_at":{"description":"Time at which the payment record was last updated.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"},"value_date":{"description":"Date on which the payment was credited.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].value_date","typeLabel":"string\u003cdate>"},"your_reference":{"oneOf":[{"description":"Your reference for reconciling this payment.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].your_reference.oneOf.0","typeLabel":"string"},{"description":"Your reference for reconciling this payment.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.payments.items.[INDEX].your_reference","typeLabel":"string | null"}},"required":["amount","claim","created_at","id","mandate","metadata","updated_at","value_date","your_reference"],"type":"object","uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.payments.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.payments","typeLabel":"object[]"},"principal_amount":{"oneOf":[{"type":"object","description":"Always null for a titled claim; use enforceable_title.amount for the authoritative gross amount.","required":["currency","value"],"properties":{"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","enum":["EUR"],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.principal_amount.oneOf.0.currency","typeLabel":"enum\u003cstring>"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.principal_amount.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.principal_amount.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.principal_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.principal_amount","typeLabel":"object | null"},"status":{"type":"string","description":"Read-only effective claim lifecycle. Draft-only commands return 409 claim_not_editable after submission and 409 order_expired once the draft has passed its expires_at; payment and title commands retain their specific lifecycle conflict codes.","enum":["draft","submitted","awaiting_client_response","accepted","rejected","withdrawn"],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.status","typeLabel":"enum\u003cstring>"},"subject_matter":{"oneOf":[{"description":"Goods, services, or other obligation underlying the claim. API submissions are limited to 2000 characters.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.subject_matter.oneOf.0","typeLabel":"string"},{"description":"Goods, services, or other obligation underlying the claim. API submissions are limited to 2000 characters.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.subject_matter.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.subject_matter","typeLabel":"string | null"},"total_amount":{"oneOf":[{"type":"object","description":"Authoritative gross enforceable-title amount; reported payments are exposed separately and do not reduce it.","required":["currency","value"],"properties":{"currency":{"type":"string","description":"Currency of the amount; currently always EUR.\n\n* `EUR` - EUR","enum":["EUR"],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.total_amount.oneOf.0.currency","typeLabel":"enum\u003cstring>"},"value":{"description":"Monetary value expressed with two decimal places. Exact decimal string; parse it with a decimal type, never a binary float.","pattern":"^-?[0-9]{1,14}(?:\\.[0-9]{1,2})?$","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.total_amount.oneOf.0.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.total_amount.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.total_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.total_amount","typeLabel":"object | null"},"type":{"type":"string","description":"Literal titled claim discriminator.","enum":["titled"],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"updated_at":{"description":"Time at which the claim was last updated.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.updated_at","typeLabel":"string\u003cdate-time>"},"your_reference":{"oneOf":[{"description":"Your reference for this claim.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.your_reference.oneOf.0","typeLabel":"string"},{"description":"Your reference for this claim.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1.your_reference","typeLabel":"string | null"}},"uniqueKey":"oneOf.2.claims.items.[INDEX].oneOf.1","typeLabel":"Titled claim · object"}],"uniqueKey":"oneOf.2.claims.items.[INDEX]","typeLabel":"Receivable claim · object | Titled claim · object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.2.claims","typeLabel":"(Receivable claim · object | Titled claim · object)[]"},"confirmation_email":{"oneOf":[{"description":"Address receiving the order-entry confirmation, when requested.","format":"email","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.confirmation_email.oneOf.0","typeLabel":"string\u003cemail>"},{"description":"Address receiving the order-entry confirmation, when requested.","format":"email","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.confirmation_email.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.confirmation_email","typeLabel":"string\u003cemail> | null"},"created_at":{"description":"Time at which the order was created.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.created_at","typeLabel":"string\u003cdate-time>"},"debtor":{"type":"object","description":"Inline summary of the primary debtor. Retrieve full details with GET /v2/debtors/{id}/ using its id.","required":["acting_as","events","id","legal_form","metadata","organization","person","your_reference"],"properties":{"acting_as":{"type":"string","description":"Whether the debtor incurred the obligation as a consumer or in a business capacity.\n\n* `consumer` - consumer\n* `business` - business","enum":["consumer","business"],"isRequired":true,"uniqueKey":"oneOf.2.debtor.acting_as","typeLabel":"enum\u003cstring>"},"events":{"description":"Stored contextual events associated with this resource.","items":{"description":"Stored events may likewise use retired or internal type values.","properties":{"description":{"oneOf":[{"description":"Optional description of the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.debtor.events.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"description":"Optional description of the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.debtor.events.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.debtor.events.items.[INDEX].description","typeLabel":"string | null"},"location":{"oneOf":[{"description":"Optional location associated with the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.debtor.events.items.[INDEX].location.oneOf.0","typeLabel":"string"},{"description":"Optional location associated with the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.debtor.events.items.[INDEX].location.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.debtor.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.2.debtor.events.items.[INDEX].occurence","typeLabel":"string\u003cdate-time>"},"title":{"description":"Human-readable title of the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.debtor.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.2.debtor.events.items.[INDEX].type","typeLabel":"string"},"your_reference":{"oneOf":[{"description":"Your optional reference for the event.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.debtor.events.items.[INDEX].your_reference.oneOf.0","typeLabel":"string"},{"description":"Your optional reference for the event.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.debtor.events.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.debtor.events.items.[INDEX].your_reference","typeLabel":"string | null"}},"required":["description","location","occurence","title","type","your_reference"],"type":"object","uniqueKey":"oneOf.2.debtor.events.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.2.debtor.events","typeLabel":"object[]"},"id":{"description":"Stable identifier of this debtor.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.debtor.id","typeLabel":"string\u003cuuid>"},"legal_form":{"oneOf":[{"description":"Permanent public legal-form code; look up its label and representation rules with GET /v2/legal-forms/. Null for consumers.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.debtor.legal_form.oneOf.0","typeLabel":"string"},{"description":"Permanent public legal-form code; look up its label and representation rules with GET /v2/legal-forms/. Null for consumers.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.debtor.legal_form.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.debtor.legal_form","typeLabel":"string | null"},"metadata":{"description":"Stored metadata entries; duplicate types remain separate entries.","items":{"description":"Stored types may predate today's resource-specific input choices.","properties":{"type":{"description":"Stored metadata type; historical values may be outside today's input enum.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.debtor.metadata.items.[INDEX].type","typeLabel":"string"},"value":{"description":"Stored metadata value.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.debtor.metadata.items.[INDEX].value","typeLabel":"string"}},"required":["type","value"],"type":"object","uniqueKey":"oneOf.2.debtor.metadata.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.2.debtor.metadata","typeLabel":"object[]"},"organization":{"oneOf":[{"type":"object","description":"Organization identity for a business debtor.","required":["commercial_register","commercial_registration_number","name"],"properties":{"commercial_register":{"oneOf":[{"description":"Register court or authority holding the registration.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.debtor.organization.oneOf.0.commercial_register.oneOf.0","typeLabel":"string"},{"description":"Register court or authority holding the registration.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.debtor.organization.oneOf.0.commercial_register.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.debtor.organization.oneOf.0.commercial_register","typeLabel":"string | null"},"commercial_registration_number":{"oneOf":[{"description":"Commercial, association, or partnership register number.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.debtor.organization.oneOf.0.commercial_registration_number.oneOf.0","typeLabel":"string"},{"description":"Commercial, association, or partnership register number.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.debtor.organization.oneOf.0.commercial_registration_number.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.debtor.organization.oneOf.0.commercial_registration_number","typeLabel":"string | null"},"name":{"description":"Registered or trading name of the organization.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.debtor.organization.oneOf.0.name","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.2.debtor.organization.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.2.debtor.organization.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.debtor.organization","typeLabel":"object | null"},"person":{"oneOf":[{"type":"object","description":"Natural-person identity for a consumer or sole proprietor.","required":["birth_date","first_name","last_name","salutation"],"properties":{"birth_date":{"oneOf":[{"description":"Date of birth used to identify the natural person.","format":"date","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.debtor.person.oneOf.0.birth_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"Date of birth used to identify the natural person.","format":"date","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.debtor.person.oneOf.0.birth_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.debtor.person.oneOf.0.birth_date","typeLabel":"string\u003cdate> | null"},"first_name":{"description":"Given name of the natural person.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.debtor.person.oneOf.0.first_name","typeLabel":"string"},"last_name":{"description":"Family name of the natural person.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.debtor.person.oneOf.0.last_name","typeLabel":"string"},"salutation":{"oneOf":[{"type":"string","description":"Salutation of the natural person; null if no supported salutation is stored.","enum":["mr","ms","mx"],"isRequired":true,"uniqueKey":"oneOf.2.debtor.person.oneOf.0.salutation.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.2.debtor.person.oneOf.0.salutation.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.debtor.person.oneOf.0.salutation","typeLabel":"enum\u003cstring> | null"}},"isRequired":true,"uniqueKey":"oneOf.2.debtor.person.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.2.debtor.person.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.debtor.person","typeLabel":"object | null"},"your_reference":{"oneOf":[{"description":"Your reference for this debtor.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.debtor.your_reference.oneOf.0","typeLabel":"string"},{"description":"Your reference for this debtor.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.debtor.your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.debtor.your_reference","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"oneOf.2.debtor","typeLabel":"object"},"expires_at":{"oneOf":[{"description":"Time at which this API-created draft expires: updated_at plus 90 days, refreshed by every successful draft change. Once it has passed, the order reads expired and every change answers 409 order_expired until the daily cleanup deletes it. Null once the order is finalized and for orders created in the portal.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Time at which this API-created draft expires: updated_at plus 90 days, refreshed by every successful draft change. Once it has passed, the order reads expired and every change answers 409 order_expired until the daily cleanup deletes it. Null once the order is finalized and for orders created in the portal.","format":"date-time","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.expires_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.expires_at","typeLabel":"string\u003cdate-time> | null"},"id":{"description":"Stable identifier of this order.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.id","typeLabel":"string\u003cuuid>"},"mandate":{"oneOf":[{"description":"Accepted case created from this order, when available.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.mandate.oneOf.0","typeLabel":"string\u003cuuid>"},{"description":"Accepted case created from this order, when available.","format":"uuid","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.mandate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.mandate","typeLabel":"string\u003cuuid> | null"},"merged_into":{"oneOf":[{"description":"Surviving order when this order was merged during review.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.merged_into.oneOf.0","typeLabel":"string\u003cuuid>"},{"description":"Surviving order when this order was merged during review.","format":"uuid","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.merged_into.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.merged_into","typeLabel":"string\u003cuuid> | null"},"rejection":{"oneOf":[{"type":"object","description":"Why paywise declined the order: reason, time, notified recipients, and the standard reason's key. Null unless status is rejected.","required":["code","notified_to","reason","rejected_at"],"properties":{"code":{"oneOf":[{"description":"Stable machine-readable key of the standard rejection reason when the rejection used one; null for an individually worded rejection.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.rejection.oneOf.0.code.oneOf.0","typeLabel":"string"},{"description":"Stable machine-readable key of the standard rejection reason when the rejection used one; null for an individually worded rejection.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.rejection.oneOf.0.code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.rejection.oneOf.0.code","typeLabel":"string | null"},"notified_to":{"description":"E-mail addresses of your company's status-update recipients the rejection notice was delivered to. Empty when no notice was sent.","items":{"format":"email","type":"string","uniqueKey":"oneOf.2.rejection.oneOf.0.notified_to.items.[INDEX]","typeLabel":"string\u003cemail>"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"oneOf.2.rejection.oneOf.0.notified_to","typeLabel":"string\u003cemail>[]"},"reason":{"oneOf":[{"description":"Plain-text reason paywise gave for rejecting the order: the wording of the rejection notice with formatting removed.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.rejection.oneOf.0.reason.oneOf.0","typeLabel":"string"},{"description":"Plain-text reason paywise gave for rejecting the order: the wording of the rejection notice with formatting removed.","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"oneOf.2.rejection.oneOf.0.reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.rejection.oneOf.0.reason","typeLabel":"string | null"},"rejected_at":{"description":"Time at which paywise rejected the order.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.rejection.oneOf.0.rejected_at","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"oneOf.2.rejection.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.2.rejection.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.2.rejection","typeLabel":"object | null"},"status":{"type":"string","description":"Order lifecycle state: draft is editable; submitted awaits processing; awaiting_client_response requires client input; accepted has entered case processing; rejected was declined; withdrawn was cancelled by the client; expired passed its draft deadline and accepts no further changes (409 order_expired) until the daily cleanup deletes it; merged points to the surviving order in merged_into.","enum":["draft","submitted","awaiting_client_response","accepted","rejected","withdrawn","expired","merged"],"isRequired":true,"uniqueKey":"oneOf.2.status","typeLabel":"enum\u003cstring>"},"success_fee_confirmed":{"description":"Whether the titled-order success-fee arrangement has been confirmed for finalization. See the [paywise General Terms and Conditions (AGB)](https://paywise.de/agb/) for the exact conditions for titled orders.","readOnly":true,"type":"boolean","isRequired":true,"uniqueKey":"oneOf.2.success_fee_confirmed","typeLabel":"boolean"},"totals":{"type":"object","description":"Financial totals calculated across the order's claims.","required":["charges","main_claims","order_value","payments"],"properties":{"charges":{"type":"object","description":"Sum of itemized additional charges on receivable claims.","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.2.totals.charges.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.2.totals.charges.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.2.totals.charges","typeLabel":"object"},"main_claims":{"type":"object","description":"Sum of receivable-claim principal amounts plus gross enforceable-title amounts.","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.2.totals.main_claims.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.2.totals.main_claims.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.2.totals.main_claims","typeLabel":"object"},"order_value":{"type":"object","description":"Current open value for invoice and rental orders; for titled orders, gross main_claims plus charges, with payments reported separately.","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.2.totals.order_value.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.2.totals.order_value.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.2.totals.order_value","typeLabel":"object"},"payments":{"type":"object","description":"Sum of payments already reported for the order's claims.","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.2.totals.payments.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.2.totals.payments.value","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.2.totals.payments","typeLabel":"object"}},"isRequired":true,"uniqueKey":"oneOf.2.totals","typeLabel":"object"},"type":{"type":"string","description":"Literal titled order discriminator.","enum":["titled"],"isRequired":true,"uniqueKey":"oneOf.2.type","typeLabel":"enum\u003cstring>"},"updated_at":{"description":"Time at which the order was last updated.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"oneOf.2","typeLabel":"Titled order · object"}],"uniqueKey":"","typeLabel":"Invoice order · object | Rental order · object | Titled order · 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"},"f38689b7-363d-43f7-b7af-9f9655d73a01":{"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"},"86402ae8-9e16-4d6f-bdab-c46bf3858457":{"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"},"6eee3a80-f4d6-46ec-945d-2324309feccd":{"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"},"e6a9bc35-7408-4833-8e5d-643faf100aed":{"content":{"application/json":{"examples":{"conflict-error":{"title":"conflict-error","value":{"code":"conflict","detail":"The resource changed state and cannot accept this command."}}},"schema":{"properties":{"code":{"description":"Machine-readable error category.","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"description":"Short human-readable summary of the error.","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"errors":{"description":"Field-level validation errors, when applicable.","items":{"properties":{"code":{"description":"Machine-readable field error code.","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"field":{"oneOf":[{"description":"Path to the field that caused the error, using dots for objects and brackets for list indexes, for example `claims[0].amount`; null for an error without a field path.","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].field.oneOf.0","typeLabel":"string"},{"description":"Path to the field that caused the error, using dots for objects and brackets for list indexes, for example `claims[0].amount`; null for an error without a field path.","type":"null","isRequired":true,"uniqueKey":"errors.items.[INDEX].field.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string | null"},"message":{"description":"Human-readable explanation of the field error.","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"required":["field","code","message"],"type":"object","uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"errors","typeLabel":"object[]"}},"required":["detail","code"],"type":"object","uniqueKey":"","typeLabel":"object"},"exampleType":"examples"}},"description":"Standard error response.","headers":{"Cache-Control":{"description":"Cacheability directive. Authenticated responses use `private, no-store`; the legal-form catalog may use `private, max-age=86400`.","schema":{"type":"string"}},"X-Paywise-Environment":{"description":"Environment that produced the response.","schema":{"enum":["production","sandbox"],"type":"string"}},"X-Paywise-Request-Id":{"description":"Fresh server-assigned correlation id for this response. Caller-provided request ids are ignored.","schema":{"format":"uuid","type":"string"}}},"exampleType":"examples"},"b936896b-3cf9-4be0-8c99-bac20d10ca5e":{"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"},"283fae73-1435-4724-98c4-fd95dfa63b89":{"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":{"5d748241-3de9-48f0-933b-c42fa8fbefa3":{"caseBearerAuth":{"description":"Company-bound Case Management API key — the standard credential for this API.","scheme":"bearer","type":"http","scopes":[],"schemeName":"caseBearerAuth"}},"9dbe94c7-1d53-4df9-ac3d-a470f6cab86e":{"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":"Create order - paywise Knowledge Center","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"de":{"href":"/user-docs/overview","matchLevel":4},"en":{"href":"/api-docs/case-management-api/reference/orders/create-order","matchLevel":0}}},"lastModified":"2026-10-16T12:47:30.191Z","originalFileLocation":"api-docs/case-management-api/reference/orders/create-order.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"The collection orders of your company. Create a draft with a referenced debtor and embedded claims, edit it while it is a draft, finalize it for review, and follow it to acceptance. 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=\"Create order - paywise Knowledge Center\">\u003cmeta data-mint-head property=\"og:description\" content=\"The collection orders of your company. Create a draft with a referenced debtor and embedded claims, edit it while it is a draft, finalize it for review, and follow it to acceptance. 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/orders/create-order\">\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=Orders\u0026amp;title=Create+order\u0026amp;description=The+collection+orders+of+your+company.%0A%0ACreate+a+draft+with+a+referenced+debtor+and+embedded+claims%2C%0Aedit+it+while+it+is+a+draft%2C+finalize+it+for+review%2C+and+fo\u0026amp;theme=bad878af30f1dee220dabe6f\u0026amp;signature=e8d1925c5bf19f86536386e95f04aec30edcc572504cfeb19a2a8b4b30e05db9\">\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=\"Create order - paywise Knowledge Center\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"The collection orders of your company. Create a draft with a referenced debtor and embedded claims, edit it while it is a draft, finalize it for review, and follow it to acceptance. Tenant-scoped by the authenticated company.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://paywisegmbh.mintlify.site/_mintlify/api/og/v2?division=Orders\u0026amp;title=Create+order\u0026amp;description=The+collection+orders+of+your+company.%0A%0ACreate+a+draft+with+a+referenced+debtor+and+embedded+claims%2C%0Aedit+it+while+it+is+a+draft%2C+finalize+it+for+review%2C+and+fo\u0026amp;theme=bad878af30f1dee220dabe6f\u0026amp;signature=e8d1925c5bf19f86536386e95f04aec30edcc572504cfeb19a2a8b4b30e05db9\">\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/orders/create-order\">\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/orders/create-order.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/orders/create-order#webpage\",\"url\":\"https://docs.paywise.de/api-docs/case-management-api/reference/orders/create-order\",\"name\":\"Create order\",\"description\":\"The collection orders of your company. Create a draft with a referenced debtor and embedded claims, edit it while it is a draft, finalize it for review, and follow it to acceptance. Tenant-scoped by the authenticated company.\",\"dateModified\":\"2026-10-16T12:47:30.191Z\",\"isPartOf\":{\"@id\":\"https://docs.paywise.de#website\"},\"breadcrumb\":{\"@id\":\"https://docs.paywise.de/api-docs/case-management-api/reference/orders/create-order#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.paywise.de/api-docs/case-management-api/reference/orders/create-order#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\":\"Orders\",\"item\":\"https://docs.paywise.de/api-docs/case-management-api/reference/orders/list-orders\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Create order\",\"item\":\"https://docs.paywise.de/api-docs/case-management-api/reference/orders/create-order\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.paywise.de/api-docs/case-management-api/reference/orders/create-order#apireference\",\"headline\":\"Create order\",\"name\":\"Create order\",\"description\":\"The collection orders of your company. Create a draft with a referenced debtor and embedded claims, edit it while it is a draft, finalize it for review, and follow it to acceptance. Tenant-scoped by the authenticated company.\",\"url\":\"https://docs.paywise.de/api-docs/case-management-api/reference/orders/create-order\",\"mainEntityOfPage\":{\"@id\":\"https://docs.paywise.de/api-docs/case-management-api/reference/orders/create-order#webpage\"},\"dateModified\":\"2026-10-16T12:47:30.191Z\",\"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/orders/create-order.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","description":"The collection orders of your company.\n\nCreate a draft with a referenced debtor and embedded claims,\nedit it while it is a draft, finalize it for review, and follow it to\nacceptance. Tenant-scoped by the authenticated company.","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","description":"The collection orders of your company.\n\nCreate a draft with a referenced debtor and embedded claims,\nedit it while it is a draft, finalize it for review, and follow it to\nacceptance. Tenant-scoped by the authenticated company.","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{id}/","href":"/api-docs/case-management-api/reference/orders/get-order"},{"title":"Update order","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json patch /v2/orders/{id}/","href":"/api-docs/case-management-api/reference/orders/update-order"},{"title":"Delete draft order","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json delete /v2/orders/{id}/","href":"/api-docs/case-management-api/reference/orders/delete-draft-order"},{"title":"Finalize order","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/orders/{id}/finalize/","href":"/api-docs/case-management-api/reference/orders/finalize-order"},{"title":"Withdraw order","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/orders/{id}/withdraw/","href":"/api-docs/case-management-api/reference/orders/withdraw-order"},{"group":"Messages","icon":"comments","pages":[{"title":"List order messages","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/messages/","href":"/api-docs/case-management-api/reference/orders/list-order-messages"},{"title":"Create order message","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/orders/{order_id}/messages/","href":"/api-docs/case-management-api/reference/orders/create-order-message"},{"title":"Get order message","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/messages/{id}/","href":"/api-docs/case-management-api/reference/orders/get-order-message"},{"title":"Update order message","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json patch /v2/orders/{order_id}/messages/{id}/","href":"/api-docs/case-management-api/reference/orders/update-order-message"},{"title":"List order message documents","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/messages/{message_id}/documents/","href":"/api-docs/case-management-api/reference/orders/list-order-message-documents"},{"title":"Create order message document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/orders/{order_id}/messages/{message_id}/documents/","href":"/api-docs/case-management-api/reference/orders/create-order-message-document"},{"title":"Get order message document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/messages/{message_id}/documents/{id}/","href":"/api-docs/case-management-api/reference/orders/get-order-message-document"},{"title":"Delete order message document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json delete /v2/orders/{order_id}/messages/{message_id}/documents/{id}/","href":"/api-docs/case-management-api/reference/orders/delete-order-message-document"},{"title":"Download order message document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/messages/{message_id}/documents/{id}/download/","href":"/api-docs/case-management-api/reference/orders/download-order-message-document"}]},{"group":"Requests to client","icon":"inbox","pages":[{"title":"List order requests to client","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/requests-to-client/","href":"/api-docs/case-management-api/reference/orders/list-order-requests-to-client"},{"title":"Get order request to client","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/requests-to-client/{id}/","href":"/api-docs/case-management-api/reference/orders/get-order-request-to-client"},{"title":"Answer order request to client","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/orders/{order_id}/requests-to-client/{id}/answer/","href":"/api-docs/case-management-api/reference/orders/answer-order-request-to-client"},{"title":"Download order request to client attachment","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/requests-to-client/{id}/attachments/{attachment_id}/download/","href":"/api-docs/case-management-api/reference/orders/download-order-request-to-client-attachment"},{"title":"List order request to client answer documents","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/requests-to-client/{request_id}/answer/documents/","href":"/api-docs/case-management-api/reference/orders/list-order-request-to-client-answer-documents"},{"title":"Create order request to client answer document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/orders/{order_id}/requests-to-client/{request_id}/answer/documents/","href":"/api-docs/case-management-api/reference/orders/create-order-request-to-client-answer-document"},{"title":"Get order request to client answer document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/requests-to-client/{request_id}/answer/documents/{id}/","href":"/api-docs/case-management-api/reference/orders/get-order-request-to-client-answer-document"},{"title":"Delete order request to client answer document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json delete /v2/orders/{order_id}/requests-to-client/{request_id}/answer/documents/{id}/","href":"/api-docs/case-management-api/reference/orders/delete-order-request-to-client-answer-document"},{"title":"Download order request to client answer document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/requests-to-client/{request_id}/answer/documents/{id}/download/","href":"/api-docs/case-management-api/reference/orders/download-order-request-to-client-answer-document"}]}]},{"group":"Claims","icon":"file-spreadsheet","pages":[{"title":"List claims","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/claims/","href":"/api-docs/case-management-api/reference/claims/list-claims"},{"title":"Create claim","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/claims/","href":"/api-docs/case-management-api/reference/claims/create-claim"},{"title":"Get claim","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/claims/{id}/","href":"/api-docs/case-management-api/reference/claims/get-claim"},{"title":"Update claim","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json patch /v2/claims/{id}/","href":"/api-docs/case-management-api/reference/claims/update-claim"},{"title":"Delete claim","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json delete /v2/claims/{id}/","href":"/api-docs/case-management-api/reference/claims/delete-claim"},{"group":"Documents","icon":"file-lines","pages":[{"title":"List claim documents","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/claims/{claim_id}/documents/","href":"/api-docs/case-management-api/reference/documents/list-claim-documents"},{"title":"Create claim document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/claims/{claim_id}/documents/","href":"/api-docs/case-management-api/reference/documents/create-claim-document"},{"title":"Get claim document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/claims/{claim_id}/documents/{id}/","href":"/api-docs/case-management-api/reference/documents/get-claim-document"},{"title":"Delete claim document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json delete /v2/claims/{claim_id}/documents/{id}/","href":"/api-docs/case-management-api/reference/documents/delete-claim-document"},{"title":"Download claim document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/claims/{claim_id}/documents/{id}/download/","href":"/api-docs/case-management-api/reference/documents/download-claim-document"}]},{"group":"Payments","icon":"credit-card","pages":[{"title":"List claim payments","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/claims/{claim_id}/payments/","href":"/api-docs/case-management-api/reference/claims/list-claim-payments"},{"title":"Create claim payment","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/claims/{claim_id}/payments/","href":"/api-docs/case-management-api/reference/claims/create-claim-payment"},{"title":"Delete claim payment","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json delete /v2/claims/{claim_id}/payments/{id}/","href":"/api-docs/case-management-api/reference/claims/delete-claim-payment"}]},{"group":"Enforceable titles","icon":"scale-balanced","pages":[{"title":"Get enforceable title","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/claims/{claim_id}/enforceable-title/","href":"/api-docs/case-management-api/reference/claims/get-enforceable-title"},{"title":"Replace enforceable title","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json put /v2/claims/{claim_id}/enforceable-title/","href":"/api-docs/case-management-api/reference/claims/replace-enforceable-title"},{"title":"Update enforceable title","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json patch /v2/claims/{claim_id}/enforceable-title/","href":"/api-docs/case-management-api/reference/claims/update-enforceable-title"},{"title":"Delete enforceable title","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json delete /v2/claims/{claim_id}/enforceable-title/","href":"/api-docs/case-management-api/reference/claims/delete-enforceable-title"},{"title":"List enforceable title documents","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/claims/{claim_id}/enforceable-title/documents/","href":"/api-docs/case-management-api/reference/claims/list-enforceable-title-documents"},{"title":"Create enforceable title document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/claims/{claim_id}/enforceable-title/documents/","href":"/api-docs/case-management-api/reference/claims/create-enforceable-title-document"},{"title":"Get enforceable title document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/claims/{claim_id}/enforceable-title/documents/{id}/","href":"/api-docs/case-management-api/reference/claims/get-enforceable-title-document"},{"title":"Delete enforceable title document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json delete /v2/claims/{claim_id}/enforceable-title/documents/{id}/","href":"/api-docs/case-management-api/reference/claims/delete-enforceable-title-document"},{"title":"Download enforceable title document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/claims/{claim_id}/enforceable-title/documents/{id}/download/","href":"/api-docs/case-management-api/reference/claims/download-enforceable-title-document"}]}]},{"group":"Rental agreements","icon":"house","pages":[{"title":"Get rental agreement","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/rental-agreement/","href":"/api-docs/case-management-api/reference/orders/get-rental-agreement"},{"title":"Update rental agreement","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json patch /v2/orders/{order_id}/rental-agreement/","href":"/api-docs/case-management-api/reference/orders/update-rental-agreement"},{"title":"List rental agreement documents","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/rental-agreement/documents/","href":"/api-docs/case-management-api/reference/orders/list-rental-agreement-documents"},{"title":"Create rental agreement document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/orders/{order_id}/rental-agreement/documents/","href":"/api-docs/case-management-api/reference/orders/create-rental-agreement-document"},{"title":"Get rental agreement document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/rental-agreement/documents/{id}/","href":"/api-docs/case-management-api/reference/orders/get-rental-agreement-document"},{"title":"Delete rental agreement document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json delete /v2/orders/{order_id}/rental-agreement/documents/{id}/","href":"/api-docs/case-management-api/reference/orders/delete-rental-agreement-document"},{"title":"Download rental agreement document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/rental-agreement/documents/{id}/download/","href":"/api-docs/case-management-api/reference/orders/download-rental-agreement-document"}]},{"group":"Debtors","icon":"users","pages":[{"title":"List debtors","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/debtors/","href":"/api-docs/case-management-api/reference/debtors/list-debtors"},{"title":"Create debtor","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/debtors/","href":"/api-docs/case-management-api/reference/debtors/create-debtor"},{"title":"Get debtor","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/debtors/{id}/","href":"/api-docs/case-management-api/reference/debtors/get-debtor"},{"title":"Update debtor","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json patch /v2/debtors/{id}/","href":"/api-docs/case-management-api/reference/debtors/update-debtor"}]},{"group":"Mandates","icon":"folder","pages":[{"title":"List mandates","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":"Create order - 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"]}