Preview taking back a paid-already mark

Shows what "Not paid yet" would take back on a bill that Pay bills holds as paid already outside Cybooks (a person's mark, or the automatic backfill's), without writing anything: the payment (id, state, the day it was marked paid, amount, currency, source, the account), the bill, and after: the bill is back in To pay (being_paid null), the payment is put back, and no journal entry is written or reversed (the mark never reached the ledger, so no period lock applies). Returns the bill's etag and the confirmation_token bill.paidAlready.undo needs. Only a mark still waiting for its bank line (waiting or not_seen) is taken back. Refusals name their code in error.code and at the start of the message: bill_paid_already_undo_not_marked (no mark holds the bill), bill_in_bank_file (a bank file holds it, not a mark: put it back to To pay in Cybooks), bill_paid_already_undo_line_found (its bank line arrived and waits for a person in Banking), bill_paid_already_undo_settling (its bank line is being booked now: read the bill again in a few minutes), bill_paid_already_undo_settled (the bill was settled, by its line or another way: undo that payment instead). A support seat is refused (403). Requires Idempotency-Key (send the same key on the commit) and 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

Proposed values used to preview taking back a paid-already mark without persisting changes.

Previewing "Not paid yet" on a bill marked paid already
(bill.paidAlready.undoPreview): no body; the bill is the path's, and the
payment is the one that holds it. A confirmation token is refused here.

Headers
string
required
length ≤ 191

Required operation-specific request key. This requirement does not imply durable public API response replay.

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
*/*