Skip to main content
GET
List chart of accounts

Authorizations

Authorization
string
header
required

Partner-level JWT token (unscoped). Token payload includes partner_id. Business access is validated via partner ownership. Format: Bearer <your-jwt-token>

Use this for: Multi-business operations where the business_id is specified in the URL and partner has access to multiple businesses.

Path Parameters

business_id
string<uuid>
required

Business UUID

Query Parameters

account_type
string

Filter by account type (case-insensitive). Values: asset, liability, equity, revenue, expense

fiscal_year
integer

Filter to show only accounts with journal entry activity in the specified fiscal year. Note: For export endpoint, use fiscal_year to calculate period-specific balances instead.

group_by
string

Group accounts by category. Values: 'type' (groups by Assets, Liabilities, Equity, Revenue, Expenses)

include_zero_balance
boolean
default:true

Include accounts with zero balance (default: true)

is_active
boolean
page
integer

Page number (default: 1). Not used when group_by is specified.

page_size
integer

Items per page (default: 20, max: 100). Not used when group_by is specified.

parent_account_id
string<uuid>

Filter by parent account UUID (show sub-accounts only)

period_month
integer

Month for period-specific balance calculation (1-12). Must be used with period_year.

period_year
integer

Year for period-specific balance calculation (e.g., 2024). Must be used with period_month.

Search by account name, code, or institution name

Response

count
integer
required

Total number of items

Example:

123

page_info
object
required
Example:
results
object[]
required