Get the books the caller may open

The books are split by organization when the account has two or more active organizations, or when an archived organization owns journal entries; while they are not, split is false, organizations is empty and every accounting read covers the account as before. While split, each accounting read covers one organization's books, named by the X-Accounting-Books: {organizationId} header. organizations lists the ones the caller may name: the active organizations their campus lens (the X-Campus-Lens header) reaches where they hold Full Read Accounting at one or more campuses, by id, then the archived organizations that own journal entries where they hold Full Read Accounting without any campus limit or campus override narrowing it, by name (archived books are read-only). On another accounting read, a header naming any other organization is refused (403), and so is every accounting read while nothing is offered. Without the header the books fall back to the only offered active organization, else the default organization when offered, else the first offered active organization; never an archived one. This endpoint ignores X-Accounting-Books, so a stale header never refuses it. Needs Full Read Accounting. Requires the Accounting add-on (403 otherwise).

Required permission: Full Read Accounting

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json