Get GST audit report
/firm-partners/workspace/reports/gst-audit-reportLists the transactions behind a period's NZ GST return, one page at a time.
Each row carries its gross, net, and GST amounts, the revenue or expense account, the GST account and rate, and `gstIssue`: `rateMismatch` (the GST is not `taxPercentage` of `netAmount`), `gstWithoutTaxableSupply` (GST with no income, expense, or asset line behind it, so its gross is missing from the return's boxes), or null. `summary` is totalled over every row `filter` selects across the whole period, not just this page — take whole-return figures from the GST return. When `truncated` is true, narrow `filter`, set `issuesOnly`, or page with `offset`. The first page (`offset` 0) also carries `lateClaimTransactions` (at most 200), `lateClaimSummary`, and `lateClaimTransactionsTruncated`: changes to already-filed periods that this return picks up. 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 filing frequency gives.
filterstringoptionalComma-separated groups to return: `income` (sales side), `expenses` (purchases side), `zeroRated`, `gstOnImports`, `noGst`. Omit for every row.
issuesOnlybooleanoptionalReturn only rows with a `gstIssue`. Defaults to false.
limitintegeroptionalRows per page, 1–200. Defaults to 200.
offsetintegeroptionalRows to skip. Defaults to 0.
Responses
200`transactionCount` counts the rows matching this request across the period; `gstIssueCount` counts rows with an issue among those `filter` selects.400The workspace is not in New Zealand, a date is not YYYY-MM-DD, `periodStartDate` is after `periodEndDate`, `filter` names an unknown group, `issuesOnly` is not true or false, or `limit`/`offset` is out of range.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-audit-reportimport 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-audit-report';
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-audit-report`, {
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 retrieving the GST audit report",
"data": {
"startDate": "2026-02-01",
"endDate": "2026-03-31",
"dueDate": "2026-05-07",
"gstAccountingBasis": "invoice",
"filingFrequency": "2-monthly",
"summary": {
"totalGstOnIncome": 3000,
"totalGstOnExpenses": 1500,
"totalGstOnImports": 0,
"netGst": 1500,
"totalNoGstGross": 0,
"transactionCount": 1
},
"transactionCount": 1,
"gstIssueCount": 1,
"offset": 0,
"limit": 200,
"truncated": false,
"transactions": [
{
"journalEntryLineId": "e7f8a9b0-c1d2-4e3f-8a9b-0c1d2e3f4a5b",
"journalLinkUuid": "a9b8c7d6-e5f4-3210-abcd-ef9876543210",
"date": "2026-03-04",
"description": "Office rent March",
"sourceDocumentType": "bill",
"sourceDocumentReference": "BILL-0311",
"sourceDocumentUrl": "https://app.getcount.com/bills?activeBillId=8812&wsId=341&wsName=Acme+Corp&wsCurrency=NZD&wsDateFormat=dd%2Fmm%2Fyyyy&wsIsPmOnly=false",
"transactionId": null,
"invoiceId": null,
"billId": "4f3e2d1c-0b9a-4876-a5b4-c3d2e1f0a9b8",
"journalEntryHeaderId": null,
"accountId": "3c4d5e6f-7a8b-4c9d-8e0f-2a3b4c5d6e7f",
"accountName": "Office Rent",
"gstAccountId": "5e6f7a8b-9c0d-4e1f-a2b3-c4d5e6f7a8b9",
"gstAccountName": "GST",
"taxName": "GST on Expenses",
"taxPercentage": 15,
"customerId": null,
"customerName": null,
"vendorId": "6f7a8b9c-0d1e-4f2a-b3c4-d5e6f7a8b9c0",
"vendorName": "Harbour Properties",
"projectId": null,
"projectName": null,
"grossAmount": 11500,
"netAmount": 10000,
"gstAmount": 1600,
"gstIssue": "rateMismatch"
}
],
"lateClaimSummary": {
"incomeAdjustmentTotal": 0,
"expenseAdjustmentTotal": 0,
"transactionCount": 0,
"source": "pending"
},
"lateClaimTransactions": [],
"lateClaimTransactionsTruncated": false
}
}