List orders
import requests
url = "https://api.paywise.de/v2/orders/"
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/orders/', 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/orders/")
.header("Authorization", "Bearer <token>")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.paywise.de/v2/orders/");
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/orders/ \
--header 'Authorization: Bearer <token>'{
"count": 123,
"results": [
{
"additional_debtors": [
{
"acting_as": "consumer",
"events": [
{
"description": "<string>",
"location": "<string>",
"occurence": "2023-11-07T05:31:56Z",
"title": "<string>",
"type": "<string>",
"your_reference": "<string>"
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"legal_form": "<string>",
"metadata": [
{
"type": "<string>",
"value": "<string>"
}
],
"organization": {
"commercial_register": "<string>",
"commercial_registration_number": "<string>",
"name": "<string>"
},
"person": {
"birth_date": "2023-12-25",
"first_name": "<string>",
"last_name": "<string>",
"salutation": "mr"
},
"your_reference": "<string>"
}
],
"claims": [
{
"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>"
}
],
"confirmation_email": "[email protected]",
"created_at": "2023-11-07T05:31:56Z",
"creditor_obligation_fulfilled": true,
"debtor": {
"acting_as": "consumer",
"events": [
{
"description": "<string>",
"location": "<string>",
"occurence": "2023-11-07T05:31:56Z",
"title": "<string>",
"type": "<string>",
"your_reference": "<string>"
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"legal_form": "<string>",
"metadata": [
{
"type": "<string>",
"value": "<string>"
}
],
"organization": {
"commercial_register": "<string>",
"commercial_registration_number": "<string>",
"name": "<string>"
},
"person": {
"birth_date": "2023-12-25",
"first_name": "<string>",
"last_name": "<string>",
"salutation": "mr"
},
"your_reference": "<string>"
},
"expires_at": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mandate": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"merged_into": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"rejection": {
"code": "<string>",
"notified_to": [
"[email protected]"
],
"reason": "<string>",
"rejected_at": "2023-11-07T05:31:56Z"
},
"starting_approach": "extrajudicial",
"status": "draft",
"totals": {
"charges": {
"currency": "EUR",
"value": "<string>"
},
"main_claims": {
"currency": "EUR",
"value": "<string>"
},
"order_value": {
"currency": "EUR",
"value": "<string>"
},
"payments": {
"currency": "EUR",
"value": "<string>"
}
},
"type": "invoice",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"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>"
}
]
}Orders
List orders
The collection orders of your company.
Create a draft with a referenced debtor and embedded claims, edit it while it is a draft, finalize it for review, and follow it to acceptance. Tenant-scoped by the authenticated company.
GET
/
v2
/
orders
/
List orders
import requests
url = "https://api.paywise.de/v2/orders/"
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/orders/', 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/orders/")
.header("Authorization", "Bearer <token>")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.paywise.de/v2/orders/");
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/orders/ \
--header 'Authorization: Bearer <token>'{
"count": 123,
"results": [
{
"additional_debtors": [
{
"acting_as": "consumer",
"events": [
{
"description": "<string>",
"location": "<string>",
"occurence": "2023-11-07T05:31:56Z",
"title": "<string>",
"type": "<string>",
"your_reference": "<string>"
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"legal_form": "<string>",
"metadata": [
{
"type": "<string>",
"value": "<string>"
}
],
"organization": {
"commercial_register": "<string>",
"commercial_registration_number": "<string>",
"name": "<string>"
},
"person": {
"birth_date": "2023-12-25",
"first_name": "<string>",
"last_name": "<string>",
"salutation": "mr"
},
"your_reference": "<string>"
}
],
"claims": [
{
"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>"
}
],
"confirmation_email": "[email protected]",
"created_at": "2023-11-07T05:31:56Z",
"creditor_obligation_fulfilled": true,
"debtor": {
"acting_as": "consumer",
"events": [
{
"description": "<string>",
"location": "<string>",
"occurence": "2023-11-07T05:31:56Z",
"title": "<string>",
"type": "<string>",
"your_reference": "<string>"
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"legal_form": "<string>",
"metadata": [
{
"type": "<string>",
"value": "<string>"
}
],
"organization": {
"commercial_register": "<string>",
"commercial_registration_number": "<string>",
"name": "<string>"
},
"person": {
"birth_date": "2023-12-25",
"first_name": "<string>",
"last_name": "<string>",
"salutation": "mr"
},
"your_reference": "<string>"
},
"expires_at": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mandate": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"merged_into": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"rejection": {
"code": "<string>",
"notified_to": [
"[email protected]"
],
"reason": "<string>",
"rejected_at": "2023-11-07T05:31:56Z"
},
"starting_approach": "extrajudicial",
"status": "draft",
"totals": {
"charges": {
"currency": "EUR",
"value": "<string>"
},
"main_claims": {
"currency": "EUR",
"value": "<string>"
},
"order_value": {
"currency": "EUR",
"value": "<string>"
},
"payments": {
"currency": "EUR",
"value": "<string>"
}
},
"type": "invoice",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"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
caseBearerAuthpartnerBearerAuth
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
Created at or after this timestamp (inclusive).
Created at or before this timestamp (inclusive).
Number of results to return (maximum 100).
Required range:
1 <= x <= 100Zero-based result offset.
Required range:
x >= 0Comma-separated sort fields: debtor name, created, total claim amount, or public order status. Prefix a field with - for descending order. Defaults to -created; updated_since uses its synchronization order instead.
A UUID matches the order or its debtor. Otherwise searches debtor names, claim references, document references, and claim subject matter by case-insensitive substring.
Exact public order status, including drafts whose expiry time has passed.
Available options:
accepted, awaiting_client_response, draft, expired, merged, rejected, submitted, withdrawn Exact order variant: invoice, rental, or titled.
Available options:
invoice, rental, titled 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.
Example:
123
Resources returned for the requested page.
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.
- Invoice order
- Rental order
- Titled order
Show child attributes
Show child attributes
URL for the next page, or null when this is the last page.
Example:
"http://api.example.org/accounts/?offset=400&limit=100"
URL for the previous page, or null when this is the first page.
Example:
"http://api.example.org/accounts/?offset=200&limit=100"