Preview report

Preview report in the credential-bound company. This preview validates and describes the proposed effects without writing changes. Idempotency-Key is required and stores the terminal response for safe retries for 24 hours. Requires the manual-journals:action OAuth scope.

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 report without persisting changes.

A VAT return box adjustment as the VAT return page's "Adjust" takes it:
the box, the amount it adds (negative lowers the box), the reason, and the
account the entry books against the VAT control account.

string
enum
required

The box, e.g. box-4. Box 3 and Box 5 follow from the others.

number
required

What the adjustment adds to or takes off the box, in euros; negative lowers it. It replaces the box's earlier adjustment on this return. Not zero. Whole euros for Box 6 to Box 11B.

string
required
length between 3 and 500

Why the box is adjusted; shown in the journal and the box's history.

string | null

The account the entry debits, credited for a negative amount (VAT control takes the other side); required without account_code.

string | null

The account's code; required without account_id.

string | null

The tax rule on the account's line. Default: the company's No VAT rule.

string | null

The tax rule's code, instead of tax_rule_id.

Headers
string
required
length ≤ 191

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

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