GET
List accounts (client account)
Client space Accounting module For: Accountant · Permission: accounting_accounts.list Conditions
  • The accounting module must be included in the plan of the organization.
  • From the client space the book is always the client account’s own book.
  • 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 code ascending unless sort_by (code, name, created_at) and sort_order are sent.
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

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:
code,
name,
created_at
sort_order
enum<string> | null

asc for ascending order, desc for descending order.

Available options:
asc,
desc
parent_id
string | null

Only accounts whose parent has this identifier (27-character KSUID), that is the direct sub-accounts of that account.

is_postable
boolean | null

Boolean. true keeps only accounts entries can be posted to; false keeps only grouping accounts (accounts with sub-accounts, or third-party group accounts).

code
string | null

Keeps accounts whose code starts with this text (prefix match, for example 41 lists the customer accounts).

auxiliary_type
enum<string> | null

Keeps only the accounts of customers (customer) or vendors (vendor), to pick a third party of the book, for example as a related party.

Available options:
customer,
vendor
search
string | null

Text of 255 characters at most: keeps accounts whose name contains it (case does not matter) or whose code starts with it.

Maximum string length: 255
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, code, name, parent_id, normal_balance, is_postable, is_standard, syscohada_template_id, auxiliary_type, auxiliary_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: .

Response

Resource.

data
AccountingAccountResource · object[]
required

Items of this page.

meta
object
required

Pagination details.