VAT Return Summary

GEThttps://app.speybooks.com/api/v1/reports/vat

VAT return data for a period. Computes output VAT (on revenue) and input VAT (on expenses) from transaction lines with non-zero VAT rates.

The response includes:

  • breakdown: per-rate net and VAT amounts, split by output (revenue) and input (expenses). This is the data needed to render a detailed VAT rate table.
  • vatLiabilityMovement: movement on the VAT Liability control account (2202) for the period.
  • boxes: standard HMRC boxes 1 to 9 mapping. Boxes 1, 3, 4, and 5 are computed; boxes 2, 6, 7, 8, and 9 are returned as 0 (not currently populated).

The payable flag is true when net VAT is positive (owe HMRC). The reclaimable flag is true when net VAT is negative (refund due).

All amounts are in minor units (pence).

Query parameters

fromstringrequired
date
tostringrequired
date

Response

200Default Response
Show response fields
boxesobject
Show child attributes
box1integer
box2integer
box3integer
box4integer
box5integer
box6integer
box7integer
box8integer
box9integer
breakdownarray<object>
Show child attributes
netAmountinteger
rateinteger
typestring
vatAmountinteger
inputVatinteger
netVatinteger
outputVatinteger
payableboolean
periodobject
Show child attributes
fromstring
tostring
reclaimableboolean
vatLiabilityMovementinteger