BillOS v1
Console llms.txt OpenAPI
GET/businesses/{bid}/reports/vat

The VAT return figures for a period

GET /businesses/{bid}/reports/vat

Requires the export scope.

What the PCN874 file would say, without writing it: the four figures of the periodic return (taxable sales, VAT on sales, zero-rated/exempt sales, input VAT on equipment and on everything else, VAT to pay or reclaim), every entry, and the warnings.

Path parameters

NameTypeDescription
bidstringrequiredBusiness id, from POST /businesses.

Query parameters

NameTypeDescription
periodstringrequiredYYYY-MM.
monthsintegerOne of: 1, 2. Default 1.

Response

200: { "ok": true, … }

FieldTypeDescription
okbooleanrequired
reportobjectrequired
report.periodobject
report.totalsVatTotalsThe periodic VAT return in whole shekels, signed (a period of credit notes can go negative).
report.entriesarray of object
report.warningsarray of VatWarning

Errors: 400, 401, 403, 404, 429. Every failure answers { "error", "reason", "hint", "param", "doc_url", "retryable", "request_id" }: branch on reason, and read hint for what to change (https://docs.billos.co.il/errors.md).

PreviousGenerate the detailed VAT return (PCN874) NextNumbering-continuity report
On this page
Path parametersQuery parametersResponse
GET /businesses/{bid}/reports/vat 
curl -X GET "$BASE/businesses/$BID/reports/vat?period=&months=" \
  -H "X-Api-Key: $KEY"
const res = await fetch(`${BASE}/businesses/${BID}/reports/vat`, {
  method: 'GET',
  headers: {
    'X-Api-Key': KEY,
  },
})
const data = await res.json()
if (!data.ok) throw new Error(data.reason)
import requests
res = requests.get(
    f"{BASE}/businesses/{BID}/reports/vat",
    headers={"X-Api-Key": KEY},
)
data = res.json()
Set BASE to https://api.billos.co.il/v1 and KEY to your bk_live_… key, or a bk_test_… key to run it against the sandbox.
Manage your businesses, keys and webhooks in the BillOS Console.