Create child account

curl --request POST \
  --url https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/general-ledger/chart-of-accounts/{account_id}/children/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "<string>",
  "name": "<string>",
  "description": "<string>",
  "external_id": "<string>",
  "custom_fields": "<unknown>",
  "institution_name": "<string>",
  "iban": "<string>",
  "sort_code": "<string>",
  "account_number_mask": "<string>"
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "code": "<string>",
  "name": "<string>",
  "currency": "<string>",
  "account_type": "asset",
  "account_type_display": "<string>",
  "account_subtype": "current_assets",
  "account_subtype_display": "<string>",
  "parent_account_code": "<string>",
  "current_balance": 123,
  "current_balance_formatted": "<string>",
  "debit_balance": 123,
  "credit_balance": 123,
  "period_balance": 123,
  "period_balance_formatted": "<string>",
  "has_children": true,
  "hierarchy_level": 123,
  "is_active": true,
  "description": "<string>",
  "institution_name": "<string>",
  "iban": "<string>",
  "sort_code": "<string>",
  "account_number_mask": "<string>",
  "total_debits": 123,
  "total_credits": 123,
  "last_entry_date": "2023-11-07T05:31:56Z",
  "last_entry_reference": "<string>",
  "sub_accounts": [
    {}
  ]
}

POST

platform

businesses

{business_id}

general-ledger

chart-of-accounts

{account_id}

children

Create child account

curl --request POST \
  --url https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/general-ledger/chart-of-accounts/{account_id}/children/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "<string>",
  "name": "<string>",
  "description": "<string>",
  "external_id": "<string>",
  "custom_fields": "<unknown>",
  "institution_name": "<string>",
  "iban": "<string>",
  "sort_code": "<string>",
  "account_number_mask": "<string>"
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "code": "<string>",
  "name": "<string>",
  "currency": "<string>",
  "account_type": "asset",
  "account_type_display": "<string>",
  "account_subtype": "current_assets",
  "account_subtype_display": "<string>",
  "parent_account_code": "<string>",
  "current_balance": 123,
  "current_balance_formatted": "<string>",
  "debit_balance": 123,
  "credit_balance": 123,
  "period_balance": 123,
  "period_balance_formatted": "<string>",
  "has_children": true,
  "hierarchy_level": 123,
  "is_active": true,
  "description": "<string>",
  "institution_name": "<string>",
  "iban": "<string>",
  "sort_code": "<string>",
  "account_number_mask": "<string>",
  "total_debits": 123,
  "total_credits": 123,
  "last_entry_date": "2023-11-07T05:31:56Z",
  "last_entry_reference": "<string>",
  "sub_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

account_id

string<uuid>

required

A UUID string identifying this account.

business_id

string

required

Body

Simplified serializer for creating child accounts.

Inherits from parent:

account_type
account_subtype
balance_behavior

Only code is required; inherits accounting properties from parent.

code

string

required

Unique account code within business

Required string length: 1 - 50

name

string

Account display name

Maximum string length: 255

description

string

external_id

string

External system identifier for idempotency

Maximum string length: 100

custom_fields

any

institution_name

string

Maximum string length: 255

iban

string

Maximum string length: 34

sort_code

string

Maximum string length: 8

account_number_mask

string

Maximum string length: 20

Response

Detailed serializer for account with additional information.

string<uuid>

required

Unique account identifier

code

string

required

Account code from chart of accounts (e.g., '1000', '4000')

name

string

required

Account name from chart of accounts

currency

string

required

Account currency from business base currency (GBP, EUR, USD)

account_type

enum<string>

required

Account type code (asset, liability, equity, revenue, expense)

asset - Asset
liability - Liability
equity - Equity
revenue - Revenue
expense - Expense

Available options:

asset,

liability,

equity,

revenue,

expense

account_type_display

string | null

required

Human-readable account type (e.g., 'Current Asset', 'Revenue')

account_subtype

enum<string>

required

Account subtype code for more granular classification (bank, cash, etc.)

current_assets - Current Assets
non_current_assets - Non-current Assets
current_liabilities - Current Liabilities
non_current_liabilities - Non-current Liabilities
share_capital - Share Capital
share_premium - Share Premium
reserves - Reserves
retained_earnings - Retained Earnings
revenue - Revenue
other_operating_income - Other Operating Income
finance_income - Finance Income
direct_costs - Direct Costs
operating_expenses - Operating Expenses
finance_costs - Finance Costs
income_tax - Income Tax

Available options:

current_assets,

non_current_assets,

current_liabilities,

non_current_liabilities,

share_capital,

share_premium,

reserves,

retained_earnings,

revenue,

other_operating_income,

finance_income,

direct_costs,

operating_expenses,

finance_costs,

income_tax

account_subtype_display

string | null

required

Account subtype for more granular classification

parent_account_code

string | null

required

Parent account code if this is a sub-account (null for top-level accounts)

current_balance

integer

required

Current balance in cents

current_balance_formatted

string

required

Formatted balance with currency symbol (e.g., '£12,500.50')

debit_balance

integer

required

Debit balance in cents

credit_balance

integer

required

Credit balance in cents

period_balance

integer

required

Period balance in cents (null if no period filter applied)

period_balance_formatted

string | null

required

Formatted period balance with currency symbol (null if no period filter)

has_children

boolean

required

Whether this account has sub-accounts (nested hierarchy)

hierarchy_level

integer

required

Depth in account hierarchy (0 for root accounts)

is_active

boolean

required

Whether this account is active and accepting transactions

description

string

required

Detailed account description

institution_name

string | null

required

Bank institution name (for bank accounts only)

iban

string | null

required

International Bank Account Number (for bank accounts)

sort_code

string | null

required

UK bank sort code (for UK bank accounts, format: XX-XX-XX)

account_number_mask

string | null

required

Masked account number showing last 4 digits (e.g., '****5555')

total_debits

integer

required

Total number of debit transactions (count, not amount)

total_credits

integer

required

Total number of credit transactions (count, not amount)

last_entry_date

string<date-time> | null

required

Date of most recent journal entry

last_entry_reference

string

required

Reference of most recent journal entry

sub_accounts

object[]

required

List of sub-accounts if this is a parent account (empty array if no children)

Show child attributes

Archive account (soft delete)Get account journal entry lines

⌘I

Managing Businesses

Importing Business Activity

Financial Reports

Create child account

Authorizations

Path Parameters

Body

Response