List Book Entity Assignments

GET /accounting/books/{bookId}/entity-assignments

Group: Accounting › Books · Operation ID: listBookEntityAssignments

Returns the legal entities that post to the given accounting book, each with its chart of accounts, fiscal calendar and currency.

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.
bookId path string yes The unique identifier for the accounting book whose assignments to return.
page query string no The cursor from the previous response's pagination.nextCursor. Omit for the first page.
pageSize query string no The number of assignments per page. Defaults to 50. A value above 200 is treated as 200, not rejected.

Response

200 Success

Under data (listBookEntityAssignmentsOutput):

Field Type Required Description
items array of object yes The book's entity assignments, one per legal entity that posts to it. An empty array when the book has none.
items[].id string yes The unique identifier for the entity assignment.
items[].bookId string yes The accounting book this assignment belongs to, the same book named on the path. See id on GET accounting/books/:id.
items[].bookName string no The display name of the accounting book.
items[].entityId string yes The legal entity assigned to the book. See id on GET base/entities.
items[].entityName string no The name of the assigned legal entity.
items[].chartOfAccountsId string no The chart of accounts used for this entity on this book. Absent when none is assigned. See id on GET accounting/chart-of-accounts/:id.
items[].chartOfAccountsName string no The name of the chart of accounts. Absent when none is assigned.
items[].fiscalCalendarId string no The fiscal calendar used for this entity on this book. Absent when none is assigned. See id on GET accounting/fiscal-calendars/:id.
items[].fiscalCalendarName string no The name of the fiscal calendar. Absent when none is assigned.
items[].currency string no The currency for this entity on this book. Format ISO 4217, for example 'USD'. Absent when none is set.
items[].lastModifiedDate string (date-time) yes The date and time the entity assignment last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
pagination object yes The pagination cursor for this page.
pagination.nextCursor string no The cursor for the next page. Pass it as the page query parameter. Absent on the last page.
pagination.hasMore boolean yes True when more assignments remain beyond this page.

Errors

Code Status
BOOK_NOT_FOUND 400

Statuses