using RestSharp;
var options = new RestClientOptions("https://api.paywise.de/partner/v2/companies/{id}/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{}", false);
var response = await client.PatchAsync(request);
Console.WriteLine("{0}", response.Content);
Partially update a managed company. A company disconnected by this partner is inaccessible and returns 404 not_found. An empty or unchanged PATCH is a no-op that leaves updated_at and the ETag untouched. Sending onboarding_mode returns 409 onboarding_mode_immutable.
using RestSharp;
var options = new RestClientOptions("https://api.paywise.de/partner/v2/companies/{id}/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{}", false);
var response = await client.PatchAsync(request);
Console.WriteLine("{0}", response.Content);
Partner API Bearer key: Authorization: Bearer <key>. Keys are created only through authorized portal or staff flows.
Headers
If-Match
string
Apply the change only while the current ETag matches one of the supplied validators (or *); otherwise the request fails with 412 precondition_failed and nothing is written.
Path Parameters
id
string<uuid>
required
UUID of the managed company in this request.
Body
application/json
Detail and mutation representation of a Partner-managed company.
address
object | null
Postal address of the company. Supplied address fields update the existing address; omitted fields retain their values. When the company has no address, supply all four fields: street, postal_code, city, and country. Omit the address to preserve it or set null to remove it.
Show child attributes
data_sharing_basis
enum<string>
Legal basis on which the partner may share this company's data. The declaration is optional here; once recorded, repeating the same value is allowed but replacing it returns 409 data_sharing_basis_already_declared.
Available options:
not_secret_carrier,
self_authorized
default_claim_type
enum<string> | null
Default contract or transaction type for new principal claims.
H17 - Miete für Geschäftsraum einschl. Nebenkosten
H45 - Zeitungs-/Zeitschriftenbezug
H37 - Ungerechtfertigte Bereicherung
H29 - Schadenersatz aus Unfall/Vorfall
H01 - Anzeigen in Zeitungen u.a.
H78 - Tierärztliche Leistung
H14 - Lagerkosten
H77 - Krankentransportkosten
H40 - Vermittlungs-/Maklerprovision
H15 - Leasing/Mietkauf
H23 - Pacht
H04 - Darlehensrückzahlung
H20 - Mietnebenkosten - auch Renovierungskosten-
H79 - Verpflegungskosten
H75 - Reisevertrag
H33 - Schuldanerkenntnis
H39 - Vergleich, außergerichtlicher
H70 - Kindertagesstättenbeitrag
H90 - Wohngeld/Hausgeld für Wohnungseigentümergemeinschaft
H09 - Heimunterbringung
H03 - Bürgschaft
H07 - Geschäftsbesorgung durch Selbständige
H12 - Kontokorrentabrechnung
H13 - Krankenhauskosten-Pflege/Behandlung
H36 - Überziehung des Bankkontos
H61 - Wahlleistungen bei stationärer Behandlung
H76 - Telekommunikationsleistungen
Available options:
H05,
H43,
H22,
H21,
H11,
H44,
H08,
H41,
H16,
H10,
H02,
H28,
H26,
H24,
H06,
H18,
H34,
H19,
H42,
H17,
H45,
H37,
H29,
H01,
H78,
H14,
H77,
H40,
H15,
H23,
H04,
H20,
H79,
H75,
H33,
H39,
H70,
H90,
H09,
H03,
H07,
H12,
H13,
H36,
H61,
H76
external_reference
string | null
Your identifier for this company, unique within your partner organization. A duplicate returns 409 company_exists with the existing company_id. Set null to clear it; omit it to keep the current value.
Required string length: 1 - 120
legal_form
string | null
Permanent public code from GET /legal-forms/, or null when not set. A non-null legal_form is required when legal_representatives is nonempty. On PATCH, omission preserves the current form; it cannot be cleared while retaining representatives. Changes follow the paywise UI identity lock: after transfer for processing, or once company data is complete and a case has been submitted.
legal_representatives
object[]
People or organizations legally representing the company, up to three, with roles matching legal_form. A nonempty array requires a non-null legal_form, using the stored form when legal_form is omitted. Omit to preserve them; a supplied array replaces them. They cannot be changed once company data submission is complete, even before the first case submission. Maximum 3 entries in the replacement list; exceeding this limit returns 400 validation_error.
Show child attributes
name
string
Registered or trading name of the company. Changes follow the paywise UI identity lock: after transfer for processing, or once company data is complete and a case has been submitted.
Required string length: 1 - 255
notification_channels
object[]
Company-level email recipients for operational notifications, up to 10. Omit to preserve the recipients; a supplied array replaces them, and [] removes them. After the first case submission, required recipients for requests to client and statements must remain. Maximum 10 recipients in the replacement list; exceeding this limit returns 400 validation_error.
Show child attributes
payout_bank_account
object | null
Account to which collected funds are transferred. Omit to preserve the current account; before the first case submission, provide an account to replace it or null to remove it. After submission, changes must use the secured payout-account change process in the paywise UI. Resubmitting the unchanged account is allowed.
Show child attributes
phone
string | null
Primary telephone number of the company in E.164 format; null clears it.
Required string length: 1 - 50
tax_treatment
enum<string> | null
Company VAT treatment, consistent with the address country. reverse_charge requires vat_number. Changes follow the paywise UI identity lock: after transfer for processing, or once company data is complete and a case has been submitted.
Available options:
input_tax_deductible,
not_input_tax_deductible,
reverse_charge,
third_country_non_taxable
vat_number
string | null
Company VAT identification number. Required when tax_treatment is reverse_charge. Changes follow the paywise UI identity lock: after transfer for processing, or once company data is complete and a case has been submitted.
Maximum string length: 64
Response
Detail and mutation representation of a Partner-managed company.
case_access
enum<string>
required
Whether the partner may operate the Case Management API for this company.
Available options:
available,
unavailable
case_submission_readiness
object
required
Whether company data is complete enough to submit a case.
Show child attributes
created_at
string<date-time>
required
read-only
Time at which the managed company was created.
customer_number
string
required
read-only
paywise customer number assigned to the managed company.
id
string<uuid>
required
read-only
Stable identifier for this resource.
name
string
required
Registered or trading name of the company.
Maximum string length: 255
onboarding_mode
enum<string>
required
Selected mode for this Partner-company relationship. Read-only after creation.
Available options:
api_only,
web_flow
onboarding_status
enum<string>
required
Administrator confirmation status: confirmation_not_required for api_only; confirmation_pending for provisional web_flow; confirmed for confirmed web_flow. Poll this field independently of membership setup or email delivery.
Available options:
confirmation_not_required,
confirmation_pending,
confirmed
sandbox_origin
enum<string>
required
Provenance of this record. sandbox_native — created inside the sandbox and therefore a test resource you fully own. production_mirror — a read-only copy of a production record. unclassified — everything else, including every record in production. Determines what may be changed in the sandbox, so it is published rather than left to guesswork.
production_mirror - Production mirror
sandbox_native - Sandbox native
unclassified - Unclassified
Available options:
production_mirror,
sandbox_native,
unclassified
updated_at
string<date-time>
required
read-only
Time at which the managed company was last updated.
address
object | null
Postal address of the company.
Show child attributes
default_claim_type
enum<string> | null
Default contract or transaction type for new principal claims.
H17 - Miete für Geschäftsraum einschl. Nebenkosten
H45 - Zeitungs-/Zeitschriftenbezug
H37 - Ungerechtfertigte Bereicherung
H29 - Schadenersatz aus Unfall/Vorfall
H01 - Anzeigen in Zeitungen u.a.
H78 - Tierärztliche Leistung
H14 - Lagerkosten
H77 - Krankentransportkosten
H40 - Vermittlungs-/Maklerprovision
H15 - Leasing/Mietkauf
H23 - Pacht
H04 - Darlehensrückzahlung
H20 - Mietnebenkosten - auch Renovierungskosten-
H79 - Verpflegungskosten
H75 - Reisevertrag
H33 - Schuldanerkenntnis
H39 - Vergleich, außergerichtlicher
H70 - Kindertagesstättenbeitrag
H90 - Wohngeld/Hausgeld für Wohnungseigentümergemeinschaft
H09 - Heimunterbringung
H03 - Bürgschaft
H07 - Geschäftsbesorgung durch Selbständige
H12 - Kontokorrentabrechnung
H13 - Krankenhauskosten-Pflege/Behandlung
H36 - Überziehung des Bankkontos
H61 - Wahlleistungen bei stationärer Behandlung
H76 - Telekommunikationsleistungen
Available options:
H05,
H43,
H22,
H21,
H11,
H44,
H08,
H41,
H16,
H10,
H02,
H28,
H26,
H24,
H06,
H18,
H34,
H19,
H42,
H17,
H45,
H37,
H29,
H01,
H78,
H14,
H77,
H40,
H15,
H23,
H04,
H20,
H79,
H75,
H33,
H39,
H70,
H90,
H09,
H03,
H07,
H12,
H13,
H36,
H61,
H76
external_reference
string | null
Your own identifier for this company (for example a CRM id). Unique per partner, compared byte-exact after trimming surrounding whitespace (case-sensitive): creating a second company with the same value returns 409 company_exists with the existing company_id. Filter with ?external_reference= on the list endpoint.
Maximum string length: 120
legal_form
string | null
Permanent public code from GET /legal-forms/.
legal_representatives
object[]
People or organizations legally representing the company.
Show child attributes
notification_channels
object[]
Company-level email recipients for operational notifications.
Show child attributes
payout_bank_account
object | null
Account to which collected funds are transferred.
Show child attributes
phone
string | null
Primary telephone number of the company in E.164 format; null clears it.
User memberships in the managed company. Each entry identifies a membership and its current onboarding or revocation state.
Show child attributes
vat_number
string | null
VAT identification number of the company.
Maximum string length: 64
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"paywise Knowledge Center","colors":{"primary":"#fd7e14","light":"#6a9bf4","dark":"#37384e"},"logo":{"light":"https://mintcdn.com/paywisegmbh/NM1UIIld1WRHivnS/logo/paywise-logo.svg?fit=max\u0026auto=format\u0026n=NM1UIIld1WRHivnS\u0026q=85\u0026s=0d1a1b06e878f9d25ef70b19e3df50cc","dark":"https://mintcdn.com/paywisegmbh/NM1UIIld1WRHivnS/logo/paywise-logo-light.png?fit=max\u0026auto=format\u0026n=NM1UIIld1WRHivnS\u0026q=85\u0026s=ab0f73c7353586d673c947dc946db86b"},"favicon":"https://mintcdn.com/paywisegmbh/NM1UIIld1WRHivnS/favicon-32x32.png?fit=max\u0026auto=format\u0026n=NM1UIIld1WRHivnS\u0026q=85\u0026s=f1eaf1b6461ee62ec891fd1a5309f891","api":{"examples":{"defaults":"required","languages":["python","javascript","java","csharp","curl"],"prefill":true,"autogenerate":true}},"navbar":{"links":[{"href":"mailto:[email protected]","label":"Kontakt"}],"primary":{"type":"button","label":"Login","href":"https://app.paywise.de/account/"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/paywise-gmbh","github":"https://github.com/paywise-gmbh"}},"contextual":{"options":["copy","view","chatgpt","claude","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"languages":[{"language":"de","default":true,"href":"user-docs/overview"},{"language":"en","href":"en/user-docs/overview"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"paywisegmbh","hasAudioNarration":false,"actualSubdomain":"paywisegmbh","customDomains":["docs.paywise.de"],"gitSource":{"type":"github","owner":"paywise-gmbh","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{},"buildId":"6af19bb3e7b89d498acbc16f","clientVersion":"0.0.4227","searchFilterCounts":[{"language":"en","tag":"Technical documentation","count":287},{"language":"en","tag":"Case Management API","count":135},{"language":"en","tag":"Case Management API reference","count":112},{"language":"en","tag":"Legacy APIs (v1)","count":68},{"language":"en","tag":"Frozen Case Management API","count":50},{"language":"en","tag":"Partner API","count":42},{"language":"en","tag":"Frozen Case Management API reference","count":40},{"language":"en","tag":"Mahnservice API","count":28},{"language":"en","tag":"Mandates","count":28},{"language":"en","tag":"Partner API reference","count":27},{"language":"de","tag":"Integrationen","count":20},{"language":"de","tag":"Buchhaltungs-Integrationen","count":15},{"language":"de","tag":"Anwenderdokumentation","count":12},{"language":"de","tag":"Mahnservice","count":10},{"language":"de","tag":"DATEV","count":5},{"language":"de","tag":"Technische Dokumentation","count":1},{"language":"de","tag":"Verwaltung","count":1}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"svg[data-pw-icon]{color:#fd7e14}html.dark svg[data-pw-icon]{color:#6a9bf4}img.sidebar-group-icon[src$=\"case-api.svg\"],img.sidebar-group-icon[src$=\"partner-api.svg\"],img.sidebar-group-icon[src$=\"mahnservice-api.svg\"]{content:url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'%3E%3C/svg%3E\");background-color:#fd7e14!important;-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;-webkit-mask-size:contain;mask-repeat:no-repeat;mask-position:center;mask-size:contain}img.sidebar-group-icon[src$=\"case-api.svg\"]{-webkit-mask-image:url(\"/images/icons/case-api.svg\");mask-image:url(\"/images/icons/case-api.svg\")}img.sidebar-group-icon[src$=\"partner-api.svg\"]{-webkit-mask-image:url(\"/images/icons/partner-api.svg\");mask-image:url(\"/images/icons/partner-api.svg\")}img.sidebar-group-icon[src$=\"mahnservice-api.svg\"]{-webkit-mask-image:url(\"/images/icons/mahnservice-api.svg\");mask-image:url(\"/images/icons/mahnservice-api.svg\")}html.dark img.sidebar-group-icon[src$=\"case-api.svg\"],html.dark img.sidebar-group-icon[src$=\"partner-api.svg\"],html.dark img.sidebar-group-icon[src$=\"mahnservice-api.svg\"]{background-color:#6a9bf4!important}.pw-download-button{background-color:#fd7e14;color:#fff}html.dark .pw-download-button{background-color:#6a9bf4;color:#111}.mermaid .edgeLabel,.mermaid .edgeLabel rect,.mermaid .edgeLabel .label-container{background-color:transparent!important;fill:transparent!important}"}]}
{"page":{"pagePath":"api-docs/partner-api/reference/companies/update-a-company-patch","slug":"/api-docs/partner-api/reference/companies/update-a-company-patch","pageMetadata":{"title":"Update a company","description":"Partially update a managed company. A company disconnected by this partner is inaccessible and returns `404 not_found`. An empty or unchanged PATCH is a no-op that leaves `updated_at` and the ETag untouched. Sending `onboarding_mode` returns 409 `onboarding_mode_immutable`.","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","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 code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Partially update a managed company. A company disconnected by this partner is inaccessible and returns \", _jsx(_components.code, {\n children: \"404 not_found\"\n }), \". An empty or unchanged PATCH is a no-op that leaves \", _jsx(_components.code, {\n children: \"updated_at\"\n }), \" and the ETag untouched. Sending \", _jsx(_components.code, {\n children: \"onboarding_mode\"\n }), \" returns 409 \", _jsx(_components.code, {\n children: \"onboarding_mode_immutable\"\n }), \".\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Update a company","description":"Partially update a managed company. A company disconnected by this partner is inaccessible and returns `404 not_found`. An empty or unchanged PATCH is a no-op that leaves `updated_at` and the ETag untouched. Sending `onboarding_mode` returns 409 `onboarding_mode_immutable`.","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","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/paywisegmbh/c0e4bbe3e0c9277e/api-field-anchors.js"],"openApiReferenceData":{"operation":{"description":"Partially update a managed company. A company disconnected by this partner is inaccessible and returns `404 not_found`. An empty or unchanged PATCH is a no-op that leaves `updated_at` and the ETag untouched. Sending `onboarding_mode` returns 409 `onboarding_mode_immutable`.","operationId":"update-a-company-patch","parameters":["af41f346-e5c1-4e3d-a28f-63d417aa3943","3dfbc4ea-b140-47d4-872f-8405f01d544f"],"requestBody":"64857d6c-72a3-4ea5-aa6d-32fb6bd42a8e","responses":{"200":"53237de9-ee43-4290-aec2-d5486a83a375","400":"fddecbb8-9155-47ed-a5e3-24f232e40250","401":"e65bf3a8-dc26-4304-9453-fb455dde527d","403":"4aea4194-3e6b-4736-a77e-870f247edff0","404":"18d4ac2f-6345-44e9-8ec8-0a1be56ceb50","409":"4ca30e71-dab8-416d-ba0b-b7fcc4b98135","412":"d8852380-172e-4392-a327-d35511adb4c4","429":"6a61c610-90e7-424d-ae9d-8d133e343c76","500":"1c62707c-711d-4b17-a8c8-fa6fcca0890d"},"security":["ec09edb1-e962-4882-8b01-c1d5ad3c0d72"],"summary":"Update a company (PATCH)","tags":["Companies"],"x-mint":{"metadata":{"description":"Partially update a managed company. A company disconnected by this partner is inaccessible and returns `404 not_found`. An empty or unchanged PATCH is a no-op that leaves `updated_at` and the ETag untouched. Sending `onboarding_mode` returns 409 `onboarding_mode_immutable`.","title":"Update a company"}},"x-required-scopes":["partner:companies:write"],"method":"patch","type":"path","servers":["a699daf5-8fe3-4a41-9110-47eed256cb1a","a9d6e1a0-4bf9-4e27-a7c7-a37a00abcbfc"],"path":"/partner/v2/companies/{id}/","baseUrlOptions":["https://api.paywise.de","https://api-sandbox.paywise.de"],"title":"Update a company (PATCH)","codeSamples":[],"requestExampleLanguages":["python","javascript","java","csharp","bash"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.notification_channels.items.0.type":"email","body.notification_channels.items.0.value":"[email protected]","body.notification_channels.items.0.notifications.oneOf.0.items.0":"requests_to_client","body.notification_channels.items.0.notifications.oneOf.0.items.1":"status_updates","body.notification_channels.items.0.notifications.oneOf.0.items.2":"statements","body.phone.oneOf.0":"+49307654321"}]},"dependencies":{"parameters":{"af41f346-e5c1-4e3d-a28f-63d417aa3943":{"description":"UUID of the managed company in this request.","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string","isRequired":true,"description":"UUID of the managed company in this request.","uniqueKey":"","typeLabel":"string\u003cuuid>"}},"3dfbc4ea-b140-47d4-872f-8405f01d544f":{"description":"Apply the change only while the current `ETag` matches one of the supplied validators (or `*`); otherwise the request fails with `412 precondition_failed` and nothing is written.","in":"header","name":"If-Match","required":false,"schema":{"type":"string","isRequired":false,"description":"Apply the change only while the current `ETag` matches one of the supplied validators (or `*`); otherwise the request fails with `412 precondition_failed` and nothing is written.","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"examples":{"PatchCompany":{"title":"PatchCompany","summary":"Patch company","value":{"notification_channels":[{"notifications":["requests_to_client","status_updates","statements"],"type":"email","value":"[email protected]"}],"phone":"+49307654321"}}},"schema":{"description":"Detail and mutation representation of a Partner-managed company.","properties":{"address":{"oneOf":[{"type":"object","description":"Postal address of the company. Supplied address fields update the existing address; omitted fields retain their values. When the company has no address, supply all four fields: street, postal_code, city, and country. Omit the address to preserve it or set null to remove it.","properties":{"city":{"description":"City or locality of the company address.","maxLength":100,"minLength":1,"type":"string","uniqueKey":"address.oneOf.0.city","typeLabel":"string"},"country":{"type":"string","description":"Country as a two-letter ISO 3166-1 code.\n\n* `AF` - Afghanistan\n* `AX` - Åland Islands\n* `AL` - Albania\n* `DZ` - Algeria\n* `AS` - American Samoa\n* `AD` - Andorra\n* `AO` - Angola\n* `AI` - Anguilla\n* `AQ` - Antarctica\n* `AG` - Antigua and Barbuda\n* `AR` - Argentina\n* `AM` - Armenia\n* `AW` - Aruba\n* `AU` - Australia\n* `AT` - Austria\n* `AZ` - Azerbaijan\n* `BS` - Bahamas\n* `BH` - Bahrain\n* `BD` - Bangladesh\n* `BB` - Barbados\n* `BY` - Belarus\n* `BE` - Belgium\n* `BZ` - Belize\n* `BJ` - Benin\n* `BM` - Bermuda\n* `BT` - Bhutan\n* `BO` - Bolivia\n* `BQ` - Bonaire, Sint Eustatius and Saba\n* `BA` - Bosnia and Herzegovina\n* `BW` - Botswana\n* `BV` - Bouvet Island\n* `BR` - Brazil\n* `IO` - British Indian Ocean Territory\n* `BN` - Brunei\n* `BG` - Bulgaria\n* `BF` - Burkina Faso\n* `BI` - Burundi\n* `CV` - Cabo Verde\n* `KH` - Cambodia\n* `CM` - Cameroon\n* `CA` - Canada\n* `KY` - Cayman Islands\n* `CF` - Central African Republic\n* `TD` - Chad\n* `CL` - Chile\n* `CN` - China\n* `CX` - Christmas Island\n* `CC` - Cocos (Keeling) Islands\n* `CO` - Colombia\n* `KM` - Comoros\n* `CG` - Congo\n* `CD` - Congo (the Democratic Republic of the)\n* `CK` - Cook Islands\n* `CR` - Costa Rica\n* `CI` - Côte d'Ivoire\n* `HR` - Croatia\n* `CU` - Cuba\n* `CW` - Curaçao\n* `CY` - Cyprus\n* `CZ` - Czechia\n* `DK` - Denmark\n* `DJ` - Djibouti\n* `DM` - Dominica\n* `DO` - Dominican Republic\n* `EC` - Ecuador\n* `EG` - Egypt\n* `SV` - El Salvador\n* `GQ` - Equatorial Guinea\n* `ER` - Eritrea\n* `EE` - Estonia\n* `SZ` - Eswatini\n* `ET` - Ethiopia\n* `FK` - Falkland Islands (Malvinas)\n* `FO` - Faroe Islands\n* `FJ` - Fiji\n* `FI` - Finland\n* `FR` - France\n* `GF` - French Guiana\n* `PF` - French Polynesia\n* `TF` - French Southern Territories\n* `GA` - Gabon\n* `GM` - Gambia\n* `GE` - Georgia\n* `DE` - Germany\n* `GH` - Ghana\n* `GI` - Gibraltar\n* `GR` - Greece\n* `GL` - Greenland\n* `GD` - Grenada\n* `GP` - Guadeloupe\n* `GU` - Guam\n* `GT` - Guatemala\n* `GG` - Guernsey\n* `GN` - Guinea\n* `GW` - Guinea-Bissau\n* `GY` - Guyana\n* `HT` - Haiti\n* `HM` - Heard Island and McDonald Islands\n* `VA` - Holy See\n* `HN` - Honduras\n* `HK` - Hong Kong\n* `HU` - Hungary\n* `IS` - Iceland\n* `IN` - India\n* `ID` - Indonesia\n* `IR` - Iran\n* `IQ` - Iraq\n* `IE` - Ireland\n* `IM` - Isle of Man\n* `IL` - Israel\n* `IT` - Italy\n* `JM` - Jamaica\n* `JP` - Japan\n* `JE` - Jersey\n* `JO` - Jordan\n* `KZ` - Kazakhstan\n* `KE` - Kenya\n* `KI` - Kiribati\n* `XK` - Kosovo\n* `KW` - Kuwait\n* `KG` - Kyrgyzstan\n* `LA` - Laos\n* `LV` - Latvia\n* `LB` - Lebanon\n* `LS` - Lesotho\n* `LR` - Liberia\n* `LY` - Libya\n* `LI` - Liechtenstein\n* `LT` - Lithuania\n* `LU` - Luxembourg\n* `MO` - Macao\n* `MG` - Madagascar\n* `MW` - Malawi\n* `MY` - Malaysia\n* `MV` - Maldives\n* `ML` - Mali\n* `MT` - Malta\n* `MH` - Marshall Islands\n* `MQ` - Martinique\n* `MR` - Mauritania\n* `MU` - Mauritius\n* `YT` - Mayotte\n* `MX` - Mexico\n* `FM` - Micronesia\n* `MD` - Moldova\n* `MC` - Monaco\n* `MN` - Mongolia\n* `ME` - Montenegro\n* `MS` - Montserrat\n* `MA` - Morocco\n* `MZ` - Mozambique\n* `MM` - Myanmar\n* `NA` - Namibia\n* `NR` - Nauru\n* `NP` - Nepal\n* `NL` - Netherlands\n* `NC` - New Caledonia\n* `NZ` - New Zealand\n* `NI` - Nicaragua\n* `NE` - Niger\n* `NG` - Nigeria\n* `NU` - Niue\n* `NF` - Norfolk Island\n* `KP` - North Korea\n* `MK` - North Macedonia\n* `MP` - Northern Mariana Islands\n* `NO` - Norway\n* `OM` - Oman\n* `PK` - Pakistan\n* `PW` - Palau\n* `PS` - Palestine, State of\n* `PA` - Panama\n* `PG` - Papua New Guinea\n* `PY` - Paraguay\n* `PE` - Peru\n* `PH` - Philippines\n* `PN` - Pitcairn\n* `PL` - Poland\n* `PT` - Portugal\n* `PR` - Puerto Rico\n* `QA` - Qatar\n* `RE` - Réunion\n* `RO` - Romania\n* `RU` - Russia\n* `RW` - Rwanda\n* `BL` - Saint Barthélemy\n* `SH` - Saint Helena, Ascension and Tristan da Cunha\n* `KN` - Saint Kitts and Nevis\n* `LC` - Saint Lucia\n* `MF` - Saint Martin (French part)\n* `PM` - Saint Pierre and Miquelon\n* `VC` - Saint Vincent and the Grenadines\n* `WS` - Samoa\n* `SM` - San Marino\n* `ST` - Sao Tome and Principe\n* `SA` - Saudi Arabia\n* `SN` - Senegal\n* `RS` - Serbia\n* `SC` - Seychelles\n* `SL` - Sierra Leone\n* `SG` - Singapore\n* `SX` - Sint Maarten (Dutch part)\n* `SK` - Slovakia\n* `SI` - Slovenia\n* `SB` - Solomon Islands\n* `SO` - Somalia\n* `ZA` - South Africa\n* `GS` - South Georgia and the South Sandwich Islands\n* `KR` - South Korea\n* `SS` - South Sudan\n* `ES` - Spain\n* `LK` - Sri Lanka\n* `SD` - Sudan\n* `SR` - Suriname\n* `SJ` - Svalbard and Jan Mayen\n* `SE` - Sweden\n* `CH` - Switzerland\n* `SY` - Syria\n* `TW` - Taiwan\n* `TJ` - Tajikistan\n* `TZ` - Tanzania\n* `TH` - Thailand\n* `TL` - Timor-Leste\n* `TG` - Togo\n* `TK` - Tokelau\n* `TO` - Tonga\n* `TT` - Trinidad and Tobago\n* `TN` - Tunisia\n* `TR` - Türkiye\n* `TM` - Turkmenistan\n* `TC` - Turks and Caicos Islands\n* `TV` - Tuvalu\n* `UG` - Uganda\n* `UA` - Ukraine\n* `AE` - United Arab Emirates\n* `GB` - United Kingdom\n* `UM` - United States Minor Outlying Islands\n* `US` - United States of America\n* `UY` - Uruguay\n* `UZ` - Uzbekistan\n* `VU` - Vanuatu\n* `VE` - Venezuela\n* `VN` - Vietnam\n* `VG` - Virgin Islands (British)\n* `VI` - Virgin Islands (U.S.)\n* `WF` - Wallis and Futuna\n* `EH` - Western Sahara\n* `YE` - Yemen\n* `ZM` - Zambia\n* `ZW` - Zimbabwe","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","CV","KH","CM","CA","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","SZ","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","XK","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","KP","MK","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","KR","SS","ES","LK","SD","SR","SJ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","US","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"uniqueKey":"address.oneOf.0.country","typeLabel":"enum\u003cstring>"},"postal_code":{"description":"Postal code of the company address.","maxLength":100,"minLength":1,"type":"string","uniqueKey":"address.oneOf.0.postal_code","typeLabel":"string"},"street":{"description":"Street and house number of the company address.","maxLength":255,"minLength":1,"type":"string","uniqueKey":"address.oneOf.0.street","typeLabel":"string"}},"uniqueKey":"address.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"address.oneOf.1","typeLabel":"null"}],"uniqueKey":"address","typeLabel":"object | null"},"data_sharing_basis":{"type":"string","description":"Legal basis on which the partner may share this company's data. The declaration is optional here; once recorded, repeating the same value is allowed but replacing it returns 409 data_sharing_basis_already_declared.","enum":["not_secret_carrier","self_authorized"],"uniqueKey":"data_sharing_basis","typeLabel":"enum\u003cstring>"},"default_claim_type":{"oneOf":[{"type":"string","description":"Default contract or transaction type for new principal claims.\n\n* `H05` - Dienstleistungsvertrag\n* `H43` - Warenlieferung/-en\n* `H22` - Mitgliedsbeitrag\n* `H21` - Miete\n* `H11` - Kaufvertrag\n* `H44` - Werkvertrag/Werklieferungsvertrag\n* `H08` - Handwerkerleistung\n* `H41` - Versicherungsprämie/-beitrag\n* `H16` - Lehrgangs-/Unterrichtskosten\n* `H10` - Hotelkosten\n* `H02` - Ärztliche oder zahnärztliche Leistung\n* `H28` - Schadenersatz aus Vertrag\n* `H26` - Reparaturleistung\n* `H24` - Rechtsanwalts-/Rechtsbeistandshonorar\n* `H06` - Frachtkosten\n* `H18` - Miete für Kraftfahrzeug\n* `H34` - Speditionskosten\n* `H19` - Miete für Wohnraum einschl. Nebenkosten\n* `H42` - Versorgungsleistung - Strom, Wasser, Gas, Wärme-\n* `H17` - Miete für Geschäftsraum einschl. Nebenkosten\n* `H45` - Zeitungs-/Zeitschriftenbezug\n* `H37` - Ungerechtfertigte Bereicherung\n* `H29` - Schadenersatz aus Unfall/Vorfall\n* `H01` - Anzeigen in Zeitungen u.a.\n* `H78` - Tierärztliche Leistung\n* `H14` - Lagerkosten\n* `H77` - Krankentransportkosten\n* `H40` - Vermittlungs-/Maklerprovision\n* `H15` - Leasing/Mietkauf\n* `H23` - Pacht\n* `H04` - Darlehensrückzahlung\n* `H20` - Mietnebenkosten - auch Renovierungskosten-\n* `H79` - Verpflegungskosten\n* `H75` - Reisevertrag\n* `H33` - Schuldanerkenntnis\n* `H39` - Vergleich, außergerichtlicher\n* `H70` - Kindertagesstättenbeitrag\n* `H90` - Wohngeld/Hausgeld für Wohnungseigentümergemeinschaft\n* `H09` - Heimunterbringung\n* `H03` - Bürgschaft\n* `H07` - Geschäftsbesorgung durch Selbständige\n* `H12` - Kontokorrentabrechnung\n* `H13` - Krankenhauskosten-Pflege/Behandlung\n* `H36` - Überziehung des Bankkontos\n* `H61` - Wahlleistungen bei stationärer Behandlung\n* `H76` - Telekommunikationsleistungen","enum":["H05","H43","H22","H21","H11","H44","H08","H41","H16","H10","H02","H28","H26","H24","H06","H18","H34","H19","H42","H17","H45","H37","H29","H01","H78","H14","H77","H40","H15","H23","H04","H20","H79","H75","H33","H39","H70","H90","H09","H03","H07","H12","H13","H36","H61","H76"],"uniqueKey":"default_claim_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"default_claim_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"default_claim_type","typeLabel":"enum\u003cstring> | null"},"external_reference":{"oneOf":[{"description":"Your identifier for this company, unique within your partner organization. A duplicate returns 409 company_exists with the existing company_id. Set null to clear it; omit it to keep the current value.","maxLength":120,"minLength":1,"type":"string","uniqueKey":"external_reference.oneOf.0","typeLabel":"string"},{"description":"Your identifier for this company, unique within your partner organization. A duplicate returns 409 company_exists with the existing company_id. Set null to clear it; omit it to keep the current value.","maxLength":120,"minLength":1,"type":"null","uniqueKey":"external_reference.oneOf.1","typeLabel":"null"}],"uniqueKey":"external_reference","typeLabel":"string | null"},"legal_form":{"oneOf":[{"description":"Permanent public code from GET /legal-forms/, or null when not set. A non-null legal_form is required when legal_representatives is nonempty. On PATCH, omission preserves the current form; it cannot be cleared while retaining representatives. Changes follow the paywise UI identity lock: after transfer for processing, or once company data is complete and a case has been submitted.","type":"string","uniqueKey":"legal_form.oneOf.0","typeLabel":"string"},{"description":"Permanent public code from GET /legal-forms/, or null when not set. A non-null legal_form is required when legal_representatives is nonempty. On PATCH, omission preserves the current form; it cannot be cleared while retaining representatives. Changes follow the paywise UI identity lock: after transfer for processing, or once company data is complete and a case has been submitted.","type":"null","uniqueKey":"legal_form.oneOf.1","typeLabel":"null"}],"uniqueKey":"legal_form","typeLabel":"string | null"},"legal_representatives":{"description":"People or organizations legally representing the company, up to three, with roles matching legal_form. A nonempty array requires a non-null legal_form, using the stored form when legal_form is omitted. Omit to preserve them; a supplied array replaces them. They cannot be changed once company data submission is complete, even before the first case submission. Maximum 3 entries in the replacement list; exceeding this limit returns 400 validation_error.","items":{"description":"Legal representative embedded in the company aggregate.\n\n`type` uses the stable public role codes returned by\n`GET /partner/v2/legal-forms/`.","properties":{"name":{"description":"Full name of the person or organization representing the company.","maxLength":255,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].name","typeLabel":"string"},"type":{"type":"string","description":"Role of the representative. GET /legal-forms/ lists, per legal form, the roles a company must name (representative_requirements).\n\n* `managing_director` - managing_director\n* `director` - director\n* `board_member` - board_member\n* `chairperson` - chairperson\n* `general_partner` - general_partner\n* `shareholder` - shareholder\n* `owner` - owner\n* `partner` - partner\n* `supervisory_board` - supervisory_board\n* `other` - other","enum":["managing_director","director","board_member","chairperson","general_partner","shareholder","owner","partner","supervisory_board","other"],"isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].type","typeLabel":"enum\u003cstring>"}},"required":["name","type"],"type":"object","uniqueKey":"legal_representatives.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"legal_representatives","typeLabel":"object[]"},"name":{"description":"Registered or trading name of the company. Changes follow the paywise UI identity lock: after transfer for processing, or once company data is complete and a case has been submitted.","maxLength":255,"minLength":1,"type":"string","uniqueKey":"name","typeLabel":"string"},"notification_channels":{"description":"Company-level email recipients for operational notifications, up to 10. Omit to preserve the recipients; a supplied array replaces them, and [] removes them. After the first case submission, required recipients for requests to client and statements must remain. Maximum 10 recipients in the replacement list; exceeding this limit returns 400 validation_error.","items":{"description":"Public company-level email notification channel.","properties":{"type":{"type":"string","description":"Communication channel used for notifications.\n\n* `email` - email","enum":["email"],"isRequired":true,"uniqueKey":"notification_channels.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"value":{"description":"Email address receiving the selected notifications.","format":"email","maxLength":128,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"notification_channels.items.[INDEX].value","typeLabel":"string\u003cemail>"},"notifications":{"oneOf":[{"description":"Business events delivered to this email address. Omitted, null, or empty selections default to requests_to_client, status_updates, statements, and advance_requests. Nonempty selections are preserved.","items":{"description":"* `status_updates` - status_updates\n* `requests_to_client` - requests_to_client\n* `statements` - statements\n* `advance_requests` - advance_requests","enum":["status_updates","requests_to_client","statements","advance_requests"],"type":"string","uniqueKey":"notification_channels.items.[INDEX].notifications.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","uniqueKey":"notification_channels.items.[INDEX].notifications.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"description":"Business events delivered to this email address. Omitted, null, or empty selections default to requests_to_client, status_updates, statements, and advance_requests. Nonempty selections are preserved.","items":{"description":"* `status_updates` - status_updates\n* `requests_to_client` - requests_to_client\n* `statements` - statements\n* `advance_requests` - advance_requests","enum":["status_updates","requests_to_client","statements","advance_requests"],"type":"string"},"type":"null","uniqueKey":"notification_channels.items.[INDEX].notifications.oneOf.1","typeLabel":"null"}],"uniqueKey":"notification_channels.items.[INDEX].notifications","typeLabel":"enum\u003cstring>[] | null"}},"required":["type","value"],"type":"object","uniqueKey":"notification_channels.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"notification_channels","typeLabel":"object[]"},"payout_bank_account":{"oneOf":[{"type":"object","description":"Account to which collected funds are transferred. Omit to preserve the current account; before the first case submission, provide an account to replace it or null to remove it. After submission, changes must use the secured payout-account change process in the paywise UI. Resubmitting the unchanged account is allowed.","required":["account_holder","iban"],"properties":{"account_holder":{"description":"Name of the payout-account holder.","maxLength":255,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"payout_bank_account.oneOf.0.account_holder","typeLabel":"string"},"iban":{"description":"IBAN to which collected funds are transferred.","maxLength":34,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"payout_bank_account.oneOf.0.iban","typeLabel":"string"},"bic":{"oneOf":[{"description":"BIC/SWIFT code; required for non-German IBANs.","maxLength":11,"type":"string","uniqueKey":"payout_bank_account.oneOf.0.bic.oneOf.0","typeLabel":"string"},{"description":"BIC/SWIFT code; required for non-German IBANs.","maxLength":11,"type":"null","uniqueKey":"payout_bank_account.oneOf.0.bic.oneOf.1","typeLabel":"null"}],"uniqueKey":"payout_bank_account.oneOf.0.bic","typeLabel":"string | null"}},"uniqueKey":"payout_bank_account.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"payout_bank_account.oneOf.1","typeLabel":"null"}],"uniqueKey":"payout_bank_account","typeLabel":"object | null"},"phone":{"oneOf":[{"description":"Primary telephone number of the company in E.164 format; `null` clears it.","maxLength":50,"minLength":1,"type":"string","uniqueKey":"phone.oneOf.0","typeLabel":"string"},{"description":"Primary telephone number of the company in E.164 format; `null` clears it.","maxLength":50,"minLength":1,"type":"null","uniqueKey":"phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"phone","typeLabel":"string | null"},"tax_treatment":{"oneOf":[{"type":"string","description":"Company VAT treatment, consistent with the address country. reverse_charge requires vat_number. Changes follow the paywise UI identity lock: after transfer for processing, or once company data is complete and a case has been submitted.","enum":["input_tax_deductible","not_input_tax_deductible","reverse_charge","third_country_non_taxable"],"uniqueKey":"tax_treatment.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"tax_treatment.oneOf.1","typeLabel":"null"}],"uniqueKey":"tax_treatment","typeLabel":"enum\u003cstring> | null"},"vat_number":{"oneOf":[{"description":"Company VAT identification number. Required when tax_treatment is reverse_charge. Changes follow the paywise UI identity lock: after transfer for processing, or once company data is complete and a case has been submitted.","maxLength":64,"type":"string","uniqueKey":"vat_number.oneOf.0","typeLabel":"string"},{"description":"Company VAT identification number. Required when tax_treatment is reverse_charge. Changes follow the paywise UI identity lock: after transfer for processing, or once company data is complete and a case has been submitted.","maxLength":64,"type":"null","uniqueKey":"vat_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"vat_number","typeLabel":"string | null"}},"type":"object","uniqueKey":"","typeLabel":"object"},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"53237de9-ee43-4290-aec2-d5486a83a375":{"content":{"application/json":{"examples":{"Company":{"title":"Company","value":{"address":{"city":"Berlin","country":"DE","postal_code":"10115","street":"Example Avenue 5"},"case_access":"available","case_submission_readiness":{"issues":[],"ready":true},"created_at":"2026-07-18T10:00:00Z","customer_number":"5G0123","default_claim_type":"H11","external_reference":"crm-4711","id":"12000000-0000-4000-8000-000000000001","legal_form":"gmbh","legal_representatives":[{"name":"Taylor Example","type":"managing_director"}],"name":"Example Manufacturing GmbH","notification_channels":[{"notifications":["requests_to_client","status_updates","statements"],"type":"email","value":"[email protected]"}],"onboarding_mode":"api_only","onboarding_status":"confirmation_not_required","payout_bank_account":{"account_holder":"Example Manufacturing GmbH","iban":"DE89370400440532013000"},"phone":"+49301234567","sandbox_origin":"unclassified","tax_treatment":"input_tax_deductible","updated_at":"2026-07-18T10:00:00Z","users":[{"created_at":"2026-07-18T10:00:00Z","email":"[email protected]","first_name":"Taylor","id":"13000000-0000-4000-8000-000000000001","invite_expires_at":"2026-07-28T10:00:00Z","last_name":"Example","revocation_reason":"","revoked_at":null,"revoked_by_token_id":null,"role":"admin","sandbox_origin":"unclassified","status":"pending_setup","updated_at":"2026-07-18T10:00:00Z"}],"vat_number":"DE129273398"}}},"schema":{"description":"Detail and mutation representation of a Partner-managed company.","properties":{"case_access":{"type":"string","description":"Whether the partner may operate the Case Management API for this company.","enum":["available","unavailable"],"isRequired":true,"uniqueKey":"case_access","typeLabel":"enum\u003cstring>"},"case_submission_readiness":{"type":"object","description":"Whether company data is complete enough to submit a case.","required":["issues","ready"],"properties":{"issues":{"description":"Missing or invalid data that must be resolved before submission.","items":{"description":"Stable client-actionable issue in a company readiness report.","properties":{"code":{"description":"Machine-readable readiness issue code.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"case_submission_readiness.issues.items.[INDEX].code","typeLabel":"string"},"field":{"description":"Company field that prevents case submission.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"case_submission_readiness.issues.items.[INDEX].field","typeLabel":"string"},"message":{"description":"Human-readable action needed to resolve the issue.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"case_submission_readiness.issues.items.[INDEX].message","typeLabel":"string"}},"required":["code","field","message"],"type":"object","uniqueKey":"case_submission_readiness.issues.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"case_submission_readiness.issues","typeLabel":"object[]"},"ready":{"description":"Whether the company currently has all data needed to submit cases.","readOnly":true,"type":"boolean","isRequired":true,"uniqueKey":"case_submission_readiness.ready","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"case_submission_readiness","typeLabel":"object"},"created_at":{"description":"Time at which the managed company was created.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"customer_number":{"description":"paywise customer number assigned to the managed company.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"customer_number","typeLabel":"string"},"id":{"description":"Stable identifier for this resource.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"name":{"description":"Registered or trading name of the company.","maxLength":255,"type":"string","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"onboarding_mode":{"type":"string","description":"Selected mode for this Partner-company relationship. Read-only after creation.","enum":["api_only","web_flow"],"isRequired":true,"uniqueKey":"onboarding_mode","typeLabel":"enum\u003cstring>"},"onboarding_status":{"type":"string","description":"Administrator confirmation status: confirmation_not_required for api_only; confirmation_pending for provisional web_flow; confirmed for confirmed web_flow. Poll this field independently of membership setup or email delivery.","enum":["confirmation_not_required","confirmation_pending","confirmed"],"isRequired":true,"uniqueKey":"onboarding_status","typeLabel":"enum\u003cstring>"},"sandbox_origin":{"type":"string","description":"Provenance of this record. `sandbox_native` — created inside the sandbox and therefore a test resource you fully own. `production_mirror` — a read-only copy of a production record. `unclassified` — everything else, including every record in production. Determines what may be changed in the sandbox, so it is published rather than left to guesswork.\n\n* `production_mirror` - Production mirror\n* `sandbox_native` - Sandbox native\n* `unclassified` - Unclassified","enum":["production_mirror","sandbox_native","unclassified"],"isRequired":true,"uniqueKey":"sandbox_origin","typeLabel":"enum\u003cstring>"},"updated_at":{"description":"Time at which the managed company was last updated.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"},"address":{"oneOf":[{"type":"object","description":"Postal address of the company.","required":["city","country","postal_code","street"],"properties":{"city":{"description":"City or locality of the company address.","maxLength":100,"type":"string","isRequired":true,"uniqueKey":"address.oneOf.0.city","typeLabel":"string"},"country":{"type":"string","description":"Country as a two-letter ISO 3166-1 code.\n\n* `AF` - Afghanistan\n* `AX` - Åland Islands\n* `AL` - Albania\n* `DZ` - Algeria\n* `AS` - American Samoa\n* `AD` - Andorra\n* `AO` - Angola\n* `AI` - Anguilla\n* `AQ` - Antarctica\n* `AG` - Antigua and Barbuda\n* `AR` - Argentina\n* `AM` - Armenia\n* `AW` - Aruba\n* `AU` - Australia\n* `AT` - Austria\n* `AZ` - Azerbaijan\n* `BS` - Bahamas\n* `BH` - Bahrain\n* `BD` - Bangladesh\n* `BB` - Barbados\n* `BY` - Belarus\n* `BE` - Belgium\n* `BZ` - Belize\n* `BJ` - Benin\n* `BM` - Bermuda\n* `BT` - Bhutan\n* `BO` - Bolivia\n* `BQ` - Bonaire, Sint Eustatius and Saba\n* `BA` - Bosnia and Herzegovina\n* `BW` - Botswana\n* `BV` - Bouvet Island\n* `BR` - Brazil\n* `IO` - British Indian Ocean Territory\n* `BN` - Brunei\n* `BG` - Bulgaria\n* `BF` - Burkina Faso\n* `BI` - Burundi\n* `CV` - Cabo Verde\n* `KH` - Cambodia\n* `CM` - Cameroon\n* `CA` - Canada\n* `KY` - Cayman Islands\n* `CF` - Central African Republic\n* `TD` - Chad\n* `CL` - Chile\n* `CN` - China\n* `CX` - Christmas Island\n* `CC` - Cocos (Keeling) Islands\n* `CO` - Colombia\n* `KM` - Comoros\n* `CG` - Congo\n* `CD` - Congo (the Democratic Republic of the)\n* `CK` - Cook Islands\n* `CR` - Costa Rica\n* `CI` - Côte d'Ivoire\n* `HR` - Croatia\n* `CU` - Cuba\n* `CW` - Curaçao\n* `CY` - Cyprus\n* `CZ` - Czechia\n* `DK` - Denmark\n* `DJ` - Djibouti\n* `DM` - Dominica\n* `DO` - Dominican Republic\n* `EC` - Ecuador\n* `EG` - Egypt\n* `SV` - El Salvador\n* `GQ` - Equatorial Guinea\n* `ER` - Eritrea\n* `EE` - Estonia\n* `SZ` - Eswatini\n* `ET` - Ethiopia\n* `FK` - Falkland Islands (Malvinas)\n* `FO` - Faroe Islands\n* `FJ` - Fiji\n* `FI` - Finland\n* `FR` - France\n* `GF` - French Guiana\n* `PF` - French Polynesia\n* `TF` - French Southern Territories\n* `GA` - Gabon\n* `GM` - Gambia\n* `GE` - Georgia\n* `DE` - Germany\n* `GH` - Ghana\n* `GI` - Gibraltar\n* `GR` - Greece\n* `GL` - Greenland\n* `GD` - Grenada\n* `GP` - Guadeloupe\n* `GU` - Guam\n* `GT` - Guatemala\n* `GG` - Guernsey\n* `GN` - Guinea\n* `GW` - Guinea-Bissau\n* `GY` - Guyana\n* `HT` - Haiti\n* `HM` - Heard Island and McDonald Islands\n* `VA` - Holy See\n* `HN` - Honduras\n* `HK` - Hong Kong\n* `HU` - Hungary\n* `IS` - Iceland\n* `IN` - India\n* `ID` - Indonesia\n* `IR` - Iran\n* `IQ` - Iraq\n* `IE` - Ireland\n* `IM` - Isle of Man\n* `IL` - Israel\n* `IT` - Italy\n* `JM` - Jamaica\n* `JP` - Japan\n* `JE` - Jersey\n* `JO` - Jordan\n* `KZ` - Kazakhstan\n* `KE` - Kenya\n* `KI` - Kiribati\n* `XK` - Kosovo\n* `KW` - Kuwait\n* `KG` - Kyrgyzstan\n* `LA` - Laos\n* `LV` - Latvia\n* `LB` - Lebanon\n* `LS` - Lesotho\n* `LR` - Liberia\n* `LY` - Libya\n* `LI` - Liechtenstein\n* `LT` - Lithuania\n* `LU` - Luxembourg\n* `MO` - Macao\n* `MG` - Madagascar\n* `MW` - Malawi\n* `MY` - Malaysia\n* `MV` - Maldives\n* `ML` - Mali\n* `MT` - Malta\n* `MH` - Marshall Islands\n* `MQ` - Martinique\n* `MR` - Mauritania\n* `MU` - Mauritius\n* `YT` - Mayotte\n* `MX` - Mexico\n* `FM` - Micronesia\n* `MD` - Moldova\n* `MC` - Monaco\n* `MN` - Mongolia\n* `ME` - Montenegro\n* `MS` - Montserrat\n* `MA` - Morocco\n* `MZ` - Mozambique\n* `MM` - Myanmar\n* `NA` - Namibia\n* `NR` - Nauru\n* `NP` - Nepal\n* `NL` - Netherlands\n* `NC` - New Caledonia\n* `NZ` - New Zealand\n* `NI` - Nicaragua\n* `NE` - Niger\n* `NG` - Nigeria\n* `NU` - Niue\n* `NF` - Norfolk Island\n* `KP` - North Korea\n* `MK` - North Macedonia\n* `MP` - Northern Mariana Islands\n* `NO` - Norway\n* `OM` - Oman\n* `PK` - Pakistan\n* `PW` - Palau\n* `PS` - Palestine, State of\n* `PA` - Panama\n* `PG` - Papua New Guinea\n* `PY` - Paraguay\n* `PE` - Peru\n* `PH` - Philippines\n* `PN` - Pitcairn\n* `PL` - Poland\n* `PT` - Portugal\n* `PR` - Puerto Rico\n* `QA` - Qatar\n* `RE` - Réunion\n* `RO` - Romania\n* `RU` - Russia\n* `RW` - Rwanda\n* `BL` - Saint Barthélemy\n* `SH` - Saint Helena, Ascension and Tristan da Cunha\n* `KN` - Saint Kitts and Nevis\n* `LC` - Saint Lucia\n* `MF` - Saint Martin (French part)\n* `PM` - Saint Pierre and Miquelon\n* `VC` - Saint Vincent and the Grenadines\n* `WS` - Samoa\n* `SM` - San Marino\n* `ST` - Sao Tome and Principe\n* `SA` - Saudi Arabia\n* `SN` - Senegal\n* `RS` - Serbia\n* `SC` - Seychelles\n* `SL` - Sierra Leone\n* `SG` - Singapore\n* `SX` - Sint Maarten (Dutch part)\n* `SK` - Slovakia\n* `SI` - Slovenia\n* `SB` - Solomon Islands\n* `SO` - Somalia\n* `ZA` - South Africa\n* `GS` - South Georgia and the South Sandwich Islands\n* `KR` - South Korea\n* `SS` - South Sudan\n* `ES` - Spain\n* `LK` - Sri Lanka\n* `SD` - Sudan\n* `SR` - Suriname\n* `SJ` - Svalbard and Jan Mayen\n* `SE` - Sweden\n* `CH` - Switzerland\n* `SY` - Syria\n* `TW` - Taiwan\n* `TJ` - Tajikistan\n* `TZ` - Tanzania\n* `TH` - Thailand\n* `TL` - Timor-Leste\n* `TG` - Togo\n* `TK` - Tokelau\n* `TO` - Tonga\n* `TT` - Trinidad and Tobago\n* `TN` - Tunisia\n* `TR` - Türkiye\n* `TM` - Turkmenistan\n* `TC` - Turks and Caicos Islands\n* `TV` - Tuvalu\n* `UG` - Uganda\n* `UA` - Ukraine\n* `AE` - United Arab Emirates\n* `GB` - United Kingdom\n* `UM` - United States Minor Outlying Islands\n* `US` - United States of America\n* `UY` - Uruguay\n* `UZ` - Uzbekistan\n* `VU` - Vanuatu\n* `VE` - Venezuela\n* `VN` - Vietnam\n* `VG` - Virgin Islands (British)\n* `VI` - Virgin Islands (U.S.)\n* `WF` - Wallis and Futuna\n* `EH` - Western Sahara\n* `YE` - Yemen\n* `ZM` - Zambia\n* `ZW` - Zimbabwe","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","CV","KH","CM","CA","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","SZ","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","XK","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","KP","MK","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","KR","SS","ES","LK","SD","SR","SJ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","US","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"isRequired":true,"uniqueKey":"address.oneOf.0.country","typeLabel":"enum\u003cstring>"},"postal_code":{"description":"Postal code of the company address.","maxLength":100,"type":"string","isRequired":true,"uniqueKey":"address.oneOf.0.postal_code","typeLabel":"string"},"street":{"description":"Street and house number of the company address.","maxLength":255,"type":"string","isRequired":true,"uniqueKey":"address.oneOf.0.street","typeLabel":"string"}},"uniqueKey":"address.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"address.oneOf.1","typeLabel":"null"}],"uniqueKey":"address","typeLabel":"object | null"},"default_claim_type":{"oneOf":[{"type":"string","description":"Default contract or transaction type for new principal claims.\n\n* `H05` - Dienstleistungsvertrag\n* `H43` - Warenlieferung/-en\n* `H22` - Mitgliedsbeitrag\n* `H21` - Miete\n* `H11` - Kaufvertrag\n* `H44` - Werkvertrag/Werklieferungsvertrag\n* `H08` - Handwerkerleistung\n* `H41` - Versicherungsprämie/-beitrag\n* `H16` - Lehrgangs-/Unterrichtskosten\n* `H10` - Hotelkosten\n* `H02` - Ärztliche oder zahnärztliche Leistung\n* `H28` - Schadenersatz aus Vertrag\n* `H26` - Reparaturleistung\n* `H24` - Rechtsanwalts-/Rechtsbeistandshonorar\n* `H06` - Frachtkosten\n* `H18` - Miete für Kraftfahrzeug\n* `H34` - Speditionskosten\n* `H19` - Miete für Wohnraum einschl. Nebenkosten\n* `H42` - Versorgungsleistung - Strom, Wasser, Gas, Wärme-\n* `H17` - Miete für Geschäftsraum einschl. Nebenkosten\n* `H45` - Zeitungs-/Zeitschriftenbezug\n* `H37` - Ungerechtfertigte Bereicherung\n* `H29` - Schadenersatz aus Unfall/Vorfall\n* `H01` - Anzeigen in Zeitungen u.a.\n* `H78` - Tierärztliche Leistung\n* `H14` - Lagerkosten\n* `H77` - Krankentransportkosten\n* `H40` - Vermittlungs-/Maklerprovision\n* `H15` - Leasing/Mietkauf\n* `H23` - Pacht\n* `H04` - Darlehensrückzahlung\n* `H20` - Mietnebenkosten - auch Renovierungskosten-\n* `H79` - Verpflegungskosten\n* `H75` - Reisevertrag\n* `H33` - Schuldanerkenntnis\n* `H39` - Vergleich, außergerichtlicher\n* `H70` - Kindertagesstättenbeitrag\n* `H90` - Wohngeld/Hausgeld für Wohnungseigentümergemeinschaft\n* `H09` - Heimunterbringung\n* `H03` - Bürgschaft\n* `H07` - Geschäftsbesorgung durch Selbständige\n* `H12` - Kontokorrentabrechnung\n* `H13` - Krankenhauskosten-Pflege/Behandlung\n* `H36` - Überziehung des Bankkontos\n* `H61` - Wahlleistungen bei stationärer Behandlung\n* `H76` - Telekommunikationsleistungen","enum":["H05","H43","H22","H21","H11","H44","H08","H41","H16","H10","H02","H28","H26","H24","H06","H18","H34","H19","H42","H17","H45","H37","H29","H01","H78","H14","H77","H40","H15","H23","H04","H20","H79","H75","H33","H39","H70","H90","H09","H03","H07","H12","H13","H36","H61","H76"],"uniqueKey":"default_claim_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"default_claim_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"default_claim_type","typeLabel":"enum\u003cstring> | null"},"external_reference":{"oneOf":[{"description":"Your own identifier for this company (for example a CRM id). Unique per partner, compared byte-exact after trimming surrounding whitespace (case-sensitive): creating a second company with the same value returns 409 company_exists with the existing company_id. Filter with ?external_reference= on the list endpoint.","maxLength":120,"type":"string","uniqueKey":"external_reference.oneOf.0","typeLabel":"string"},{"description":"Your own identifier for this company (for example a CRM id). Unique per partner, compared byte-exact after trimming surrounding whitespace (case-sensitive): creating a second company with the same value returns 409 company_exists with the existing company_id. Filter with ?external_reference= on the list endpoint.","maxLength":120,"type":"null","uniqueKey":"external_reference.oneOf.1","typeLabel":"null"}],"uniqueKey":"external_reference","typeLabel":"string | null"},"legal_form":{"oneOf":[{"description":"Permanent public code from GET /legal-forms/.","type":"string","uniqueKey":"legal_form.oneOf.0","typeLabel":"string"},{"description":"Permanent public code from GET /legal-forms/.","type":"null","uniqueKey":"legal_form.oneOf.1","typeLabel":"null"}],"uniqueKey":"legal_form","typeLabel":"string | null"},"legal_representatives":{"description":"People or organizations legally representing the company.","items":{"description":"Legal representative embedded in the company aggregate.\n\n`type` uses the stable public role codes returned by\n`GET /partner/v2/legal-forms/`.","properties":{"name":{"description":"Full name of the person or organization representing the company.","maxLength":255,"type":"string","isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].name","typeLabel":"string"},"type":{"type":"string","description":"Role of the representative. GET /legal-forms/ lists, per legal form, the roles a company must name (representative_requirements).\n\n* `managing_director` - managing_director\n* `director` - director\n* `board_member` - board_member\n* `chairperson` - chairperson\n* `general_partner` - general_partner\n* `shareholder` - shareholder\n* `owner` - owner\n* `partner` - partner\n* `supervisory_board` - supervisory_board\n* `other` - other","enum":["managing_director","director","board_member","chairperson","general_partner","shareholder","owner","partner","supervisory_board","other"],"isRequired":true,"uniqueKey":"legal_representatives.items.[INDEX].type","typeLabel":"enum\u003cstring>"}},"required":["name","type"],"type":"object","uniqueKey":"legal_representatives.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"legal_representatives","typeLabel":"object[]"},"notification_channels":{"description":"Company-level email recipients for operational notifications.","items":{"description":"Public company-level email notification channel.","properties":{"type":{"type":"string","description":"Communication channel used for notifications.\n\n* `email` - email","enum":["email"],"isRequired":true,"uniqueKey":"notification_channels.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"value":{"description":"Email address receiving the selected notifications.","format":"email","maxLength":128,"type":"string","isRequired":true,"uniqueKey":"notification_channels.items.[INDEX].value","typeLabel":"string\u003cemail>"},"notifications":{"oneOf":[{"description":"Business events delivered to this email address. Omitted, null, or empty selections default to requests_to_client, status_updates, statements, and advance_requests. Nonempty selections are preserved.","items":{"description":"* `status_updates` - status_updates\n* `requests_to_client` - requests_to_client\n* `statements` - statements\n* `advance_requests` - advance_requests","enum":["status_updates","requests_to_client","statements","advance_requests"],"type":"string","uniqueKey":"notification_channels.items.[INDEX].notifications.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"type":"array","uniqueKey":"notification_channels.items.[INDEX].notifications.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"description":"Business events delivered to this email address. Omitted, null, or empty selections default to requests_to_client, status_updates, statements, and advance_requests. Nonempty selections are preserved.","items":{"description":"* `status_updates` - status_updates\n* `requests_to_client` - requests_to_client\n* `statements` - statements\n* `advance_requests` - advance_requests","enum":["status_updates","requests_to_client","statements","advance_requests"],"type":"string"},"type":"null","uniqueKey":"notification_channels.items.[INDEX].notifications.oneOf.1","typeLabel":"null"}],"uniqueKey":"notification_channels.items.[INDEX].notifications","typeLabel":"enum\u003cstring>[] | null"}},"required":["type","value"],"type":"object","uniqueKey":"notification_channels.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"notification_channels","typeLabel":"object[]"},"payout_bank_account":{"oneOf":[{"type":"object","description":"Account to which collected funds are transferred.","required":["account_holder","iban"],"properties":{"account_holder":{"description":"Name of the payout-account holder.","maxLength":255,"type":"string","isRequired":true,"uniqueKey":"payout_bank_account.oneOf.0.account_holder","typeLabel":"string"},"iban":{"description":"IBAN to which collected funds are transferred.","maxLength":34,"type":"string","isRequired":true,"uniqueKey":"payout_bank_account.oneOf.0.iban","typeLabel":"string"},"bic":{"oneOf":[{"description":"BIC/SWIFT code; required for non-German IBANs.","maxLength":11,"type":"string","uniqueKey":"payout_bank_account.oneOf.0.bic.oneOf.0","typeLabel":"string"},{"description":"BIC/SWIFT code; required for non-German IBANs.","maxLength":11,"type":"null","uniqueKey":"payout_bank_account.oneOf.0.bic.oneOf.1","typeLabel":"null"}],"uniqueKey":"payout_bank_account.oneOf.0.bic","typeLabel":"string | null"}},"uniqueKey":"payout_bank_account.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"payout_bank_account.oneOf.1","typeLabel":"null"}],"uniqueKey":"payout_bank_account","typeLabel":"object | null"},"phone":{"oneOf":[{"description":"Primary telephone number of the company in E.164 format; `null` clears it.","maxLength":50,"type":"string","uniqueKey":"phone.oneOf.0","typeLabel":"string"},{"description":"Primary telephone number of the company in E.164 format; `null` clears it.","maxLength":50,"type":"null","uniqueKey":"phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"phone","typeLabel":"string | null"},"tax_treatment":{"oneOf":[{"type":"string","description":"Company's input-VAT or reverse-charge treatment.\n\n* `input_tax_deductible` - input_tax_deductible\n* `not_input_tax_deductible` - not_input_tax_deductible\n* `reverse_charge` - reverse_charge\n* `third_country_non_taxable` - third_country_non_taxable","enum":["input_tax_deductible","not_input_tax_deductible","reverse_charge","third_country_non_taxable"],"uniqueKey":"tax_treatment.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"tax_treatment.oneOf.1","typeLabel":"null"}],"uniqueKey":"tax_treatment","typeLabel":"enum\u003cstring> | null"},"users":{"description":"User memberships in the managed company. Each entry identifies a membership and its current onboarding or revocation state.","items":{"description":"A user's membership in a managed company.","properties":{"created_at":{"description":"Time at which the membership was created.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"users.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"email":{"description":"Email address submitted with the invitation while it is unaccepted; after acceptance, reflects the user's current profile.","format":"email","maxLength":128,"type":"string","isRequired":true,"uniqueKey":"users.items.[INDEX].email","typeLabel":"string\u003cemail>"},"first_name":{"description":"Given name submitted with the invitation while it is unaccepted; after acceptance, reflects the user's current profile.","maxLength":128,"type":"string","isRequired":true,"uniqueKey":"users.items.[INDEX].first_name","typeLabel":"string"},"id":{"description":"Stable identifier of this user's membership in the managed company. Use it as membership_id in the company users endpoints.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"users.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"invite_expires_at":{"oneOf":[{"description":"Expiry time of the setup invitation while the membership is pending_setup; null when no pending setup invitation is attached.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"users.items.[INDEX].invite_expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Expiry time of the setup invitation while the membership is pending_setup; null when no pending setup invitation is attached.","format":"date-time","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"users.items.[INDEX].invite_expires_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"users.items.[INDEX].invite_expires_at","typeLabel":"string\u003cdate-time> | null"},"last_name":{"description":"Family name submitted with the invitation while it is unaccepted; after acceptance, reflects the user's current profile.","maxLength":128,"type":"string","isRequired":true,"uniqueKey":"users.items.[INDEX].last_name","typeLabel":"string"},"revocation_reason":{"description":"Reason recorded when the membership was revoked.","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"users.items.[INDEX].revocation_reason","typeLabel":"string"},"revoked_at":{"oneOf":[{"description":"Time at which the membership was revoked.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"users.items.[INDEX].revoked_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Time at which the membership was revoked.","format":"date-time","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"users.items.[INDEX].revoked_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"users.items.[INDEX].revoked_at","typeLabel":"string\u003cdate-time> | null"},"revoked_by_token_id":{"oneOf":[{"description":"Partner credential that revoked the membership, when applicable.","format":"uuid","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"users.items.[INDEX].revoked_by_token_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"description":"Partner credential that revoked the membership, when applicable.","format":"uuid","readOnly":true,"type":"null","isRequired":true,"uniqueKey":"users.items.[INDEX].revoked_by_token_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"users.items.[INDEX].revoked_by_token_id","typeLabel":"string\u003cuuid> | null"},"role":{"type":"string","description":"Permissions the user receives within the managed company.\n\n* `admin` - admin\n* `tax_consultant` - tax_consultant\n* `member` - member\n* `readonly` - readonly\n* `developer` - developer","enum":["admin","tax_consultant","member","readonly","developer"],"isRequired":true,"uniqueKey":"users.items.[INDEX].role","typeLabel":"enum\u003cstring>"},"sandbox_origin":{"type":"string","description":"Provenance of the user behind this membership — `sandbox_native` for a subject created inside the sandbox (a test resource), `production_mirror` for a read-only copy of a production user, `unclassified` otherwise (always so in production).\n\n* `production_mirror` - Production mirror\n* `sandbox_native` - Sandbox native\n* `unclassified` - Unclassified","enum":["production_mirror","sandbox_native","unclassified"],"isRequired":true,"uniqueKey":"users.items.[INDEX].sandbox_origin","typeLabel":"enum\u003cstring>"},"status":{"type":"string","description":"Membership lifecycle state: pending_setup awaits invitation acceptance; active grants access; cancelled ends a pending invitation; revoked removes an active membership's access.","enum":["pending_setup","active","cancelled","revoked"],"isRequired":true,"uniqueKey":"users.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"updated_at":{"description":"Time at which the membership was last updated.","format":"date-time","readOnly":true,"type":"string","isRequired":true,"uniqueKey":"users.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"}},"required":["created_at","email","first_name","id","invite_expires_at","last_name","revocation_reason","revoked_at","revoked_by_token_id","role","sandbox_origin","status","updated_at"],"type":"object","uniqueKey":"users.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"users","typeLabel":"object[]"},"vat_number":{"oneOf":[{"description":"VAT identification number of the company.","maxLength":64,"type":"string","uniqueKey":"vat_number.oneOf.0","typeLabel":"string"},{"description":"VAT identification number of the company.","maxLength":64,"type":"null","uniqueKey":"vat_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"vat_number","typeLabel":"string | null"}},"required":["case_access","case_submission_readiness","created_at","customer_number","id","name","onboarding_mode","onboarding_status","sandbox_origin","updated_at"],"type":"object","uniqueKey":"","typeLabel":"object"},"exampleType":"examples"}},"description":"","headers":{"Cache-Control":{"description":"Cacheability directive. Authenticated responses use `private, no-store`; the legal-form catalog may use `private, max-age=86400`.","schema":{"type":"string"}},"ETag":{"description":"Strong validator of this representation. Send it back as `If-None-Match` to skip an unchanged re-read (304) or as `If-Match` on PATCH/PUT/DELETE to fail with 412 when the resource changed.","schema":{"type":"string"}},"X-Paywise-Environment":{"description":"Environment that produced the response.","schema":{"enum":["production","sandbox"],"type":"string"}},"X-Paywise-Request-Id":{"description":"Fresh server-assigned correlation id for this response. Caller-provided request ids are ignored.","schema":{"format":"uuid","type":"string"}}},"exampleType":"examples"},"fddecbb8-9155-47ed-a5e3-24f232e40250":{"content":{"application/json":{"examples":{"validation-error":{"title":"validation-error","value":{"code":"validation_error","detail":"The request contains invalid data.","errors":[{"code":"invalid","field":"users[0].email","message":"Enter a valid email address."}]}}},"schema":{"properties":{"code":{"description":"Machine-readable error category.","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"description":"Short human-readable summary of the error.","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"errors":{"description":"Field-level validation errors, when applicable.","items":{"properties":{"code":{"description":"Machine-readable field error code.","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"field":{"oneOf":[{"description":"Path to the field that caused the error, using dots for objects and brackets for list indexes, for example `claims[0].amount`; null for an error without a field path.","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].field.oneOf.0","typeLabel":"string"},{"description":"Path to the field that caused the error, using dots for objects and brackets for list indexes, for example `claims[0].amount`; null for an error without a field path.","type":"null","isRequired":true,"uniqueKey":"errors.items.[INDEX].field.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string | null"},"message":{"description":"Human-readable explanation of the field error.","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"required":["field","code","message"],"type":"object","uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"errors","typeLabel":"object[]"}},"required":["detail","code"],"type":"object","uniqueKey":"","typeLabel":"object"},"exampleType":"examples"}},"description":"","headers":{"Cache-Control":{"description":"Cacheability directive. Authenticated responses use `private, no-store`; the legal-form catalog may use `private, max-age=86400`.","schema":{"type":"string"}},"X-Paywise-Environment":{"description":"Environment that produced the response.","schema":{"enum":["production","sandbox"],"type":"string"}},"X-Paywise-Request-Id":{"description":"Fresh server-assigned correlation id for this response. Caller-provided request ids are ignored.","schema":{"format":"uuid","type":"string"}}},"exampleType":"examples"},"e65bf3a8-dc26-4304-9453-fb455dde527d":{"content":{"application/json":{"examples":{"authentication-error":{"title":"authentication-error","value":{"code":"not_authenticated","detail":"Authentication credentials were not provided."}}},"schema":{"properties":{"code":{"description":"Machine-readable error category.","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"description":"Short human-readable summary of the error.","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"errors":{"description":"Field-level validation errors, when applicable.","items":{"properties":{"code":{"description":"Machine-readable field error code.","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"field":{"oneOf":[{"description":"Path to the field that caused the error, using dots for objects and brackets for list indexes, for example `claims[0].amount`; null for an error without a field path.","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].field.oneOf.0","typeLabel":"string"},{"description":"Path to the field that caused the error, using dots for objects and brackets for list indexes, for example `claims[0].amount`; null for an error without a field path.","type":"null","isRequired":true,"uniqueKey":"errors.items.[INDEX].field.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string | null"},"message":{"description":"Human-readable explanation of the field error.","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"required":["field","code","message"],"type":"object","uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"errors","typeLabel":"object[]"}},"required":["detail","code"],"type":"object","uniqueKey":"","typeLabel":"object"},"exampleType":"examples"}},"description":"","headers":{"Cache-Control":{"description":"Cacheability directive. Authenticated responses use `private, no-store`; the legal-form catalog may use `private, max-age=86400`.","schema":{"type":"string"}},"X-Paywise-Environment":{"description":"Environment that produced the response.","schema":{"enum":["production","sandbox"],"type":"string"}},"X-Paywise-Request-Id":{"description":"Fresh server-assigned correlation id for this response. Caller-provided request ids are ignored.","schema":{"format":"uuid","type":"string"}}},"exampleType":"examples"},"4aea4194-3e6b-4736-a77e-870f247edff0":{"content":{"application/json":{"schema":{"properties":{"code":{"description":"Machine-readable error category.","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"description":"Short human-readable summary of the error.","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"errors":{"description":"Field-level validation errors, when applicable.","items":{"properties":{"code":{"description":"Machine-readable field error code.","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"field":{"oneOf":[{"description":"Path to the field that caused the error, using dots for objects and brackets for list indexes, for example `claims[0].amount`; null for an error without a field path.","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].field.oneOf.0","typeLabel":"string"},{"description":"Path to the field that caused the error, using dots for objects and brackets for list indexes, for example `claims[0].amount`; null for an error without a field path.","type":"null","isRequired":true,"uniqueKey":"errors.items.[INDEX].field.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string | null"},"message":{"description":"Human-readable explanation of the field error.","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"required":["field","code","message"],"type":"object","uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"errors","typeLabel":"object[]"}},"required":["detail","code"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","detail":"\u003cstring>","errors":[{"code":"\u003cstring>","field":"\u003cstring>","message":"\u003cstring>"}]}}},"exampleType":"generated"}},"description":"Standard error response.","headers":{"Cache-Control":{"description":"Cacheability directive. Authenticated responses use `private, no-store`; the legal-form catalog may use `private, max-age=86400`.","schema":{"type":"string"}},"X-Paywise-Environment":{"description":"Environment that produced the response.","schema":{"enum":["production","sandbox"],"type":"string"}},"X-Paywise-Request-Id":{"description":"Fresh server-assigned correlation id for this response. Caller-provided request ids are ignored.","schema":{"format":"uuid","type":"string"}}},"exampleType":"generated"},"18d4ac2f-6345-44e9-8ec8-0a1be56ceb50":{"content":{"application/json":{"examples":{"not-found-error":{"title":"not-found-error","value":{"code":"not_found","detail":"The requested resource was not found."}}},"schema":{"properties":{"code":{"description":"Machine-readable error category.","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"description":"Short human-readable summary of the error.","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"errors":{"description":"Field-level validation errors, when applicable.","items":{"properties":{"code":{"description":"Machine-readable field error code.","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"field":{"oneOf":[{"description":"Path to the field that caused the error, using dots for objects and brackets for list indexes, for example `claims[0].amount`; null for an error without a field path.","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].field.oneOf.0","typeLabel":"string"},{"description":"Path to the field that caused the error, using dots for objects and brackets for list indexes, for example `claims[0].amount`; null for an error without a field path.","type":"null","isRequired":true,"uniqueKey":"errors.items.[INDEX].field.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string | null"},"message":{"description":"Human-readable explanation of the field error.","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"required":["field","code","message"],"type":"object","uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"errors","typeLabel":"object[]"}},"required":["detail","code"],"type":"object","uniqueKey":"","typeLabel":"object"},"exampleType":"examples"}},"description":"","headers":{"Cache-Control":{"description":"Cacheability directive. Authenticated responses use `private, no-store`; the legal-form catalog may use `private, max-age=86400`.","schema":{"type":"string"}},"X-Paywise-Environment":{"description":"Environment that produced the response.","schema":{"enum":["production","sandbox"],"type":"string"}},"X-Paywise-Request-Id":{"description":"Fresh server-assigned correlation id for this response. Caller-provided request ids are ignored.","schema":{"format":"uuid","type":"string"}}},"exampleType":"examples"},"4ca30e71-dab8-416d-ba0b-b7fcc4b98135":{"content":{"application/json":{"schema":{"properties":{"code":{"description":"Machine-readable error category.","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"description":"Short human-readable summary of the error.","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"company_id":{"description":"Identifier of the existing company with this external_reference.","format":"uuid","type":"string","uniqueKey":"company_id","typeLabel":"string\u003cuuid>"},"errors":{"description":"Field-level validation errors, when applicable.","items":{"properties":{"code":{"description":"Machine-readable field error code.","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"field":{"oneOf":[{"description":"Path to the field that caused the error, using dots for objects and brackets for list indexes, for example `claims[0].amount`; null for an error without a field path.","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].field.oneOf.0","typeLabel":"string"},{"description":"Path to the field that caused the error, using dots for objects and brackets for list indexes, for example `claims[0].amount`; null for an error without a field path.","type":"null","isRequired":true,"uniqueKey":"errors.items.[INDEX].field.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string | null"},"message":{"description":"Human-readable explanation of the field error.","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"required":["field","code","message"],"type":"object","uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"errors","typeLabel":"object[]"}},"required":["detail","code"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","detail":"\u003cstring>","company_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","errors":[{"code":"\u003cstring>","field":"\u003cstring>","message":"\u003cstring>"}]}}},"exampleType":"generated"}},"description":"","headers":{"Cache-Control":{"description":"Cacheability directive. Authenticated responses use `private, no-store`; the legal-form catalog may use `private, max-age=86400`.","schema":{"type":"string"}},"X-Paywise-Environment":{"description":"Environment that produced the response.","schema":{"enum":["production","sandbox"],"type":"string"}},"X-Paywise-Request-Id":{"description":"Fresh server-assigned correlation id for this response. Caller-provided request ids are ignored.","schema":{"format":"uuid","type":"string"}}},"exampleType":"generated"},"d8852380-172e-4392-a327-d35511adb4c4":{"content":{"application/json":{"schema":{"properties":{"code":{"description":"Machine-readable error category.","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"description":"Short human-readable summary of the error.","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"errors":{"description":"Field-level validation errors, when applicable.","items":{"properties":{"code":{"description":"Machine-readable field error code.","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"field":{"oneOf":[{"description":"Path to the field that caused the error, using dots for objects and brackets for list indexes, for example `claims[0].amount`; null for an error without a field path.","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].field.oneOf.0","typeLabel":"string"},{"description":"Path to the field that caused the error, using dots for objects and brackets for list indexes, for example `claims[0].amount`; null for an error without a field path.","type":"null","isRequired":true,"uniqueKey":"errors.items.[INDEX].field.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string | null"},"message":{"description":"Human-readable explanation of the field error.","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"required":["field","code","message"],"type":"object","uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"errors","typeLabel":"object[]"}},"required":["detail","code"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","detail":"\u003cstring>","errors":[{"code":"\u003cstring>","field":"\u003cstring>","message":"\u003cstring>"}]}}},"exampleType":"generated"}},"description":"Standard error response.","headers":{"Cache-Control":{"description":"Cacheability directive. Authenticated responses use `private, no-store`; the legal-form catalog may use `private, max-age=86400`.","schema":{"type":"string"}},"X-Paywise-Environment":{"description":"Environment that produced the response.","schema":{"enum":["production","sandbox"],"type":"string"}},"X-Paywise-Request-Id":{"description":"Fresh server-assigned correlation id for this response. Caller-provided request ids are ignored.","schema":{"format":"uuid","type":"string"}}},"exampleType":"generated"},"6a61c610-90e7-424d-ae9d-8d133e343c76":{"content":{"application/json":{"schema":{"properties":{"code":{"description":"Machine-readable error category.","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"description":"Short human-readable summary of the error.","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"errors":{"description":"Field-level validation errors, when applicable.","items":{"properties":{"code":{"description":"Machine-readable field error code.","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"field":{"oneOf":[{"description":"Path to the field that caused the error, using dots for objects and brackets for list indexes, for example `claims[0].amount`; null for an error without a field path.","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].field.oneOf.0","typeLabel":"string"},{"description":"Path to the field that caused the error, using dots for objects and brackets for list indexes, for example `claims[0].amount`; null for an error without a field path.","type":"null","isRequired":true,"uniqueKey":"errors.items.[INDEX].field.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string | null"},"message":{"description":"Human-readable explanation of the field error.","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"required":["field","code","message"],"type":"object","uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"errors","typeLabel":"object[]"}},"required":["detail","code"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","detail":"\u003cstring>","errors":[{"code":"\u003cstring>","field":"\u003cstring>","message":"\u003cstring>"}]}}},"exampleType":"generated"}},"description":"Standard error response.","headers":{"Cache-Control":{"description":"Cacheability directive. Authenticated responses use `private, no-store`; the legal-form catalog may use `private, max-age=86400`.","schema":{"type":"string"}},"Retry-After":{"description":"Integer seconds to wait before retrying a throttled request.","schema":{"minimum":1,"type":"integer"}},"X-Paywise-Environment":{"description":"Environment that produced the response.","schema":{"enum":["production","sandbox"],"type":"string"}},"X-Paywise-Request-Id":{"description":"Fresh server-assigned correlation id for this response. Caller-provided request ids are ignored.","schema":{"format":"uuid","type":"string"}}},"exampleType":"generated"},"1c62707c-711d-4b17-a8c8-fa6fcca0890d":{"content":{"application/json":{"schema":{"properties":{"code":{"description":"Machine-readable error category.","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"description":"Short human-readable summary of the error.","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"errors":{"description":"Field-level validation errors, when applicable.","items":{"properties":{"code":{"description":"Machine-readable field error code.","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"field":{"oneOf":[{"description":"Path to the field that caused the error, using dots for objects and brackets for list indexes, for example `claims[0].amount`; null for an error without a field path.","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].field.oneOf.0","typeLabel":"string"},{"description":"Path to the field that caused the error, using dots for objects and brackets for list indexes, for example `claims[0].amount`; null for an error without a field path.","type":"null","isRequired":true,"uniqueKey":"errors.items.[INDEX].field.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string | null"},"message":{"description":"Human-readable explanation of the field error.","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"required":["field","code","message"],"type":"object","uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"errors","typeLabel":"object[]"}},"required":["detail","code"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","detail":"\u003cstring>","errors":[{"code":"\u003cstring>","field":"\u003cstring>","message":"\u003cstring>"}]}}},"exampleType":"generated"}},"description":"Standard error response.","headers":{"Cache-Control":{"description":"Cacheability directive. Authenticated responses use `private, no-store`; the legal-form catalog may use `private, max-age=86400`.","schema":{"type":"string"}},"X-Paywise-Environment":{"description":"Environment that produced the response.","schema":{"enum":["production","sandbox"],"type":"string"}},"X-Paywise-Request-Id":{"description":"Fresh server-assigned correlation id for this response. Caller-provided request ids are ignored.","schema":{"format":"uuid","type":"string"}}},"exampleType":"generated"}},"security":{"ec09edb1-e962-4882-8b01-c1d5ad3c0d72":{"partnerBearerAuth":{"description":"Partner API Bearer key: `Authorization: Bearer \u003ckey>`. Keys are created only through authorized portal or staff flows.","scheme":"bearer","type":"http","scopes":[],"schemeName":"partnerBearerAuth"}}},"servers":{"a699daf5-8fe3-4a41-9110-47eed256cb1a":{"description":"Production environment","url":"https://api.paywise.de"},"a9d6e1a0-4bf9-4e27-a7c7-a37a00abcbfc":{"description":"Sandbox environment","url":"https://api-sandbox.paywise.de"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"description":"Partner API Bearer key: `Authorization: Bearer \u003ckey>`. Keys are created only through authorized portal or staff flows.","scheme":"bearer","type":"http","scopes":[],"schemeName":"partnerBearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Partner API Bearer key: `Authorization: Bearer \u003ckey>`. Keys are created only through authorized portal or staff flows.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"partnerBearerAuth","name":"Authorization"}],"title":"partnerBearerAuth"}]},"originalFileLocation":"api-docs/partner-api/openapi.json"},"subdomain":"paywisegmbh","siteName":"paywise Knowledge Center","title":"Update a company - paywise Knowledge Center","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"de":{"href":"/user-docs/overview","matchLevel":4},"en":{"href":"/api-docs/partner-api/reference/companies/update-a-company-patch","matchLevel":0}}},"lastModified":"2026-10-16T12:47:31.554Z","originalFileLocation":"api-docs/partner-api/reference/companies/update-a-company-patch.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=\"Partially update a managed company. A company disconnected by this partner is inaccessible and returns 404 not_found. An empty or unchanged PATCH is a no-op that leaves updated_at and the ETag untouched. Sending onboarding_mode returns 409 onboarding_mode_immutable.\">\u003cmeta data-mint-head name=\"application-name\" content=\"paywise Knowledge Center\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/paywisegmbh/pNaPPB2tJ3SHoGQC/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/paywisegmbh/pNaPPB2tJ3SHoGQC/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/paywisegmbh/pNaPPB2tJ3SHoGQC/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/paywisegmbh/pNaPPB2tJ3SHoGQC/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/paywisegmbh/pNaPPB2tJ3SHoGQC/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/paywisegmbh/pNaPPB2tJ3SHoGQC/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/paywisegmbh/pNaPPB2tJ3SHoGQC/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/paywisegmbh/pNaPPB2tJ3SHoGQC/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/paywisegmbh/pNaPPB2tJ3SHoGQC/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update a company - paywise Knowledge Center\">\u003cmeta data-mint-head property=\"og:description\" content=\"Partially update a managed company. A company disconnected by this partner is inaccessible and returns 404 not_found. An empty or unchanged PATCH is a no-op that leaves updated_at and the ETag untouched. Sending onboarding_mode returns 409 onboarding_mode_immutable.\">\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/partner-api/reference/companies/update-a-company-patch\">\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=Companies\u0026amp;title=Update+a+company\u0026amp;description=Partially+update+a+managed+company.+A+company+disconnected+by+this+partner+is+inaccessible+and+returns+%60404+not_found%60.+An+empty+or+unchanged+PATCH+is+a+no-op+t\u0026amp;theme=bad878af30f1dee220dabe6f\u0026amp;signature=3c69011608de2727660abc832d0ace41dd0722d920de64c86857edf0d04c1102\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Update a company - paywise Knowledge Center\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Partially update a managed company. A company disconnected by this partner is inaccessible and returns 404 not_found. An empty or unchanged PATCH is a no-op that leaves updated_at and the ETag untouched. Sending onboarding_mode returns 409 onboarding_mode_immutable.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://paywisegmbh.mintlify.site/_mintlify/api/og/v2?division=Companies\u0026amp;title=Update+a+company\u0026amp;description=Partially+update+a+managed+company.+A+company+disconnected+by+this+partner+is+inaccessible+and+returns+%60404+not_found%60.+An+empty+or+unchanged+PATCH+is+a+no-op+t\u0026amp;theme=bad878af30f1dee220dabe6f\u0026amp;signature=3c69011608de2727660abc832d0ace41dd0722d920de64c86857edf0d04c1102\">\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/partner-api/reference/companies/update-a-company-patch\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-docs/partner-api/reference/companies/update-a-company-patch.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/partner-api/reference/companies/update-a-company-patch#webpage\",\"url\":\"https://docs.paywise.de/api-docs/partner-api/reference/companies/update-a-company-patch\",\"name\":\"Update a company\",\"description\":\"Partially update a managed company. A company disconnected by this partner is inaccessible and returns 404 not_found. An empty or unchanged PATCH is a no-op that leaves updated_at and the ETag untouched. Sending onboarding_mode returns 409 onboarding_mode_immutable.\",\"dateModified\":\"2026-10-16T12:47:31.554Z\",\"isPartOf\":{\"@id\":\"https://docs.paywise.de#website\"},\"breadcrumb\":{\"@id\":\"https://docs.paywise.de/api-docs/partner-api/reference/companies/update-a-company-patch#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.paywise.de/api-docs/partner-api/reference/companies/update-a-company-patch#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Partner API\",\"item\":\"https://docs.paywise.de/api-docs/partner-api/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Partner API reference\",\"item\":\"https://docs.paywise.de/api-docs/partner-api/reference/companies/list-managed-companies\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Companies\",\"item\":\"https://docs.paywise.de/api-docs/partner-api/reference/companies/list-managed-companies\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Update a company\",\"item\":\"https://docs.paywise.de/api-docs/partner-api/reference/companies/update-a-company-patch\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.paywise.de/api-docs/partner-api/reference/companies/update-a-company-patch#apireference\",\"headline\":\"Update a company\",\"name\":\"Update a company\",\"description\":\"Partially update a managed company. A company disconnected by this partner is inaccessible and returns 404 not_found. An empty or unchanged PATCH is a no-op that leaves updated_at and the ETag untouched. Sending onboarding_mode returns 409 onboarding_mode_immutable.\",\"url\":\"https://docs.paywise.de/api-docs/partner-api/reference/companies/update-a-company-patch\",\"mainEntityOfPage\":{\"@id\":\"https://docs.paywise.de/api-docs/partner-api/reference/companies/update-a-company-patch#webpage\"},\"dateModified\":\"2026-10-16T12:47:31.554Z\",\"publisher\":{\"@id\":\"https://docs.paywise.de/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.paywise.de#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"paywise Knowledge Center\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"paywise Knowledge Center\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-docs/partner-api/reference/companies/update-a-company-patch.md","siteName":"paywise Knowledge Center","nav":{"global":null,"languages":[{"language":"de","default":true,"pages":[{"title":"de","href":"/user-docs/overview"}]},{"language":"en","tabs":[{"tab":"User documentation","icon":"book-open","pages":[{"title":"User documentation","href":"/en/user-docs/overview"}]},{"tab":"Integrations","icon":"plug","pages":[{"title":"Integrations","href":"/en/integrations/overview"}]},{"tab":"Technical documentation","icon":"code","pages":[{"group":"Start here","icon":"house","pages":[{"title":"API overview","href":"/api-docs/overview"},{"title":"API Changelog","href":"/api-docs/changelog"}]},{"group":"API essentials","icon":"arrows-left-right","pages":[{"title":"Authentication and environments","href":"/api-docs/essentials/authentication-and-environments"},{"title":"Requests and responses","href":"/api-docs/essentials/requests-and-responses"},{"title":"Errors and safe retries","href":"/api-docs/essentials/errors-and-safe-retries"},{"title":"Pagination and synchronization","href":"/api-docs/essentials/pagination-and-synchronization"},{"title":"Public limits","href":"/api-docs/essentials/limits"},{"title":"Versioning and deprecation","href":"/api-docs/essentials/versioning"},{"title":"Webhooks","href":"/api-docs/essentials/webhooks"}]},{"group":"Case Management API","icon":"/images/icons/case-api.svg","pages":[{"title":"Case Management API","href":"/api-docs/case-management-api/introduction"},{"title":"Case Management quickstart","href":"/api-docs/case-management-api/quickstart"},{"group":"Concepts","pages":[{"title":"Core resources","href":"/api-docs/case-management-api/concepts/resource-model"},{"title":"Debtors","href":"/api-docs/case-management-api/concepts/debtors"},{"title":"Orders","href":"/api-docs/case-management-api/concepts/orders"},{"title":"Claims","href":"/api-docs/case-management-api/concepts/claims"},{"title":"Mandates","href":"/api-docs/case-management-api/concepts/mandates"},{"title":"Documents and communication","href":"/api-docs/case-management-api/concepts/documents-and-communication"},{"title":"Payments","href":"/api-docs/case-management-api/concepts/payments"},{"title":"Statements","href":"/api-docs/case-management-api/concepts/statements"},{"title":"Webhook events","href":"/api-docs/case-management-api/concepts/webhook-events"},{"title":"Sandbox environment","href":"/api-docs/case-management-api/concepts/sandbox"}]},{"group":"Workflows","pages":[{"title":"Submit an order","href":"/api-docs/case-management-api/workflows/submit-an-order"},{"title":"Submit a rental order","href":"/api-docs/case-management-api/workflows/submit-a-rental-order"},{"title":"Submit a titled order","href":"/api-docs/case-management-api/workflows/submit-a-titled-order"},{"title":"Manage documents","href":"/api-docs/case-management-api/workflows/manage-documents"},{"title":"Follow a case","href":"/api-docs/case-management-api/workflows/follow-a-case"},{"title":"Read debtor correspondence","href":"/api-docs/case-management-api/workflows/read-debtor-correspondence"},{"title":"Messages and client requests","href":"/api-docs/case-management-api/workflows/messages-and-client-requests"},{"title":"Report payments","href":"/api-docs/case-management-api/workflows/report-payments"},{"title":"Consume Case webhooks","href":"/api-docs/case-management-api/workflows/consume-webhooks"}]},{"title":"Migrate from Case Management API v1","href":"/api-docs/case-management-api/migrate-from-v1"},{"title":"Use with Postman","href":"/api-docs/case-management-api/postman"},{"group":"Case Management API reference","pages":[{"group":"Orders","icon":"file-lines","pages":[{"title":"List orders","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/","href":"/api-docs/case-management-api/reference/orders/list-orders"},{"title":"Create order","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/orders/","href":"/api-docs/case-management-api/reference/orders/create-order"},{"title":"Get order","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{id}/","href":"/api-docs/case-management-api/reference/orders/get-order"},{"title":"Update order","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json patch /v2/orders/{id}/","href":"/api-docs/case-management-api/reference/orders/update-order"},{"title":"Delete draft order","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json delete /v2/orders/{id}/","href":"/api-docs/case-management-api/reference/orders/delete-draft-order"},{"title":"Finalize order","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/orders/{id}/finalize/","href":"/api-docs/case-management-api/reference/orders/finalize-order"},{"title":"Withdraw order","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/orders/{id}/withdraw/","href":"/api-docs/case-management-api/reference/orders/withdraw-order"},{"group":"Messages","icon":"comments","pages":[{"title":"List order messages","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/messages/","href":"/api-docs/case-management-api/reference/orders/list-order-messages"},{"title":"Create order message","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/orders/{order_id}/messages/","href":"/api-docs/case-management-api/reference/orders/create-order-message"},{"title":"Get order message","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/messages/{id}/","href":"/api-docs/case-management-api/reference/orders/get-order-message"},{"title":"Update order message","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json patch /v2/orders/{order_id}/messages/{id}/","href":"/api-docs/case-management-api/reference/orders/update-order-message"},{"title":"List order message documents","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/messages/{message_id}/documents/","href":"/api-docs/case-management-api/reference/orders/list-order-message-documents"},{"title":"Create order message document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/orders/{order_id}/messages/{message_id}/documents/","href":"/api-docs/case-management-api/reference/orders/create-order-message-document"},{"title":"Get order message document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/messages/{message_id}/documents/{id}/","href":"/api-docs/case-management-api/reference/orders/get-order-message-document"},{"title":"Delete order message document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json delete /v2/orders/{order_id}/messages/{message_id}/documents/{id}/","href":"/api-docs/case-management-api/reference/orders/delete-order-message-document"},{"title":"Download order message document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/messages/{message_id}/documents/{id}/download/","href":"/api-docs/case-management-api/reference/orders/download-order-message-document"}]},{"group":"Requests to client","icon":"inbox","pages":[{"title":"List order requests to client","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/requests-to-client/","href":"/api-docs/case-management-api/reference/orders/list-order-requests-to-client"},{"title":"Get order request to client","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/requests-to-client/{id}/","href":"/api-docs/case-management-api/reference/orders/get-order-request-to-client"},{"title":"Answer order request to client","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/orders/{order_id}/requests-to-client/{id}/answer/","href":"/api-docs/case-management-api/reference/orders/answer-order-request-to-client"},{"title":"Download order request to client attachment","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/requests-to-client/{id}/attachments/{attachment_id}/download/","href":"/api-docs/case-management-api/reference/orders/download-order-request-to-client-attachment"},{"title":"List order request to client answer documents","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/requests-to-client/{request_id}/answer/documents/","href":"/api-docs/case-management-api/reference/orders/list-order-request-to-client-answer-documents"},{"title":"Create order request to client answer document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/orders/{order_id}/requests-to-client/{request_id}/answer/documents/","href":"/api-docs/case-management-api/reference/orders/create-order-request-to-client-answer-document"},{"title":"Get order request to client answer document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/requests-to-client/{request_id}/answer/documents/{id}/","href":"/api-docs/case-management-api/reference/orders/get-order-request-to-client-answer-document"},{"title":"Delete order request to client answer document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json delete /v2/orders/{order_id}/requests-to-client/{request_id}/answer/documents/{id}/","href":"/api-docs/case-management-api/reference/orders/delete-order-request-to-client-answer-document"},{"title":"Download order request to client answer document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/requests-to-client/{request_id}/answer/documents/{id}/download/","href":"/api-docs/case-management-api/reference/orders/download-order-request-to-client-answer-document"}]}]},{"group":"Claims","icon":"file-spreadsheet","pages":[{"title":"List claims","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/claims/","href":"/api-docs/case-management-api/reference/claims/list-claims"},{"title":"Create claim","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/claims/","href":"/api-docs/case-management-api/reference/claims/create-claim"},{"title":"Get claim","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/claims/{id}/","href":"/api-docs/case-management-api/reference/claims/get-claim"},{"title":"Update claim","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json patch /v2/claims/{id}/","href":"/api-docs/case-management-api/reference/claims/update-claim"},{"title":"Delete claim","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json delete /v2/claims/{id}/","href":"/api-docs/case-management-api/reference/claims/delete-claim"},{"group":"Documents","icon":"file-lines","pages":[{"title":"List claim documents","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/claims/{claim_id}/documents/","href":"/api-docs/case-management-api/reference/documents/list-claim-documents"},{"title":"Create claim document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/claims/{claim_id}/documents/","href":"/api-docs/case-management-api/reference/documents/create-claim-document"},{"title":"Get claim document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/claims/{claim_id}/documents/{id}/","href":"/api-docs/case-management-api/reference/documents/get-claim-document"},{"title":"Delete claim document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json delete /v2/claims/{claim_id}/documents/{id}/","href":"/api-docs/case-management-api/reference/documents/delete-claim-document"},{"title":"Download claim document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/claims/{claim_id}/documents/{id}/download/","href":"/api-docs/case-management-api/reference/documents/download-claim-document"}]},{"group":"Payments","icon":"credit-card","pages":[{"title":"List claim payments","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/claims/{claim_id}/payments/","href":"/api-docs/case-management-api/reference/claims/list-claim-payments"},{"title":"Create claim payment","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/claims/{claim_id}/payments/","href":"/api-docs/case-management-api/reference/claims/create-claim-payment"},{"title":"Delete claim payment","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json delete /v2/claims/{claim_id}/payments/{id}/","href":"/api-docs/case-management-api/reference/claims/delete-claim-payment"}]},{"group":"Enforceable titles","icon":"scale-balanced","pages":[{"title":"Get enforceable title","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/claims/{claim_id}/enforceable-title/","href":"/api-docs/case-management-api/reference/claims/get-enforceable-title"},{"title":"Replace enforceable title","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json put /v2/claims/{claim_id}/enforceable-title/","href":"/api-docs/case-management-api/reference/claims/replace-enforceable-title"},{"title":"Update enforceable title","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json patch /v2/claims/{claim_id}/enforceable-title/","href":"/api-docs/case-management-api/reference/claims/update-enforceable-title"},{"title":"Delete enforceable title","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json delete /v2/claims/{claim_id}/enforceable-title/","href":"/api-docs/case-management-api/reference/claims/delete-enforceable-title"},{"title":"List enforceable title documents","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/claims/{claim_id}/enforceable-title/documents/","href":"/api-docs/case-management-api/reference/claims/list-enforceable-title-documents"},{"title":"Create enforceable title document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/claims/{claim_id}/enforceable-title/documents/","href":"/api-docs/case-management-api/reference/claims/create-enforceable-title-document"},{"title":"Get enforceable title document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/claims/{claim_id}/enforceable-title/documents/{id}/","href":"/api-docs/case-management-api/reference/claims/get-enforceable-title-document"},{"title":"Delete enforceable title document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json delete /v2/claims/{claim_id}/enforceable-title/documents/{id}/","href":"/api-docs/case-management-api/reference/claims/delete-enforceable-title-document"},{"title":"Download enforceable title document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/claims/{claim_id}/enforceable-title/documents/{id}/download/","href":"/api-docs/case-management-api/reference/claims/download-enforceable-title-document"}]}]},{"group":"Rental agreements","icon":"house","pages":[{"title":"Get rental agreement","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/rental-agreement/","href":"/api-docs/case-management-api/reference/orders/get-rental-agreement"},{"title":"Update rental agreement","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json patch /v2/orders/{order_id}/rental-agreement/","href":"/api-docs/case-management-api/reference/orders/update-rental-agreement"},{"title":"List rental agreement documents","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/rental-agreement/documents/","href":"/api-docs/case-management-api/reference/orders/list-rental-agreement-documents"},{"title":"Create rental agreement document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/orders/{order_id}/rental-agreement/documents/","href":"/api-docs/case-management-api/reference/orders/create-rental-agreement-document"},{"title":"Get rental agreement document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/rental-agreement/documents/{id}/","href":"/api-docs/case-management-api/reference/orders/get-rental-agreement-document"},{"title":"Delete rental agreement document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json delete /v2/orders/{order_id}/rental-agreement/documents/{id}/","href":"/api-docs/case-management-api/reference/orders/delete-rental-agreement-document"},{"title":"Download rental agreement document","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/orders/{order_id}/rental-agreement/documents/{id}/download/","href":"/api-docs/case-management-api/reference/orders/download-rental-agreement-document"}]},{"group":"Debtors","icon":"users","pages":[{"title":"List debtors","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/debtors/","href":"/api-docs/case-management-api/reference/debtors/list-debtors"},{"title":"Create debtor","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json post /v2/debtors/","href":"/api-docs/case-management-api/reference/debtors/create-debtor"},{"title":"Get debtor","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json get /v2/debtors/{id}/","href":"/api-docs/case-management-api/reference/debtors/get-debtor"},{"title":"Update debtor","deprecated":null,"version":null,"openapi":"/api-docs/case-management-api/openapi.json patch /v2/debtors/{id}/","href":"/api-docs/case-management-api/reference/debtors/update-debtor"}]},{"group":"Mandates","icon":"folder","pages":[{"title":"List mandates","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","description":"Retrieve a single managed company by its uuid.","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","description":"End all of this partner's access to a managed company. The company keeps its submitted cases, users, portal access and any credentials of its own. Orders this partner created on the company's behalf and never submitted are deleted; submitted orders and the company's own drafts survive. The company's `external_reference` is cleared so the same reference can onboard a fresh company later; the record itself stays attributed to the partner for history. Emits `company.access.revoked` with `reason: \"partner_released\"`. Requires an `Idempotency-Key` header and the `partner:companies:write` scope. Returns only an id and `case_access: unavailable` receipt. The same key replays this receipt; a new key after disconnection returns 404.","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json post /partner/v2/companies/{id}/release/","href":"/api-docs/partner-api/reference/companies/release-a-company"}]},{"group":"Company memberships","icon":"users","pages":[{"title":"List company memberships","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json get /partner/v2/companies/{company_id}/users/","href":"/api-docs/partner-api/reference/company-users/list-company-memberships"},{"title":"Add a company membership","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json post /partner/v2/companies/{company_id}/users/","href":"/api-docs/partner-api/reference/company-users/add-a-company-membership"},{"title":"Get a company membership","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json get /partner/v2/companies/{company_id}/users/{membership_id}/","href":"/api-docs/partner-api/reference/company-users/get-a-company-membership"},{"title":"Change a pending membership role","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json patch /partner/v2/companies/{company_id}/users/{membership_id}/","href":"/api-docs/partner-api/reference/company-users/change-a-pending-membership-role"},{"title":"Cancel a pending company membership","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json post /partner/v2/companies/{company_id}/users/{membership_id}/cancel/","href":"/api-docs/partner-api/reference/company-users/cancel-a-pending-company-membership"},{"title":"Replace and resend a pending setup token","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json post /partner/v2/companies/{company_id}/users/{membership_id}/resend/","href":"/api-docs/partner-api/reference/company-users/replace-and-resend-a-pending-setup-token"},{"title":"Revoke an active company membership","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json post /partner/v2/companies/{company_id}/users/{membership_id}/revoke/","href":"/api-docs/partner-api/reference/company-users/revoke-an-active-company-membership"}]},{"group":"Webhooks","icon":"bell","pages":[{"title":"List webhooks","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json get /partner/v2/webhooks/","href":"/api-docs/partner-api/reference/webhooks/list-webhooks"},{"title":"Create webhook","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json post /partner/v2/webhooks/","href":"/api-docs/partner-api/reference/webhooks/create-webhook"},{"title":"Get webhook","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json get /partner/v2/webhooks/{id}/","href":"/api-docs/partner-api/reference/webhooks/get-webhook"},{"title":"Update webhook","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json patch /partner/v2/webhooks/{id}/","href":"/api-docs/partner-api/reference/webhooks/update-webhook"},{"title":"Delete webhook","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json delete /partner/v2/webhooks/{id}/","href":"/api-docs/partner-api/reference/webhooks/delete-webhook"},{"title":"Rotate webhook secret","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json post /partner/v2/webhooks/{id}/rotate-secret/","href":"/api-docs/partner-api/reference/webhooks/rotate-webhook-secret"},{"title":"Test webhook","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json post /partner/v2/webhooks/{id}/test/","href":"/api-docs/partner-api/reference/webhooks/test-webhook"}]},{"group":"Webhook deliveries","icon":"paper-plane","pages":[{"title":"List webhook deliveries","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json get /partner/v2/webhook-deliveries/","href":"/api-docs/partner-api/reference/webhook-deliveries/list-webhook-deliveries"},{"title":"Get webhook delivery","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json get /partner/v2/webhook-deliveries/{id}/","href":"/api-docs/partner-api/reference/webhook-deliveries/get-webhook-delivery"},{"title":"Redeliver webhook delivery","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json post /partner/v2/webhook-deliveries/{id}/redeliver/","href":"/api-docs/partner-api/reference/webhook-deliveries/redeliver-webhook-delivery"}]},{"group":"Events","icon":"list-timeline","pages":[{"title":"List events","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json get /partner/v2/events/","href":"/api-docs/partner-api/reference/events/list-events"}]},{"group":"Reference and status","icon":"circle-info","pages":[{"title":"List legal forms","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json get /partner/v2/legal-forms/","href":"/api-docs/partner-api/reference/legal-forms/list-legal-forms"},{"title":"Health check","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json get /partner/v2/health/","href":"/api-docs/partner-api/reference/meta/health-check"},{"title":"Get partner token info","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json get /partner/v2/info/","href":"/api-docs/partner-api/reference/meta/get-partner-token-info"},{"title":"Get rate-limit headroom","deprecated":null,"version":null,"openapi":"/api-docs/partner-api/openapi.json get /partner/v2/usage/","href":"/api-docs/partner-api/reference/usage/get-rate-limit-headroom"}]}]}]},{"group":"Mahnservice API","icon":"/images/icons/mahnservice-api.svg","pages":[{"title":"Mahnservice API","href":"/api-docs/mahnservice-api/introduction"},{"title":"Mahnservice quickstart","href":"/api-docs/mahnservice-api/quickstart"},{"group":"Concepts","pages":[{"title":"Invoice lifecycle","href":"/api-docs/mahnservice-api/concepts/invoice-lifecycle"},{"title":"Invoice documents","href":"/api-docs/mahnservice-api/concepts/documents"},{"title":"Ownership and access","href":"/api-docs/mahnservice-api/concepts/ownership-and-access"},{"title":"Invoice groups — implementation plan","href":"/api-docs/mahnservice-api/concepts/invoice-groups"}]},{"group":"Mahnservice API reference","pages":[{"group":"Invoices","icon":"file-invoice","pages":[{"title":"List invoices","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json get /mahnservice/v1/invoices/","href":"/api-docs/mahnservice-api/reference/invoices/list-invoices"},{"title":"Submit an invoice","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json post /mahnservice/v1/invoices/","href":"/api-docs/mahnservice-api/reference/invoices/submit-an-invoice"},{"title":"Get an invoice","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json get /mahnservice/v1/invoices/{uuid}/","href":"/api-docs/mahnservice-api/reference/invoices/get-an-invoice"},{"title":"Correct a held invoice","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json patch /mahnservice/v1/invoices/{uuid}/","href":"/api-docs/mahnservice-api/reference/invoices/correct-a-held-invoice"},{"title":"Cancel an invoice (Storno)","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json post /mahnservice/v1/invoices/{uuid}/cancel/","href":"/api-docs/mahnservice-api/reference/invoices/cancel-an-invoice-storno"},{"title":"List the invoice documents","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json get /mahnservice/v1/invoices/{uuid}/documents/","href":"/api-docs/mahnservice-api/reference/invoices/list-the-invoice-documents"},{"title":"Attach the invoice PDF","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json post /mahnservice/v1/invoices/{uuid}/documents/","href":"/api-docs/mahnservice-api/reference/invoices/attach-the-invoice-pdf"},{"title":"Get an invoice document","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json get /mahnservice/v1/invoices/{uuid}/documents/{document_uuid}/","href":"/api-docs/mahnservice-api/reference/invoices/get-an-invoice-document"},{"title":"Download the invoice document","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json get /mahnservice/v1/invoices/{uuid}/documents/{document_uuid}/download/","href":"/api-docs/mahnservice-api/reference/invoices/download-the-invoice-document"},{"title":"Get the dunning state","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json get /mahnservice/v1/invoices/{uuid}/dunning/","href":"/api-docs/mahnservice-api/reference/invoices/get-the-dunning-state"},{"title":"Pause the dunning process","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json post /mahnservice/v1/invoices/{uuid}/dunning/pause/","href":"/api-docs/mahnservice-api/reference/invoices/pause-the-dunning-process"},{"title":"Resume the dunning process","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json post /mahnservice/v1/invoices/{uuid}/dunning/resume/","href":"/api-docs/mahnservice-api/reference/invoices/resume-the-dunning-process"},{"title":"List reported payments","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json get /mahnservice/v1/invoices/{uuid}/payments/","href":"/api-docs/mahnservice-api/reference/invoices/list-reported-payments"},{"title":"Report a payment","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json post /mahnservice/v1/invoices/{uuid}/payments/","href":"/api-docs/mahnservice-api/reference/invoices/report-a-payment"},{"title":"Release a held invoice for dunning","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json post /mahnservice/v1/invoices/{uuid}/release/","href":"/api-docs/mahnservice-api/reference/invoices/release-a-held-invoice-for-dunning"},{"title":"Write off an invoice (Ausbuchung)","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json post /mahnservice/v1/invoices/{uuid}/write-off/","href":"/api-docs/mahnservice-api/reference/invoices/write-off-an-invoice-ausbuchung"}]},{"group":"Debtors","icon":"users","pages":[{"title":"List debtors","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json get /mahnservice/v1/debtors/","href":"/api-docs/mahnservice-api/reference/debtors/list-debtors"},{"title":"Create a debtor","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json post /mahnservice/v1/debtors/","href":"/api-docs/mahnservice-api/reference/debtors/create-a-debtor"},{"title":"Get a debtor","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json get /mahnservice/v1/debtors/{uuid}/","href":"/api-docs/mahnservice-api/reference/debtors/get-a-debtor"}]},{"group":"Dunning flows","icon":"list-check","pages":[{"title":"List dunning flows","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json get /mahnservice/v1/dunning-flows/","href":"/api-docs/mahnservice-api/reference/dunning-flows/list-dunning-flows"},{"title":"Get a dunning flow","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json get /mahnservice/v1/dunning-flows/{uuid}/","href":"/api-docs/mahnservice-api/reference/dunning-flows/get-a-dunning-flow"}]},{"group":"Reference and status","icon":"circle-info","pages":[{"title":"Get token info","deprecated":null,"version":null,"openapi":"/api-docs/mahnservice-api/openapi.json get /mahnservice/v1/info/","href":"/api-docs/mahnservice-api/reference/info/get-token-info"}]}]}]},{"group":"SDKs","icon":"code","pages":[{"title":"SDKs","href":"/sdks/overview"}]},{"group":"Integrations","icon":"plug","pages":[{"title":"Introduction","href":"/integrations/introduction"},{"title":"Make","href":"/integrations/make"},{"title":"n8n","href":"/integrations/n8n-node"},{"title":"Zapier","href":"/integrations/zapier"}]},{"group":"Legacy APIs (v1)","icon":"box-archive","pages":[{"title":"Legacy API v1 snapshot","href":"/api-docs/legacy/overview"},{"group":"Frozen Case Management API","pages":[{"title":"Introduction","href":"/api-docs/legacy/case-management/introduction"},{"group":"Statements guides","pages":[{"title":"Statements Overview","href":"/api-docs/legacy/case-management/statements/overview"},{"title":"Single Mandate Statements Overview","href":"/api-docs/legacy/case-management/single-mandate-statements/overview"}]},{"group":"Status update guides","pages":[{"title":"Search status updates","href":"/api-docs/legacy/case-management/status-updates/overview"}]},{"group":"Webhook guides","pages":[{"title":"Webhooks","href":"/api-docs/legacy/case-management/webhooks/overview"},{"title":"Event Types","href":"/api-docs/legacy/case-management/webhooks/event-types"},{"title":"Manage Endpoints","href":"/api-docs/legacy/case-management/webhooks/manage-endpoints"},{"title":"Signature Verification","href":"/api-docs/legacy/case-management/webhooks/signature-verification"},{"title":"Delivery \u0026 Retries","href":"/api-docs/legacy/case-management/webhooks/delivery-and-retries"}]},{"title":"Release Notes","href":"/api-docs/legacy/case-management/releasenotes"},{"group":"Frozen Case Management API reference","pages":[{"group":"claims","pages":[{"title":"List claims","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/claims/","href":"/api-docs/legacy/case-management/reference/claims/list-claims"},{"title":"Create a claim","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json post /v1/claims/","href":"/api-docs/legacy/case-management/reference/claims/create-a-claim"},{"title":"Retrieve a claim","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/claims/{id}/","href":"/api-docs/legacy/case-management/reference/claims/retrieve-a-claim"},{"title":"Delete an unreleased claim","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json delete /v1/claims/{id}/","href":"/api-docs/legacy/case-management/reference/claims/delete-an-unreleased-claim"},{"title":"Release claim for processing","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json patch /v1/claims/{id}/","href":"/api-docs/legacy/case-management/reference/claims/release-claim-for-processing"},{"title":"Upload a document to a claim","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json post /v1/claims/{id}/documents/","href":"/api-docs/legacy/case-management/reference/claims/upload-a-document-to-a-claim"}]},{"group":"debtors","pages":[{"title":"List debtors","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/debtors/","href":"/api-docs/legacy/case-management/reference/debtors/list-debtors"},{"title":"Create a debtor","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json post /v1/debtors/","href":"/api-docs/legacy/case-management/reference/debtors/create-a-debtor"},{"title":"Retrieve a debtor","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/debtors/{id}/","href":"/api-docs/legacy/case-management/reference/debtors/retrieve-a-debtor"},{"title":"Add address to a debtor","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json post /v1/debtors/{id}/addresses/","href":"/api-docs/legacy/case-management/reference/debtors/add-address-to-a-debtor"},{"title":"Add bank account to a debtor","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json post /v1/debtors/{id}/bankaccounts/","href":"/api-docs/legacy/case-management/reference/debtors/add-bank-account-to-a-debtor"},{"title":"Add debtor Communication Channel","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json post /v1/debtors/{id}/communicationchannels/","href":"/api-docs/legacy/case-management/reference/debtors/add-debtor-communication-channel"}]},{"group":"info","pages":[{"title":"Get v1info","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/info/","href":"/api-docs/legacy/case-management/reference/info/get-v1info"}]},{"group":"mandates","pages":[{"title":"List mandates","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/mandates/","href":"/api-docs/legacy/case-management/reference/mandates/list-mandates"},{"title":"Retrieve a mandate","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/mandates/{id}/","href":"/api-docs/legacy/case-management/reference/mandates/retrieve-a-mandate"},{"title":"Archive a mandate","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json patch /v1/mandates/{id}/","href":"/api-docs/legacy/case-management/reference/mandates/archive-a-mandate"},{"title":"List status updates","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/mandates/{id}/statusupdates/","href":"/api-docs/legacy/case-management/reference/mandates/list-status-updates"},{"title":"List requests to client for a mandate","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/mandates/{mandate_id}/requests-to-client/","href":"/api-docs/legacy/case-management/reference/mandates/list-requests-to-client-for-a-mandate"},{"title":"Get request to client details","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/mandates/{mandate_id}/requests-to-client/{request_id}/","href":"/api-docs/legacy/case-management/reference/mandates/get-request-to-client-details"},{"title":"Submit request to client answer","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json post /v1/mandates/{mandate_id}/requests-to-client/{request_id}/answer/","href":"/api-docs/legacy/case-management/reference/mandates/submit-request-to-client-answer"},{"title":"Upload document to request to client answer","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json post /v1/mandates/{mandate_id}/requests-to-client/{request_id}/answer/documents/","href":"/api-docs/legacy/case-management/reference/mandates/upload-document-to-request-to-client-answer"}]},{"group":"payments","pages":[{"title":"List payments","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/payments/","href":"/api-docs/legacy/case-management/reference/payments/list-payments"},{"title":"Create a payment","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json post /v1/payments/","href":"/api-docs/legacy/case-management/reference/payments/create-a-payment"},{"title":"Retrieve a payment","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/payments/{id}/","href":"/api-docs/legacy/case-management/reference/payments/retrieve-a-payment"}]},{"group":"single-mandate-statements","pages":[{"title":"List Aktenabrechnungen","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/single-mandate-statements/","href":"/api-docs/legacy/case-management/reference/single-mandate-statements/list-aktenabrechnungen"},{"title":"Retrieve an Aktenabrechnung","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/single-mandate-statements/{id}/","href":"/api-docs/legacy/case-management/reference/single-mandate-statements/retrieve-an-aktenabrechnung"}]},{"group":"statements","pages":[{"title":"List statements","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/statements/","href":"/api-docs/legacy/case-management/reference/statements/list-statements"},{"title":"Retrieve a statement","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/statements/{id}/","href":"/api-docs/legacy/case-management/reference/statements/retrieve-a-statement"},{"title":"List mandate details for statement","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/statements/{statement_id}/mandate-details/","href":"/api-docs/legacy/case-management/reference/statements/list-mandate-details-for-statement"}]},{"group":"statusupdates","pages":[{"title":"Search status updates across mandates","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/statusupdates/","href":"/api-docs/legacy/case-management/reference/statusupdates/search-status-updates-across-mandates"}]},{"group":"webhook-deliveries","pages":[{"title":"List all webhook deliveries","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/webhook-deliveries/","href":"/api-docs/legacy/case-management/reference/webhook-deliveries/list-all-webhook-deliveries"},{"title":"Retrieve a webhook delivery","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/webhook-deliveries/{id}/","href":"/api-docs/legacy/case-management/reference/webhook-deliveries/retrieve-a-webhook-delivery"}]},{"group":"webhooks","pages":[{"title":"List webhook endpoints","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/webhooks/","href":"/api-docs/legacy/case-management/reference/webhooks/list-webhook-endpoints"},{"title":"Create a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json post /v1/webhooks/","href":"/api-docs/legacy/case-management/reference/webhooks/create-a-webhook-endpoint"},{"title":"Retrieve a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/webhooks/{id}/","href":"/api-docs/legacy/case-management/reference/webhooks/retrieve-a-webhook-endpoint"},{"title":"Put v1webhooks ","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json put /v1/webhooks/{id}/","href":"/api-docs/legacy/case-management/reference/webhooks/put-v1webhooks-"},{"title":"Delete a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json delete /v1/webhooks/{id}/","href":"/api-docs/legacy/case-management/reference/webhooks/delete-a-webhook-endpoint"},{"title":"Update a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json patch /v1/webhooks/{id}/","href":"/api-docs/legacy/case-management/reference/webhooks/update-a-webhook-endpoint"},{"title":"List deliveries for a webhook","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json get /v1/webhooks/{id}/deliveries/","href":"/api-docs/legacy/case-management/reference/webhooks/list-deliveries-for-a-webhook"},{"title":"Send a test event to webhook","deprecated":null,"version":null,"openapi":"/api-docs/legacy/case-management/openapi.json post /v1/webhooks/{id}/test/","href":"/api-docs/legacy/case-management/reference/webhooks/send-a-test-event-to-webhook"}]}]}]},{"group":"Frozen Partner API","pages":[{"title":"Introduction","href":"/api-docs/legacy/partner/introduction"},{"title":"Get Started","href":"/api-docs/legacy/partner/getstarted"},{"title":"Entities","href":"/api-docs/legacy/partner/entities"},{"title":"API-Only Onboarding","href":"/api-docs/legacy/partner/onboarding-api-only"},{"title":"Web Flow Onboarding","href":"/api-docs/legacy/partner/onboarding-web-flow"},{"title":"Release Notes","href":"/api-docs/legacy/partner/releasenotes"},{"group":"Frozen Partner API reference","pages":[{"group":"companies","pages":[{"title":"List Companies","deprecated":null,"version":null,"openapi":"/api-docs/legacy/partner/openapi.json get /partner/v1/companies/","href":"/api-docs/legacy/partner/reference/companies/list-companies"},{"title":"Create Company","deprecated":null,"version":null,"openapi":"/api-docs/legacy/partner/openapi.json post /partner/v1/companies/","href":"/api-docs/legacy/partner/reference/companies/create-company"},{"title":"Get Company","deprecated":null,"version":null,"openapi":"/api-docs/legacy/partner/openapi.json get /partner/v1/companies/{id}/","href":"/api-docs/legacy/partner/reference/companies/get-company"},{"title":"Update Company","deprecated":null,"version":null,"openapi":"/api-docs/legacy/partner/openapi.json patch /partner/v1/companies/{id}/","href":"/api-docs/legacy/partner/reference/companies/update-company"}]},{"group":"info","pages":[{"title":"Get Token Info","deprecated":null,"version":null,"openapi":"/api-docs/legacy/partner/openapi.json get /partner/v1/info/","href":"/api-docs/legacy/partner/reference/info/get-token-info"}]},{"group":"userinvites","pages":[{"title":"Create User Invite","deprecated":null,"version":null,"openapi":"/api-docs/legacy/partner/openapi.json post /partner/v1/userinvites/","href":"/api-docs/legacy/partner/reference/userinvites/create-user-invite"},{"title":"Get User Invite","deprecated":null,"version":null,"openapi":"/api-docs/legacy/partner/openapi.json get /partner/v1/userinvites/{id}/","href":"/api-docs/legacy/partner/reference/userinvites/get-user-invite"},{"title":"Get Onboarded User","deprecated":null,"version":null,"openapi":"/api-docs/legacy/partner/openapi.json get /partner/v1/userinvites/{id}/get-onboarded-user/","href":"/api-docs/legacy/partner/reference/userinvites/get-onboarded-user"}]},{"group":"users","pages":[{"title":"List Users","deprecated":null,"version":null,"openapi":"/api-docs/legacy/partner/openapi.json get /partner/v1/users/","href":"/api-docs/legacy/partner/reference/users/list-users"},{"title":"Create user","deprecated":null,"version":null,"openapi":"/api-docs/legacy/partner/openapi.json post /partner/v1/users/","href":"/api-docs/legacy/partner/reference/users/create-user"},{"title":"Get User","deprecated":null,"version":null,"openapi":"/api-docs/legacy/partner/openapi.json get /partner/v1/users/{id}/","href":"/api-docs/legacy/partner/reference/users/get-user"}]}]}]}]}]}]}]},"basePath":"","title":"Update a company - paywise Knowledge Center","deploymentId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","buildId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CrDfRf61.js","snippetPresets-Dv-cOUrx.js","utils-BUTreAgv.js","style-to-object-BY3JEAdk.js","utils-wsznt9RM.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-DEsMlaPy.js","conditional-requirements-CFM0id0Q.js","cloneDeep-DontW4xJ.js","_Uint8Array-pP7X6_RM.js","isObject-FP1Yky1u.js","ApiExamples-CU_aGGP0.js","usePlaygroundInputsStore-7dNmUIbS.js","shallow-fTtruD8x.js","isEqual-BRfNFpSD.js","CodeSnippets-52884wUJ.js","CodeSnippet-eoRjC4Le.js","getApiPlaygroundDisplay-CZyAPlR2.js","Page-Cr9IwkK7.js","DynamicMarkdown-NFqqduU7.js","SectionHeading-DQ-mJoAt.js","icon-DXTBUt6s.js","MethodPill-2v-b3js5.js","getPastedJson-v_8Y1_4v.js","DuplicateIcon-DXIkhZIo.js","createIcon-DRpYuPZs.js","axios-CsQoIw0U.js","Markdown-CwtoSfEf.js","AssistantPageLink-CTqa3eoi.js","dist-DIfYWxfm.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}