Report on VAT by month

Admin and branch manager. Returns monthly rated turnover, VAT collected, and gross total. Rows are sorted newest month first, and a branch_id scopes the figures to one branch.

GET/api/v1/reports/vat

Authorization

AuthorizationBearer token (JWT) · headerrequired

JWT from POST /api/v1/auth/login sent as Authorization Bearer.

Query parameters

from_datestring

First day of the window, YYYY-MM-DD. Defaults to thirty days ago.

to_datestring

Last day of the window, YYYY-MM-DD. Defaults to today.

branch_idstring

Scope the report to one branch. Empty reports every branch together.

Responses

200

The VAT report

from_datestringrequired

to_datestringrequired

rowsobject[]required

Show properties

Array of object

monthstringrequired

taxable_0stringrequired

taxable_18stringrequired

taxable_15stringrequired

vat_collectedstringrequired

grand_totalstringrequired

400

from_date or to_date is not a valid YYYY-MM-DD date, or from_date is after to_date

detailstringrequired

401

Not authenticated

detailstringrequired

403

Caller is not an admin, branch manager, or auditor

detailstringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Parameters

from_datequeryFirst day of the window, YYYY-MM-DD. Defaults to thirty days ago.to_datequeryLast day of the window, YYYY-MM-DD. Defaults to today.branch_idqueryScope the report to one branch. Empty reports every branch together.

Request

curl -X GET 'http://localhost:8000/api/v1/reports/vat' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch("http://localhost:8000/api/v1/reports/vat", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "http://localhost:8000/api/v1/reports/vat",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "from_date": "string",
  "to_date": "string",
  "rows": [
    {
      "month": "string",
      "taxable_0": "string",
      "taxable_18": "string",
      "taxable_15": "string",
      "vat_collected": "string",
      "grand_total": "string"
    }
  ]
}

{
  "detail": "string"
}

{
  "detail": "string"
}

{
  "detail": "string"
}