Returns a list of accounting books.
GET /accounting/books
Group: Accounting › Books · Operation ID: books
Open in the interactive reference
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
Api-Version |
header | "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. |
Query surface
id— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, liketype— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likeaccountingStandard— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likeconsolidation— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likebaseBookId— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likelastModifiedDate— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like- Orderable: id, name, type, accountingStandard, consolidation, lastModifiedDate
- Selectable: id, name, type, accountingStandard, consolidation, description, baseBookId, lastModifiedDate
Response
200 Success
Under data, an array of booksRow:
| Field | Type | Required | Description |
|---|---|---|---|
id |
string | no | The unique identifier for the accounting book. |
name |
string | no | The display name of the accounting book. |
type |
string | no | The kind of accounting book. Possible values: 'full', 'adjustment'. An adjustment book adjusts the full book named in baseBookId. |
accountingStandard |
string or null | no | The accounting standard the book follows, for example 'IFRS' or 'US GAAP'. Absent when none is set. |
consolidation |
boolean | no | Whether the book consolidates other books or entities. |
description |
string or null | no | A free-form description of the accounting book. Absent when none is set. |
baseBookId |
string or null | no | The full book this adjustment book adjusts. Absent for a full book. See id on GET accounting/books/:id. |
lastModifiedDate |
string (date-time) | no | The date and time the accounting book record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. |
Statuses
400— Invalid request or business failure401— Missing or invalid access token403— Not authorized404— Not found429— Too many requests500— Internal server error