Skip to main content
POST
Answer order request to client

Authorizations

Authorization
string
header
required

Company-bound Case Management API key — the standard credential for this API.

Headers

X-On-Behalf-Of-Company
string<uuid>

Required when a Partner key calls the Case Management API; rejected for direct Case keys. Contains the entitled paywise company UUID.

Idempotency-Key
string
required

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.

Maximum string length: 255

Path Parameters

id
string<uuid>
required

UUID of the client request in this request.

order_id
string<uuid>
required

UUID of the parent order in this request.

Body

application/json

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.

text
string
required

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.

Required string length: 1 - 5000
additional_comment
string | null

Required 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.

Maximum string length: 5000
booking_date
string<date>

Required for "yes" only when allowed_answer_types is yes-with-date-no-freetext-on-no; forbidden otherwise.

documents
object[]

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.

Maximum array length: 20

Response

Published order clarification, available before case acceptance.

allowed_answer_types
enum<string>
required

Answer format accepted for this request.

  • fileupload - fileupload
  • freetext - freetext
  • yes-no - yes-no
  • yes-no-dontknow - yes-no-dontknow
  • yes-no-freetext-on-no - yes-no-freetext-on-no
  • yes-with-date-no-freetext-on-no - yes-with-date-no-freetext-on-no
Available options:
fileupload,
freetext,
yes-no,
yes-no-dontknow,
yes-no-freetext-on-no,
yes-with-date-no-freetext-on-no
answer
object | null
required

Submitted answer, or null while unanswered.

answered
boolean
required
read-only

Whether an answer has already been submitted.

answered_at
string<date-time> | null
required
read-only

Time at which the answer was submitted, when answered.

created_at
string<date-time>
required
read-only

Time at which the request was created.

description
string | null
required
read-only

Question or explanation describing what paywise needs.

href
string<uri>
required
read-only

API URL of this client request.

id
string<uuid>
required
read-only

Stable identifier of this client request.

order
object
required
read-only

Order for which paywise needs information.

question_attachments
object[]
required
read-only

Files paywise attached to the question.

title
string
required
read-only

Short subject of the requested information.

updated_at
string<date-time>
required
read-only

Time at which the request was last updated.