Take back a paid-already mark

Runs "Not paid yet" on the bill exactly as the bill menu in Cybooks does: the paid-already payment is put back, the bill returns to To pay with nothing booked or reversed, and the bill's history says "Not paid yet". The bill can then be voided, corrected or paid. Send the preview's confirmation_token, the same Idempotency-Key and the bill's ETag as If-Match (the preview's etag, or bill.show). If the bill or the mark changed since the preview, or the token was previewed for another bill or mark, the answer is 412 (preview again); a token sent with another Idempotency-Key, by another person, for another company or operation, or expired is refused with bill_paid_already_undo_token_invalid, one already used with confirmation_already_claimed, and the preview's refusals apply. Returns the bill with its new ETag: use it as If-Match on bill.void. Requires the bills:action OAuth scope with update_bills.

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

Confirmed values used to take back a paid-already mark, including the confirmation token returned by bill.paidAlready.undoPreview.

"Not paid yet" on a bill marked paid already (bill.paidAlready.undo):
the preview's token, with the preview's Idempotency-Key and the bill's
If-Match.

string
required
length ≤ 8192
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
*/*