Sign in

v1

latestOpenAPI 3.0.32026-07-26362271803.3 KB
Company Objects

Update Chart Account

put/coa/api/account/{id}

Path parameters

idinteger required

Request body

idinteger required
is_deletedboolean required
deleted_atstring date-time nullable required
reconciliation_ending_datestring date required
reconciliation_ending_balancenumber double required
balance_ytdnumber double required
name_and_numberstring required
parent_name_and_numberstring nullable required
sort_keystring required
has_associated_databoolean required
last_modified_atstring date-time required
account_idstring uuid required
numberstring nullable required
currencystring
namestring nullable
nicknamestring nullable
descriptionstring nullable
status'ACTIVE' | 'INACTIVE'
  • ACTIVE - Active
  • INACTIVE - Inactive
account_type'ASSET' | 'LIABILITY' | 'EQUITY' | 'REVENUE' | 'COGS' | 'OPERATING_EXPENSES' | 'OTHER_INCOME' | 'OTHER_EXPENSE' | 'UNCATEGORIZED' | 'COST_ALLOCATION'
  • ASSET - Asset
  • LIABILITY - Liability
  • EQUITY - Equity
  • REVENUE - Revenue
  • COGS - Cost of Goods Sold
  • OPERATING_EXPENSES - Operating Expenses
  • OTHER_INCOME - Other Income
  • OTHER_EXPENSE - Other Expense
  • UNCATEGORIZED - Uncategorized
  • COST_ALLOCATION - Cost Allocation
account_subtype'BANK' | 'ACCOUNTS_RECEIVABLE' | 'OTHER_CURRENT_ASSET' | 'FIXED_ASSET' | 'OTHER_ASSET' | 'ACCOUNTS_PAYABLE' | 'UNAPPLIED_CREDITS' | 'CREDIT_CARD' | 'ACCRUED_REVENUE' | 'DEFERRED_REVENUE' | 'OTHER_CURRENT_LIABILITY' | 'LONG_TERM_LIABILITY' | 'UNBILLED_RECEIVABLE' | 'EQUITY' | 'RETAINED_EARNINGS' | 'INCOME' | 'COST_OF_GOODS_SOLD' | 'EXPENSE' | 'DEFERRED_EXPENSE' | 'OTHER_INCOME' | 'OTHER_EXPENSE' | 'REALIZED_GAIN_LOSS' | 'UNREALIZED_GAIN_LOSS' | 'PREPAID' | 'COST_ALLOCATION' | 'UNCATEGORIZED'
  • BANK - Bank
  • ACCOUNTS_RECEIVABLE - Accounts Receivable
  • OTHER_CURRENT_ASSET - Other Current Asset
  • FIXED_ASSET - Fixed Asset
  • OTHER_ASSET - Other Asset
  • ACCOUNTS_PAYABLE - Accounts Payable
  • UNAPPLIED_CREDITS - Unapplied Credits
  • CREDIT_CARD - Credit Card
  • ACCRUED_REVENUE - Accrued Revenue
  • DEFERRED_REVENUE - Deferred Revenue
  • OTHER_CURRENT_LIABILITY - Other Current Liability
  • LONG_TERM_LIABILITY - Long Term Liability
  • UNBILLED_RECEIVABLE - Unbilled Receivable
  • EQUITY - Equity
  • RETAINED_EARNINGS - Retained Earnings
  • INCOME - Income
  • COST_OF_GOODS_SOLD - Cost of Goods Sold
  • EXPENSE - Expense
  • DEFERRED_EXPENSE - Deferred Expense
  • OTHER_INCOME - Other Income
  • OTHER_EXPENSE - Other Expense
  • REALIZED_GAIN_LOSS - Realized Gain Loss
  • UNREALIZED_GAIN_LOSS - Unrealized Gain Loss
  • PREPAID - Prepaid
  • COST_ALLOCATION - Cost Allocation
  • UNCATEGORIZED - Uncategorized
account_cashflow_classification'NONE' | 'OPERATING' | 'INVESTING' | 'FINANCING'
  • NONE - None
  • OPERATING - Operating
  • INVESTING - Investing
  • FINANCING - Financing
include_in_eliminationsboolean
include_in_revaluationsboolean
protectedboolean
skip_subledger_validationboolean

Allow manual journal entries to post to this AR/AP account, bypassing subledger validation

external_idstring nullable required
created_atstring date-time required
last_recompute_balance_atstring date-time nullable
lock_recompute_balance_keystring nullable
current_balancenumber double
current_balance_booknumber double
lineage_arraystring[] nullable

Pre-computed lineage array from root to this account

