GET
View an analytic section (organization)
Organization space Accounting module For: Accountant · Permission: analytic_sections.retrieve 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.
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

analyticSection
string
required

Identifier of the accounting book (27-character KSUID); the route names this segment after the resource, but it selects the book.

analytic_section
string
required

Identifier of the analytic section (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, analytic_axis_id, parent_id, code, label, is_postable, status, created_by, created_by_type, created_at, updated_at.

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: axis, parent, parent.axis, parent.parent.

Response

Resource.

id

Identifier of the section (27-character KSUID).

analytic_axis_id

Identifier of the axis the section belongs to.

axis
object | null

The axis, included only when the caller may retrieve analytic axes.

parent_id

Identifier of the parent section; null for a top-level section.

parent
object | null

The parent section, included only when the caller may retrieve analytic sections.

code

Code of the section, unique within its axis and book.

label

Display name of the section.

is_postable
boolean

Whether the section is marked postable. A section receives allocations only when it is postable, active, has no child sections and its axis is active.

status

active or archived.

created_by

Identifier of the actor that created the section.

created_by_type

Kind of actor that created the section (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).