TaxesUpdate a tax code

Update a tax code

PATCH/firm-partners/workspace/taxes/{uuid}

Renames, re-rates, describes, or switches a tax code on or off.

Send only the fields that change. Renaming a code renames its liability account. A rate cannot change once the code has been posted to the ledger. A system code (`editable: false`) keeps its name and rate, and a US sales tax code that is the rate for a customer job site cannot be switched off.

HMAC signature only

Headers

count-workspace-iduuidrequired

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.

Path parameters

uuiduuidrequired

The tax UUID, the `id` from List tax codes.

Request body

namestring

New display name.

percentagestring

New rate, zero or more, as a number or an unsigned numeric string.

descriptionstring

New description, or null to clear it.

enabledboolean

`false` stops the code being offered on new lines; `true` turns it back on.

Responses

200The updated tax code.
400Empty body or invalid field; renaming or re-rating a system code; changing the rate of a code already posted to the ledger; or switching off a sales tax code a customer job site uses.
401Missing signing headers, an invalid HMAC signature, or a timestamp more than 5 minutes off. Troubleshoot
403The 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. Troubleshoot
404No tax code with that UUID in the workspace, or it has been deleted.
429Rate limit exceeded (100 requests per minute per firm user of each app, or 10,000 per minute per app). Troubleshoot
PATCHhttps://api.getcount.com/firm-partners/workspace/taxes/{uuid}
Request
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/taxes/3f6c2a1e-8b4d-4e7a-9c2f-1d5e8a7b6c40';
const timestamp = Math.floor(Date.now() / 1000).toString();
const body = {
  "name": "GST (standard)",
  "enabled": true
};
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/taxes/3f6c2a1e-8b4d-4e7a-9c2f-1d5e8a7b6c40`, {
  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
{
  "status": "success",
  "message": "Success on update tax",
  "data": {
    "tax": {
      "id": "3f6c2a1e-8b4d-4e7a-9c2f-1d5e8a7b6c40",
      "name": "CA Sales Tax (state)",
      "percentage": "7.2500",
      "type": "Sales Tax",
      "description": "California state sales tax",
      "enabled": true,
      "editable": true,
      "systemCreated": false,
      "country": "US",
      "state": "CA",
      "county": null,
      "city": null,
      "zipCode": null,
      "locationCode": null
    }
  }
}