COconductor-is

Retrieve an account

Changed on

Retrieves an account by ID.

IMPORTANT: If you need to fetch multiple specific accounts by ID, use the list endpoint instead with the ids parameter. It accepts an array of IDs so you can batch the request into a single call, which is significantly faster.

get/quickbooks-desktop/accounts/{id}

Request

Path parameters

idstring required

The QuickBooks-assigned unique identifier of the account to retrieve.

Example:80000001-1234567890

Headers

Conductor-End-User-Idstring required

The ID of the End-User to receive this request.

Example:end_usr_1234567abcdefg

Response

Returns the specified account.

idstring required

The unique identifier assigned by QuickBooks to this account. This ID is unique across all accounts but not across different QuickBooks object types.

objectType'qbd_account' required

The type of object. This value is always "qbd_account".

createdAtstring required

The date and time when this account was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local timezone of the end-user's computer.

updatedAtstring required

The date and time when this account was last updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local timezone of the end-user's computer.

revisionNumberstring required

The current QuickBooks-assigned 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.

namestring required

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".

fullNamestring required

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.

isActiveboolean required

Indicates whether this account is active. Inactive objects are typically hidden from views and reports in QuickBooks. Defaults to true.

sublevelnumber required

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.

accountType'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' required

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.

specialAccountType'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' nullable required

Indicates if this account is a special account automatically created by QuickBooks for specific purposes.

isTaxAccountboolean nullable required

Indicates whether this account is used for tracking taxes.

accountNumberstring nullable required

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.

bankAccountNumberstring nullable required

The bank account number or identifying note for this account. Access to this field may be restricted based on permissions.

descriptionstring nullable required

A description of this account.

balancestring nullable required

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.

totalBalancestring nullable required

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.

cashFlowClassification'financing' | 'investing' | 'none' | 'not_applicable' | 'operating' nullable required

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).

Example response

{
  "id": "80000001-1234567890",
  "objectType": "qbd_account",
  "createdAt": "2025-01-01T12:34:56+00:00",
  "updatedAt": "2025-02-01T12:34:56+00:00",
  "revisionNumber": "1721172183",
  "name": "Accounts-Payable",
  "fullName": "Corporate:Accounts-Payable",
  "isActive": true,
  "parent": {
    "id": "80000001-1234567890",
    "fullName": "Corporate"
  },
  "sublevel": 1,
  "accountType": "bank",
  "specialAccountType": "undeposited_funds",
  "isTaxAccount": true,
  "accountNumber": "1010",
  "bankAccountNumber": "123456789",
  "description": "Accounts-payable are the amounts owed to suppliers for goods and services purchased on credit.",
  "balance": "1000.00",
  "totalBalance": "5000.00",
  "salesTaxCode": {
    "id": "80000001-1234567890",
    "fullName": "Non"
  },
  "taxLineDetails": {
    "taxLineId": 123,
    "taxLineName": "State Sales Tax"
  },
  "cashFlowClassification": "operating",
  "currency": {
    "id": "80000001-1234567890",
    "fullName": "USD"
  },
  "customFields": [
    {
      "ownerId": "0",
      "name": "Customer Rating",
      "type": "string_1024_type",
      "value": "Premium"
    }
  ]
}

Changes

  • 1de07095c4b7Revision changes
    • warning

      for the path request parameter id, the maxLength was set to 36

  • 10d4e9ebd1dfRevision changes
    • breaking

      response property accountNumber list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property balance list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property bankAccountNumber list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property cashFlowClassification list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property description list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property isTaxAccount list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property specialAccountType list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property totalBalance list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      the response's property type changed from object null to no type for status

    • breaking

      the response's property type changed from object null to no type for status

    • breaking

      the response's property type changed from object null to no type for status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • info

      added subschema #2 to the response property anyOf list for the response status

    • info

      added subschema #1 subschema #2 to the response property anyOf list for the response status

    • info

      added subschema #1 subschema #2 to the response property anyOf list for the response status

    • info

      added subschema #1 subschema #2 to the response property anyOf list for the response status

    • info

      removed the accounts_payable enum value from the response property for the response status

    • info

      removed the accounts_receivable enum value from the response property for the response status

    • info

      removed the condense_item_adjustment_expenses enum value from the response property for the response status

    • info

      removed the cost_of_goods_sold enum value from the response property for the response status

    • info

      removed the direct_deposit_liabilities enum value from the response property for the response status

    • info

      removed the estimates enum value from the response property for the response status

    • info

      removed the exchange_gain_loss enum value from the response property for the response status

    • info

      removed the financing enum value from the response property for the response status

    • info

      removed the inventory_assets enum value from the response property for the response status

    • info

      removed the investing enum value from the response property for the response status

    • info

      removed the item_receipt_account enum value from the response property for the response status

    • info

      removed the none enum value from the response property for the response status

    • info

      removed the not_applicable enum value from the response property for the response status

    • info

      removed the opening_balance_equity enum value from the response property for the response status

    • info

      removed the operating enum value from the response property for the response status

    • info

      removed the payroll_expenses enum value from the response property for the response status

    • info

      removed the payroll_liabilities enum value from the response property for the response status

    • info

      removed the petty_cash enum value from the response property for the response status

    • info

      removed the purchase_orders enum value from the response property for the response status

    • info

      removed the reconciliation_differences enum value from the response property for the response status

    • info

      removed the retained_earnings enum value from the response property for the response status

    • info

      removed the sales_orders enum value from the response property for the response status

    • info

      removed the sales_tax_payable enum value from the response property for the response status

    • info

      removed the uncategorized_expenses enum value from the response property for the response status

    • info

      removed the uncategorized_income enum value from the response property for the response status

    • info

      removed the undefined enum value from the response property for the response status

    • info

      removed the undefined enum value from the response property for the response status

    • info

      removed the undeposited_funds enum value from the response property for the response status

    • info

      removed subschema #2 from the response property oneOf list for the response status