evenbooks
Sign inStart for free

Chart of accounts

Categories and balance sheet accounts.

Paths are relative to https://evenbooks.org/api/v1. How keys, errors, paging and versions work is in the guide; the whole reference is also an OpenAPI 3.1 document.

Administrator key marks endpoints that need a key with the admin role, Write access those a read-only key can’t call, and Idempotent those that accept an idempotency key.

List accounts

get/accounts

The chart of accounts, by code. Archived accounts are left out unless includeArchived=true. withBalances=true adds each account’s balance from posted entries, in its natural direction (debit minus credit for assets and expenses, credit minus debit for the rest).

Parameters

Response 200

array of AccountDto

Errors 400 · 401 · 403 · 404 · 409 · 429

Create an account

post/accounts
Write access

Adds a category or balance sheet account in the company’s currency. A parentId must be an account of the same type. For an income or expense account, scheduleCLine also sets its Schedule C line for the current tax year.

Request body

CreateAccountInput

  • codestringrequired

    1–20 characters

  • namestringrequired

    1–120 characters

  • typestring · AccountTyperequired

    One of: asset liability equity income expense

  • rolestring or null

    One of: bank credit_card owner_equity owner_draws

  • parentIdstring · Uuid or null
  • descriptionstring or null

    up to 500 characters

  • scheduleCLinestring or null

    up to 10 characters

Response 200

AccountDto (fields under Schemas)

Errors 400 · 401 · 403 · 404 · 409 · 429

Change an account

patch/accounts/{id}
Write access

Omitted fields stay as they are. isActive: false archives the account; built-in system accounts cannot be archived. A new parent must have the same type. Needs version from the last read (409 version_conflict otherwise).

Parameters

  • idstring (uuid)path · required

Request body

UpdateAccountInput

  • versionintegerrequired
  • codestring

    1–20 characters

  • namestring

    1–120 characters

  • descriptionstring or null

    up to 500 characters

  • parentIdstring · Uuid or null
  • isActiveboolean

Response 200

AccountDto (fields under Schemas)

Errors 400 · 401 · 403 · 404 · 409 · 429

Schemas

The types these endpoints take or return, by name. Type names above link here.

AccountDto

  • idstring
  • codestring
  • namestring
  • typestring · AccountType

    One of: asset liability equity income expense

  • rolestring · AccountRole or null
    19 possible values

    accounts_receivable customer_deposits sales_tax_payable undeposited_funds bank credit_card opening_balance_equity owner_equity owner_draws retained_earnings sales_discounts bad_debt bank_fees uncategorized_income uncategorized_expense rounding advance_payments processor_clearing processor_fees

  • parentIdstring or null
  • descriptionstring or null
  • currencystring
  • isActiveboolean
  • isSystemboolean
  • versioninteger
  • balancestring · DecimalStringoptional

AccountRole

string

19 possible values

accounts_receivable customer_deposits sales_tax_payable undeposited_funds bank credit_card opening_balance_equity owner_equity owner_draws retained_earnings sales_discounts bad_debt bank_fees uncategorized_income uncategorized_expense rounding advance_payments processor_clearing processor_fees

AccountType

string

One of: asset liability equity income expense

DecimalString

decimal string

string

up to 32 characters · pattern ^-?\d+(\.\d+)?$

QueryBoolean

boolean

Uuid

string (uuid)