Retrieve an accounting book

Operation ID: getBook

Group: Accounting › Books

Open in the interactive reference

GET /accounting/books/{id}

Read-only: Reads and returns; changes nothing.

Retrieves an accounting book.

Parameters

Name In Type Required Description
Api-Version header string · v1 yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.
id path string yes The unique identifier for the accounting book to return.

Response

200 Success

Under data (getBookOutput):

Field Type Required Description
id string yes The unique identifier for the accounting book.
name string yes The display name of the accounting book.
type string yes The kind of accounting book. Possible values: 'full', 'adjustment'. An adjustment book adjusts the full book named in baseBookId.
accountingStandard string no The accounting standard the book follows, for example 'IFRS' or 'US GAAP'. Absent when none is set.
consolidation boolean yes Whether the book consolidates other books or entities.
description string no A free-form description of the accounting book. Absent when none is set.
baseBookId string no The full book this adjustment book adjusts. Absent for a full book. See id on GET accounting/books/:id.
lastModifiedDate date-time yes The date and time the accounting book record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. 
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "<name>",
    "type": "<type>",
    "accountingStandard": "<accountingStandard>",
    "consolidation": true,
    "description": "<description>",
    "baseBookId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "lastModifiedDate": "2026-01-15T09:30:00.000Z"
  },
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

Errors

Code Status
NOT_FOUND 400

Statuses