COUNTCOUNT
Sign Up
DocumentsSet document period

Set document period

PUT/partners/documents/{uuid}/period

Sets or clears the period a document covers.

Send both keys every time; null clears that end of the period. The change is recorded as a person's choice (`periodSource: "person"`), so COUNT's AI classifier never overwrites it.

HMAC signature + Bearer access token
Try this request
Customers APIProjects API

Path parameters

uuiduuidrequired

Document UUID.

Request body

periodStartDatedaterequired

First day of the period (YYYY-MM-DD), or null.

periodEndDatedaterequired

Last day of the period (YYYY-MM-DD), or null. Must be on or after `periodStartDate`.

Responses

200The updated document.
400A key is missing, a date is not a valid YYYY-MM-DD date, the start is after the end, or the body has other keys.
404Document not found. Also returned for a signed payroll or tax form when the token is not the owner's or payroll admin's.
401Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token. Troubleshoot
403The credential does not have access to this workspace or resource. Troubleshoot
429Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header. Troubleshoot
PUThttps://api.getcount.com/partners/documents/{uuid}/period
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 ACCESS_TOKEN = process.env.COUNT_ACCESS_TOKEN;

const method = 'PUT';
const signingPath = '/documents/d9e0f1a2-b3c4-5678-def0-890123456789/period';
const timestamp = Math.floor(Date.now() / 1000).toString();
const body = {
  "periodStartDate": "2026-04-01",
  "periodEndDate": "2027-03-31"
};
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}/partners/documents/d9e0f1a2-b3c4-5678-def0-890123456789/period`, {
  method,
  headers: {
    'x-client-id': CLIENT_ID,
    'x-timestamp': timestamp,
    'x-signature': signature,
    'Content-Type': 'application/json',
    Authorization: `Bearer ${ACCESS_TOKEN}`,
  },
  body: bodyString,
});

console.log(await response.json());
Response · 200
{
  "status": "success",
  "message": "Success on updating document period",
  "data": {
    "id": "d9e0f1a2-b3c4-5678-def0-890123456789",
    "fileName": "contract-acme-2026.pdf",
    "folderPath": "Contracts",
    "mimeType": "application/pdf",
    "fileSize": 245760,
    "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": "ai",
    "periodStartDate": "2026-04-01",
    "periodEndDate": "2027-03-31",
    "periodSource": "person",
    "createdAt": "2026-03-01T09:00:00.000Z",
    "updatedAt": "2026-03-01T09:00:00.000Z"
  }
}