---
title: "Get GST return · Reports · COUNT Partner API"
description: "Calculates the workspace's NZ GST return for a period. Nothing is saved or filed. GET /partners/reports/gst-return"
canonical: "https://developers.getcount.com/reference/reports/get-gst-return"
source: "https://developers.getcount.com/reference/reports/get-gst-return"
---
[Reports](https://developers.getcount.com/reference/reports) / Get GST return

# Get GST return

GET NZ· GST `/partners/reports/gst-return`

Calculates the workspace's NZ GST return for a period. Nothing is saved or filed.

Returns the figures the GST return screen shows: `GSTBoxes` (the `income` boxes 5–10, the `expense` boxes 11–14, and `netGST` as box 15), `gstReturn` (the figures that would be filed with IRD), and `reconciliation`. COUNT refuses to file a return that does not reconcile: IRD works out GST from the gross boxes (gross × 3/23), COUNT adds up the GST posted on each transaction, and when `reconciliation.consistent` is false (`difference` beyond `tolerance`, $5.00) filing is blocked. `reconciliation.sectionComparisons.sales` and `.purchases` show which side carries the gap; read that side with the GST audit report. NZ workspaces only.

HMAC signature + Bearer access token

[Try this request](https://developers.getcount.com/tools/try-it?method=GET&path=%2Fpartners%2Freports%2Fgst-return)

[Chart of Accounts API](https://developers.getcount.com/reference/chart-of-accounts) [Tags API](https://developers.getcount.com/reference/tags) [Workspace Stats API](https://developers.getcount.com/reference/workspace-stats) [Fixed Assets API](https://developers.getcount.com/reference/fixed-assets)

#### Query parameters

`periodEndDate` date required

YYYY-MM-DD, the last day of the GST period.

`periodStartDate` date optional

YYYY-MM-DD. Defaults to the start of the period the workspace's filing frequency gives. Must be on or before `periodEndDate`.

`incomeAdjustment` string optional

Box 9 adjustment as a decimal string with at most two places, e.g. `"125.50"`. Defaults to 0.

`expenseAdjustment` string optional

Box 13 adjustment as a decimal string with at most two places. Defaults to 0.

#### Responses

`200` The calculated return.

`400` The workspace is not in New Zealand, a date is not YYYY-MM-DD, `periodStartDate` is after `periodEndDate`, or an adjustment is not a decimal with at most two places.

`401` Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token. [Troubleshoot](https://developers.getcount.com/getting-started/errors#error-401)

`403` The credential does not have access to this workspace or resource. [Troubleshoot](https://developers.getcount.com/getting-started/errors#error-403)

`429` Rate limit exceeded (100 requests per minute per user of each app, or 10,000 per minute per app). Retry after the Retry-After header. [Troubleshoot](https://developers.getcount.com/getting-started/errors#error-429)

[Previous POST Generate cash flow forecast](https://developers.getcount.com/reference/reports/generate-cash-flow-forecast) [Next GET Get GST audit report](https://developers.getcount.com/reference/reports/get-gst-audit-report)

GET `https://api.getcount.com/partners/reports/gst-return`

Request

```javascript
import crypto from 'node:crypto';

const BASE_URL = 'https://api.getcount.com';
const CLIENT_ID = process.env.COUNT_CLIENT_ID;
const CLIENT_SECRET = process.env.COUNT_CLIENT_SECRET;
const ACCESS_TOKEN = process.env.COUNT_ACCESS_TOKEN;

const method = 'GET';
const signingPath = '/reports/gst-return';
const timestamp = Math.floor(Date.now() / 1000).toString();
const bodyString = '';

const bodyHash = '';
const baseString = `${method}:${signingPath}:${timestamp}:${bodyHash}`;
const signature = crypto.createHmac('sha256', CLIENT_SECRET).update(baseString).digest('hex');

const response = await fetch(`${BASE_URL}/partners/reports/gst-return`, {
  method,
  headers: {
    'x-client-id': CLIENT_ID,
    'x-timestamp': timestamp,
    'x-signature': signature,
    Authorization: `Bearer ${ACCESS_TOKEN}`,
  },
});

console.log(await response.json());
```

Response · 200

```json
{
  "status": "success",
  "message": "Success on calculating the GST return",
  "data": {
    "gstAccountingBasis": "invoice",
    "filingFrequency": "2-monthly",
    "startDate": "2026-02-01",
    "endDate": "2026-03-31",
    "dueDate": "2026-05-07",
    "name": "Feb 01 - 31 Mar 2026",
    "GSTBoxes": {
      "income": {
        "totalSalesAndIncome": {
          "code": "box5",
          "total": 23000
        },
        "totalZeroRatedSales": {
          "code": "box6",
          "total": 0
        },
        "totalTaxedSales": {
          "code": "box7",
          "total": 23000
        },
        "GSTBeforeAdjustment": {
          "code": "box8",
          "total": 3000
        },
        "adjustments": {
          "code": "box9",
          "total": 0
        },
        "lateClaimAdjustmentTotal": 0,
        "totalGSTAfterAdjustment": {
          "code": "box10",
          "total": 3000
        },
        "totalGSTCollectedRaw": 3000,
        "debitAdjustmentBreakdown": {
          "other": 0,
          "lateClaims": 0
        }
      },
      "expense": {
        "totalPurchaseAndExpense": {
          "code": "box11",
          "total": 11500
        },
        "GSTBeforeAdjustment": {
          "code": "box12",
          "total": 1500
        },
        "adjustments": {
          "code": "box13",
          "total": 0
        },
        "totalGSTAfterAdjustment": {
          "code": "box14",
          "total": 1500
        },
        "totalGSTCollectedRaw": 1500,
        "creditAdjustmentBreakdown": {
          "other": 0,
          "gstOnImports": 0,
          "lateClaims": 0
        }
      },
      "netGST": {
        "code": "box15",
        "total": 1500
      }
    },
    "actualCollectedNetGst": 1500,
    "reconciliation": {
      "consistent": true,
      "derivedNetGst": 1500,
      "actualCollectedNetGst": 1500,
      "difference": 0,
      "tolerance": 5,
      "sectionComparisons": {
        "sales": {
          "grossBoxCode": "box7",
          "grossTotal": 23000,
          "gstBoxCode": "box8",
          "derivedGst": 3000,
          "actualGst": 3000,
          "difference": 0
        },
        "purchases": {
          "grossBoxCode": "box11",
          "grossTotal": 11500,
          "gstBoxCode": "box12",
          "derivedGst": 1500,
          "actualGst": 1500,
          "difference": 0
        }
      }
    },
    "gstReturn": {
      "periodEndDate": "2026-03-31",
      "totalSales": 23000,
      "zeroRatedSupplies": 0,
      "totalExpenses": 11500,
      "totalGST": 1500
    }
  }
}
```
