> ## Documentation Index > Fetch the complete documentation index at: https://docs.paywise.de/llms.txt > Use this file to discover all available pages before exploring further. # Update order > Update the order's mutable fields while it is a draft. A supplied `additional_debtor_ids` array replaces its membership; omit it to preserve the links or send `[]` to unlink all additional debtors without deleting their records. Read full debtor details through `GET /v2/debtors/{id}/`. ## OpenAPI ````yaml /api-docs/case-management-api/openapi.json patch /v2/orders/{id}/ openapi: 3.0.3 info: description: >- Submit orders and manage their complete lifecycle through the current API at the `/v2/` HTTP path. title: paywise Case Management API version: current servers: - description: Production environment url: https://api.paywise.de - description: Sandbox environment url: https://api-sandbox.paywise.de security: [] tags: - description: Submit orders and manage them until acceptance. name: Orders - description: Stable claim resources and their current relationships. name: Claims - description: 'Accepted cases: state, published history and documents.' name: Mandates - description: Debtor master data reused across orders. name: Debtors - description: Payments reported by you and booked by paywise. name: Payments - description: Files attached to claims and other resources. name: Documents - description: Collective statements (Sammelabrechnungen). name: Statements - description: Per-case statements (Aktenabrechnungen). name: Single mandate statements - description: Webhook endpoints and their signing secrets. name: Webhooks - description: Delivery log and redelivery of webhook events. name: Webhook deliveries - description: Ordered feed of the events webhooks deliver. name: Events - description: Reference catalog of legal forms. name: Legal forms - description: The authenticated credential and its context. name: Info - description: Rate-limit headroom of the credential. name: Usage - description: Availability of the API. name: Health externalDocs: url: https://docs.paywise.de/api-docs/case-management-api/introduction paths: /v2/orders/{id}/: patch: tags: - Orders summary: Update order description: >- Update the order's mutable fields while it is a draft. A supplied `additional_debtor_ids` array replaces its membership; omit it to preserve the links or send `[]` to unlink all additional debtors without deleting their records. Read full debtor details through `GET /v2/debtors/{id}/`. operationId: update-order parameters: - description: >- Required when a Partner key calls the Case Management API; rejected for direct Case keys. Contains the entitled paywise company UUID. in: header name: X-On-Behalf-Of-Company schema: format: uuid type: string - description: UUID of the order in this request. in: path name: id required: true schema: format: uuid type: string - 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 requestBody: content: application/json: examples: order-draft-patch: value: confirmation_email: billing@example.test starting_approach: extrajudicial titled-success-fee-confirmation: value: success_fee_confirmed: true schema: $ref: '#/components/schemas/PatchedOrderDecisionPatchRequest' responses: '200': content: application/json: examples: invoice: summary: Invoice order value: additional_debtors: [] claims: - additional_charges: [] additional_charges_amount: currency: EUR value: '0.00' additional_debtor_ids: [] created_at: '2026-07-18T10:00:00Z' debtor_id: 40000000-0000-4000-8000-000000000001 delay_date: '2026-07-09' dispute_reason: null document_date: '2026-06-05' document_reference: 2026-0042 documents: [] due_date: '2026-06-19' events: - description: null location: null occurence: '2026-06-05T09:00:00Z' title: Invoice issued type: claim your_reference: 2026-0042 id: 30000000-0000-4000-8000-000000000001 is_disputed: false items: [] legal_basis: claim_type_code: null contract_date: null description: null mandate_id: null metadata: - type: comment value: Consulting invoice from the customer portal order_id: 20000000-0000-4000-8000-000000000001 payments: [] principal_amount: currency: EUR value: '100.00' reminders: [] status: draft subject_matter: Website accessibility consulting in June 2026 total_amount: currency: EUR value: '100.00' type: receivable updated_at: '2026-07-18T10:00:00Z' your_reference: INV-2026-0042 confirmation_email: null created_at: '2026-07-18T10:00:00Z' creditor_obligation_fulfilled: true debtor: acting_as: consumer events: - description: null location: null occurence: '2026-05-01T09:00:00Z' title: Customer registered type: registration your_reference: null id: 40000000-0000-4000-8000-000000000001 legal_form: null metadata: - type: user:reference value: CUSTOMER-1001 organization: null person: birth_date: null first_name: Alex last_name: Example salutation: mx your_reference: CUSTOMER-1001 expires_at: '2026-10-16T10:00:00Z' id: 20000000-0000-4000-8000-000000000001 mandate: null merged_into: null rejection: null starting_approach: extrajudicial status: draft totals: charges: currency: EUR value: '0.00' main_claims: currency: EUR value: '100.00' order_value: currency: EUR value: '100.00' payments: currency: EUR value: '0.00' type: invoice updated_at: '2026-07-18T10:00:00Z' rental: summary: Rental order value: additional_debtors: [] claims: - additional_charges: [] additional_charges_amount: currency: EUR value: '0.00' additional_debtor_ids: [] created_at: '2026-07-18T10:00:00Z' debtor_id: 40000000-0000-4000-8000-000000000001 delay_date: '2026-02-05' dispute_reason: null document_date: '2026-02-01' document_reference: null documents: [] due_date: '2026-02-04' events: - description: null location: null occurence: '2026-06-05T09:00:00Z' title: Invoice issued type: claim your_reference: 2026-0042 id: 30000000-0000-4000-8000-000000000001 is_disputed: false items: [] legal_basis: claim_type_code: H19 contract_date: '2026-01-10' description: null mandate_id: null metadata: - type: comment value: Consulting invoice from the customer portal order_id: 20000000-0000-4000-8000-000000000001 payments: [] principal_amount: currency: EUR value: '1200.00' reminders: [] status: draft subject_matter: Residential rent for February 2026 total_amount: currency: EUR value: '1200.00' type: receivable updated_at: '2026-07-18T10:00:00Z' your_reference: RENT-2026-02 confirmation_email: null created_at: '2026-07-18T10:00:00Z' creditor_obligation_fulfilled: true debtor: acting_as: consumer events: - description: null location: null occurence: '2026-05-01T09:00:00Z' title: Customer registered type: registration your_reference: null id: 40000000-0000-4000-8000-000000000001 legal_form: null metadata: - type: user:reference value: CUSTOMER-1001 organization: null person: birth_date: null first_name: Alex last_name: Example salutation: mx your_reference: CUSTOMER-1001 expires_at: '2026-10-16T10:00:00Z' id: 20000000-0000-4000-8000-000000000001 mandate: null merged_into: null rejection: null rental_agreement: contract_date: '2026-01-10' created_at: '2026-07-18T10:00:00Z' documents: [] due_rule: null id: 21000000-0000-4000-8000-000000000001 monthly_rent: currency: EUR value: '1200.00' property_address: city: Berlin country: DE postal_code: '10115' street: Rental Example Street 8 updated_at: '2026-07-18T10:00:00Z' starting_approach: extrajudicial status: draft totals: charges: currency: EUR value: '0.00' main_claims: currency: EUR value: '1200.00' order_value: currency: EUR value: '1200.00' payments: currency: EUR value: '0.00' type: rental updated_at: '2026-07-18T10:00:00Z' titled: summary: Titled order value: additional_debtors: [] claims: - additional_debtor_ids: [] created_at: '2026-07-18T10:00:00Z' debtor_id: 40000000-0000-4000-8000-000000000001 dispute_reason: null document_reference: null enforceable_title: amount: currency: EUR value: '2500.00' created_at: '2026-07-18T10:00:00Z' documents: [] file_number: 12-3456789-0-1 id: 31000000-0000-4000-8000-000000000001 issued_on: '2026-01-15' issuing_authority: Amtsgericht Berlin legally_binding_since: '2026-02-01' served_on: '2026-01-20' title_type: enforcement_order updated_at: '2026-07-18T10:00:00Z' events: [] id: 30000000-0000-4000-8000-000000000001 is_disputed: false mandate_id: null metadata: [] order_id: 20000000-0000-4000-8000-000000000001 payments: [] principal_amount: null status: draft subject_matter: Enforcement title total_amount: currency: EUR value: '2500.00' type: titled updated_at: '2026-07-18T10:00:00Z' your_reference: TITLE-2026-0042 confirmation_email: null created_at: '2026-07-18T10:00:00Z' debtor: acting_as: consumer events: - description: null location: null occurence: '2026-05-01T09:00:00Z' title: Customer registered type: registration your_reference: null id: 40000000-0000-4000-8000-000000000001 legal_form: null metadata: - type: user:reference value: CUSTOMER-1001 organization: null person: birth_date: null first_name: Alex last_name: Example salutation: mx your_reference: CUSTOMER-1001 expires_at: '2026-10-16T10:00:00Z' id: 20000000-0000-4000-8000-000000000001 mandate: null merged_into: null rejection: null status: draft success_fee_confirmed: true totals: charges: currency: EUR value: '0.00' main_claims: currency: EUR value: '2500.00' order_value: currency: EUR value: '2500.00' payments: currency: EUR value: '0.00' type: titled updated_at: '2026-07-18T10:00:00Z' schema: $ref: '#/components/schemas/Order' 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 '400': content: application/json: examples: validation-error: value: code: validation_error detail: The request contains invalid data. errors: - code: invalid field: claims[0].due_date message: Due date must not precede the document date. schema: $ref: '#/components/schemas/Error' 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 '401': content: application/json: examples: authentication-error: value: code: not_authenticated detail: Authentication credentials were not provided. schema: $ref: '#/components/schemas/Error' 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 '403': content: application/json: schema: $ref: '#/components/schemas/Error' 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 '404': content: application/json: examples: not-found-error: value: code: not_found detail: The requested resource was not found. schema: $ref: '#/components/schemas/Error' 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 '409': content: application/json: examples: conflict-error: value: code: conflict detail: The resource changed state and cannot accept this command. order-expired: value: code: order_expired detail: The draft order has expired and can no longer be changed. schema: $ref: '#/components/schemas/Error' 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 '412': content: application/json: schema: $ref: '#/components/schemas/Error' 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 '429': content: application/json: schema: $ref: '#/components/schemas/Error' 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 '500': content: application/json: schema: $ref: '#/components/schemas/Error' 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 security: - caseBearerAuth: [] - partnerBearerAuth: [] components: schemas: PatchedOrderDecisionPatchRequest: description: The order fields that stay editable while it is a draft. properties: additional_debtor_ids: description: >- Replace the order's additional-debtor membership with up to 10 existing debtor UUIDs from the active company. Omit to leave membership unchanged; [] unlinks all additional debtors without deleting their records. The primary debtor cannot also appear here, and duplicates are rejected. Available only while the order is a draft. items: format: uuid type: string maxItems: 10 type: array confirmation_email: description: >- Address that receives the order entry confirmation (Eingangsbestätigung) when the order is finalized. Set null to turn the confirmation email off again. format: email maxLength: 255 minLength: 1 nullable: true type: string creditor_obligation_fulfilled: description: >- Whether you have fully performed your obligation to the debtor. For invoice and rental orders, supply true or false before finalization; null leaves the decision unset. Omit for titled orders. nullable: true type: boolean debtor_id: description: >- Replace the primary debtor with an existing debtor in the selected company. format: uuid type: string starting_approach: allOf: - $ref: '#/components/schemas/StartingApproachEnum' description: >- Initial route for invoice and rental orders: extrajudicial starts with out-of-court collection; judicial starts by applying for a payment order (Mahnbescheid). Required before finalization; omit for titled orders, where enforcement is implicit. nullable: true success_fee_confirmed: description: >- Only valid for titled orders. Confirmation of the titled-order success-fee arrangement; it must be true before finalization. See the [paywise General Terms and Conditions (AGB)](https://paywise.de/agb/) for the exact conditions for titled orders. type: boolean type: object Order: discriminator: mapping: invoice: '#/components/schemas/InvoiceOrder' rental: '#/components/schemas/RentalOrder' titled: '#/components/schemas/TitledOrder' propertyName: type oneOf: - $ref: '#/components/schemas/InvoiceOrder' - $ref: '#/components/schemas/RentalOrder' - $ref: '#/components/schemas/TitledOrder' Error: properties: code: description: Machine-readable error category. type: string detail: description: Short human-readable summary of the error. type: string errors: description: Field-level validation errors, when applicable. items: $ref: '#/components/schemas/ErrorItem' type: array required: - detail - code type: object StartingApproachEnum: enum: - extrajudicial - judicial type: string InvoiceOrder: description: >- An invoice order contains receivable claims and exposes `starting_approach` and `creditor_obligation_fulfilled`. Read representation of an order. `status` is derived from the order's submission and review progress; `mandate` names the created mandate once the order is accepted; `merged_into` names the surviving order when this order was merged away during review. properties: additional_debtors: description: >- Inline summaries of the additional debtors. Retrieve each debtor's full details with GET /v2/debtors/{id}/ using its id. Replace membership through PATCH /v2/orders/{id}/ while the order is a draft. API submissions are limited to 10 additional debtors. items: $ref: '#/components/schemas/DebtorSummary' readOnly: true type: array claims: description: >- Receivable claims belonging to this order, including their itemized charges and documents. Titled claims are accepted only in titled orders. API submissions are limited to 50 claims per order. items: $ref: '#/components/schemas/Claim' readOnly: true type: array confirmation_email: description: Address receiving the order-entry confirmation, when requested. format: email nullable: true readOnly: true type: string created_at: description: Time at which the order was created. format: date-time readOnly: true type: string creditor_obligation_fulfilled: description: Whether you fully performed your obligation to the debtor. nullable: true readOnly: true type: boolean debtor: allOf: - $ref: '#/components/schemas/DebtorSummary' description: >- Inline summary of the primary debtor. Retrieve full details with GET /v2/debtors/{id}/ using its id. readOnly: true expires_at: description: >- Time at which this API-created draft expires: updated_at plus 90 days, refreshed by every successful draft change. Once it has passed, the order reads expired and every change answers 409 order_expired until the daily cleanup deletes it. Null once the order is finalized and for orders created in the portal. format: date-time nullable: true readOnly: true type: string id: description: Stable identifier of this order. format: uuid readOnly: true type: string mandate: description: Accepted case created from this order, when available. format: uuid nullable: true readOnly: true type: string merged_into: description: Surviving order when this order was merged during review. format: uuid nullable: true readOnly: true type: string rejection: allOf: - $ref: '#/components/schemas/OrderRejection' description: >- Why paywise declined the order: reason, time, notified recipients, and the standard reason's key. Null unless status is rejected. nullable: true readOnly: true starting_approach: allOf: - $ref: '#/components/schemas/StartingApproachEnum' description: >- Initial collection route: extrajudicial starts out of court; judicial starts by applying for a payment order (Mahnbescheid). Null while this decision is unset. nullable: true readOnly: true status: allOf: - $ref: '#/components/schemas/OrderStatusEnum' description: >- Order lifecycle state: draft is editable; submitted awaits processing; awaiting_client_response requires client input; accepted has entered case processing; rejected was declined; withdrawn was cancelled by the client; expired passed its draft deadline and accepts no further changes (409 order_expired) until the daily cleanup deletes it; merged points to the surviving order in merged_into. readOnly: true totals: allOf: - $ref: '#/components/schemas/OrderTotals' description: Financial totals calculated across the order's claims. readOnly: true type: allOf: - $ref: '#/components/schemas/InvoiceOrderTypeEnum' description: Literal invoice order discriminator. readOnly: true updated_at: description: Time at which the order was last updated. format: date-time readOnly: true type: string required: - additional_debtors - claims - confirmation_email - created_at - creditor_obligation_fulfilled - debtor - expires_at - id - mandate - merged_into - rejection - starting_approach - status - totals - type - updated_at title: Invoice order type: object RentalOrder: description: >- A rental order contains receivable claims and one `rental_agreement`, alongside `starting_approach` and `creditor_obligation_fulfilled`. Read representation of an order. `status` is derived from the order's submission and review progress; `mandate` names the created mandate once the order is accepted; `merged_into` names the surviving order when this order was merged away during review. properties: additional_debtors: description: >- Inline summaries of the additional debtors. Retrieve each debtor's full details with GET /v2/debtors/{id}/ using its id. Replace membership through PATCH /v2/orders/{id}/ while the order is a draft. API submissions are limited to 10 additional debtors. items: $ref: '#/components/schemas/DebtorSummary' readOnly: true type: array claims: description: >- Receivable claims belonging to this order, including their itemized charges and documents. Titled claims are accepted only in titled orders. API submissions are limited to 50 claims per order. items: $ref: '#/components/schemas/Claim' readOnly: true type: array confirmation_email: description: Address receiving the order-entry confirmation, when requested. format: email nullable: true readOnly: true type: string created_at: description: Time at which the order was created. format: date-time readOnly: true type: string creditor_obligation_fulfilled: description: Whether you fully performed your obligation to the debtor. nullable: true readOnly: true type: boolean debtor: allOf: - $ref: '#/components/schemas/DebtorSummary' description: >- Inline summary of the primary debtor. Retrieve full details with GET /v2/debtors/{id}/ using its id. readOnly: true expires_at: description: >- Time at which this API-created draft expires: updated_at plus 90 days, refreshed by every successful draft change. Once it has passed, the order reads expired and every change answers 409 order_expired until the daily cleanup deletes it. Null once the order is finalized and for orders created in the portal. format: date-time nullable: true readOnly: true type: string id: description: Stable identifier of this order. format: uuid readOnly: true type: string mandate: description: Accepted case created from this order, when available. format: uuid nullable: true readOnly: true type: string merged_into: description: Surviving order when this order was merged during review. format: uuid nullable: true readOnly: true type: string rejection: allOf: - $ref: '#/components/schemas/OrderRejection' description: >- Why paywise declined the order: reason, time, notified recipients, and the standard reason's key. Null unless status is rejected. nullable: true readOnly: true rental_agreement: allOf: - $ref: '#/components/schemas/RentalAgreementRead' description: Rental-agreement singleton owned by this order. nullable: true readOnly: true starting_approach: allOf: - $ref: '#/components/schemas/StartingApproachEnum' description: >- Initial collection route: extrajudicial starts out of court; judicial starts by applying for a payment order (Mahnbescheid). Null while this decision is unset. nullable: true readOnly: true status: allOf: - $ref: '#/components/schemas/OrderStatusEnum' description: >- Order lifecycle state: draft is editable; submitted awaits processing; awaiting_client_response requires client input; accepted has entered case processing; rejected was declined; withdrawn was cancelled by the client; expired passed its draft deadline and accepts no further changes (409 order_expired) until the daily cleanup deletes it; merged points to the surviving order in merged_into. readOnly: true totals: allOf: - $ref: '#/components/schemas/OrderTotals' description: Financial totals calculated across the order's claims. readOnly: true type: allOf: - $ref: '#/components/schemas/RentalOrderTypeEnum' description: Literal rental order discriminator. readOnly: true updated_at: description: Time at which the order was last updated. format: date-time readOnly: true type: string required: - additional_debtors - claims - confirmation_email - created_at - creditor_obligation_fulfilled - debtor - expires_at - id - mandate - merged_into - rejection - rental_agreement - starting_approach - status - totals - type - updated_at title: Rental order type: object TitledOrder: description: >- A titled order contains titled claims and may include receivable claims for enforcement costs. It exposes `success_fee_confirmed` and omits `starting_approach` and `creditor_obligation_fulfilled`; enforcement is implicit. Read representation of an order. `status` is derived from the order's submission and review progress; `mandate` names the created mandate once the order is accepted; `merged_into` names the surviving order when this order was merged away during review. properties: additional_debtors: description: >- Inline summaries of the additional debtors. Retrieve each debtor's full details with GET /v2/debtors/{id}/ using its id. Replace membership through PATCH /v2/orders/{id}/ while the order is a draft. API submissions are limited to 10 additional debtors. items: $ref: '#/components/schemas/DebtorSummary' readOnly: true type: array claims: description: >- Titled claims owning enforceable titles, plus any receivable claims for enforcement costs (K014). At least one complete titled claim is required before finalization. API submissions are limited to 50 claims per order. items: $ref: '#/components/schemas/Claim' readOnly: true type: array confirmation_email: description: Address receiving the order-entry confirmation, when requested. format: email nullable: true readOnly: true type: string created_at: description: Time at which the order was created. format: date-time readOnly: true type: string debtor: allOf: - $ref: '#/components/schemas/DebtorSummary' description: >- Inline summary of the primary debtor. Retrieve full details with GET /v2/debtors/{id}/ using its id. readOnly: true expires_at: description: >- Time at which this API-created draft expires: updated_at plus 90 days, refreshed by every successful draft change. Once it has passed, the order reads expired and every change answers 409 order_expired until the daily cleanup deletes it. Null once the order is finalized and for orders created in the portal. format: date-time nullable: true readOnly: true type: string id: description: Stable identifier of this order. format: uuid readOnly: true type: string mandate: description: Accepted case created from this order, when available. format: uuid nullable: true readOnly: true type: string merged_into: description: Surviving order when this order was merged during review. format: uuid nullable: true readOnly: true type: string rejection: allOf: - $ref: '#/components/schemas/OrderRejection' description: >- Why paywise declined the order: reason, time, notified recipients, and the standard reason's key. Null unless status is rejected. nullable: true readOnly: true status: allOf: - $ref: '#/components/schemas/OrderStatusEnum' description: >- Order lifecycle state: draft is editable; submitted awaits processing; awaiting_client_response requires client input; accepted has entered case processing; rejected was declined; withdrawn was cancelled by the client; expired passed its draft deadline and accepts no further changes (409 order_expired) until the daily cleanup deletes it; merged points to the surviving order in merged_into. readOnly: true success_fee_confirmed: description: >- Whether the titled-order success-fee arrangement has been confirmed for finalization. See the [paywise General Terms and Conditions (AGB)](https://paywise.de/agb/) for the exact conditions for titled orders. readOnly: true type: boolean totals: allOf: - $ref: '#/components/schemas/OrderTotals' description: Financial totals calculated across the order's claims. readOnly: true type: allOf: - $ref: '#/components/schemas/TitledOrderTypeEnum' description: Literal titled order discriminator. readOnly: true updated_at: description: Time at which the order was last updated. format: date-time readOnly: true type: string required: - additional_debtors - claims - confirmation_email - created_at - debtor - expires_at - id - mandate - merged_into - rejection - status - success_fee_confirmed - totals - type - updated_at title: Titled order type: object ErrorItem: properties: code: description: Machine-readable field error code. type: string field: 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. nullable: true type: string message: description: Human-readable explanation of the field error. type: string required: - field - code - message type: object DebtorSummary: properties: acting_as: allOf: - $ref: '#/components/schemas/ActingAsEnum' description: >- Whether the debtor incurred the obligation as a consumer or in a business capacity. * `consumer` - consumer * `business` - business readOnly: true events: description: Stored contextual events associated with this resource. items: $ref: '#/components/schemas/LegacyEventRead' readOnly: true type: array id: description: Stable identifier of this debtor. format: uuid readOnly: true type: string legal_form: description: >- Permanent public legal-form code; look up its label and representation rules with GET /v2/legal-forms/. Null for consumers. nullable: true readOnly: true type: string metadata: description: Stored metadata entries; duplicate types remain separate entries. items: $ref: '#/components/schemas/LegacyMetadataRead' readOnly: true type: array organization: allOf: - $ref: '#/components/schemas/OrganizationRead' description: Organization identity for a business debtor. nullable: true readOnly: true person: allOf: - $ref: '#/components/schemas/PersonRead' description: Natural-person identity for a consumer or sole proprietor. nullable: true readOnly: true your_reference: description: Your reference for this debtor. nullable: true readOnly: true type: string required: - acting_as - events - id - legal_form - metadata - organization - person - your_reference type: object Claim: discriminator: mapping: receivable: '#/components/schemas/ReceivableClaim' titled: '#/components/schemas/TitledClaim' propertyName: type oneOf: - $ref: '#/components/schemas/ReceivableClaim' - $ref: '#/components/schemas/TitledClaim' OrderRejection: description: Why and when paywise declined an order, present only while rejected. properties: code: description: >- Stable machine-readable key of the standard rejection reason when the rejection used one; null for an individually worded rejection. nullable: true readOnly: true type: string notified_to: description: >- E-mail addresses of your company's status-update recipients the rejection notice was delivered to. Empty when no notice was sent. items: format: email type: string readOnly: true type: array reason: description: >- Plain-text reason paywise gave for rejecting the order: the wording of the rejection notice with formatting removed. nullable: true readOnly: true type: string rejected_at: description: Time at which paywise rejected the order. format: date-time readOnly: true type: string required: - code - notified_to - reason - rejected_at type: object OrderStatusEnum: enum: - draft - submitted - awaiting_client_response - accepted - rejected - withdrawn - expired - merged type: string OrderTotals: properties: charges: allOf: - $ref: '#/components/schemas/ClaimAmountRead' description: Sum of itemized additional charges on receivable claims. readOnly: true main_claims: allOf: - $ref: '#/components/schemas/ClaimAmountRead' description: >- Sum of receivable-claim principal amounts plus gross enforceable-title amounts. readOnly: true order_value: allOf: - $ref: '#/components/schemas/ClaimAmountRead' description: >- Current open value for invoice and rental orders; for titled orders, gross main_claims plus charges, with payments reported separately. readOnly: true payments: allOf: - $ref: '#/components/schemas/ClaimAmountRead' description: Sum of payments already reported for the order's claims. readOnly: true required: - charges - main_claims - order_value - payments type: object InvoiceOrderTypeEnum: enum: - invoice type: string RentalAgreementRead: properties: contract_date: description: >- Date on which the rental contract was concluded; this is not the tenancy start or move-in date. format: date nullable: true readOnly: true type: string created_at: description: Time at which the rental agreement was created. format: date-time readOnly: true type: string documents: description: >- Documents owned by the agreement, including the optional rental-agreement and claim-statement primary slots. items: $ref: '#/components/schemas/DocumentRead' readOnly: true type: array due_rule: allOf: - $ref: '#/components/schemas/RentalDueRule' description: >- Rule used to derive H17/H19 rental due dates. Null means the default third German business day of the rental month applies; explicit claim-level dates override the derived result. nullable: true readOnly: true id: description: Stable identifier of the rental agreement. format: uuid readOnly: true type: string monthly_rent: allOf: - $ref: '#/components/schemas/ClaimAmountRead' description: >- Total recurring Warmmiete, including ancillary-cost prepayments; it does not constrain an individual claim amount. nullable: true readOnly: true property_address: allOf: - $ref: '#/components/schemas/RentalPropertyAddressRead' description: >- Complete address of the rented property, even when it matches the debtor address. nullable: true readOnly: true updated_at: description: Time at which the rental agreement last changed. format: date-time readOnly: true type: string required: - contract_date - created_at - documents - due_rule - id - monthly_rent - property_address - updated_at type: object RentalOrderTypeEnum: enum: - rental type: string TitledOrderTypeEnum: enum: - titled type: string ActingAsEnum: description: |- * `consumer` - consumer * `business` - business enum: - consumer - business type: string LegacyEventRead: description: Stored events may likewise use retired or internal type values. properties: description: description: Optional description of the event. nullable: true readOnly: true type: string location: description: Optional location associated with the event. nullable: true readOnly: true type: string occurence: description: >- Time at which the event occurred; the historical field spelling is intentional. format: date-time readOnly: true type: string title: description: Human-readable title of the event. readOnly: true type: string type: description: >- Stored event type; historical values may be outside today's input enum. readOnly: true type: string your_reference: description: Your optional reference for the event. nullable: true readOnly: true type: string required: - description - location - occurence - title - type - your_reference type: object LegacyMetadataRead: description: Stored types may predate today's resource-specific input choices. properties: type: description: >- Stored metadata type; historical values may be outside today's input enum. readOnly: true type: string value: description: Stored metadata value. readOnly: true type: string required: - type - value type: object OrganizationRead: properties: commercial_register: description: Register court or authority holding the registration. nullable: true readOnly: true type: string commercial_registration_number: description: Commercial, association, or partnership register number. nullable: true readOnly: true type: string name: description: Registered or trading name of the organization. readOnly: true type: string required: - commercial_register - commercial_registration_number - name type: object PersonRead: properties: birth_date: description: Date of birth used to identify the natural person. format: date nullable: true readOnly: true type: string first_name: description: Given name of the natural person. readOnly: true type: string last_name: description: Family name of the natural person. readOnly: true type: string salutation: allOf: - $ref: '#/components/schemas/SalutationEnum' description: >- Salutation of the natural person; null if no supported salutation is stored. nullable: true readOnly: true required: - birth_date - first_name - last_name - salutation type: object ReceivableClaim: description: >- A receivable claim based on an invoice, rent, or another obligation. Its principal amount, dates, charges, and documents belong to the claim. properties: additional_charges: description: >- Itemized incidental claims such as reminder or bank fees. API submissions are limited to 50 entries. items: $ref: '#/components/schemas/ClaimChargeRead' readOnly: true type: array additional_charges_amount: allOf: - $ref: '#/components/schemas/ClaimAmountRead' description: Sum of all itemized additional charges. readOnly: true additional_debtor_ids: description: >- Read-only additional debtor identifiers projected from the current order. items: format: uuid type: string readOnly: true type: array created_at: description: Time at which the claim was created. format: date-time readOnly: true type: string debtor_id: description: >- Read-only primary debtor identifier projected from the current order. Change party membership only on a draft order; debtor details use the debtor resource. format: uuid nullable: true readOnly: true type: string delay_date: description: Date from which the debtor is considered in payment default. format: date nullable: true readOnly: true type: string dispute_reason: description: Debtor's stated reason for disputing the claim. nullable: true readOnly: true type: string document_date: description: Date of the invoice, contract, or other claim document. format: date nullable: true readOnly: true type: string document_reference: description: Invoice, contract, or other source-document number. nullable: true readOnly: true type: string documents: description: Documents relevant to processing the claim. items: $ref: '#/components/schemas/DocumentRead' readOnly: true type: array due_date: description: Date on which payment of the principal claim became due. format: date nullable: true readOnly: true type: string events: description: Stored contextual events associated with this resource. items: $ref: '#/components/schemas/LegacyEventRead' readOnly: true type: array id: description: Stable identifier of this claim. format: uuid readOnly: true type: string is_disputed: description: Whether the debtor disputes the claim. readOnly: true type: boolean items: description: >- Invoice or contract lines that make up the principal claim. API submissions are limited to 100 entries. items: $ref: '#/components/schemas/ClaimItemRead' readOnly: true type: array legal_basis: allOf: - $ref: '#/components/schemas/ClaimLegalBasisRead' description: Contract or obligation that establishes the principal claim. readOnly: true mandate_id: description: Read-only accepted mandate identifier, or null before acceptance. format: uuid nullable: true readOnly: true type: string metadata: description: Stored metadata entries; duplicate types remain separate entries. items: $ref: '#/components/schemas/LegacyMetadataRead' readOnly: true type: array order_id: description: >- Read-only current order identifier. Internal review may change this relationship while the claim identifier and all claim-specific URLs remain stable. format: uuid readOnly: true type: string payments: description: >- Read-only payments attributed to this claim. Report subsequent payments through the stable claim payments URL, including after acceptance or an internal order move. Reporting requires case:payments:write. items: $ref: '#/components/schemas/PaymentRead' readOnly: true type: array principal_amount: allOf: - $ref: '#/components/schemas/ClaimAmountRead' description: >- Original principal amount including VAT, before charges and payments. nullable: true readOnly: true reminders: description: >- Payment reminders issued for this claim in chronological order. API submissions are limited to 50 entries. items: $ref: '#/components/schemas/ClaimReminderRead' readOnly: true type: array status: allOf: - $ref: '#/components/schemas/ClaimStatusEnum' description: >- Read-only effective claim lifecycle. Draft-only commands return 409 claim_not_editable after submission and 409 order_expired once the draft has passed its expires_at; payment and title commands retain their specific lifecycle conflict codes. readOnly: true subject_matter: description: >- Goods, services, or other obligation underlying the claim. API submissions are limited to 2000 characters. nullable: true readOnly: true type: string total_amount: allOf: - $ref: '#/components/schemas/ClaimAmountRead' description: Current open amount after charges and reported payments. nullable: true readOnly: true type: allOf: - $ref: '#/components/schemas/ReceivableClaimTypeEnum' description: Literal receivable claim discriminator. readOnly: true updated_at: description: Time at which the claim was last updated. format: date-time readOnly: true type: string your_reference: description: Your reference for this claim. nullable: true readOnly: true type: string required: - additional_charges - additional_charges_amount - additional_debtor_ids - created_at - debtor_id - delay_date - dispute_reason - document_date - document_reference - documents - due_date - events - id - is_disputed - items - legal_basis - mandate_id - metadata - order_id - payments - principal_amount - reminders - status - subject_matter - total_amount - type - updated_at - your_reference title: Receivable claim type: object TitledClaim: description: >- A claim backed by an enforceable title. The title's amount, dates, and documents belong to `enforceable_title`. properties: additional_debtor_ids: description: >- Read-only additional debtor identifiers projected from the current order. items: format: uuid type: string readOnly: true type: array created_at: description: Time at which the claim was created. format: date-time readOnly: true type: string debtor_id: description: >- Read-only primary debtor identifier projected from the current order. Change party membership only on a draft order; debtor details use the debtor resource. format: uuid nullable: true readOnly: true type: string dispute_reason: description: Debtor's stated reason for disputing the claim. nullable: true readOnly: true type: string document_reference: description: Invoice, contract, or other source-document number. nullable: true readOnly: true type: string enforceable_title: allOf: - $ref: '#/components/schemas/EnforceableTitleRead' description: >- Enforceable title that owns this claim's gross amount, legal metadata, and title documents. nullable: true readOnly: true events: description: Stored contextual events associated with this resource. items: $ref: '#/components/schemas/LegacyEventRead' readOnly: true type: array id: description: Stable identifier of this claim. format: uuid readOnly: true type: string is_disputed: description: Whether the debtor disputes the claim. readOnly: true type: boolean mandate_id: description: Read-only accepted mandate identifier, or null before acceptance. format: uuid nullable: true readOnly: true type: string metadata: description: Stored metadata entries; duplicate types remain separate entries. items: $ref: '#/components/schemas/LegacyMetadataRead' readOnly: true type: array order_id: description: >- Read-only current order identifier. Internal review may change this relationship while the claim identifier and all claim-specific URLs remain stable. format: uuid readOnly: true type: string payments: description: >- Read-only payments attributed to this claim. Report subsequent payments through the stable claim payments URL, including after acceptance or an internal order move. Reporting requires case:payments:write. items: $ref: '#/components/schemas/PaymentRead' readOnly: true type: array principal_amount: allOf: - $ref: '#/components/schemas/ClaimAmountRead' description: >- Always null for a titled claim; use enforceable_title.amount for the authoritative gross amount. nullable: true readOnly: true status: allOf: - $ref: '#/components/schemas/ClaimStatusEnum' description: >- Read-only effective claim lifecycle. Draft-only commands return 409 claim_not_editable after submission and 409 order_expired once the draft has passed its expires_at; payment and title commands retain their specific lifecycle conflict codes. readOnly: true subject_matter: description: >- Goods, services, or other obligation underlying the claim. API submissions are limited to 2000 characters. nullable: true readOnly: true type: string total_amount: allOf: - $ref: '#/components/schemas/ClaimAmountRead' description: >- Authoritative gross enforceable-title amount; reported payments are exposed separately and do not reduce it. nullable: true readOnly: true type: allOf: - $ref: '#/components/schemas/TitledClaimTypeEnum' description: Literal titled claim discriminator. readOnly: true updated_at: description: Time at which the claim was last updated. format: date-time readOnly: true type: string your_reference: description: Your reference for this claim. nullable: true readOnly: true type: string required: - additional_debtor_ids - created_at - debtor_id - dispute_reason - document_reference - enforceable_title - events - id - is_disputed - mandate_id - metadata - order_id - payments - principal_amount - status - subject_matter - total_amount - type - updated_at - your_reference title: Titled claim type: object ClaimAmountRead: description: Read-only two-decimal EUR amount. properties: currency: allOf: - $ref: '#/components/schemas/CurrencyEnum' description: |- Currency of the amount; currently always EUR. * `EUR` - EUR readOnly: true value: description: Monetary value expressed with two decimal places. format: decimal pattern: ^-?\d{0,14}(?:\.\d{0,2})?$ readOnly: true type: string required: - currency - value type: object DocumentRead: description: Resource representation with a native UUID `id`. properties: created_at: description: Time at which the document was submitted. format: date-time readOnly: true type: string download_url: description: >- Authenticated API URL for downloading the document; null while its status is not `ready`. format: uri nullable: true readOnly: true type: string failure_reason: allOf: - $ref: '#/components/schemas/DocumentFailureReasonEnum' description: >- Why processing failed when status is `failed`; `null` otherwise. `page_limit_exceeded`: PDF above the 100-page ceiling; `encrypted`: password-protected PDF; `corrupt`: bytes could not be parsed; `unsupported`: content type not accepted; `processing_failed`: any other processing error. nullable: true readOnly: true filename: description: Original filename shown to users. readOnly: true type: string id: description: Stable identifier for this resource. format: uuid readOnly: true type: string mime_type: description: Detected media type of the document. nullable: true readOnly: true type: string parent: allOf: - $ref: '#/components/schemas/DocumentParent' description: Resource that owns the document. readOnly: true status: allOf: - $ref: '#/components/schemas/CaseDocumentStatusEnum' description: >- Document availability: `pending` while scanning or processing is incomplete; `ready` when processing permits download; `failed` when scanning or processing failed; `rejected` when the malware check rejected the file. readOnly: true type: allOf: - $ref: '#/components/schemas/CaseDocumentTypeEnum' description: Business purpose of the document. readOnly: true updated_at: description: Time at which document processing last changed. format: date-time readOnly: true type: string required: - created_at - download_url - failure_reason - filename - id - mime_type - parent - status - type - updated_at type: object RentalDueRule: description: Both keys are required even under the singleton's partial PATCH. properties: day: description: >- Day number from 1 to 31 within the rental month: calendar day for calendar_day, or ordinal business day for business_day. If the month has fewer such days, the last applicable day is used. maximum: 31 minimum: 1 type: integer kind: $ref: '#/components/schemas/KindEnum' description: >- How to interpret day: calendar_day counts all dates; business_day counts Monday through Friday excluding German federal public holidays. State-specific holidays are not considered. required: - day - kind type: object RentalPropertyAddressRead: properties: city: description: City of the rented property. readOnly: true type: string country: description: ISO 3166-1 alpha-2 country code of the rented property. readOnly: true type: string postal_code: description: Postal code of the rented property. readOnly: true type: string street: description: Street and house number of the rented property. readOnly: true type: string required: - city - country - postal_code - street type: object SalutationEnum: enum: - mr - ms - mx type: string ClaimChargeRead: description: Read representation of one canonical additional charge. properties: amount: allOf: - $ref: '#/components/schemas/ClaimAmountRead' description: Amount of the additional charge. readOnly: true events: description: Stored contextual events associated with this resource. items: $ref: '#/components/schemas/LegacyEventRead' readOnly: true type: array id: description: Stable identifier of this additional charge. format: uuid readOnly: true type: string metadata: description: Stored metadata entries; duplicate types remain separate entries. items: $ref: '#/components/schemas/LegacyMetadataRead' readOnly: true type: array occurrence_date: description: Date on which the additional charge arose. format: date nullable: true readOnly: true type: string subject_matter: description: Reason or subject of the additional charge. nullable: true readOnly: true type: string type: allOf: - $ref: '#/components/schemas/CaseChargeTypeEnum' description: |- Business category of the additional charge. * `reminder_fee` - reminder_fee * `bank_charge` - bank_charge * `research_costs` - research_costs readOnly: true your_reference: description: Your reference for this additional charge. nullable: true readOnly: true type: string required: - amount - events - id - metadata - occurrence_date - subject_matter - type - your_reference type: object ClaimItemRead: description: Read representation of one invoice line. properties: amount: allOf: - $ref: '#/components/schemas/ClaimAmountRead' description: 'Calculated line total: quantity multiplied by unit price.' readOnly: true description: description: Goods or service represented by this invoice or contract line. readOnly: true type: string quantity: description: Number of units represented by this line. format: decimal pattern: ^-?\d{0,10}(?:\.\d{0,6})?$ readOnly: true type: string unit: description: Unit of measure for the quantity, when applicable. nullable: true readOnly: true type: string unit_price: allOf: - $ref: '#/components/schemas/ClaimAmountRead' description: Price of one unit before multiplying by quantity. readOnly: true required: - amount - description - quantity - unit - unit_price type: object ClaimLegalBasisRead: description: Read representation of the singular legal basis. properties: claim_type_code: description: >- Code identifying the contract or transaction underlying the claim. H17 is commercial rent, H19 is residential rent, and K014 identifies receivable enforcement costs in titled orders. See [legal basis codes](https://docs.paywise.de/api-docs/case-management-api/concepts/claims#legal-basis-codes) for the full code-to-meaning table. nullable: true readOnly: true type: string contract_date: description: Date on which the underlying contract or obligation arose. format: date nullable: true readOnly: true type: string description: description: >- Terms or circumstances establishing the principal claim. API submissions are limited to 2000 characters. nullable: true readOnly: true type: string required: - claim_type_code - contract_date - description type: object PaymentRead: description: Read representation of one reported payment. properties: amount: allOf: - $ref: '#/components/schemas/PaymentAmountRead' description: Amount received. nullable: true readOnly: true claim: allOf: - $ref: '#/components/schemas/PaymentClaimReference' description: Claim to which the payment was reported. nullable: true readOnly: true created_at: description: Time at which the payment was reported. format: date-time readOnly: true type: string id: description: Stable identifier of this reported payment. format: uuid readOnly: true type: string mandate: allOf: - $ref: '#/components/schemas/PaymentMandateReference' description: Accepted case containing the claim. nullable: true readOnly: true metadata: description: Stored metadata entries; duplicate types remain separate entries. items: $ref: '#/components/schemas/LegacyMetadataRead' readOnly: true type: array updated_at: description: Time at which the payment record was last updated. format: date-time readOnly: true type: string value_date: description: Date on which the payment was credited. format: date readOnly: true type: string your_reference: description: Your reference for reconciling this payment. nullable: true readOnly: true type: string required: - amount - claim - created_at - id - mandate - metadata - updated_at - value_date - your_reference type: object ClaimReminderRead: description: Read representation of one normalized reminder. properties: date: description: Date on which the payment reminder was issued. format: date nullable: true readOnly: true type: string due_date: description: Payment deadline stated in the reminder, when present. format: date nullable: true readOnly: true type: string id: description: Stable identifier of this reminder. format: uuid nullable: true readOnly: true type: string required: - date - due_date - id type: object ClaimStatusEnum: description: |- * `draft` - draft * `submitted` - submitted * `awaiting_client_response` - awaiting_client_response * `accepted` - accepted * `rejected` - rejected * `withdrawn` - withdrawn enum: - draft - submitted - awaiting_client_response - accepted - rejected - withdrawn type: string ReceivableClaimTypeEnum: enum: - receivable type: string EnforceableTitleRead: properties: amount: allOf: - $ref: '#/components/schemas/TitleAmountWrite' description: >- Gross amount confirmed by the client and owned by the enforceable title. nullable: true readOnly: true created_at: description: Time at which the enforceable title was created. format: date-time readOnly: true type: string documents: description: >- Documents owned by the title; one primary enforceable-title document is required before finalization. items: $ref: '#/components/schemas/DocumentRead' readOnly: true type: array file_number: description: Official file or reference number shown on the title. readOnly: true type: string id: description: Stable identifier of the enforceable title. format: uuid readOnly: true type: string issued_on: description: Date on which the enforceable title was issued. format: date nullable: true readOnly: true type: string issuing_authority: description: Court, notary, or other authority that issued the title. readOnly: true type: string legally_binding_since: description: >- Optional date from which the title is legally binding; it cannot precede issued_on. format: date nullable: true readOnly: true type: string served_on: description: >- Optional date on which the title was served; it cannot precede issued_on. format: date nullable: true readOnly: true type: string title_type: allOf: - $ref: '#/components/schemas/TitleTypeEnum' description: >- Legal title category: enforcement_order = Vollstreckungsbescheid; default_judgment = Versäumnisurteil; final_judgment = Endurteil; acknowledgment_judgment = Anerkenntnisurteil; reservation_judgment = Vorbehaltsurteil; court_settlement = Gerichtlicher Vergleich; enforceable_notarial_deed = Vollstreckbare notarielle Urkunde; cost_assessment_order = Kostenfestsetzungsbeschluss; other = Sonstiger Titel. nullable: true readOnly: true updated_at: description: Time at which the enforceable title last changed. format: date-time readOnly: true type: string required: - amount - created_at - documents - file_number - id - issued_on - issuing_authority - legally_binding_since - served_on - title_type - updated_at type: object TitledClaimTypeEnum: description: '* `titled` - Titled claim' enum: - titled type: string CurrencyEnum: description: '* `EUR` - EUR' enum: - EUR type: string DocumentFailureReasonEnum: enum: - page_limit_exceeded - encrypted - corrupt - unsupported - processing_failed type: string DocumentParent: properties: id: description: Identifier of the resource that owns the document. format: uuid readOnly: true type: string type: allOf: - $ref: '#/components/schemas/DocumentParentTypeEnum' description: |- Kind of resource that owns the document. * `claim` - claim * `message` - message * `request_to_client_answer` - request_to_client_answer * `rental_agreement` - rental_agreement * `enforceable_title` - enforceable_title readOnly: true required: - id - type type: object CaseDocumentStatusEnum: enum: - pending - ready - failed - rejected type: string CaseDocumentTypeEnum: description: |- * `bank_statement` - bank_statement * `claim_statement` - claim_statement * `correspondence` - correspondence * `enforceable_title` - enforceable_title * `invoice` - invoice * `other` - other * `payment_proof` - payment_proof * `reminder` - reminder * `rental_agreement` - rental_agreement enum: - bank_statement - claim_statement - correspondence - enforceable_title - invoice - other - payment_proof - reminder - rental_agreement type: string KindEnum: description: |- * `calendar_day` - calendar_day * `business_day` - business_day enum: - calendar_day - business_day type: string CaseChargeTypeEnum: description: |- * `reminder_fee` - reminder_fee * `bank_charge` - bank_charge * `research_costs` - research_costs enum: - reminder_fee - bank_charge - research_costs type: string PaymentAmountRead: properties: currency: description: Currency of the payment. readOnly: true type: string value: description: Amount received, expressed with two decimal places. format: decimal pattern: ^-?\d{0,14}(?:\.\d{0,2})?$ readOnly: true type: string required: - currency - value type: object PaymentClaimReference: properties: document_reference: description: Invoice, contract, or source-document number of the claim. nullable: true readOnly: true type: string id: description: Identifier of the claim receiving the payment. format: uuid readOnly: true type: string your_reference: description: Your reference for the claim. nullable: true readOnly: true type: string required: - document_reference - id - your_reference type: object PaymentMandateReference: properties: id: description: Identifier of the accepted case receiving the payment. format: uuid readOnly: true type: string reference_number: description: paywise case-file reference number. readOnly: true type: string required: - id - reference_number type: object TitleAmountWrite: description: The gross enforceable amount; validated as a whole even on PATCH. properties: currency: allOf: - $ref: '#/components/schemas/CurrencyEnum' default: EUR description: Currency of the title amount; only EUR is supported. value: description: >- Gross title amount in major currency units, with at most two decimal places. Zero is accepted while drafting; the amount must be positive before finalization. format: decimal pattern: ^-?\d{0,14}(?:\.\d{0,2})?$ type: string required: - value type: object TitleTypeEnum: description: |- * `enforcement_order` - enforcement_order * `default_judgment` - default_judgment * `final_judgment` - final_judgment * `acknowledgment_judgment` - acknowledgment_judgment * `reservation_judgment` - reservation_judgment * `court_settlement` - court_settlement * `enforceable_notarial_deed` - enforceable_notarial_deed * `cost_assessment_order` - cost_assessment_order * `other` - other enum: - enforcement_order - default_judgment - final_judgment - acknowledgment_judgment - reservation_judgment - court_settlement - enforceable_notarial_deed - cost_assessment_order - other type: string DocumentParentTypeEnum: description: |- * `claim` - claim * `message` - message * `request_to_client_answer` - request_to_client_answer * `rental_agreement` - rental_agreement * `enforceable_title` - enforceable_title enum: - claim - message - request_to_client_answer - rental_agreement - enforceable_title type: string securitySchemes: caseBearerAuth: description: >- Company-bound Case Management API key — the standard credential for this API. scheme: bearer type: http partnerBearerAuth: description: >- Partner API key acting for one entitled company; every Case request must then also carry the X-On-Behalf-Of-Company header. scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.