Preview voiding a bill

Shows what bill.void would post, without writing anything and without a confirmation token: state ready with the reversing lines per account (lines, base currency), the date of the bill entry it undoes (original_date) and the day the reversal posts on (reversal_date: today, the first open day when a lock runs past today, or the reversal_date you send); manual when a void would write nothing and answer manual_adjustment_required (manual_reason filed_vat_period when the bill sits in a filed VAT period); or, for a voided bill, voided with the reversal it posted. For ready, vat_boxes lists the VAT return boxes the void moves, per box and VAT period (period_start, period_end, vat_return_status: each return covering the bill's posting entry, so two overlapping returns each list it, null when none does): from (what the bill puts in the box now, euros; VAT for boxes 1, 2 and 4, the net for the others), to (0.00) and change. The return leaves a voided bill out of its own period, so the reversal's date moves no box; [] when no box counts the bill, and for manual and voided; null when the VAT return cannot read the bill. Send the same reversal_date you will send to bill.void: it is checked the same way and refused with the same codes (bill_void_reversal_date_before_bill, bill_void_reversal_date_future, bill_void_reversal_date_locked_period, bill_void_reversal_date_filed_vat_period, bill_void_reversal_date_financial_year), as are the void's own refusals (bill_void_not_open, bill_paid_already, bill_in_bank_file, bill_void_active_payment, ...). Returns the bill's etag: send it as If-Match on bill.void. 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

Proposed values used to preview voiding a bill without persisting changes.

Previewing a void (bill.void.preview): optionally the day the reversal
would post on. Writes nothing and issues no token.

date | null

The day the reversal would post on (YYYY-MM-DD), as bill.void takes it. Leave it out to see the default: today, or the first open day when a lock runs past today.

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