---
title: "Workspace · Practice Manager API · COUNT Partner API"
description: "Read and update workspace-level settings for the authenticated workspace: the bookkeeping cutover date and the workspace’s GST configuration."
canonical: "https://developers.getcount.com/practice-manager/reference/workspace"
source: "https://developers.getcount.com/practice-manager/reference/workspace"
---
Practice Manager API

# Workspace

Read and update workspace-level settings for the authenticated workspace: the bookkeeping cutover date and the workspace’s GST configuration.

Last updated 2026-09-22

## Overview

The Workspace API reads and updates workspace-level settings that are not owned by a single accounting resource: the bookkeeping `cutoverDate`, and the workspace’s GST configuration.

Everything on or before the cutover date is summarized by opening balances rather than tracked line-by-line. Read the current value from GET /firm-partners/workspace/workspace-stats (`workspace.cutoverDate`) before changing it.

GST settings drive the periods, due dates, and obligation figures the GST engine produces, so they are validated strictly at the partner boundary — an unrecognised filing frequency would otherwise be resolved silently to monthly.

## Key concepts

### Moving the cutover forward

Moving cutover later is a re-baseline guard: it rejects with 400 explaining the entry count if the workspace already has posted activity.

### Imported trial balance

Setting the cutover for the first time is rejected with 400 if the workspace already has an imported trial balance with no cutover — contact support to resolve first.

### GST settings are normalized, not echoed

Reads return the values the GST engine actually applies: a workspace that has never saved a frequency still reports `monthly`, and anything other than an exact `payments` reports the `invoice` basis. `taxRegime` is derived from the workspace country (`NZ_GST` for New Zealand, otherwise null) and is not writable.

### The accounting basis locks after the first filing

Once the workspace has filed a GST return, `accountingBasisLocked` is true and changing `accountingBasis` is refused with 409. Filed periods were snapshotted on the old basis and would stop being scanned for late claims.

## Workspace cutover update

PATCH body accepts `cutoverDate` (required).

#### Attributes

`cutoverDate` date required

YYYY-MM-DD cutover date. Moving earlier is always allowed; moving later is only allowed when the workspace has zero posted journal entries.

Example

```json
{
  "cutoverDate": "2026-03-01"
}
```

Opening balances

After setting cutover, use the Opening Balance API to publish conversion balances as of that date.

GST changes need the user’s own authority

Beyond the `workspace:write` scope, `PATCH /firm-partners/workspace/workspace/gst-settings` checks the `manage_settings` permission of the user who consented to the connection — the same capability the web settings form requires. A connection consented by a user without it gets 403 on that route while every other workspace route keeps working.

MCP equivalents

COUNT_update_workspace, COUNT_get_workspace_gst_settings, COUNT_update_workspace_gst_settings.

## Related

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

## Endpoints

[PATCH Update workspace `/firm-partners/workspace/workspace` Updates workspace settings. Currently `cutoverDate` only.](https://developers.getcount.com/practice-manager/reference/workspace/update-workspace) [GET Get workspace GST settings `/firm-partners/workspace/workspace/gst-settings` Returns the workspace’s GST configuration, normalized.](https://developers.getcount.com/practice-manager/reference/workspace/get-workspace-gst-settings) [PATCH Update workspace GST settings `/firm-partners/workspace/workspace/gst-settings` Updates one or more GST settings on the workspace.](https://developers.getcount.com/practice-manager/reference/workspace/update-workspace-gst-settings)
