GET
List account mappings
Organization space Accounting module For: Accountant · Permission: account_mappings.list Conditions
  • The accounting module must be included in the plan of the organization.
  • In the organization space the caller needs an accounting access grant on the book named in the URL.
  • The book must be set up for accounting (it must have at least one journal).
  • Results are cursor-paginated (per_page 1 to 100, default 25), sorted by role ascending by default; sort_by accepts only created_at.
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.

Path Parameters

book
string
required

Identifier of the book (the organization or one of its companies) whose records are read or changed; 27-character KSUID. The caller needs an access grant on it.

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
sort_order
enum<string> | null

asc for ascending order, desc for descending order.

Available options:
asc,
desc
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, owner_type, role, auxiliary_type, accounting_account_id, 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: account.

Response

Resource.

data
AccountMappingResource · object[]
required

Items of this page.

meta
object
required

Pagination details.