import requests
url = "https://api.paywise.de/v2/claims/{id}/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
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.get("https://api.paywise.de/v2/claims/{id}/")
.header("Authorization", "Bearer <token>")
.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>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
curl --request GET \
--url https://api.paywise.de/v2/claims/{id}/ \
--header 'Authorization: Bearer <token>'{
"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"
}Get 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}/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
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.get("https://api.paywise.de/v2/claims/{id}/")
.header("Authorization", "Bearer <token>")
.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>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
curl --request GET \
--url https://api.paywise.de/v2/claims/{id}/ \
--header 'Authorization: Bearer <token>'{
"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.
Return 304 with an empty body when the current ETag matches one of the supplied validators (or *).
Path Parameters
UUID of the claim in this request.
Response
- 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.