BudgetsUpdate budget metadata

Update budget metadata

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

Updates budget metadata. Rejected when the budget is published or locked.

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

Request body

namestring

Updated name.

startPerioddate

Updated start period.

cadenceenum

Updated cadence.

One of: monthly, yearly

actualPeriodsinteger

Updated actual period count.

budgetPeriodsinteger

Updated budget period count.

isOverallboolean

Promote to Overall Budget when allowed.

Responses

200Budget updated.
400Budget is published, locked, or validation failed.
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
404Budget not found.
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/budgets/{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/budgets/3fa85f64-5717-4562-b3fc-2c963f66afa6';
const timestamp = Math.floor(Date.now() / 1000).toString();
const body = {
  "name": "FY 2026 Operating Budget — Revised"
};
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/budgets/3fa85f64-5717-4562-b3fc-2c963f66afa6`, {
  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 updating budget",
  "data": {
    "budget": {
      "id": "55667788-99aa-bbcc-ddee-ff0011223344",
      "name": "FY 2026 Operating Budget",
      "startPeriod": "2026-01-01",
      "cadence": "monthly",
      "actualPeriods": 3,
      "budgetPeriods": 12,
      "currencyCode": "USD",
      "status": "draft",
      "lockedAt": null,
      "isOverall": false,
      "versions": [
        {
          "versionNumber": 1,
          "label": "Initial",
          "isPublished": false,
          "createdAt": "2026-01-15T10:30:00.000Z"
        }
      ],
      "createdAt": "2026-01-15T10:30:00.000Z",
      "updatedAt": "2026-01-28T14:22:30.000Z"
    }
  }
}