GET
List analytic axes (organization)
Organization space Accounting module For: Accountant · Permission: analytic_axes.list Conditions
  • The accounting module must be included in the plan of the organization.
  • The caller must have been granted access to the book named in the path.
  • Only axes of the book are listed, newest first by default; sort_by accepts created_at or code.
Part of Set up analytic axes, sections and rules.

Authorizations

Authorization
string
header
required

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

Path Parameters

book
string
required

Identifier of the accounting book (27-character KSUID) whose records are handled.

Query Parameters

per_page
integer | null

Number of items per page.

Required range: 1 <= x <= 100
cursor
string | null

Position in the list. Pass the meta.next_cursor or meta.prev_cursor value of the previous page; leave it out to get the first page.

sort_by
enum<string> | null

Field the list is sorted by.

Available options:
created_at,
code
sort_order
enum<string> | null

asc for ascending order, desc for descending order.

Available options:
asc,
desc
status
enum<string> | null

Filter by status: active or archived. When omitted, all statuses are returned.

Available options:
active,
archived
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, code, label, is_mandatory, status, created_by, created_by_type, created_at, updated_at, sections_count.

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

Resource.

data
AnalyticAxisResource · object[]
required

Items of this page.

meta
object
required

Pagination details.