Quickbooks Online API Reference
›
Account Entity
Account
Fields
-
Name
Name: Name -- User recognizable name for the Account. Product: ALL Required: ALL Filterable: QBW ValidRange: QBW: Max=31 ValidRange: QBO: Max=100
Field Length in QB Desktop: 31
Field Length in QB Online: 100
Product: ALL
Required: ALL
-
Sub Account
SubAccount: Sub Account -- Specifies the Account is a SubAccount or Not. True if subaccount, false or null if it is top-level account
Product: ALL
-
Sub Account Specified
SubAccountSpecified: Sub Account Specified -- Account.SubAccountSpecified
-
Parent Ref
ParentRef: Parent Ref -- Specifies the Parent AccountId if this represents a SubAccount. Else null or empty
Product: ALL
-
Description
Description: Description -- 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. ValidRange: QBW: Max=200 ValidRange: QBO: Max=100
Field Length in QB Desktop: 200
Field Length in QB Online: 100
Product: ALL
-
Fully Qualified Name
FullyQualifiedName: Fully Qualified Name -- Fully qualified name of the entity. The fully qualified name prepends the topmost parent, followed by each sub element separated by colons. Takes the form of: Parent:Account1:SubAccount1:SubAccount2 InputType: ReadOnly
Product: ALL
-
Active
Active: Active -- Whether or not active inactive accounts may be hidden from most display purposes and may not be posted to. Filterable: QBW
Product: ALL
-
Active Specified
ActiveSpecified: Active Specified -- Account.ActiveSpecified
-
Classification
Classification: Classification -- 5 types of classification an account classified. Suggested examples of account type are Asset, Equity, Expense, Liability, Revenue Filterable: QBW
Product: ALL
Classification Enumerated Values:- Asset
- Equity
- Expense
- Liability
- Revenue
-
Classification Specified
ClassificationSpecified: Classification Specified -- Account.ClassificationSpecified
-
Account Type
AccountType: Account Type -- Type is a detailed account classification that specifies the use of this account. 16 type of account subtypes available in AccountTypeEnum Filterable: QBW Required: ALL
Product: ALL
Required: ALL
AccountType Enumerated Values:- Bank
- AccountsReceivable
- OtherCurrentAsset
- FixedAsset
- OtherAsset
- AccountsPayable
- CreditCard
- OtherCurrentLiability
- LongTermLiability
- Equity
- Income
- CostofGoodsSold
- Expense
- OtherIncome
- OtherExpense
- NonPosting
-
Account Type Specified
AccountTypeSpecified: Account Type Specified -- Account.AccountTypeSpecified
-
Account Sub Type
AccountSubType: Account Sub Type -- AccountSubTypeEnum specificies QBO on detail type. If not specified default value are listed for each SubType
Product: QBO
-
Acct Num
AcctNum: Acct Num -- User entered/specified 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.
Product: ALL
-
Bank Num
BankNum: Bank Num -- Bank Account Number, should include routing number whatever else depending upon the context, this may be the credit card number or the checking account number, etc. ValidRange: QBW: max=25
Field Length in QB Desktop: 25
Product: QBW
-
Opening Balance
OpeningBalance: Opening Balance -- Specifies the Opening Balance amount when creating a new Balance Sheet account.
Product: ALL
-
Opening Balance Specified
OpeningBalanceSpecified: Opening Balance Specified -- Account.OpeningBalanceSpecified
-
Opening Balance Date
OpeningBalanceDate: Opening Balance Date -- Specifies the Date of the Opening Balance amount when creating a new Balance Sheet account.
Product: ALL
-
Opening Balance Date Specified
OpeningBalanceDateSpecified: Opening Balance Date Specified -- Account.OpeningBalanceDateSpecified
-
Current Balance
CurrentBalance: Current Balance -- Specifies the balance amount for the current Account. Valid for Balance Sheet accounts. InputType: QBW: ReadOnly
Product: ALL
-
Current Balance Specified
CurrentBalanceSpecified: Current Balance Specified -- Account.CurrentBalanceSpecified
-
Current Balance With Sub Accounts
CurrentBalanceWithSubAccounts: Current Balance With Sub Accounts -- Specifies the cumulative balance amount for the current Account and all its sub-accounts. InputType: QBW: ReadOnly
Product: ALL
-
Current Balance With Sub Accounts Specified
CurrentBalanceWithSubAccountsSpecified: Current Balance With Sub Accounts Specified -- Account.CurrentBalanceWithSubAccountsSpecified
-
Currency Ref
CurrencyRef: Currency Ref -- Reference to the Currency that this account will hold the amounts in.
Product: ALL
-
Tax Account
TaxAccount: Tax Account -- Describes if the account is taxable
Product: ALL
-
Tax Account Specified
TaxAccountSpecified: Tax Account Specified -- Account.TaxAccountSpecified
-
Tax Code Ref
TaxCodeRef: Tax Code Ref -- If the account is taxable, refers to taxcode reference if applicable I18n: QBW: GlobalOnly
Product: QBW
-
Online Banking Enabled
OnlineBankingEnabled: Online Banking Enabled -- Indicates if the Account is linked with Online Banking feature (automatically download transactions) of QuickBooks Online or QuickBooks Desktop. Null or false indicates not linked with online banking. True if Online banking based download is enabled for this account. InputType: ALL: ReadOnly
Product: ALL
-
Online Banking Enabled Specified
OnlineBankingEnabledSpecified: Online Banking Enabled Specified -- Account.OnlineBankingEnabledSpecified
-
F I Name
FIName: F I Name -- Indicates the name of financial institution name if Account is linked with Online banking. Valid only if account is online banking enabled. This is optional and read-only. InputType: ALL: ReadOnly
Product: ALL
-
Account Ex
AccountEx: Account Ex -- extension place holder for Account.
Product: ALL
-
Sync Token
SyncToken: Sync Token -- Version number of the entity. The SyncToken is used to lock the entity for use by one application at a time. As soon as an application modifies an entity, its SyncToken is incremented; another application's request to modify the entity with the same SyncToken will fail. Only the latest version of the entity is maintained by Data Services. An attempt to modify an entity specifying an older SyncToken will fail. Required for the update operation. Required: ALL
Product: ALL
Required: ALL
-
Meta Data
MetaData: Meta Data -- Descriptive information about the entity. The MetaData values are set by Data Services and are read only for all applications.
Product: ALL
-
Custom Field
CustomField: Custom Field -- Custom field (or data extension). Filterable: QBW
Product: QBW
-
Attachable Ref
AttachableRef: Attachable Ref -- Specifies entity name of the attachment from where the attachment was requested
-
domain
domain: domain -- Domain in which the entity belongs.
Product: ALL
-
status
status: status -- System status of the entity. Output only field. Filterable: ALL
Product: ALL
status Enumerated Values:- Deleted
- Voided
- Draft
- Pending
- InTransit
- Synchronized
- SyncError
-
status Specified
statusSpecified: status Specified -- Account.statusSpecified
-
sparse
sparse: sparse -- True if the entity representation has a partial set of elements. Output only field.
Product: ALL
-
sparse Specified
sparseSpecified: sparse Specified -- Account.sparseSpecified
-
Name And Id
NameAndId: Name And Id -- Property used for Select clauses. This property is not used for entity operation and Where and orderBy clauses.
-
Overview
Overview: Overview -- Property used for Select clauses. This property is not used for entity operation and Where and orderBy clauses.
-
Header Lite
HeaderLite: Header Lite -- Property used for Select clauses. This property is not used for entity operation and Where and orderBy clauses.
-
Header Full
HeaderFull: Header Full -- Property used for Select clauses. This property is not used for entity operation and Where and orderBy clauses.