Goods & Services Tax Report

Goods & Services Tax Report is a financial document that details the collection and payment of GST within a specific reporting period.

Get All Goods & Services Tax Reports

To get all goods & services tax reports, make a GET request to the /api/v3/reports/tax-reports?startdate&enddate endpoint. Sample request using axios:

js
const response = await axios.get(
  "/api/v3/reports/tax-reports?startdate&enddate"
);

Where <startdate> is the start date and <enddate> is the end date of the good and services tax reports list

Sample Response object:

json
{
  "tax_report": [
    {
      "id": 1,
      "user_id": 1,
      "business_id": 1,
      "name": "NHIL",
      "display_name": "NHIL 2",
      "description": "null",
      "code": "null",
      "rate": 2.5,
      "type": "Simple",
      "recoverable": 0,
      "show_code": 0,
      "created_at": "2020-03-05 01:42:57",
      "updated_at": "2020-03-05 01:42:57",
      "account_id": 42,
      "deleted_at": null,
      "parent_taxID": 3,
      "sub_rate": 0,
      "invoice_sales": 0,
      "direct_sales": 0,
      "purchases": 0,
      "total_sales": 0,
      "tax_onSales": 0,
      "tax_onPurchases": 0,
      "net_owing": 0
    },
    {
      "id": 2,
      "user_id": 1,
      "business_id": 1,
      "name": "GETFUND",
      "display_name": "GETFUND",
      "description": null,
      "code": null,
      "rate": 2.5,
      "type": "Simple",
      "recoverable": 0,
      "show_code": 0,
      "created_at": "2020-03-05 01:42:57",
      "updated_at": "2020-03-05 01:42:57",
      "account_id": 43,
      "deleted_at": null,
      "parent_taxID": 3,
      "sub_rate": 0,
      "invoice_sales": 0,
      "direct_sales": 0,
      "purchases": 0,
      "total_sales": 0,
      "tax_onSales": 0,
      "tax_onPurchases": 0,
      "net_owing": 0
    },
    {
      "id": 4266,
      "user_id": 1,
      "business_id": 1,
      "name": "NHIL",
      "display_name": "NHIL",
      "description": null,
      "code": null,
      "rate": 2.5,
      "type": "Simple",
      "recoverable": 0,
      "show_code": 0,
      "created_at": "2021-05-01 01:22:40",
      "updated_at": "2021-05-01 01:22:40",
      "account_id": 65346,
      "deleted_at": null,
      "parent_taxID": 4265,
      "sub_rate": 0,
      "invoice_sales": 0,
      "direct_sales": 0,
      "purchases": 0,
      "total_sales": 0,
      "tax_onSales": 0,
      "tax_onPurchases": 0,
      "net_owing": 0
    }
  ]
}

Get a Single Goods & Services Tax Report

Sample axios request to get a single goods & services tax report

js
const response = axios.get("/api/v3/reports/tax-reports/:id?startdate&enddate");

<startdate> is the start date of the goods & services tax report
<enddate> is the end date of the goods & services tax report
id is the id of the goods & services tax report

Filtering of Goods & Services Tax Report

To filter a goods & services tax report, select starting date, and end date then make a POST request to the /gettaxreport/filter/id?from=<start_date>&to=<end_date> endpoint. Sample request using axios:

js
const response = await axios.post(
  "/api/v3/reports/tax-reports/filter/:id?startdate&enddate>",
  {
    id: 12345, // Represents the id of the balance sheet
    startdate: "2024-11-01", // Represents the start date of the balance sheet
    enddate: "2024-11-30", // Represents the end date of the balance sheet
  },
  {
    headers: {
      accept: "application/json",
      authorization: "Bearer <API-KEY>",
      "content-type": "application/json",
    },
  }
);

The Response object returned is the same as the one for getting all balancce sheets