Books

Create a Ledger Template

Changed on
post/agent-ledger-templates/{booksId}

Request

  • Base URL
    https://api.mercury.com/api/v1
  • URL
    https://api.mercury.com/api/v1/agent-ledger-templates/{booksId}
  • Auth
    • HTTP bearer
    • or HTTP basic

Path parameters

booksIdstring uuid required

Request body

coa_template_idstring base58 (max length 22) required

The COA Template Id.

debit_credit'debit' | 'credit' required

Indicates if the ledger is a credit or debit ledger.

editableboolean required

Whether line entries can be manually added or removed from the ledger.

financial_account_type'bank_account' | 'credit_card' | 'payments' | 'payroll' | 'loan' | 'prepaid_card' | 'accounts_receivable' | 'accounts_payable' | 'investment' | 'treasury' required

Indicates that the ledger represents a real-world financial account.

ledger_sub_type'current_assets' | 'non-current_assets' | 'transfers_between_accounts' | 'uncategorized_assets' | 'current_liabilities' | 'non-current_liabilities' | 'equity' | 'operating_revenues' | 'other_income' | 'cost_of_goods_sold' | 'operating_expenses' | 'other_expenses' | 'retained_earnings' required

Indicates similar characteristics and accounting treatment for a group of ledgers within a type.

ledger_type'asset' | 'liability' | 'equity' | 'revenue' | 'expense' required

Indicates the purpose and location of the funds and value recorded in the ledger and which report it is included in: asset, liability and equity ledgers are displayed on the balance sheet; revenue and expenses are displayed on the income statement.

namestring required

The name of the ledger.

parent_idstring base58 (max length 22) nullable

If the ledger is a child Ledger, the ID of the parent ledger object.

report_cash_flowboolean required

Whether Teal includes this ledger in the cash flow report.

sort_codestring required

Determines the display order in reports, ordered digit by digit,

Example request

{
  "coa_template_id": "7JRNsKwy2Lw66caxVU7WGC",
  "parent_id": "7JRNsKwy2Lw66caxVU7WGC"
}

Changes