GET
View an analytic axis (client account)
Client space Accounting module For: Accountant · Permission: analytic_axes.retrieve Conditions
  • The accounting module must be included in the plan of the organization.
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

analyticAxis
string
required

Identifier of the analytic axis (27-character KSUID).

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, 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.

id

Identifier of the axis (27-character KSUID).

code

Short code of the axis, unique within the book (32 characters at most).

label

Display name of the axis.

is_mandatory
boolean

Whether the axis is flagged as mandatory. Stored as a flag; false by default.

status

active or archived. Archived axes cannot receive new rules or allocations.

sections_count
integer

Number of sections that belong to the axis, counted across the book.

created_by

Identifier of the actor that created the axis; null when it could not be resolved.

created_by_type

Kind of actor that created the axis (the actor's morph alias); null when it could not be resolved.

created_at

Date and time the record was created (ISO 8601, UTC).

updated_at

Date and time the record was last changed (ISO 8601, UTC).