THthredfi
General Ledger

List chart of accounts

    List all accounts with current balances for a business.

    **Features:**
    - Filter by account type (Assets, Liabilities, Equity, Revenue, Expenses)
    - Filter by fiscal year (accounts with activity in that year)
    - Filter by specific accounting period (year + month)
    - Filter by parent account (hierarchical view)
    - Search by account name or code
    - Include/exclude zero balance accounts
    - Group accounts by type (Assets, Liabilities, etc.)
    - Pagination support (default: 20 per page, max: 100)

    **Response includes:**
    - Account code, name, type, sub-type
    - Current balance (from ledger)
    - Formatted balance with currency symbol (€, £, $)
    - Period-specific balance (if period filters applied)
    - Debit and credit balances
    - Parent/child account relationships
    - Hierarchy level and children indicator

    **Grouping:**
    Use `group_by=type` to get accounts grouped by:
    - Assets (Current, Fixed, Other)
    - Liabilities (Current, Long-term)
    - Equity
    - Revenue
    - Expenses (Operating, COGS)

    **Period Filtering:**
    Use both `period_year` and `period_month` together to get period-specific balances.
    Example: `period_year=2024&period_month=11` for November 2024.

    **Account Types (5 fundamental types):**
    - `asset`: Asset (use account_subtype for current/fixed/other)
    - `liability`: Liability (use account_subtype for current/long_term)
    - `equity`: Equity
    - `revenue`: Revenue
    - `expense`: Expense (use account_subtype for operating/cogs)
get/v1/platform/businesses/{business_id}/general-ledger/chart-of-accounts/

Request

  • Base URL
    https://docs.thredfi.com (the document declares no server; this is the origin it was published from)
  • Auth
    • HTTP bearer
    • or HTTP bearer
    • or HTTP basic
    • or HTTP bearer
    • or HTTP bearer

Path parameters

business_idstring uuid required

Business UUID

Query parameters

account_typestring

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

fiscal_yearinteger

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_bystring

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

include_zero_balanceboolean

Include accounts with zero balance (default: true)

is_activeboolean
pageinteger

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

page_sizeinteger

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

parent_account_idstring uuid

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

period_monthinteger

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

period_yearinteger

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

searchstring

Search by account name, code, or institution name

Response

countinteger required

Total number of items

Example response

{
  "count": 123,
  "page_info": {
    "total_count": 123,
    "current_page": 1,
    "total_pages": 7,
    "page_size": 20
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.