The Account object
An account represents a financial account, allowing customization like sub-accounting, account numbering, and initial balance setting.
The unique identifier assigned by QuickBooks to this account. This ID is unique across all accounts but not across different QuickBooks object types.
The type of object. This value is always "qbd_account"
.
"qbd_account"
The date and time when this account was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone in QuickBooks.
The date and time when this account was last updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone in QuickBooks.
The current revision number of this account object, which changes each time the object is modified. When updating this object, you must provide the most recent revisionNumber
to ensure you're working with the latest data; otherwise, the update will return an error.
The case-insensitive name of this account. Not guaranteed to be unique because it does not include the names of its hierarchical parent objects like fullName
does. For example, two accounts could both have the name
"Accounts-Payable", but they could have unique fullName
values, such as "Corporate:Accounts-Payable" and "Finance:Accounts-Payable". Maximum length: 31 characters.
The case-insensitive fully-qualified unique name of this account, formed by combining the names of its hierarchical parent objects with its own name
, separated by colons. For example, if an account is under "Corporate" and has the name
"Accounts-Payable", its fullName
would be "Corporate:Accounts-Payable".
NOTE: Unlike name
, fullName
is guaranteed to be unique across all account objects. However, fullName
can still be arbitrarily changed by the QuickBooks user when they modify the underlying name
field.
Indicates whether this account is active. Inactive objects are typically hidden from views and reports in QuickBooks.
The parent account one level above this one in the hierarchy. For example, if this account has a fullName
of "Corporate:Accounts-Payable", its parent has a fullName
of "Corporate". If this account is at the top level, this field will be null
.
The depth level of this account in the hierarchy. A top-level account has a sublevel
of 0; each subsequent sublevel increases this number by 1. For example, an account with a fullName
of "Corporate:Accounts-Payable" would have a sublevel
of 1.
The classification of this account, indicating its purpose within the chart of accounts.
NOTE: You cannot create an account of type non_posting
through the API because QuickBooks creates these accounts behind the scenes.
accounts_payable
, accounts_receivable
, bank
, cost_of_goods_sold
, credit_card
, equity
, expense
, fixed_asset
, income
, long_term_liability
, non_posting
, other_asset
, other_current_asset
, other_current_liability
, other_expense
, other_income
Indicates if this account is a special account automatically created by QuickBooks for specific purposes.
accounts_payable
, accounts_receivable
, condense_item_adjustment_expenses
, cost_of_goods_sold
, direct_deposit_liabilities
, estimates
, exchange_gain_loss
, inventory_assets
, item_receipt_account
, opening_balance_equity
, payroll_expenses
, payroll_liabilities
, petty_cash
, purchase_orders
, reconciliation_differences
, retained_earnings
, sales_orders
, sales_tax_payable
, uncategorized_expenses
, uncategorized_income
, undeposited_funds
Indicates whether this account is used for tracking taxes.
The account's account number, which appears in the QuickBooks chart of accounts, reports, and graphs. Note that if the "Use Account Numbers" preference is turned off in QuickBooks, the account number may not be visible in the user interface, but it can still be set and retrieved through the API.
The bank account number or identifying note for this account. Access to this field may be restricted based on permissions.
A description of this account.
The current balance of this account only, excluding balances from any subordinate accounts, represented as a decimal string. Compare with totalBalance
. Note that income accounts and balance sheet accounts may not have balances.
The combined balance of this account and all its sub-accounts, represented as a decimal string. For example, the totalBalance
for XYZ Bank would be the total of the balances of all its sub-accounts (checking, savings, and so on). If XYZ Bank did not have any sub-accounts, totalBalance
and balance
would be the same.
The sales-tax code associated with this account, determining whether it is taxable or non-taxable. It's used to assign a default tax status to all transactions for this account. Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes can also be created in QuickBooks. If QuickBooks is not set up to charge sales tax (via the "Do You Charge Sales Tax?" preference), it will assign the default non-taxable code to all sales.
The account's tax line details, used for tax reporting purposes.
Indicates how this account is classified for cash flow reporting. If none
, the account has not been classified. If not_applicable
, the account does not qualify to be classified (e.g., a bank account tracking cash transactions is not part of a cash flow report).
financing
, investing
, none
, not_applicable
, operating
The account's currency. For built-in currencies, the name and code are standard international values. For user-defined currencies, all values are editable.
The custom fields for the account object, added as user-defined data extensions, not included in the standard QuickBooks object.