Get GST return
/firm-partners/workspace/reports/gst-returnCalculates 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.
Headers
count-workspace-iduuidrequiredUUID of the client workspace to act on. It must be one of your firm's client workspaces (or the firm's own workspace) and within the API key's client workspaces.
Query parameters
periodEndDatedaterequiredYYYY-MM-DD, the last day of the GST period.
periodStartDatedateoptionalYYYY-MM-DD. Defaults to the start of the period the workspace's filing frequency gives. Must be on or before `periodEndDate`.
incomeAdjustmentstringoptionalBox 9 adjustment as a decimal string with at most two places, e.g. `"125.50"`. Defaults to 0.
expenseAdjustmentstringoptionalBox 13 adjustment as a decimal string with at most two places. Defaults to 0.
Responses
200The calculated return.400The 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.401Missing signing headers, an invalid HMAC signature, or a timestamp more than 5 minutes off. Troubleshoot403The key is inactive or its scope does not allow this request, the workspace is not managed by your firm or is outside the key's client workspaces, the workspace has no active subscription, or it is portal-only and the route needs bookkeeping. Troubleshoot404No workspace exists with the `count-workspace-id` UUID.429Rate limit exceeded (100 requests per minute per firm user of each app, or 10,000 per minute per app). Troubleshoothttps://api.getcount.com/firm-partners/workspace/reports/gst-returnimport 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 method = 'GET';
const signingPath = '/workspace/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}/firm-partners/workspace/reports/gst-return`, {
method,
headers: {
'x-client-id': CLIENT_ID,
'x-timestamp': timestamp,
'x-signature': signature,
'count-workspace-id': '5e4d3c2b-1a09-4f8e-8d7c-6b5a49382716',
},
});
console.log(await response.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
}
}
}