GET
List accessible books
Organization space Accounting module For: Accountant Conditions
  • The accounting module must be included in the plan of the organization.
  • No accounting permission is needed. The list contains the books the caller has an accounting access grant on (the organization’s own book and its companies); client account books are never listed.
Part of Set up the books.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

response
enum<string>
default:resource

Response mode. Default resource; none answers 204 No Content.

Available options:
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, type, name, currency_code, currency_exponent, is_active.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: .

Response

200 - application/json

Resource.

id

Identifier of the organization, company or client that owns the book (27-character KSUID).

type

Kind of book: organization, company or client.

name

Name of the organization, company or client.

currency_code

Three-letter currency code of the latest fiscal year of the book; null when the book has no fiscal year.

currency_exponent
integer

Number of decimal places of the currency (0 for XOF). An amount in minor units divided by 10 to this power gives the amount in the currency.

is_active
boolean

true when the owner of the book is active; the organization is always active.