Upload a supporting document to a reimbursement line

Adds one PDF, JPEG or PNG to a line of a draft reimbursement run, its bytes sent as standard base64 in content_base64 (at most 700 KiB decoded; line breaks are ignored). The first bytes must prove the declared file_mime, and an optional sha256 must match the decoded bytes (422 otherwise). The file is stored like one uploaded in the app. For a larger file, upload it to the document inbox with an upload session and link it with reimbursementRun.lineDocument.link. Answers 201 with the document and the run's new ETag. Refusals: 404 reimbursement_line_not_found, 409 reimbursement_run_locked (the run is not a draft). Requires Idempotency-Key, If-Match with the run's ETag, and the reimbursements:write OAuth scope with manage_reimbursement.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
string
required
Body Params

Fields accepted to upload a supporting document to a reimbursement line. The schema identifies required and optional values.

string
required
length ≤ 255

As the run shows it, e.g. electricity-2027-03.pdf.

string
enum
required
Allowed:
string
required
length ≤ 955736

Standard base64, no data: prefix; at most 700 KiB decoded.

string | null
^[A-Fa-f0-9]{64}$

Hex SHA-256 of the file; refused when it does not match.

Headers
string
required
length ≤ 191

Required unique key whose request hash and terminal response are stored durably for 24 hours.

string

Required. ETag from the latest representation; a stale value returns 412 precondition_failed. Send this header, not the standard If-Match: some HTTP intermediaries evaluate a standard If-Match themselves and can answer 412 even though the change was applied. Never send both; both with different ETags returns 400 conflicting_precondition_headers.

string
deprecated

Accepted with the same value and meaning as Cybooks-If-Match, but do not send it: an intermediary can answer 412 to it after the change was applied. Send Cybooks-If-Match instead.

Responses

Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*