Void a bill

Voids an approved, open bill with a reason: a reversing entry is posted for every active posting entry, dated today or in the first open period, and the original stays, so the trail is whole. Send reversal_date (YYYY-MM-DD) to post the reversal on another day instead, for example the bill's own date so the bill and its reversal sit in the same period: it must be on or after the bill's date and its posting entries, not after today, and in an open period no filed VAT return covers, else it is refused with bill_void_reversal_date_before_bill, bill_void_reversal_date_future, bill_void_reversal_date_locked_period, bill_void_reversal_date_filed_vat_period or bill_void_reversal_date_financial_year (422: a bill entry in a locked period reverses inside its own financial year), each naming reversal_date in error.fields. Preview the void, with or without reversal_date, with bill.void.preview. If-Match and Idempotency-Key are required. When no forward date is possible, or the original sits in a filed VAT period, nothing is written and the answer is 422 manual_adjustment_required. Refusals name their code in error.code and at the start of the message: bill_paid_already (409: Pay bills holds the bill as paid already outside Cybooks, for example from the automatic backfill; error.fields.payment_id names the payment: take the mark back with bill.paidAlready.undoPreview, then bill.paidAlready.undo, and void again; once its bank line has arrived the message says to book it in Cybooks instead), bill_in_bank_file (409: the bill is in a bank file; put it back to To pay in Cybooks), bill_void_not_open (409: only an open, unsettled bill is voided), bill_void_active_payment and bill_void_vendor_credit (422: reverse the payment or remove the vendor credit first), bill_void_no_journal (422: no posting entry to reverse), bill_void_unbalanced_journal (422: not an exact mirror and unbalanced), bill_void_expense_claim, bill_void_opening_balance, bill_void_archived, bill_void_payment_account (409: another flow owns the bill), bill_void_registered_asset, bill_void_disposed_asset (409: a fixed asset hangs off the bill) and bill_void_changed (409: the bill changed under the void; read it and retry). being_paid on the bill says beforehand whether Pay bills holds it. Requires the bills:action OAuth scope with update_bills and void_bills.

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

Fields accepted to void a bill. The schema identifies required and optional values.

string
required
length ≤ 10000
date | null
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
*/*