The Account Object
Accounts are the categories a business uses to record and classify accounting transactions. From the Accounts endpoint, you can retrieve a list of all accounts for a specified business.
Account Normalization
Railz normalizes all chart of accounts using 4 subclassifications:
section
,subSection
,group
andsubGroup
. See account normalization for more details and a list of all classifications.
Field | Type | Description |
---|---|---|
id | string | Identifier for the account, unique for the business in the accounting service. |
nominalCode | string | The nominal code of the account used to classify accounts by department or account type. |
name sortable, filterable | string | Name of the account. |
description | string | Description of the account. |
section sortable, filterable | string | Railz normalized account classification. See account normalization for more details. |
subSection sortable, filterable | string | Railz normalized account classification. See account normalization for more details. |
group sortable, filterable | string | Railz normalized account classification. See account normalization for more details. |
subGroup sortable, filterable | string | Railz normalized account classification. See account normalization for more details. |
classification sortable, filterable | string | The classification of an account in the accounting service, e.g. Asset. |
depth sortable, filterable | string | The hierarchial level of the account in the Accounts list. The highest level accounts are level 1, the lowest is n. This is an example showing account hierarchy: Assets - Level 1 Current Assets - Level 2 Bank Accounts - Level 3 National Bank Account 1 - Level 4 |
fullyQualifiedName sortable, filterable | string | The fully qualified name prepends the topmost parent, followed by each subaccount separated by colons and takes the form of Parent:Account1:SubAccount1:SubAccount2. |
currencyRef | Reference Types | Currency of the account. |
currentBalance sortable, filterable | decimal | The running balance of all credits and debits applied to the account. |
type sortable, filterable | string | Type of an account in the accounting service, e.g. Fixed Asset. |
subtype sortable, filterable | string | Subtype of an account in the accounting service, e.g. Fixed Asset. |
isBankAccount sortable, filterable | boolean | Specifies whether the account is a bank account or not. |
isSubAccount sortable, filterable | boolean | Specifies whether the account is a sub account or not. |
isActive sortable, filterable | boolean | Specifies whether the account is an active account or not. |
isPosting sortable, filterable | boolean | Specifies whether direct posting is allowed into this account. |
parentRef | Reference Types | Reference to parent account if this represents a subaccount. |
taxRateRef | Reference Types | Reference to the default tax rate used by this account. |
sourceModifiedDate sortable, filterable | string See Date | The date on which this record was last modified in the accounting service. |
The Account Reference Object
Data types that reference an account, for example, bill and invoice line items, use an accountRef that includes the id
and name
of the linked account.