---
title: "Update workspace GST settings · Workspace · Practice Manager API · COUNT Partner API"
description: "Updates one or more GST settings on the workspace. PATCH /firm-partners/workspace/workspace/gst-settings"
canonical: "https://developers.getcount.com/practice-manager/reference/workspace/update-workspace-gst-settings"
source: "https://developers.getcount.com/practice-manager/reference/workspace/update-workspace-gst-settings"
---
[Workspace](https://developers.getcount.com/practice-manager/reference/workspace) / Update workspace GST settings

# Update workspace GST settings

PATCH `/firm-partners/workspace/workspace/gst-settings`

Updates one or more GST settings on the workspace.

A partial update — send only what you want to change, but send at least one field. The body is strict: an unrecognised key is rejected rather than ignored. `filingFrequency` and `accountingBasis` are matched case-insensitively. This route additionally requires the consenting user to hold the `manage_settings` permission in the workspace, and returns 403 when they do not.

HMAC signature only

[Opening Balance](https://developers.getcount.com/practice-manager/reference/opening-balance) [Workspace Stats](https://developers.getcount.com/practice-manager/reference/workspace-stats)

#### Headers

`count-workspace-id` uuid required

UUID 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.

#### Request body

`enabled` boolean

Whether GST is enabled for the workspace.

`irdNumber` string

IRD number, 50 characters or fewer. Never validated for format. Pass an empty string or null to clear it.

`filingFrequency` enum

How often the workspace files a GST return.

One of: `monthly`, `2-monthly`, `6-monthly`

`accountingBasis` enum

Whether GST is accounted for when invoiced or when paid. Cannot be changed once the workspace has filed a return.

One of: `invoice`, `payments`

#### Responses

`200` The full GST settings after the patch is applied.

`400` Empty body, an unrecognised key, an invalid filingFrequency or accountingBasis, or an irdNumber over 50 characters.

`401` Missing signing headers, an invalid HMAC signature, or a timestamp more than 5 minutes off. [Troubleshoot](https://developers.getcount.com/practice-manager/authentication#errors)

`403` The consenting user does not hold the manage_settings permission in this workspace. [Troubleshoot](https://developers.getcount.com/practice-manager/authentication#errors)

`404` No workspace exists with the `count-workspace-id` UUID.

`409` The GST accounting basis cannot be changed once returns have been filed — filed periods were snapshotted on the previous basis.

`429` Rate limit exceeded (100 requests per minute per firm user of each app, or 10,000 per minute per app). [Troubleshoot](https://developers.getcount.com/practice-manager/authentication#errors)

[Previous GET Get workspace GST settings](https://developers.getcount.com/practice-manager/reference/workspace/get-workspace-gst-settings)

PATCH `https://api.getcount.com/firm-partners/workspace/workspace/gst-settings`

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 method = 'PATCH';
const signingPath = '/workspace/workspace/gst-settings';
const timestamp = Math.floor(Date.now() / 1000).toString();
const body = {
  "enabled": true,
  "filingFrequency": "2-monthly",
  "accountingBasis": "invoice",
  "irdNumber": "123-456-789"
};
const bodyString = JSON.stringify(body);

const bodyHash = crypto.createHash('sha256').update(bodyString).digest('hex');
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/workspace/gst-settings`, {
  method,
  headers: {
    'x-client-id': CLIENT_ID,
    'x-timestamp': timestamp,
    'x-signature': signature,
    'Content-Type': 'application/json',
    'count-workspace-id': '5e4d3c2b-1a09-4f8e-8d7c-6b5a49382716',
  },
  body: bodyString,
});

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

Response · 200

```json
{
  "status": "success",
  "message": "Workspace GST settings updated successfully.",
  "data": {
    "gstSettings": {
      "enabled": true,
      "irdNumber": "123-456-789",
      "filingFrequency": "2-monthly",
      "accountingBasis": "invoice",
      "taxRegime": "NZ_GST",
      "accountingBasisLocked": false
    }
  }
}
```
