QuickBooks: Read an account — response body — Account
Read an account: response body, field Account. Complete fields and constraints for contract 2026-10-20.
API reference · Contract 2026-10-20
SDK schema: Read an account — response body — Account
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
AccountSubType | string | Optional | The account sub-type classification and is based on the AccountType value. |
AccountType | string | Optional | A detailed account classification that specifies the use of this account. The type is based on the Classification. |
AcctNum | string | Optional | User-defined account number to help the user in identifying the account within the chart-of-accounts and in deciding what should be posted to the account. The Account.AcctNum attribute must not contain colon (:). Name must be unique. Max length for Account.AcctNum : AU & CA: 20 characters. US, UK & IN: 7 characters Conditionally required |
Active | JSON | Optional | Whether or not active inactive accounts may be hidden from most display purposes and may not be posted to. |
Active (anyOf 1) | boolean | Alternative | |
Active (anyOf 2) | string | Alternative | Known values: true, false |
Classification | string | Optional | The classification of an account. Not supported for non-posting accounts. Valid values include: Asset , Equity , Expense , Liability , Revenue Read only: true |
CurrencyRef | Model | Optional | Expand Read a bill — response body — Bill Currency Ref Reference to the currency in which this account holds amounts. Read only: true |
CurrentBalance | JSON | Optional | Specifies the balance amount for the current Account. Valid for Balance Sheet accounts. Decimal string Read only: true |
CurrentBalance (anyOf 1) | JSON | Alternative | |
CurrentBalance (anyOf 1) (anyOf 1) | number | Alternative | |
CurrentBalance (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
CurrentBalance (anyOf 2) | string | Alternative | |
CurrentBalanceWithSubAccounts | JSON | Optional | Specifies the cumulative balance amount for the current Account and all its sub-accounts. Decimal string Read only: true |
CurrentBalanceWithSubAccounts (anyOf 1) | JSON | Alternative | |
CurrentBalanceWithSubAccounts (anyOf 1) (anyOf 1) | number | Alternative | |
CurrentBalanceWithSubAccounts (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
CurrentBalanceWithSubAccounts (anyOf 2) | string | Alternative | |
Description | string | Optional | User entered description for the account, which may include user entered information to guide bookkeepers/accountants in deciding what journal entries to post to the account. |
FullyQualifiedName | string | Optional | Fully qualified name of the object; derived from Name and ParentRef . The fully qualified name prepends the topmost parent, followed by each subaccount separated by colons and takes the form of Parent:Account1:SubAccount1:SubAccount2 . System generated. Limited to 5 levels. Read only: true |
Id | string | Optional | Unique identifier for this object. Read only: true |
MetaData | Model | Optional | Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications. |
Name | string | Optional | User recognizable name for the Account. Account.Name attribute must not contain double quotes (”) or colon (:). |
ParentRef | Model | Optional | Expand Read an item — response body — Item Class Ref Specifies the Parent AccountId if this represents a SubAccount. |
SubAccount | JSON | Optional | Specifies whether this object represents a parent (false) or subaccount (true). Please note that accounts of these types - OpeningBalanceEquity , UndepositedFunds , RetainedEarnings , CashReceiptIncome , CashExpenditureExpense , ExchangeGainOrLoss cannot have a sub account and cannot be a sub account of another account. Read only: true |
SubAccount (anyOf 1) | boolean | Alternative | |
SubAccount (anyOf 2) | string | Alternative | Known values: true, false |
SyncToken | string | Optional | Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online. Read only: true |
TaxCodeRef | Model | Optional | Expand Read an item — response body — Item Class Ref Reference to the default tax code used by this account. Tax codes are referenced by the TaxCode.Id in the TaxCode object. For global locales, only. |
Referenced models: Read a bill — response body — Bill Currency Ref, Read a bill — response body — Bill Meta Data, Read an item — response body — Item Class Ref