import requests
url = "https://api.paywise.de/v2/orders/{order_id}/requests-to-client/{id}/answer/"
payload = {
"documents": [],
"text": "yes"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({documents: [], text: 'yes'})
};
fetch('https://api.paywise.de/v2/orders/{order_id}/requests-to-client/{id}/answer/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api.paywise.de/v2/orders/{order_id}/requests-to-client/{id}/answer/")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"documents\": [],\n \"text\": \"yes\"\n}")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.paywise.de/v2/orders/{order_id}/requests-to-client/{id}/answer/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Idempotency-Key", "<idempotency-key>");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"documents\": [],\n \"text\": \"yes\"\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
curl --request POST \
--url https://api.paywise.de/v2/orders/{order_id}/requests-to-client/{id}/answer/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"documents": [],
"text": "yes"
}
'{
"allowed_answer_types": "fileupload",
"answer": {
"additional_comment": "<string>",
"booking_date": "2023-12-25",
"created_at": "2023-11-07T05:31:56Z",
"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"
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"text": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
},
"answered": true,
"answered_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"href": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"order": {
"href": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"question_attachments": [
{
"download_url": "<string>",
"filename": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mime_type": "<string>"
}
],
"title": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
}{
"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>"
}
],
"translation_key": "<string>"
}{
"code": "not_found",
"detail": "The requested resource was not found."
}{
"code": "conflict",
"detail": "The resource changed state and cannot accept this command."
}{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}Answer order request to client
Published questions about one order, including orders awaiting review.
Answer once using the advertised answer type. Closed orders reject answers with 409. Review resumes after all published requests are answered. Documents become downloadable when ready. Only the authenticated company’s published requests are visible.
import requests
url = "https://api.paywise.de/v2/orders/{order_id}/requests-to-client/{id}/answer/"
payload = {
"documents": [],
"text": "yes"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({documents: [], text: 'yes'})
};
fetch('https://api.paywise.de/v2/orders/{order_id}/requests-to-client/{id}/answer/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api.paywise.de/v2/orders/{order_id}/requests-to-client/{id}/answer/")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"documents\": [],\n \"text\": \"yes\"\n}")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.paywise.de/v2/orders/{order_id}/requests-to-client/{id}/answer/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Idempotency-Key", "<idempotency-key>");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"documents\": [],\n \"text\": \"yes\"\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
curl --request POST \
--url https://api.paywise.de/v2/orders/{order_id}/requests-to-client/{id}/answer/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"documents": [],
"text": "yes"
}
'{
"allowed_answer_types": "fileupload",
"answer": {
"additional_comment": "<string>",
"booking_date": "2023-12-25",
"created_at": "2023-11-07T05:31:56Z",
"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"
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"text": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
},
"answered": true,
"answered_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"href": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"order": {
"href": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"question_attachments": [
{
"download_url": "<string>",
"filename": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mime_type": "<string>"
}
],
"title": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
}{
"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>"
}
],
"translation_key": "<string>"
}{
"code": "not_found",
"detail": "The requested resource was not found."
}{
"code": "conflict",
"detail": "The resource changed state and cannot accept this command."
}{
"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.
Required client-supplied command key scoped to the selected Case company or Partner owner, method, operation and path. An exact retry replays the original response while it is retained, including after credential rotation or replacement. Current permissions are required.
255Path Parameters
UUID of the client request in this request.
UUID of the parent order in this request.
Body
- Answer text
- Answer documents
Answer a published request-to-client. Supply non-empty text, at least one document, or both. Only fileupload questions accept documents without text; other question types require text and may also require additional_comment or booking_date as described below.
Answer text. For choice-based requests use yes or no; dontknow is also accepted for yes-no-dontknow. Required for choice-based requests and freetext. For fileupload, provide non-empty text, at least one document, or both.
1 - 5000Required for "no" answers when allowed_answer_types is yes-no-freetext-on-no or yes-with-date-no-freetext-on-no. Stored as plain text: markup is removed and the value must not be empty afterwards.
5000Required for "yes" only when allowed_answer_types is yes-with-date-no-freetext-on-no; forbidden otherwise.
Documents supplied with the answer. For fileupload, provide at least one document unless non-empty text is supplied. At most 20 documents and 50 MiB of decoded document content per command. Each file is limited to 10 MiB and each PDF to 100 pages. Exceeding a limit rejects the command with 400.
20Show child attributes
Show child attributes
Response
Published order clarification, available before case acceptance.
Answer format accepted for this request.
fileupload- fileuploadfreetext- freetextyes-no- yes-noyes-no-dontknow- yes-no-dontknowyes-no-freetext-on-no- yes-no-freetext-on-noyes-with-date-no-freetext-on-no- yes-with-date-no-freetext-on-no
fileupload, freetext, yes-no, yes-no-dontknow, yes-no-freetext-on-no, yes-with-date-no-freetext-on-no Submitted answer, or null while unanswered.
Show child attributes
Show child attributes
Whether an answer has already been submitted.
Time at which the answer was submitted, when answered.
Time at which the request was created.
Question or explanation describing what paywise needs.
API URL of this client request.
Stable identifier of this client request.
Order for which paywise needs information.
Show child attributes
Show child attributes
Files paywise attached to the question.
Show child attributes
Show child attributes
Short subject of the requested information.
Time at which the request was last updated.