customerinteger required
parentinteger nullable
parent_bank_accountinteger nullable
default_departmentinteger nullable
default_tagsinteger[]

Response

idinteger required
is_deletedboolean required
deleted_atstring date-time nullable required
reconciliation_ending_datestring date required
reconciliation_ending_balancenumber double required
balance_ytdnumber double required
name_and_numberstring required
parent_name_and_numberstring nullable required
sort_keystring required
has_associated_databoolean required
last_modified_atstring date-time required
account_idstring uuid required
numberstring nullable required
currencystring
namestring nullable
nicknamestring nullable
descriptionstring nullable
status'ACTIVE' | 'INACTIVE'
  • ACTIVE - Active
  • INACTIVE - Inactive
account_type'ASSET' | 'LIABILITY' | 'EQUITY' | 'REVENUE' | 'COGS' | 'OPERATING_EXPENSES' | 'OTHER_INCOME' | 'OTHER_EXPENSE' | 'UNCATEGORIZED' | 'COST_ALLOCATION'
  • ASSET - Asset
  • LIABILITY - Liability
  • EQUITY - Equity
  • REVENUE - Revenue
  • COGS - Cost of Goods Sold
  • OPERATING_EXPENSES - Operating Expenses
  • OTHER_INCOME - Other Income
  • OTHER_EXPENSE - Other Expense
  • UNCATEGORIZED - Uncategorized
  • COST_ALLOCATION - Cost Allocation
account_subtype'BANK' | 'ACCOUNTS_RECEIVABLE' | 'OTHER_CURRENT_ASSET' | 'FIXED_ASSET' | 'OTHER_ASSET' | 'ACCOUNTS_PAYABLE' | 'UNAPPLIED_CREDITS' | 'CREDIT_CARD' | 'ACCRUED_REVENUE' | 'DEFERRED_REVENUE' | 'OTHER_CURRENT_LIABILITY' | 'LONG_TERM_LIABILITY' | 'UNBILLED_RECEIVABLE' | 'EQUITY' | 'RETAINED_EARNINGS' | 'INCOME' | 'COST_OF_GOODS_SOLD' | 'EXPENSE' | 'DEFERRED_EXPENSE' | 'OTHER_INCOME' | 'OTHER_EXPENSE' | 'REALIZED_GAIN_LOSS' | 'UNREALIZED_GAIN_LOSS' | 'PREPAID' | 'COST_ALLOCATION' | 'UNCATEGORIZED'
  • BANK - Bank
  • ACCOUNTS_RECEIVABLE - Accounts Receivable
  • OTHER_CURRENT_ASSET - Other Current Asset
  • FIXED_ASSET - Fixed Asset
  • OTHER_ASSET - Other Asset
  • ACCOUNTS_PAYABLE - Accounts Payable
  • UNAPPLIED_CREDITS - Unapplied Credits
  • CREDIT_CARD - Credit Card
  • ACCRUED_REVENUE - Accrued Revenue
  • DEFERRED_REVENUE - Deferred Revenue
  • OTHER_CURRENT_LIABILITY - Other Current Liability
  • LONG_TERM_LIABILITY - Long Term Liability
  • UNBILLED_RECEIVABLE - Unbilled Receivable
  • EQUITY - Equity
  • RETAINED_EARNINGS - Retained Earnings
  • INCOME - Income
  • COST_OF_GOODS_SOLD - Cost of Goods Sold
  • EXPENSE - Expense
  • DEFERRED_EXPENSE - Deferred Expense
  • OTHER_INCOME - Other Income
  • OTHER_EXPENSE - Other Expense
  • REALIZED_GAIN_LOSS - Realized Gain Loss
  • UNREALIZED_GAIN_LOSS - Unrealized Gain Loss
  • PREPAID - Prepaid
  • COST_ALLOCATION - Cost Allocation
  • UNCATEGORIZED - Uncategorized
account_cashflow_classification'NONE' | 'OPERATING' | 'INVESTING' | 'FINANCING'
  • NONE - None
  • OPERATING - Operating
  • INVESTING - Investing
  • FINANCING - Financing
include_in_eliminationsboolean
include_in_revaluationsboolean
protectedboolean
skip_subledger_validationboolean

Allow manual journal entries to post to this AR/AP account, bypassing subledger validation

external_idstring nullable required
created_atstring date-time required
last_recompute_balance_atstring date-time nullable
lock_recompute_balance_keystring nullable
current_balancenumber double
current_balance_booknumber double
lineage_arraystring[] nullable

Pre-computed lineage array from root to this account

customerinteger required
parentinteger nullable
parent_bank_accountinteger nullable
default_departmentinteger nullable
default_tagsinteger[]