The books' period lock

GET /books/lock

The books' period lock: Manifold's own (own, with when and by whom it last moved), each connected ledger's as its app reported it, and the one in force — lockedThrough, the latest of them — with firstOpenDay.

Nothing dated on or before lockedThrough changes in the general ledger, the trial balance or what the ledgers are sent: a posting that would land there is posted on the first open day instead, carrying originalEffectiveAt.

Access

Requires financials:read or books:read.

Any one of these scopes is enough.

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

AI agent tool

Agents call this as accounting_get_books_lock (Accounting: Period lock), in the accounting toolset. It only reads.

Connecting an agent: AI agents.

Example

curl

curl -X GET 'https://accounting.getmanifold.io/books/lock' \
  -H "Authorization: Bearer $MANIFOLD_TOKEN"

JavaScript (fetch)

const response = await fetch("https://accounting.getmanifold.io/books/lock", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.MANIFOLD_TOKEN}` },
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const answer = await response.json();

Response · 200 · application/json

{
  "lockedThrough": "2026-09-30",
  "firstOpenDay": "2026-10-01",
  "own": "2026-06-30",
  "ownChangedAt": "2026-07-14T23:05: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
`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.	Try again shortly.

How refusals work everywhere: Errors.

Used in

Close the books on a year, step 1: Nothing is locked yet
Close the books on a year, step 6: Read the lock as it stands