DocumentsUpdate document

Update document

PUT/firm-partners/workspace/documents/{uuid}

Renames a document, sets its type and period, and links it to a vendor, customer, person or project.

Send only the fields you want to change; anything left out stays as it is. Every field is checked before anything is written, so a refused value leaves the document unchanged. A type or period set here is recorded as a person's choice (`documentTypeSource` / `periodSource: "person"`), so COUNT's AI classifier never overwrites it, including a cleared one.

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

Document UUID.

Request body

newFileNamestring

New name for the file, including its extension, e.g. `Lease 2026.pdf`. Up to 255 characters, and none of `\ / : * ? " < > | $`. The file stays in its folder. A blank value leaves the name unchanged.

documentTypeUuiduuid

A document type UUID from GET /firm-partners/workspace/document-types, or null to clear the type.

periodStartDatedate

First day of the period the document covers (YYYY-MM-DD), or null. Send together with `periodEndDate`.

periodEndDatedate

Last day of the period (YYYY-MM-DD), or null. Send together with `periodStartDate`; must be on or after it.

vendorUuiduuid

Vendor UUID to link, or null to unlink.

customerUuiduuid

Customer UUID to link, or null to unlink.

personUuiduuid

Person UUID to link, or null to unlink.

projectUuiduuid

Project UUID to link, or null to unlink.

Responses

200The updated document.
400`newFileName` has a character that is not allowed or is too long, another file in the folder already has that name, `documentTypeUuid` is not a string or null, only one of the period dates was sent, a date is not a valid YYYY-MM-DD date, or the start is after the end.
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
404Document not found, a linked vendor, customer, person or project is not in this workspace, or `documentTypeUuid` is not a type this workspace can use. Also returned when the update sets a type or period on a signed payroll or tax form and the token is not the owner's or payroll admin's.
409The file was moved while it was being renamed. Fetch it again and retry.
429Rate limit exceeded (100 requests per minute per firm user of each app, or 10,000 per minute per app). Troubleshoot
PUThttps://api.getcount.com/firm-partners/workspace/documents/{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 = 'PUT';
const signingPath = '/workspace/documents/d9e0f1a2-b3c4-5678-def0-890123456789';
const timestamp = Math.floor(Date.now() / 1000).toString();
const body = {
  "newFileName": "Office Lease 2026.pdf",
  "documentTypeUuid": "b96cbac4-95f8-46cd-b0d7-a9ab92299ce0",
  "periodStartDate": "2026-04-01",
  "periodEndDate": "2027-03-31",
  "customerUuid": "dfa3219e-6af8-4c53-997a-037534f63a35"
};
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/documents/d9e0f1a2-b3c4-5678-def0-890123456789`, {
  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 document",
  "data": {
    "id": "d9e0f1a2-b3c4-5678-def0-890123456789",
    "fileName": "Office Lease 2026.pdf",
    "originalFileName": "contract-acme-2026.pdf",
    "isPasswordProtected": false,
    "isPrivate": false,
    "vendor": null,
    "customer": {
      "id": "dfa3219e-6af8-4c53-997a-037534f63a35",
      "customer": "Acme Corporation"
    },
    "person": null,
    "project": null,
    "documentType": {
      "id": "b96cbac4-95f8-46cd-b0d7-a9ab92299ce0",
      "code": "contract",
      "name": "Contract",
      "documentTypeGroup": {
        "id": "a11040f7-ecda-43ee-917d-21c83ef278c0",
        "code": "legal_and_corporate",
        "name": "Legal and Corporate"
      }
    },
    "documentTypeSource": "person",
    "periodStartDate": "2026-04-01",
    "periodEndDate": "2027-03-31",
    "periodSource": "person",
    "uploadedBy": {
      "id": "6b7c8d9e-0f1a-4b2c-9d3e-4f5a6b7c8d9e",
      "firstName": "Jane",
      "lastName": "Smith"
    },
    "createdAt": "2026-03-01T09:00:00.000Z",
    "updatedAt": "2026-03-01T09:00:00.000Z"
  }
}