using RestSharp;
var options = new RestClientOptions("https://api.paywise.de/v1/claims/{id}/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"submission_state\": \"released\"\n}", false);
var response = await client.PatchAsync(request);
Console.WriteLine("{0}", response.Content);
Releases a claim for processing by paywise. To do so, set the claim’s submission_state field to released. After release, a claim cannot be changed anymore. To make changes to an already released claim, please contact our support.
using RestSharp;
var options = new RestClientOptions("https://api.paywise.de/v1/claims/{id}/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"submission_state\": \"released\"\n}", false);
var response = await client.PatchAsync(request);
Console.WriteLine("{0}", response.Content);
The current state of the claim submission. Possible values: created (claim saved in the system; does NOT constitute acceptance by paywise), released (released for processing by paywise), under_review (claim is being reviewed by our team), client_response_pending (waiting for your response), accepted (claim accepted and being processed), rejected (claim was rejected), cancelled (claim was cancelled by the client).
E-mail addresses the rejection notice was delivered to (your configured notification recipients at the time). Empty unless submission_state is rejected.
The date of your first reminder ("Mahnung") to your customer. Please note: the date of a "Zahlungserinnerung" does not qualify. It must be a "Mahnung" by german standards.
The total open amount of the claim, including additional charges. Equals the sum of the main claim amount and the sum of all additional charges' amounts - minus any payments you already received on the claim.
Additional charges for your claim ("incidental claims" or "Nebenforderungen"). Those are typically reminder fees ("Mahngebühren") or bank charges for chargebacks ("Rücklastschriftgebühren").
The metadata object allows you to submit additional relevant information related to the claim as type/value pairs. You can submit an unlimited number of metadata sets.
Events regarding the claim. See request/response examples.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"paywise Knowledge Center","colors":{"primary":"#fd7e14","light":"#6a9bf4","dark":"#37384e"},"logo":{"light":"https://mintcdn.com/paywisegmbh/NM1UIIld1WRHivnS/logo/paywise-logo.svg?fit=max\u0026auto=format\u0026n=NM1UIIld1WRHivnS\u0026q=85\u0026s=0d1a1b06e878f9d25ef70b19e3df50cc","dark":"https://mintcdn.com/paywisegmbh/NM1UIIld1WRHivnS/logo/paywise-logo-light.png?fit=max\u0026auto=format\u0026n=NM1UIIld1WRHivnS\u0026q=85\u0026s=ab0f73c7353586d673c947dc946db86b"},"favicon":"https://mintcdn.com/paywisegmbh/NM1UIIld1WRHivnS/favicon-32x32.png?fit=max\u0026auto=format\u0026n=NM1UIIld1WRHivnS\u0026q=85\u0026s=f1eaf1b6461ee62ec891fd1a5309f891","api":{"examples":{"defaults":"required","languages":["python","javascript","java","csharp","curl"],"prefill":true,"autogenerate":true}},"navbar":{"links":[{"href":"mailto:[email protected]","label":"Kontakt"}],"primary":{"type":"button","label":"Login","href":"https://app.paywise.de/account/"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/paywise-gmbh","github":"https://github.com/paywise-gmbh"}},"contextual":{"options":["copy","view","chatgpt","claude","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"languages":[{"language":"de","default":true,"href":"user-docs/overview"},{"language":"en","href":"en/user-docs/overview"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"paywisegmbh","hasAudioNarration":false,"actualSubdomain":"paywisegmbh","customDomains":["docs.paywise.de"],"gitSource":{"type":"github","owner":"paywise-gmbh","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae89f3bf8e61e223f920eed","collectionId":"8c709daa-6feb-48f9-972e-b03b95262215","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae89f3bf8e61e223f920eed"},"entitlements":{},"buildId":"6ae89f3bf8e61e223f920eed","clientVersion":"0.0.4076","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":"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":"llms-txt-v2","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":"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":"comment-mode","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/legacy/case-management/reference/claims/release-claim-for-processing","slug":"/api-docs/legacy/case-management/reference/claims/release-claim-for-processing","pageMetadata":{"title":"Release claim for processing","description":"Releases a claim for processing by paywise. To do so, set the claim's *submission_state* field to *released*. After release, a claim cannot be changed anymore. To make changes to an already released claim, please contact our support.","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","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n em: \"em\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Releases a claim for processing by paywise. To do so, set the claim’s \", _jsx(_components.em, {\n children: \"submission_state\"\n }), \" field to \", _jsx(_components.em, {\n children: \"released\"\n }), \". After release, a claim cannot be changed anymore. To make changes to an already released claim, please contact our support.\"]\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":"Release claim for processing","description":"Releases a claim for processing by paywise. To do so, set the claim's *submission_state* field to *released*. After release, a claim cannot be changed anymore. To make changes to an already released claim, please contact our support.","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","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/paywisegmbh/c0e4bbe3e0c9277e/api-field-anchors.js"],"openApiReferenceData":{"operation":{"operationId":"release-claim","description":"Releases a claim for processing by paywise. To do so, set the claim's *submission_state* field to *released*. After release, a claim cannot be changed anymore. To make changes to an already released claim, please contact our support.","summary":"Release claim for processing","parameters":["7403a27c-1cda-4b3d-9a15-95851bf20400"],"tags":["claims"],"requestBody":"e93ef712-6602-41da-883b-3974abf5aba3","security":["d10ffc61-ad2a-4066-bb77-3cf2263715f7","36a0050b-c162-4294-b567-e5e7cbb44fca"],"responses":{"200":"954b319c-b374-4bb4-b008-2b3f81c015f2"},"method":"patch","type":"path","servers":["e29e3281-35a6-490f-9197-c1dfaf100ed3"],"path":"/v1/claims/{id}/","baseUrlOptions":["https://api.paywise.de"],"title":"Release claim for processing","codeSamples":[],"requestExampleLanguages":["python","javascript","java","csharp","bash"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.submission_state.oneOf.0":"released"}]},"dependencies":{"parameters":{"7403a27c-1cda-4b3d-9a15-95851bf20400":{"in":"path","name":"id","schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"submission_state":{"oneOf":[{"type":"string","description":"* `created` - Created\n* `released` - Released for processing\n* `under_review` - Under review\n* `client_response_pending` - Pending client response\n* `accepted` - Accepted\n* `rejected` - Rejected\n* `cancelled` - Cancelled by client","enum":["created","released","under_review","client_response_pending","accepted","rejected","cancelled"],"uniqueKey":"submission_state.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","enum":[""],"uniqueKey":"submission_state.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"submission_state","typeLabel":"enum\u003cstring>"},"send_order_confirmation":{"type":"boolean","default":false,"description":"Indicates whether you want to receive an order entry Email ('Eingangsbest�tigung')","uniqueKey":"send_order_confirmation","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example1":{"title":"Example1","value":{"submission_state":"released"}}},"exampleType":"examples"},"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"submission_state":{"oneOf":[{"type":"string","description":"* `created` - Created\n* `released` - Released for processing\n* `under_review` - Under review\n* `client_response_pending` - Pending client response\n* `accepted` - Accepted\n* `rejected` - Rejected\n* `cancelled` - Cancelled by client","enum":["created","released","under_review","client_response_pending","accepted","rejected","cancelled"],"uniqueKey":"submission_state.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","enum":[""],"uniqueKey":"submission_state.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"submission_state","typeLabel":"enum\u003cstring>"},"send_order_confirmation":{"type":"boolean","default":false,"description":"Indicates whether you want to receive an order entry Email ('Eingangsbest�tigung')","uniqueKey":"send_order_confirmation","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"send_order_confirmation":false}}},"exampleType":"generated"},"multipart/form-data":{"schema":{"type":"object","properties":{"submission_state":{"oneOf":[{"type":"string","description":"* `created` - Created\n* `released` - Released for processing\n* `under_review` - Under review\n* `client_response_pending` - Pending client response\n* `accepted` - Accepted\n* `rejected` - Rejected\n* `cancelled` - Cancelled by client","enum":["created","released","under_review","client_response_pending","accepted","rejected","cancelled"],"uniqueKey":"submission_state.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","enum":[""],"uniqueKey":"submission_state.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"submission_state","typeLabel":"enum\u003cstring>"},"send_order_confirmation":{"type":"boolean","default":false,"description":"Indicates whether you want to receive an order entry Email ('Eingangsbest�tigung')","uniqueKey":"send_order_confirmation","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"send_order_confirmation":false}}},"exampleType":"generated"}},"exampleType":"examples"},"responses":{"954b319c-b374-4bb4-b008-2b3f81c015f2":{"content":{"application/json":{"schema":{"type":"object","properties":{"href":{"type":"string","format":"uri","readOnly":true,"isRequired":true,"uniqueKey":"href","typeLabel":"string\u003curi>"},"submission_state":{"type":"string","description":"The current state of the claim submission. Possible values: **created** (claim saved in the system; does NOT constitute acceptance by paywise), **released** (released for processing by paywise), **under_review** (claim is being reviewed by our team), **client_response_pending** (waiting for your response), **accepted** (claim accepted and being processed), **rejected** (claim was rejected), **cancelled** (claim was cancelled by the client).\n\n* `created` - Created\n* `released` - Released for processing\n* `under_review` - Under review\n* `client_response_pending` - Pending client response\n* `accepted` - Accepted\n* `rejected` - Rejected\n* `cancelled` - Cancelled by client","enum":["created","released","under_review","client_response_pending","accepted","rejected","cancelled"],"isRequired":true,"uniqueKey":"submission_state","typeLabel":"enum\u003cstring>"},"rejection_reason":{"oneOf":[{"type":"string","readOnly":true,"description":"Plain-text reason why paywise rejected this claim. Only set when submission_state is **rejected**; null otherwise.","isRequired":true,"uniqueKey":"rejection_reason.oneOf.0","typeLabel":"string"},{"type":"null","readOnly":true,"description":"Plain-text reason why paywise rejected this claim. Only set when submission_state is **rejected**; null otherwise.","isRequired":true,"uniqueKey":"rejection_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"rejection_reason","typeLabel":"string | null"},"rejected_at":{"oneOf":[{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp of the rejection. Only set when submission_state is **rejected**.","isRequired":true,"uniqueKey":"rejected_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","readOnly":true,"description":"Timestamp of the rejection. Only set when submission_state is **rejected**.","isRequired":true,"uniqueKey":"rejected_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"rejected_at","typeLabel":"string\u003cdate-time> | null"},"rejection_notified_to":{"type":"array","items":{"type":"string","format":"email","uniqueKey":"rejection_notified_to.items.[INDEX]","typeLabel":"string\u003cemail>"},"readOnly":true,"description":"E-mail addresses the rejection notice was delivered to (your configured notification recipients at the time). Empty unless submission_state is **rejected**.","isRequired":true,"uniqueKey":"rejection_notified_to","typeLabel":"string\u003cemail>[]"},"debtor":{"type":"string","format":"uuid","description":"Your existing debtor's ID.","isRequired":true,"uniqueKey":"debtor","typeLabel":"string\u003cuuid>"},"mandate":{"type":"object","description":"After a submitted claim was accepted by our team, it is added to a mandate.","required":["href"],"properties":{"href":{"type":"string","format":"uri","readOnly":true,"isRequired":true,"uniqueKey":"mandate.href","typeLabel":"string\u003curi>"},"id":{"type":"string","uniqueKey":"mandate.id","typeLabel":"string"},"reference_number":{"type":"string","description":"Our case file reference number (\"Aktenzeichen\").","uniqueKey":"mandate.reference_number","typeLabel":"string"}},"isRequired":true,"uniqueKey":"mandate","typeLabel":"object"},"your_reference":{"oneOf":[{"type":"string","description":"Your unique reference.","maxLength":255,"isRequired":true,"uniqueKey":"your_reference.oneOf.0","typeLabel":"string"},{"type":"null","description":"Your unique reference.","maxLength":255,"isRequired":true,"uniqueKey":"your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"your_reference","typeLabel":"string | null"},"subject_matter":{"oneOf":[{"type":"string","description":"A detailed description of the delivered goods or the provided service.","isRequired":true,"uniqueKey":"subject_matter.oneOf.0","typeLabel":"string"},{"type":"null","description":"A detailed description of the delivered goods or the provided service.","isRequired":true,"uniqueKey":"subject_matter.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"subject_matter","typeLabel":"string | null"},"occurence_date":{"oneOf":[{"type":"string","format":"date","description":"The date of emergence of the principal claim (\"Vertragsdatum\").","isRequired":true,"uniqueKey":"occurence_date.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","description":"The date of emergence of the principal claim (\"Vertragsdatum\").","isRequired":true,"uniqueKey":"occurence_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"occurence_date","typeLabel":"string\u003cdate> | null"},"document_reference":{"oneOf":[{"type":"string","description":"The unique reference of your invoice (\"Rechnungsnummer\"), contract (\"Vertragsnummer\") or other document (\"Belegnummer\").","maxLength":255,"isRequired":true,"uniqueKey":"document_reference.oneOf.0","typeLabel":"string"},{"type":"null","description":"The unique reference of your invoice (\"Rechnungsnummer\"), contract (\"Vertragsnummer\") or other document (\"Belegnummer\").","maxLength":255,"isRequired":true,"uniqueKey":"document_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"document_reference","typeLabel":"string | null"},"document_date":{"oneOf":[{"type":"string","format":"date","description":"The date of your invoice (\"Rechnungsdatum\"), contract (\"Vertragsdatum\") or other document (\"Belegdatum\").","isRequired":true,"uniqueKey":"document_date.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","description":"The date of your invoice (\"Rechnungsdatum\"), contract (\"Vertragsdatum\") or other document (\"Belegdatum\").","isRequired":true,"uniqueKey":"document_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"document_date","typeLabel":"string\u003cdate> | null"},"due_date":{"oneOf":[{"type":"string","format":"date","description":"The date your claim was due for payment.","isRequired":true,"uniqueKey":"due_date.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","description":"The date your claim was due for payment.","isRequired":true,"uniqueKey":"due_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"due_date","typeLabel":"string\u003cdate> | null"},"reminder_date":{"oneOf":[{"type":"string","format":"date","description":"The date of your first reminder (\"Mahnung\") to your customer. Please note: the date of a \"Zahlungserinnerung\" does not qualify. It must be a \"Mahnung\" by german standards.","isRequired":true,"uniqueKey":"reminder_date.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","description":"The date of your first reminder (\"Mahnung\") to your customer. Please note: the date of a \"Zahlungserinnerung\" does not qualify. It must be a \"Mahnung\" by german standards.","isRequired":true,"uniqueKey":"reminder_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"reminder_date","typeLabel":"string\u003cdate> | null"},"delay_date":{"oneOf":[{"type":"string","format":"date","description":"The date from which your debtor is in delay (\"Verzugsdatum\"). Please check back with our team if you are unsure what to place here.","isRequired":true,"uniqueKey":"delay_date.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","description":"The date from which your debtor is in delay (\"Verzugsdatum\"). Please check back with our team if you are unsure what to place here.","isRequired":true,"uniqueKey":"delay_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"delay_date","typeLabel":"string\u003cdate> | null"},"total_claim_amount":{"type":"object","description":"The total **open** amount of the claim, including additional charges. Equals the sum of the main claim amount and the sum of all additional charges' amounts - minus any payments you already received on the claim.","properties":{"value":{"oneOf":[{"type":"string","format":"decimal","pattern":"^-?\\d{0,14}(?:\\.\\d{0,2})?$","description":"A string representation of a positive integer or decimal with two decimal places.","uniqueKey":"total_claim_amount.value.oneOf.0","typeLabel":"string\u003cdecimal>"},{"type":"null","format":"decimal","pattern":"^-?\\d{0,14}(?:\\.\\d{0,2})?$","description":"A string representation of a positive integer or decimal with two decimal places.","uniqueKey":"total_claim_amount.value.oneOf.1","typeLabel":"null"}],"uniqueKey":"total_claim_amount.value","typeLabel":"string\u003cdecimal> | null"},"currency":{"type":"string","description":"The three-character currency code (ISO-4217).\n\n* `EUR` - Euro\n* `USD` - US Dollar","enum":["EUR","USD"],"uniqueKey":"total_claim_amount.currency","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"total_claim_amount","typeLabel":"object"},"main_claim_amount":{"type":"object","description":"The **original amount** of the principal claim including VAT or sales tax. Does not have any additional charges added or payments subtracted.","properties":{"value":{"oneOf":[{"type":"string","format":"decimal","pattern":"^-?\\d{0,14}(?:\\.\\d{0,2})?$","description":"A string representation of a positive integer or decimal with two decimal places.","uniqueKey":"main_claim_amount.value.oneOf.0","typeLabel":"string\u003cdecimal>"},{"type":"null","format":"decimal","pattern":"^-?\\d{0,14}(?:\\.\\d{0,2})?$","description":"A string representation of a positive integer or decimal with two decimal places.","uniqueKey":"main_claim_amount.value.oneOf.1","typeLabel":"null"}],"uniqueKey":"main_claim_amount.value","typeLabel":"string\u003cdecimal> | null"},"currency":{"type":"string","description":"The three-character currency code (ISO-4217).\n\n* `EUR` - Euro\n* `USD` - US Dollar","enum":["EUR","USD"],"uniqueKey":"main_claim_amount.currency","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"main_claim_amount","typeLabel":"object"},"starting_approach":{"type":"string","description":"Our starting approach to collect the claim: extrajudicial (\"außergerichtlich\") or judicial (\"gerichtliches Mahnverfahren\").\n\n* `extrajudicial` - Zunächst außergerichtlich starten\n* `judicial` - Gleich Mahnbescheid beantragen\n* `enforcement` - Direkt vollstrecken","enum":["extrajudicial","judicial","enforcement"],"isRequired":true,"uniqueKey":"starting_approach","typeLabel":"enum\u003cstring>"},"claim_disputed":{"type":"boolean","description":"Tell us if the claim was disputed by your customer. If you are unsure what to select here, please check back with our team.\n\n* `True` - Ja\n* `False` - Nein","enum":[true,false],"isRequired":true,"uniqueKey":"claim_disputed","typeLabel":"enum\u003cboolean>"},"obligation_fulfilled":{"type":"boolean","description":"Tell us if you fully fulfilled your contractual obligation towards the debtor. If you are unsure what to select here, please check back with our team.\n\n* `True` - Ja\n* `False` - Nein","enum":[true,false],"isRequired":true,"uniqueKey":"obligation_fulfilled","typeLabel":"enum\u003cboolean>"},"documents":{"type":"array","items":{"type":"object","properties":{"mime_type":{"oneOf":[{"type":"string","readOnly":true,"isRequired":true,"uniqueKey":"documents.items.[INDEX].mime_type.oneOf.0","typeLabel":"string"},{"type":"null","readOnly":true,"isRequired":true,"uniqueKey":"documents.items.[INDEX].mime_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"documents.items.[INDEX].mime_type","typeLabel":"string | null"},"filename":{"type":"string","isRequired":true,"uniqueKey":"documents.items.[INDEX].filename","typeLabel":"string"},"id":{"type":"string","uniqueKey":"documents.items.[INDEX].id","typeLabel":"string"}},"required":["filename","mime_type"],"uniqueKey":"documents.items.[INDEX]","typeLabel":"object"},"readOnly":true,"description":"Documents relevant for processing of the claim. Usually invoices, reminders, contracts or correspondence with the debtor.","isRequired":true,"uniqueKey":"documents","typeLabel":"object[]"},"created":{"type":"string","format":"date-time","readOnly":true,"isRequired":true,"uniqueKey":"created","typeLabel":"string\u003cdate-time>"},"updated":{"type":"string","format":"date-time","readOnly":true,"isRequired":true,"uniqueKey":"updated","typeLabel":"string\u003cdate-time>"},"id":{"type":"string","uniqueKey":"id","typeLabel":"string"},"items":{"type":"array","items":{"type":"object","description":"Main claim items do not have fields occurence_date and document_date","properties":{"description":{"type":"string","description":"A description of the item.","maxLength":1000,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].description","typeLabel":"string"},"quantity":{"type":"number","format":"double","description":"The quantity of the item. Usually a number of pieces or hours.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].quantity","typeLabel":"number\u003cdouble>"},"amount":{"type":"object","description":"The amount invoices for the item (\"Betrag des Rechnungspostens\").","properties":{"value":{"oneOf":[{"type":"string","format":"decimal","pattern":"^-?\\d{0,14}(?:\\.\\d{0,2})?$","description":"A string representation of a positive integer or decimal with two decimal places.","uniqueKey":"\\items.items.[INDEX].amount.value.oneOf.0","typeLabel":"string\u003cdecimal>"},{"type":"null","format":"decimal","pattern":"^-?\\d{0,14}(?:\\.\\d{0,2})?$","description":"A string representation of a positive integer or decimal with two decimal places.","uniqueKey":"\\items.items.[INDEX].amount.value.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].amount.value","typeLabel":"string\u003cdecimal> | null"},"currency":{"type":"string","description":"The three-character currency code (ISO-4217).\n\n* `EUR` - Euro\n* `USD` - US Dollar","enum":["EUR","USD"],"uniqueKey":"\\items.items.[INDEX].amount.currency","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].amount","typeLabel":"object"},"unit":{"oneOf":[{"type":"string","description":"The unit used to measure the quantity of the item. Examples are: \"pcs\" (\"pieces\"), \"hours\", \"kg\" (kilograms)","maxLength":255,"uniqueKey":"\\items.items.[INDEX].unit.oneOf.0","typeLabel":"string"},{"type":"null","description":"The unit used to measure the quantity of the item. Examples are: \"pcs\" (\"pieces\"), \"hours\", \"kg\" (kilograms)","maxLength":255,"uniqueKey":"\\items.items.[INDEX].unit.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].unit","typeLabel":"string | null"}},"required":["amount","description","quantity"],"uniqueKey":"\\items.items.[INDEX]","typeLabel":"object"},"description":"The items listed on your invoice or contract (\"Rechnungsposten\" or \"Leistungen\")","uniqueKey":"\\items","typeLabel":"object[]"},"additional_charges_amount":{"type":"object","description":"The sum of all additional charges of the claim.","properties":{"value":{"oneOf":[{"type":"string","format":"decimal","pattern":"^-?\\d{0,14}(?:\\.\\d{0,2})?$","description":"A string representation of a positive integer or decimal with two decimal places.","uniqueKey":"additional_charges_amount.value.oneOf.0","typeLabel":"string\u003cdecimal>"},{"type":"null","format":"decimal","pattern":"^-?\\d{0,14}(?:\\.\\d{0,2})?$","description":"A string representation of a positive integer or decimal with two decimal places.","uniqueKey":"additional_charges_amount.value.oneOf.1","typeLabel":"null"}],"uniqueKey":"additional_charges_amount.value","typeLabel":"string\u003cdecimal> | null"},"currency":{"type":"string","description":"The three-character currency code (ISO-4217).\n\n* `EUR` - Euro\n* `USD` - US Dollar","enum":["EUR","USD"],"uniqueKey":"additional_charges_amount.currency","typeLabel":"enum\u003cstring>"}},"uniqueKey":"additional_charges_amount","typeLabel":"object"},"additional_charges":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of additional charge (e.g., \"reminder_fee\", \"chargeback_fee\", etc.).\n\n* `reminder_fee` - Mahngebühr\n* `bank_charge` - Bankgebühr\n* `research_costs` - Ermittlungskosten Gläubiger\n* `processing_fee` - Bearbeitungsgebühr\n* `cancellation_fee` - Abbruch-/Stornierungsgebühr\n* `convenience_fee` - Aufwandsgebühr\n* `advisory_fee` - Beratungsgebühr\n* `handling_fee` - Bearbeitungspauschale\n* `insurance_fee` - Versicherungsgebühr\n* `legal_fee` - Rechtsverfolgungskosten\n* `delivery_charge` - Versandkosten\n* `service_charge` - Servicegebühr\n* `data_preparation` - Datenaufbereitung\n* `communication_cost` - Kommunikationskosten\n* `expenses` - Auslagen","enum":["reminder_fee","bank_charge","research_costs","processing_fee","cancellation_fee","convenience_fee","advisory_fee","handling_fee","insurance_fee","legal_fee","delivery_charge","service_charge","data_preparation","communication_cost","expenses"],"isRequired":true,"uniqueKey":"additional_charges.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"your_reference":{"oneOf":[{"type":"string","description":"Your unique reference.","maxLength":255,"isRequired":true,"uniqueKey":"additional_charges.items.[INDEX].your_reference.oneOf.0","typeLabel":"string"},{"type":"null","description":"Your unique reference.","maxLength":255,"isRequired":true,"uniqueKey":"additional_charges.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"additional_charges.items.[INDEX].your_reference","typeLabel":"string | null"},"subject_matter":{"oneOf":[{"type":"string","description":"A description of the incidental claim. For example \"Mahngebühren 1. Mahnung\".","isRequired":true,"uniqueKey":"additional_charges.items.[INDEX].subject_matter.oneOf.0","typeLabel":"string"},{"type":"null","description":"A description of the incidental claim. For example \"Mahngebühren 1. Mahnung\".","isRequired":true,"uniqueKey":"additional_charges.items.[INDEX].subject_matter.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"additional_charges.items.[INDEX].subject_matter","typeLabel":"string | null"},"occurence_date":{"oneOf":[{"type":"string","format":"date","description":"The date the charge was initiated. For example the date of the reminder (reminder fee) or a chargeback fee's value date.","isRequired":true,"uniqueKey":"additional_charges.items.[INDEX].occurence_date.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","description":"The date the charge was initiated. For example the date of the reminder (reminder fee) or a chargeback fee's value date.","isRequired":true,"uniqueKey":"additional_charges.items.[INDEX].occurence_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"additional_charges.items.[INDEX].occurence_date","typeLabel":"string\u003cdate> | null"},"document_date":{"oneOf":[{"type":"string","format":"date","description":"The date of the document the charge was initiated with (\"Belegdatum\").","isRequired":true,"uniqueKey":"additional_charges.items.[INDEX].document_date.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","description":"The date of the document the charge was initiated with (\"Belegdatum\").","isRequired":true,"uniqueKey":"additional_charges.items.[INDEX].document_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"additional_charges.items.[INDEX].document_date","typeLabel":"string\u003cdate> | null"},"due_date":{"oneOf":[{"type":"string","format":"date","description":"The date your additional charge was due for payment. Applicaple mainly for payment reminders. Leave empty if no due date exists (for example in case of bank fees)","isRequired":true,"uniqueKey":"additional_charges.items.[INDEX].due_date.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","description":"The date your additional charge was due for payment. Applicaple mainly for payment reminders. Leave empty if no due date exists (for example in case of bank fees)","isRequired":true,"uniqueKey":"additional_charges.items.[INDEX].due_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"additional_charges.items.[INDEX].due_date","typeLabel":"string\u003cdate> | null"},"amount":{"type":"object","description":"The amount of the additional charge.","properties":{"value":{"oneOf":[{"type":"string","format":"decimal","pattern":"^-?\\d{0,14}(?:\\.\\d{0,2})?$","description":"A string representation of a positive integer or decimal with two decimal places.","uniqueKey":"additional_charges.items.[INDEX].amount.value.oneOf.0","typeLabel":"string\u003cdecimal>"},{"type":"null","format":"decimal","pattern":"^-?\\d{0,14}(?:\\.\\d{0,2})?$","description":"A string representation of a positive integer or decimal with two decimal places.","uniqueKey":"additional_charges.items.[INDEX].amount.value.oneOf.1","typeLabel":"null"}],"uniqueKey":"additional_charges.items.[INDEX].amount.value","typeLabel":"string\u003cdecimal> | null"},"currency":{"type":"string","description":"The three-character currency code (ISO-4217).\n\n* `EUR` - Euro\n* `USD` - US Dollar","enum":["EUR","USD"],"uniqueKey":"additional_charges.items.[INDEX].amount.currency","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"additional_charges.items.[INDEX].amount","typeLabel":"object"},"id":{"type":"string","uniqueKey":"additional_charges.items.[INDEX].id","typeLabel":"string"},"metadata":{"type":"array","items":{"type":"object","description":"Metadata for debtors","properties":{"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"],"type":"string","description":"* `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","isRequired":true,"uniqueKey":"additional_charges.items.[INDEX].metadata.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","maxLength":255,"isRequired":true,"uniqueKey":"additional_charges.items.[INDEX].metadata.items.[INDEX].value","typeLabel":"string"}},"required":["type","value"],"uniqueKey":"additional_charges.items.[INDEX].metadata.items.[INDEX]","typeLabel":"object"},"description":"The metadata object allows you to submit additional relevant information related to the additional charge as type/value pairs. You can submit an unlimited number of metadata sets.","uniqueKey":"additional_charges.items.[INDEX].metadata","typeLabel":"object[]"},"events":{"type":"array","items":{"type":"object","description":"Base class for events. Subclassed by other serializers.","properties":{"type":{"enum":["invoice","transaction"],"type":"string","description":"* `invoice` - invoice\n* `transaction` - transaction","isRequired":true,"uniqueKey":"additional_charges.items.[INDEX].events.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"title":{"type":"string","maxLength":255,"isRequired":true,"uniqueKey":"additional_charges.items.[INDEX].events.items.[INDEX].title","typeLabel":"string"},"occurence":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"additional_charges.items.[INDEX].events.items.[INDEX].occurence","typeLabel":"string\u003cdate-time>"},"your_reference":{"oneOf":[{"type":"string","maxLength":255,"uniqueKey":"additional_charges.items.[INDEX].events.items.[INDEX].your_reference.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"uniqueKey":"additional_charges.items.[INDEX].events.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"uniqueKey":"additional_charges.items.[INDEX].events.items.[INDEX].your_reference","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","maxLength":255,"uniqueKey":"additional_charges.items.[INDEX].events.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"uniqueKey":"additional_charges.items.[INDEX].events.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"additional_charges.items.[INDEX].events.items.[INDEX].description","typeLabel":"string | null"},"location":{"oneOf":[{"type":"string","maxLength":255,"uniqueKey":"additional_charges.items.[INDEX].events.items.[INDEX].location.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"uniqueKey":"additional_charges.items.[INDEX].events.items.[INDEX].location.oneOf.1","typeLabel":"null"}],"uniqueKey":"additional_charges.items.[INDEX].events.items.[INDEX].location","typeLabel":"string | null"}},"required":["occurence","title","type"],"uniqueKey":"additional_charges.items.[INDEX].events.items.[INDEX]","typeLabel":"object"},"description":"Events regarding the additional charge. See request/response examples.","uniqueKey":"additional_charges.items.[INDEX].events","typeLabel":"object[]"}},"required":["amount","document_date","due_date","occurence_date","subject_matter","type","your_reference"],"uniqueKey":"additional_charges.items.[INDEX]","typeLabel":"object"},"description":"Additional charges for your claim (\"incidental claims\" or \"Nebenforderungen\"). Those are typically reminder fees (\"Mahngebühren\") or bank charges for chargebacks (\"Rücklastschriftgebühren\").","uniqueKey":"additional_charges","typeLabel":"object[]"},"payments":{"type":"array","items":{"type":"object","description":"A payment associated for a claim","properties":{"href":{"type":"string","format":"uri","readOnly":true,"isRequired":true,"uniqueKey":"payments.items.[INDEX].href","typeLabel":"string\u003curi>"},"amount":{"type":"object","description":"The amount of the payment.","properties":{"value":{"oneOf":[{"type":"string","format":"decimal","pattern":"^-?\\d{0,14}(?:\\.\\d{0,2})?$","description":"A string representation of a positive integer or decimal with two decimal places.","uniqueKey":"payments.items.[INDEX].amount.value.oneOf.0","typeLabel":"string\u003cdecimal>"},{"type":"null","format":"decimal","pattern":"^-?\\d{0,14}(?:\\.\\d{0,2})?$","description":"A string representation of a positive integer or decimal with two decimal places.","uniqueKey":"payments.items.[INDEX].amount.value.oneOf.1","typeLabel":"null"}],"uniqueKey":"payments.items.[INDEX].amount.value","typeLabel":"string\u003cdecimal> | null"},"currency":{"type":"string","description":"The three-character currency code (ISO-4217).\n\n* `EUR` - Euro\n* `USD` - US Dollar","enum":["EUR","USD"],"uniqueKey":"payments.items.[INDEX].amount.currency","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"payments.items.[INDEX].amount","typeLabel":"object"},"value_date":{"type":"string","format":"date","description":"The value date of the payment.","isRequired":true,"uniqueKey":"payments.items.[INDEX].value_date","typeLabel":"string\u003cdate>"},"created":{"type":"string","format":"date-time","readOnly":true,"isRequired":true,"uniqueKey":"payments.items.[INDEX].created","typeLabel":"string\u003cdate-time>"},"your_reference":{"oneOf":[{"type":"string","description":"Your unique reference.","maxLength":255,"uniqueKey":"payments.items.[INDEX].your_reference.oneOf.0","typeLabel":"string"},{"type":"null","description":"Your unique reference.","maxLength":255,"uniqueKey":"payments.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"uniqueKey":"payments.items.[INDEX].your_reference","typeLabel":"string | null"},"metadata":{"type":"array","items":{"type":"object","description":"Metadata for payments","properties":{"type":{"enum":["comment","invoice:reference","invoice:update_and_capture","transaction:reference","contract:reference","report:reference","contravention:reference"],"type":"string","description":"* `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","isRequired":true,"uniqueKey":"payments.items.[INDEX].metadata.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","maxLength":255,"isRequired":true,"uniqueKey":"payments.items.[INDEX].metadata.items.[INDEX].value","typeLabel":"string"}},"required":["type","value"],"uniqueKey":"payments.items.[INDEX].metadata.items.[INDEX]","typeLabel":"object"},"description":"The metadata object allows you to submit additional relevant information related to the payment as type/value pairs. You can submit an unlimited number of metadata sets.","uniqueKey":"payments.items.[INDEX].metadata","typeLabel":"object[]"}},"required":["amount","created","href","value_date"],"uniqueKey":"payments.items.[INDEX]","typeLabel":"object"},"description":"Any payments you have received for your claim so far.","uniqueKey":"payments","typeLabel":"object[]"},"metadata":{"type":"array","items":{"type":"object","description":"Metadata for debtors","properties":{"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"],"type":"string","description":"* `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","isRequired":true,"uniqueKey":"metadata.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","maxLength":255,"isRequired":true,"uniqueKey":"metadata.items.[INDEX].value","typeLabel":"string"}},"required":["type","value"],"uniqueKey":"metadata.items.[INDEX]","typeLabel":"object"},"description":"The metadata object allows you to submit additional relevant information related to the claim as type/value pairs. You can submit an unlimited number of metadata sets.","uniqueKey":"metadata","typeLabel":"object[]"},"events":{"type":"array","items":{"type":"object","description":"Base class for events. Subclassed by other serializers.","properties":{"type":{"enum":["claim","delivery"],"type":"string","description":"* `claim` - claim\n* `delivery` - delivery","isRequired":true,"uniqueKey":"events.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"title":{"type":"string","maxLength":255,"isRequired":true,"uniqueKey":"events.items.[INDEX].title","typeLabel":"string"},"occurence":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"events.items.[INDEX].occurence","typeLabel":"string\u003cdate-time>"},"your_reference":{"oneOf":[{"type":"string","maxLength":255,"uniqueKey":"events.items.[INDEX].your_reference.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"uniqueKey":"events.items.[INDEX].your_reference.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].your_reference","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","maxLength":255,"uniqueKey":"events.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"uniqueKey":"events.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].description","typeLabel":"string | null"},"location":{"oneOf":[{"type":"string","maxLength":255,"uniqueKey":"events.items.[INDEX].location.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"uniqueKey":"events.items.[INDEX].location.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].location","typeLabel":"string | null"}},"required":["occurence","title","type"],"uniqueKey":"events.items.[INDEX]","typeLabel":"object"},"description":"Events regarding the claim. See request/response examples.","uniqueKey":"events","typeLabel":"object[]"}},"required":["claim_disputed","created","debtor","delay_date","document_date","document_reference","documents","due_date","href","main_claim_amount","mandate","obligation_fulfilled","occurence_date","rejected_at","rejection_notified_to","rejection_reason","reminder_date","starting_approach","subject_matter","submission_state","total_claim_amount","updated","your_reference"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"href":"\u003cstring>","submission_state":"created","rejection_reason":"\u003cstring>","rejected_at":"2023-11-07T05:31:56Z","rejection_notified_to":["[email protected]"],"debtor":"3c90c3cc-0d44-4b50-8888-8dd25736052a","mandate":{"href":"\u003cstring>","id":"\u003cstring>","reference_number":"\u003cstring>"},"your_reference":"\u003cstring>","subject_matter":"\u003cstring>","occurence_date":"2023-12-25","document_reference":"\u003cstring>","document_date":"2023-12-25","due_date":"2023-12-25","reminder_date":"2023-12-25","delay_date":"2023-12-25","total_claim_amount":{"value":"\u003cstring>","currency":"EUR"},"main_claim_amount":{"value":"\u003cstring>","currency":"EUR"},"starting_approach":"extrajudicial","claim_disputed":true,"obligation_fulfilled":true,"documents":[{"mime_type":"\u003cstring>","filename":"\u003cstring>","id":"\u003cstring>"}],"created":"2023-11-07T05:31:56Z","updated":"2023-11-07T05:31:56Z","id":"\u003cstring>","items":[{"description":"\u003cstring>","quantity":123,"amount":{"value":"\u003cstring>","currency":"EUR"},"unit":"\u003cstring>"}],"additional_charges_amount":{"value":"\u003cstring>","currency":"EUR"},"additional_charges":[{"type":"reminder_fee","your_reference":"\u003cstring>","subject_matter":"\u003cstring>","occurence_date":"2023-12-25","document_date":"2023-12-25","due_date":"2023-12-25","amount":{"value":"\u003cstring>","currency":"EUR"},"id":"\u003cstring>","metadata":[{"type":"comment","value":"\u003cstring>"}],"events":[{"type":"invoice","title":"\u003cstring>","occurence":"2023-11-07T05:31:56Z","your_reference":"\u003cstring>","description":"\u003cstring>","location":"\u003cstring>"}]}],"payments":[{"href":"\u003cstring>","amount":{"value":"\u003cstring>","currency":"EUR"},"value_date":"2023-12-25","created":"2023-11-07T05:31:56Z","your_reference":"\u003cstring>","metadata":[{"type":"comment","value":"\u003cstring>"}]}],"metadata":[{"type":"comment","value":"\u003cstring>"}],"events":[{"type":"claim","title":"\u003cstring>","occurence":"2023-11-07T05:31:56Z","your_reference":"\u003cstring>","description":"\u003cstring>","location":"\u003cstring>"}]}}},"exampleType":"generated"}},"description":"","exampleType":"generated"}},"security":{"d10ffc61-ad2a-4066-bb77-3cf2263715f7":{"tokenAuth":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"tokenAuth"}},"36a0050b-c162-4294-b567-e5e7cbb44fca":{"tokenAuth":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"tokenAuth"}}},"servers":{"e29e3281-35a6-490f-9197-c1dfaf100ed3":{"url":"https://api.paywise.de","description":"Production environment"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"tokenAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"tokenAuth","name":"Authorization"}],"title":"tokenAuth"},{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"tokenAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"tokenAuth","name":"Authorization"}],"title":"tokenAuth"}]},"originalFileLocation":"api-docs/legacy/case-management/openapi.json"},"subdomain":"paywisegmbh","siteName":"paywise Knowledge Center","title":"Release claim for processing - paywise Knowledge Center","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"de":{"href":"/user-docs/overview","matchLevel":4},"en":{"href":"/api-docs/legacy/case-management/reference/claims/release-claim-for-processing","matchLevel":0}}},"lastModified":"2026-10-15T06:12:04.604Z","originalFileLocation":"api-docs/legacy/case-management/reference/claims/release-claim-for-processing.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=\"Releases a claim for processing by paywise. To do so, set the claim\u0026#x27;s submission_state field to released. After release, a claim cannot be changed anymore. To make changes to an already released claim, please contact our support.\">\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=\"Release claim for processing - paywise Knowledge Center\">\u003cmeta data-mint-head property=\"og:description\" content=\"Releases a claim for processing by paywise. To do so, set the claim\u0026#x27;s submission_state field to released. After release, a claim cannot be changed anymore. To make changes to an already released claim, please contact our support.\">\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/legacy/case-management/reference/claims/release-claim-for-processing\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://paywisegmbh.mintlify.site/_mintlify/api/og/v2?division=claims\u0026amp;title=Release+claim+for+processing\u0026amp;description=Releases+a+claim+for+processing+by+paywise.+To+do+so%2C+set+the+claim%27s+*submission_state*+field+to+*released*.+After+release%2C+a+claim+cannot+be+changed+anymore.+\u0026amp;theme=5678ea7ba150bf102cf0f366\u0026amp;signature=5f495f9cda583ef646b405abce09df37ae84a1443a587c74b070dcf87156b49e\">\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=\"Release claim for processing - paywise Knowledge Center\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Releases a claim for processing by paywise. To do so, set the claim\u0026#x27;s submission_state field to released. After release, a claim cannot be changed anymore. To make changes to an already released claim, please contact our support.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://paywisegmbh.mintlify.site/_mintlify/api/og/v2?division=claims\u0026amp;title=Release+claim+for+processing\u0026amp;description=Releases+a+claim+for+processing+by+paywise.+To+do+so%2C+set+the+claim%27s+*submission_state*+field+to+*released*.+After+release%2C+a+claim+cannot+be+changed+anymore.+\u0026amp;theme=5678ea7ba150bf102cf0f366\u0026amp;signature=5f495f9cda583ef646b405abce09df37ae84a1443a587c74b070dcf87156b49e\">\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/legacy/case-management/reference/claims/release-claim-for-processing\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-docs/legacy/case-management/reference/claims/release-claim-for-processing.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/legacy/case-management/reference/claims/release-claim-for-processing#webpage\",\"url\":\"https://docs.paywise.de/api-docs/legacy/case-management/reference/claims/release-claim-for-processing\",\"name\":\"Release claim for processing\",\"description\":\"Releases a claim for processing by paywise. To do so, set the claim's submission_state field to released. After release, a claim cannot be changed anymore. To make changes to an already released claim, please contact our support.\",\"dateModified\":\"2026-10-15T06:12:04.604Z\",\"isPartOf\":{\"@id\":\"https://docs.paywise.de#website\"},\"breadcrumb\":{\"@id\":\"https://docs.paywise.de/api-docs/legacy/case-management/reference/claims/release-claim-for-processing#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.paywise.de/api-docs/legacy/case-management/reference/claims/release-claim-for-processing#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Legacy APIs (v1)\",\"item\":\"https://docs.paywise.de/api-docs/legacy/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Frozen Case Management API\",\"item\":\"https://docs.paywise.de/api-docs/legacy/case-management/introduction\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Frozen Case Management API reference\",\"item\":\"https://docs.paywise.de/api-docs/legacy/case-management/reference/claims/list-claims\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"claims\",\"item\":\"https://docs.paywise.de/api-docs/legacy/case-management/reference/claims/list-claims\"},{\"@type\":\"ListItem\",\"position\":5,\"name\":\"Release claim for processing\",\"item\":\"https://docs.paywise.de/api-docs/legacy/case-management/reference/claims/release-claim-for-processing\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.paywise.de/api-docs/legacy/case-management/reference/claims/release-claim-for-processing#apireference\",\"headline\":\"Release claim for processing\",\"name\":\"Release claim for processing\",\"description\":\"Releases a claim for processing by paywise. To do so, set the claim's submission_state field to released. After release, a claim cannot be changed anymore. To make changes to an already released claim, please contact our support.\",\"url\":\"https://docs.paywise.de/api-docs/legacy/case-management/reference/claims/release-claim-for-processing\",\"mainEntityOfPage\":{\"@id\":\"https://docs.paywise.de/api-docs/legacy/case-management/reference/claims/release-claim-for-processing#webpage\"},\"dateModified\":\"2026-10-15T06:12:04.604Z\",\"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\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"paywise Knowledge Center","nav":{"global":null,"languages":[{"language":"de","default":true,"pages":[{"title":"de","href":"/user-docs/overview"}]},{"language":"en","tabs":[{"tab":"User documentation","icon":"book-open","pages":[{"title":"User documentation","href":"/en/user-docs/overview"}]},{"tab":"Integrations","icon":"plug","pages":[{"title":"Integrations","href":"/en/integrations/overview"}]},{"tab":"Technical documentation","icon":"code","pages":[{"group":"Start here","icon":"house","pages":[{"title":"API overview","href":"/api-docs/overview"},{"title":"API Changelog","href":"/api-docs/changelog"}]},{"group":"API essentials","icon":"arrows-left-right","pages":[{"title":"Authentication and environments","href":"/api-docs/essentials/authentication-and-environments"},{"title":"Requests and responses","href":"/api-docs/essentials/requests-and-responses"},{"title":"Errors and safe retries","href":"/api-docs/essentials/errors-and-safe-retries"},{"title":"Pagination and synchronization","href":"/api-docs/essentials/pagination-and-synchronization"},{"title":"Public limits","href":"/api-docs/essentials/limits"},{"title":"Versioning and deprecation","href":"/api-docs/essentials/versioning"},{"title":"Webhooks","href":"/api-docs/essentials/webhooks"}]},{"group":"Case Management API","icon":"/images/icons/case-api.svg","pages":[{"title":"Case Management API","href":"/api-docs/case-management-api/introduction"},{"title":"Case Management quickstart","href":"/api-docs/case-management-api/quickstart"},{"group":"Concepts","pages":[{"title":"Core resources","href":"/api-docs/case-management-api/concepts/resource-model"},{"title":"Debtors","href":"/api-docs/case-management-api/concepts/debtors"},{"title":"Orders","href":"/api-docs/case-management-api/concepts/orders"},{"title":"Claims","href":"/api-docs/case-management-api/concepts/claims"},{"title":"Mandates","href":"/api-docs/case-management-api/concepts/mandates"},{"title":"Documents and communication","href":"/api-docs/case-management-api/concepts/documents-and-communication"},{"title":"Payments","href":"/api-docs/case-management-api/concepts/payments"},{"title":"Statements","href":"/api-docs/case-management-api/concepts/statements"},{"title":"Webhook events","href":"/api-docs/case-management-api/concepts/webhook-events"},{"title":"Sandbox environment","href":"/api-docs/case-management-api/concepts/sandbox"}]},{"group":"Workflows","pages":[{"title":"Submit an order","href":"/api-docs/case-management-api/workflows/submit-an-order"},{"title":"Submit a rental order","href":"/api-docs/case-management-api/workflows/submit-a-rental-order"},{"title":"Submit a titled order","href":"/api-docs/case-management-api/workflows/submit-a-titled-order"},{"title":"Manage documents","href":"/api-docs/case-management-api/workflows/manage-documents"},{"title":"Follow a case","href":"/api-docs/case-management-api/workflows/follow-a-case"},{"title":"Read debtor correspondence","href":"/api-docs/case-management-api/workflows/read-debtor-correspondence"},{"title":"Messages and client requests","href":"/api-docs/case-management-api/workflows/messages-and-client-requests"},{"title":"Report payments","href":"/api-docs/case-management-api/workflows/report-payments"},{"title":"Consume Case webhooks","href":"/api-docs/case-management-api/workflows/consume-webhooks"}]},{"title":"Migrate from Case Management API v1","href":"/api-docs/case-management-api/migrate-from-v1"},{"title":"Use with Postman","href":"/api-docs/case-management-api/postman"},{"group":"Case Management API reference","pages":[{"group":"Orders","icon":"file-lines","pages":[{"title":"List orders","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/","href":"/api-docs/case-management-api/reference/orders/list-orders"},{"title":"Create order","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/orders/","href":"/api-docs/case-management-api/reference/orders/create-order"},{"title":"Get order","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{id}/","href":"/api-docs/case-management-api/reference/orders/get-order"},{"title":"Update order","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json patch /v2/orders/{id}/","href":"/api-docs/case-management-api/reference/orders/update-order"},{"title":"Delete draft order","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json delete /v2/orders/{id}/","href":"/api-docs/case-management-api/reference/orders/delete-draft-order"},{"title":"Finalize order","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/orders/{id}/finalize/","href":"/api-docs/case-management-api/reference/orders/finalize-order"},{"title":"Withdraw order","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/orders/{id}/withdraw/","href":"/api-docs/case-management-api/reference/orders/withdraw-order"},{"group":"Messages","icon":"comments","pages":[{"title":"List order messages","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/messages/","href":"/api-docs/case-management-api/reference/orders/list-order-messages"},{"title":"Create order message","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/orders/{order_id}/messages/","href":"/api-docs/case-management-api/reference/orders/create-order-message"},{"title":"Get order message","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/messages/{id}/","href":"/api-docs/case-management-api/reference/orders/get-order-message"},{"title":"Update order message","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json patch /v2/orders/{order_id}/messages/{id}/","href":"/api-docs/case-management-api/reference/orders/update-order-message"},{"title":"List order message documents","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/messages/{message_id}/documents/","href":"/api-docs/case-management-api/reference/orders/list-order-message-documents"},{"title":"Create order message document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/orders/{order_id}/messages/{message_id}/documents/","href":"/api-docs/case-management-api/reference/orders/create-order-message-document"},{"title":"Get order message document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/messages/{message_id}/documents/{id}/","href":"/api-docs/case-management-api/reference/orders/get-order-message-document"},{"title":"Delete order message document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json delete /v2/orders/{order_id}/messages/{message_id}/documents/{id}/","href":"/api-docs/case-management-api/reference/orders/delete-order-message-document"},{"title":"Download order message document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/messages/{message_id}/documents/{id}/download/","href":"/api-docs/case-management-api/reference/orders/download-order-message-document"}]},{"group":"Requests to client","icon":"inbox","pages":[{"title":"List order requests to client","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/requests-to-client/","href":"/api-docs/case-management-api/reference/orders/list-order-requests-to-client"},{"title":"Get order request to client","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/requests-to-client/{id}/","href":"/api-docs/case-management-api/reference/orders/get-order-request-to-client"},{"title":"Answer order request to client","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/orders/{order_id}/requests-to-client/{id}/answer/","href":"/api-docs/case-management-api/reference/orders/answer-order-request-to-client"},{"title":"Download order request to client attachment","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/requests-to-client/{id}/attachments/{attachment_id}/download/","href":"/api-docs/case-management-api/reference/orders/download-order-request-to-client-attachment"},{"title":"List order request to client answer documents","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/requests-to-client/{request_id}/answer/documents/","href":"/api-docs/case-management-api/reference/orders/list-order-request-to-client-answer-documents"},{"title":"Create order request to client answer document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/orders/{order_id}/requests-to-client/{request_id}/answer/documents/","href":"/api-docs/case-management-api/reference/orders/create-order-request-to-client-answer-document"},{"title":"Get order request to client answer document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/requests-to-client/{request_id}/answer/documents/{id}/","href":"/api-docs/case-management-api/reference/orders/get-order-request-to-client-answer-document"},{"title":"Delete order request to client answer document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json delete /v2/orders/{order_id}/requests-to-client/{request_id}/answer/documents/{id}/","href":"/api-docs/case-management-api/reference/orders/delete-order-request-to-client-answer-document"},{"title":"Download order request to client answer document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/requests-to-client/{request_id}/answer/documents/{id}/download/","href":"/api-docs/case-management-api/reference/orders/download-order-request-to-client-answer-document"}]}]},{"group":"Claims","icon":"file-spreadsheet","pages":[{"title":"List claims","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/claims/","href":"/api-docs/case-management-api/reference/claims/list-claims"},{"title":"Create claim","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/claims/","href":"/api-docs/case-management-api/reference/claims/create-claim"},{"title":"Get claim","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/claims/{id}/","href":"/api-docs/case-management-api/reference/claims/get-claim"},{"title":"Update claim","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json patch /v2/claims/{id}/","href":"/api-docs/case-management-api/reference/claims/update-claim"},{"title":"Delete claim","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json delete /v2/claims/{id}/","href":"/api-docs/case-management-api/reference/claims/delete-claim"},{"group":"Documents","icon":"file-lines","pages":[{"title":"List claim documents","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/claims/{claim_id}/documents/","href":"/api-docs/case-management-api/reference/documents/list-claim-documents"},{"title":"Create claim document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/claims/{claim_id}/documents/","href":"/api-docs/case-management-api/reference/documents/create-claim-document"},{"title":"Get claim document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/claims/{claim_id}/documents/{id}/","href":"/api-docs/case-management-api/reference/documents/get-claim-document"},{"title":"Delete claim document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json delete /v2/claims/{claim_id}/documents/{id}/","href":"/api-docs/case-management-api/reference/documents/delete-claim-document"},{"title":"Download claim document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/claims/{claim_id}/documents/{id}/download/","href":"/api-docs/case-management-api/reference/documents/download-claim-document"}]},{"group":"Payments","icon":"credit-card","pages":[{"title":"List claim payments","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/claims/{claim_id}/payments/","href":"/api-docs/case-management-api/reference/claims/list-claim-payments"},{"title":"Create claim payment","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/claims/{claim_id}/payments/","href":"/api-docs/case-management-api/reference/claims/create-claim-payment"},{"title":"Delete claim payment","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json delete /v2/claims/{claim_id}/payments/{id}/","href":"/api-docs/case-management-api/reference/claims/delete-claim-payment"}]},{"group":"Enforceable titles","icon":"scale-balanced","pages":[{"title":"Get enforceable title","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/claims/{claim_id}/enforceable-title/","href":"/api-docs/case-management-api/reference/claims/get-enforceable-title"},{"title":"Replace enforceable title","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json put /v2/claims/{claim_id}/enforceable-title/","href":"/api-docs/case-management-api/reference/claims/replace-enforceable-title"},{"title":"Update enforceable title","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json patch /v2/claims/{claim_id}/enforceable-title/","href":"/api-docs/case-management-api/reference/claims/update-enforceable-title"},{"title":"Delete enforceable title","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json delete /v2/claims/{claim_id}/enforceable-title/","href":"/api-docs/case-management-api/reference/claims/delete-enforceable-title"},{"title":"List enforceable title documents","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/claims/{claim_id}/enforceable-title/documents/","href":"/api-docs/case-management-api/reference/claims/list-enforceable-title-documents"},{"title":"Create enforceable title document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/claims/{claim_id}/enforceable-title/documents/","href":"/api-docs/case-management-api/reference/claims/create-enforceable-title-document"},{"title":"Get enforceable title document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/claims/{claim_id}/enforceable-title/documents/{id}/","href":"/api-docs/case-management-api/reference/claims/get-enforceable-title-document"},{"title":"Delete enforceable title document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json delete /v2/claims/{claim_id}/enforceable-title/documents/{id}/","href":"/api-docs/case-management-api/reference/claims/delete-enforceable-title-document"},{"title":"Download enforceable title document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/claims/{claim_id}/enforceable-title/documents/{id}/download/","href":"/api-docs/case-management-api/reference/claims/download-enforceable-title-document"}]}]},{"group":"Rental agreements","icon":"house","pages":[{"title":"Get rental agreement","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/rental-agreement/","href":"/api-docs/case-management-api/reference/orders/get-rental-agreement"},{"title":"Update rental agreement","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json patch /v2/orders/{order_id}/rental-agreement/","href":"/api-docs/case-management-api/reference/orders/update-rental-agreement"},{"title":"List rental agreement documents","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/rental-agreement/documents/","href":"/api-docs/case-management-api/reference/orders/list-rental-agreement-documents"},{"title":"Create rental agreement document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/orders/{order_id}/rental-agreement/documents/","href":"/api-docs/case-management-api/reference/orders/create-rental-agreement-document"},{"title":"Get rental agreement document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/rental-agreement/documents/{id}/","href":"/api-docs/case-management-api/reference/orders/get-rental-agreement-document"},{"title":"Delete rental agreement document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json delete /v2/orders/{order_id}/rental-agreement/documents/{id}/","href":"/api-docs/case-management-api/reference/orders/delete-rental-agreement-document"},{"title":"Download rental agreement document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/rental-agreement/documents/{id}/download/","href":"/api-docs/case-management-api/reference/orders/download-rental-agreement-document"}]},{"group":"Debtors","icon":"users","pages":[{"title":"List debtors","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/debtors/","href":"/api-docs/case-management-api/reference/debtors/list-debtors"},{"title":"Create debtor","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/debtors/","href":"/api-docs/case-management-api/reference/debtors/create-debtor"},{"title":"Get debtor","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/debtors/{id}/","href":"/api-docs/case-management-api/reference/debtors/get-debtor"},{"title":"Update debtor","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json patch /v2/debtors/{id}/","href":"/api-docs/case-management-api/reference/debtors/update-debtor"}]},{"group":"Mandates","icon":"folder","pages":[{"title":"List mandates","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 Community Node","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","description":"Delete a claim that has not been released for processing. Claims can only be deleted if their submission_state is \"created\". Once a claim has been released (submission_state is \"released\"), it cannot be deleted.\n\n**Access Mode Support**: This endpoint works for both test and production claims. When using a production token, you can delete unreleased production claims. When using a test token, you can delete unreleased test claims. The token's access mode determines which claims you can access and delete.","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","description":"Upload a document to a claim. Accepted filetypes are PDF, JPEG and PNG.","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":"Release claim for processing - paywise Knowledge Center","buildId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","deploymentId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-i2a3QZ8E.js","utils-ChLwp8m0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DRktVTDc.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CA2pEs4T.js","snippetPresets-ClQ6XrKD.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Ct_Lv36y.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Cn2PYw9e.js","shallow-rkyymjXQ.js","getApiPlaygroundDisplay-BB9vkXtE.js","CodeSnippet-Bm5RU7m1.js","CodeSnippets-BgU9Deuz.js","Page-BUDYNlhG.js","getPastedJson-BD-6NNum.js","icon-8Z6tud2e.js","MethodPill-Tuzr4g3V.js","DuplicateIcon-0ceWFYhN.js","createIcon-FBXow_ST.js","DynamicMarkdown-CD8713Yy.js","SectionHeading-7zgzQbH-.js","axios-vUo_bRtp.js","Markdown-D7Ofw1oz.js","clsx-eKJ4rcii.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CwjSCXIK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-9EK5IAXV.js"]}