BudgetsCreate budget

Create budget

POST/firm-partners/workspace/budgets

Creates a budget and its initial version.

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.

Request body

namestringrequired

Unique budget name (among non-archived budgets).

startPerioddaterequired

First period start date (ISO).

cadenceenumrequired

Period cadence.

One of: monthly, yearly

actualPeriodsintegerrequired

Historical actual periods (0 or greater).

budgetPeriodsintegerrequired

Forward budget periods (minimum 1).

currencyCodestring

ISO 4217 currency. Defaults to USD.

isOverallboolean

Create as the workspace Overall Budget.

Responses

201Budget and initial version created.
400Validation failed or duplicate budget name.
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 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). Troubleshoot
POSThttps://api.getcount.com/firm-partners/workspace/budgets
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 = 'POST';
const signingPath = '/workspace/budgets';
const timestamp = Math.floor(Date.now() / 1000).toString();
const body = {
  "name": "FY 2026 Operating Budget",
  "startPeriod": "2026-01-01",
  "cadence": "monthly",
  "actualPeriods": 3,
  "budgetPeriods": 12,
  "currencyCode": "USD"
};
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`, {
  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 · 201
{
  "status": "success",
  "message": "Success on creating 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"
    },
    "version": {
      "versionNumber": 1,
      "label": "Initial",
      "isPublished": false,
      "createdAt": "2026-01-15T10:30:00.000Z"
    }
  }
}