import requests
url = "https://api.paywise.de/v2/claims/"
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/', 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/")
.header("Authorization", "Bearer <token>")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.paywise.de/v2/claims/");
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/ \
--header 'Authorization: Bearer <token>'{
"count": 123,
"results": [
{
"additional_charges": [
{
"amount": {
"currency": "EUR",
"value": "<string>"
},
"events": [
{
"description": "<string>",
"location": "<string>",
"occurence": "2023-11-07T05:31:56Z",
"title": "<string>",
"type": "<string>",
"your_reference": "<string>"
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": [
{
"type": "<string>",
"value": "<string>"
}
],
"occurrence_date": "2023-12-25",
"subject_matter": "<string>",
"type": "reminder_fee",
"your_reference": "<string>"
}
],
"additional_charges_amount": {
"currency": "EUR",
"value": "<string>"
},
"additional_debtor_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"created_at": "2023-11-07T05:31:56Z",
"debtor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"delay_date": "2023-12-25",
"dispute_reason": "<string>",
"document_date": "2023-12-25",
"document_reference": "<string>",
"documents": [
{
"created_at": "2023-11-07T05:31:56Z",
"download_url": "<string>",
"failure_reason": "page_limit_exceeded",
"filename": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mime_type": "<string>",
"parent": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "claim"
},
"status": "pending",
"type": "bank_statement",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"due_date": "2023-12-25",
"events": [
{
"description": "<string>",
"location": "<string>",
"occurence": "2023-11-07T05:31:56Z",
"title": "<string>",
"type": "<string>",
"your_reference": "<string>"
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_disputed": true,
"items": [
{
"amount": {
"currency": "EUR",
"value": "<string>"
},
"description": "<string>",
"quantity": "<string>",
"unit": "<string>",
"unit_price": {
"currency": "EUR",
"value": "<string>"
}
}
],
"legal_basis": {
"claim_type_code": "<string>",
"contract_date": "2023-12-25",
"description": "<string>"
},
"mandate_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": [
{
"type": "<string>",
"value": "<string>"
}
],
"order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"payments": [
{
"amount": {
"currency": "<string>",
"value": "<string>"
},
"claim": {
"document_reference": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"your_reference": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mandate": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reference_number": "<string>"
},
"metadata": [
{
"type": "<string>",
"value": "<string>"
}
],
"updated_at": "2023-11-07T05:31:56Z",
"value_date": "2023-12-25",
"your_reference": "<string>"
}
],
"principal_amount": {
"currency": "EUR",
"value": "<string>"
},
"reminders": [
{
"date": "2023-12-25",
"due_date": "2023-12-25",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"status": "draft",
"subject_matter": "<string>",
"total_amount": {
"currency": "EUR",
"value": "<string>"
},
"type": "receivable",
"updated_at": "2023-11-07T05:31:56Z",
"your_reference": "<string>"
}
],
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100"
}{
"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."
}
]
}{
"code": "not_authenticated",
"detail": "Authentication credentials were not provided."
}{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}List claims
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/"
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/', 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/")
.header("Authorization", "Bearer <token>")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.paywise.de/v2/claims/");
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/ \
--header 'Authorization: Bearer <token>'{
"count": 123,
"results": [
{
"additional_charges": [
{
"amount": {
"currency": "EUR",
"value": "<string>"
},
"events": [
{
"description": "<string>",
"location": "<string>",
"occurence": "2023-11-07T05:31:56Z",
"title": "<string>",
"type": "<string>",
"your_reference": "<string>"
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": [
{
"type": "<string>",
"value": "<string>"
}
],
"occurrence_date": "2023-12-25",
"subject_matter": "<string>",
"type": "reminder_fee",
"your_reference": "<string>"
}
],
"additional_charges_amount": {
"currency": "EUR",
"value": "<string>"
},
"additional_debtor_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"created_at": "2023-11-07T05:31:56Z",
"debtor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"delay_date": "2023-12-25",
"dispute_reason": "<string>",
"document_date": "2023-12-25",
"document_reference": "<string>",
"documents": [
{
"created_at": "2023-11-07T05:31:56Z",
"download_url": "<string>",
"failure_reason": "page_limit_exceeded",
"filename": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mime_type": "<string>",
"parent": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "claim"
},
"status": "pending",
"type": "bank_statement",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"due_date": "2023-12-25",
"events": [
{
"description": "<string>",
"location": "<string>",
"occurence": "2023-11-07T05:31:56Z",
"title": "<string>",
"type": "<string>",
"your_reference": "<string>"
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_disputed": true,
"items": [
{
"amount": {
"currency": "EUR",
"value": "<string>"
},
"description": "<string>",
"quantity": "<string>",
"unit": "<string>",
"unit_price": {
"currency": "EUR",
"value": "<string>"
}
}
],
"legal_basis": {
"claim_type_code": "<string>",
"contract_date": "2023-12-25",
"description": "<string>"
},
"mandate_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": [
{
"type": "<string>",
"value": "<string>"
}
],
"order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"payments": [
{
"amount": {
"currency": "<string>",
"value": "<string>"
},
"claim": {
"document_reference": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"your_reference": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mandate": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reference_number": "<string>"
},
"metadata": [
{
"type": "<string>",
"value": "<string>"
}
],
"updated_at": "2023-11-07T05:31:56Z",
"value_date": "2023-12-25",
"your_reference": "<string>"
}
],
"principal_amount": {
"currency": "EUR",
"value": "<string>"
},
"reminders": [
{
"date": "2023-12-25",
"due_date": "2023-12-25",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"status": "draft",
"subject_matter": "<string>",
"total_amount": {
"currency": "EUR",
"value": "<string>"
},
"type": "receivable",
"updated_at": "2023-11-07T05:31:56Z",
"your_reference": "<string>"
}
],
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100"
}{
"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."
}
]
}{
"code": "not_authenticated",
"detail": "Authentication credentials were not provided."
}{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}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.
Query Parameters
Number of results to return (maximum 100).
1 <= x <= 100Zero-based result offset.
x >= 0Filter claims by their parent order's UUID.
draft- draftsubmitted- submittedawaiting_client_response- awaiting_client_responseaccepted- acceptedrejected- rejectedwithdrawn- withdrawn
accepted, awaiting_client_response, draft, rejected, submitted, withdrawn Return rows changed at or after this timezone-aware RFC 3339 timestamp. Results are ordered by updated_at and id.
Response
Total number of matching resources.
123
Resources returned for the requested page.
A receivable claim based on an invoice, rent, or another obligation. Its principal amount, dates, charges, and documents belong to the claim.
- Receivable claim
- Titled claim
Show child attributes
Show child attributes
URL for the next page, or null when this is the last page.
"http://api.example.org/accounts/?offset=400&limit=100"
URL for the previous page, or null when this is the first page.
"http://api.example.org/accounts/?offset=200&limit=100"
