Lock the books through lockedThrough

PUT /books/lock

Lock the books through lockedThrough, a day that has ended in their zone (409 LockDateNotPast names the latest): what was done on or before it is final — the general ledger and the trial balance never change there again, a revaluation is never recorded into it, and what is unsent to a ledger from before it is planned on the first open day.

Forward only: a day before Manifold's own lock is 409 PeriodLocked, naming the lock date — only an owner moves it back (POST /books/unlock). Appends accounting.books-locked. Idempotent by content: the lock as it stands appends nothing.

Access

Requires books:write.

How scopes come from roles: Scopes and roles. Getting a token: Authentication and app tokens.

Retries

Idempotent by content: the lock as it stands appends nothing.

Why every write carries a key: Idempotency and retries.

Facts appended

accounting.books-locked

What a fact is: Facts and the journal.

AI agent tool

Agents call this as accounting_lock_books (Accounting: Lock books), in the accounting toolset. It is marked destructive, so the agent asks before running it.

Connecting an agent: AI agents.

Example

curl

curl -X PUT 'https://accounting.getmanifold.io/books/lock' \
  -H "Authorization: Bearer $MANIFOLD_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "lockedThrough": "2026-09-30"
}'

JavaScript (fetch)

const response = await fetch("https://accounting.getmanifold.io/books/lock", {
  method: "PUT",
  headers: { Authorization: `Bearer ${process.env.MANIFOLD_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({
    "lockedThrough": "2026-09-30"
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const answer = await response.json();

Request body · application/json

{
  "lockedThrough": "2026-09-30"
}

Response · 200 · application/json

{
  "lockedThrough": "2026-09-30",
  "firstOpenDay": "2026-10-01",
  "own": "2026-09-30",
  "ownChangedAt": "2026-10-21T04:12:00.000Z",
  "ownChangedBy": {
    "_tag": "user",
    "id": "usr_01a1588c-0e00-7a81-9b92-000000000901"
  },
  "ledgers": [
    {
      "ledgerId": "lgr_01a0f6b2-1c00-7f71-8a82-465768798a9b",
      "name": "Saltbush Homewares Pty Ltd",
      "lockedThrough": "2026-09-30"
    }
  ],
  "timeZone": "Australia/Sydney"
}

The panel writes this call in other languages. It does not send it: Manifold's APIs do not take calls from a web page on another site, so run the call from your own code or terminal. The whole API as OpenAPI: accounting-manager.openapi.json. Base URL https://accounting.getmanifold.io.

Errors

Every refusal is a status and a JSON body whose _tag names it. A refused call changes nothing.

`401`

Refusal	What it means	What to do
`Unauthorized` reason	The token is missing, expired or not one Manifold issued.	Get a fresh token and send the call again.
`TokenAlreadyUsed` tokenId	A single-use app token was already spent.	Mint a new token for this call.

`402`

Refusal	What it means	What to do
`SubscriptionRequired` status	The organization's subscription has lapsed, so writes are refused.	An owner settles billing. Reads still work meanwhile.

`403`

Refusal	What it means	What to do
`TenantRequired` userId	The token names no organization.	Choose the organization, then get a new token.
`ScopeRequired` required	The token's roles do not grant the scope this call needs.	Ask an owner or admin for a role that grants it.

`409`

Refusal	What it means	What to do
`PeriodLocked` lockedThrough, reason	The request was refused. `reason` says why.	Nothing changed. Read the record, then decide.
`LockDateNotPast` lockedThrough, latest	The request was refused, and nothing changed.	Nothing changed. Read the record, then decide.
`MirroredFromSource` source	This area is fed by your source system until the organization goes live.	Make the change in the source system, or go live first.

`503`

Refusal	What it means	What to do
`RequestLogUnavailable` tokenId, reason	The service could not record the request, so it did nothing.	Send the same request again shortly.

How refusals work everywhere: Errors.

Used in

Close the books on a year, step 2: Lock the year
Close the books on a year, step 3: A retry locks nothing twice
Close the books on a year, step 4: A lock never moves back by itself