import requests
url = "https://api.paywise.de/v2/claims/{id}/"
payload = {}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://api.paywise.de/v2/claims/{id}/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.patch("https://api.paywise.de/v2/claims/{id}/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{}")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.paywise.de/v2/claims/{id}/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{}", false);
var response = await client.PatchAsync(request);
Console.WriteLine("{0}", response.Content);
curl --request PATCH \
--url https://api.paywise.de/v2/claims/{id}/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'{
"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"
}Update claim
Claims addressed by their stable UUID and current relationships.
Read claims throughout their lifecycle using URLs that remain valid after
internal order moves. Standalone creation requires a draft order_id;
the relationship is read-only thereafter. Create, PATCH, and DELETE require
a draft order and otherwise return 409 claim_not_editable. An expired
draft instead returns 409 order_expired. Tenant-scoped by the
authenticated company.
import requests
url = "https://api.paywise.de/v2/claims/{id}/"
payload = {}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://api.paywise.de/v2/claims/{id}/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.patch("https://api.paywise.de/v2/claims/{id}/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{}")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.paywise.de/v2/claims/{id}/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{}", false);
var response = await client.PatchAsync(request);
Console.WriteLine("{0}", response.Content);
curl --request PATCH \
--url https://api.paywise.de/v2/claims/{id}/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'{
"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"
}Authorizations
Company-bound Case Management API key — the standard credential for this API.
Headers
Required when a Partner key calls the Case Management API; rejected for direct Case keys. Contains the entitled paywise company UUID.
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
UUID of the claim in this request.
Body
Partial update of a claim while its order is a draft.
One flat schema: a claim's type is immutable, so type is not a
writable field here and title ownership changes only through the
claim-owned enforceable-title route.
Itemized incidental charges for a receivable claim, such as reminder or bank fees. This array replaces all existing charges; [] clears them and omission preserves them. Maximum 50 entries per claim.
50Show child attributes
Show child attributes
Payment-default date for a receivable claim. For H17/H19 rent, an explicit date overrides the derived day after due_date and null restores derivation. For other receivables, null clears it; changing document_date, due_date, or reminders without supplying delay_date recalculates it. An explicit date must follow the applicable due or reminder date.
Debtor's stated reason for disputing the claim. The resulting disputed claim must have a non-blank reason; an existing reason satisfies this requirement when omitted from PATCH. Setting is_disputed to false clears the existing reason unless you supply this field, which must then be empty or null.
2500Date of the invoice, contract, or other claim document. For H17/H19 rent, supply the first day of the rental month; only one rental claim per calendar month is allowed. Only valid for receivable claims. Required and cannot be in the future at finalization.
Invoice, contract, or other source-document number.
255Date on which a receivable claim became due. For H17/H19 rent, an explicit date overrides the agreement rule, null restores derivation, and omission preserves the current date or its existing derivation. For other receivables it cannot precede document_date.
Whether the debtor disputes the claim. Setting false also clears the existing dispute_reason unless you supply that field explicitly.
Invoice or contract lines for a receivable claim. This array replaces all existing lines; [] clears them and omission preserves them. Supply principal_amount separately when the principal changes. Maximum 100 entries per claim.
100Show child attributes
Show child attributes
Contract or obligation establishing a receivable claim. Supplied properties update the existing legal basis; omitted properties stay unchanged. Not valid on titled claims or on receivable enforcement costs in titled orders, which always use K014.
Show child attributes
Show child attributes
Replacement principal amount including VAT, before charges and payments. Only valid for receivable claims; titled claims use their enforceable-title amount. Changing items does not update this amount. The principal must be positive before finalization.
Show child attributes
Show child attributes
Payment reminders for a receivable claim, in chronological order starting no earlier than its due date (or document date when due_date is absent). This array replaces all reminders; [] clears them and omission preserves them. Retain existing entries with their id. Maximum 50 entries per claim.
50Show child attributes
Show child attributes
Goods, services, or other obligation underlying the claim. Before finalization, a receivable claim must have non-blank subject_matter or at least one claim document. Maximum 2000 characters.
2000Your reference for this claim.
255Response
- Receivable claim
- Titled claim
A receivable claim based on an invoice, rent, or another obligation. Its principal amount, dates, charges, and documents belong to the claim.
Itemized incidental claims such as reminder or bank fees. API submissions are limited to 50 entries.
Show child attributes
Show child attributes
Sum of all itemized additional charges.
Show child attributes
Show child attributes
Read-only additional debtor identifiers projected from the current order.
Time at which the claim was created.
Read-only primary debtor identifier projected from the current order. Change party membership only on a draft order; debtor details use the debtor resource.
Date from which the debtor is considered in payment default.
Debtor's stated reason for disputing the claim.
Date of the invoice, contract, or other claim document.
Invoice, contract, or other source-document number.
Documents relevant to processing the claim.
Show child attributes
Show child attributes
Date on which payment of the principal claim became due.
Stored contextual events associated with this resource.
Show child attributes
Show child attributes
Stable identifier of this claim.
Whether the debtor disputes the claim.
Invoice or contract lines that make up the principal claim. API submissions are limited to 100 entries.
Show child attributes
Show child attributes
Contract or obligation that establishes the principal claim.
Show child attributes
Show child attributes
Read-only accepted mandate identifier, or null before acceptance.
Stored metadata entries; duplicate types remain separate entries.
Show child attributes
Show child attributes
Read-only current order identifier. Internal review may change this relationship while the claim identifier and all claim-specific URLs remain stable.
Read-only payments attributed to this claim. Report subsequent payments through the stable claim payments URL, including after acceptance or an internal order move. Reporting requires case:payments:write.
Show child attributes
Show child attributes
Original principal amount including VAT, before charges and payments.
Show child attributes
Show child attributes
Payment reminders issued for this claim in chronological order. API submissions are limited to 50 entries.
Show child attributes
Show child attributes
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.
draft, submitted, awaiting_client_response, accepted, rejected, withdrawn Goods, services, or other obligation underlying the claim. API submissions are limited to 2000 characters.
Current open amount after charges and reported payments.
Show child attributes
Show child attributes
Literal receivable claim discriminator.
receivable Time at which the claim was last updated.
Your reference for this claim.