List all accounts - Conductor Docs

QuickBooks Desktop API

Welcome to Conductor's new QuickBooks Desktop API (alpha)
Accounts
- The Account object
- POST
  Create an account
- POST
  Update an account
- GET
  Retrieve an account
- GET
  List all accounts
Bill Check Payments
Bill Credit Card Payments
Bills
Checks
Classes
Credit Card Charges
Credit Card Credits
Customers
Date-Driven Terms
Estimates
Inventory Assembly Items
Inventory Items
Inventory Sites
Invoices
Journal Entries
Non-Inventory Items
Purchase Orders
Receive-Payments
Sales Orders
Sales Receipts
Sales-Tax Codes
Sales-Tax Items
Service Items
Standard Terms
Transfers
Vendors

GET

quickbooks-desktop

accounts

ids

array

fullNames

array

limit

integer

status

enum<string>

updatedAfter

string

updatedBefore

string

nameContains

string

nameStartsWith

string

nameEndsWith

string

nameFrom

string

nameTo

string

accountType

enum<string>

currencyIds

array

Authorizations

Authorization

string

headerrequired

Your Conductor secret key using Bearer auth (e.g., "Authorization: Bearer {{YOUR_SECRET_KEY}}").

Headers

Conductor-End-User-Id

string

required

The ID of the EndUser to receive this request (e.g., "Conductor-End-User-Id: {{END_USER_ID}}").

Query Parameters

ids

string[]

Filter for specific accounts by their QuickBooks-assigned unique identifier(s).

IMPORTANT: If you include this parameter, QuickBooks will ignore all other query parameters for this request.

fullNames

string[]

Filter for specific accounts by their full-name(s), case-insensitive. Like id, fullName is a unique identifier for an account, formed by by combining the names of its 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".

IMPORTANT: If you include this parameter, QuickBooks will ignore all other query parameters for this request.

limit

integer

The maximum number of objects to return.

IMPORTANT: QuickBooks Desktop does not support cursor-based pagination for accounts. Hence, this parameter will limit the response size, but you will not be able to fetch the next set of results. If needed, you can paginate by fetching batches via the name-range (e.g., nameFrom=A&nameTo=B) query parameters.

Required range: x > 1

status

enum<string>

default: active

Filter for accounts that are active, inactive, or both.

Available options:

active,

all,

inactive

updatedAfter

string

Filter for accounts updated on or after this date and time, in ISO 8601 format (YYYY-MM-DDTHH:mm:ss). If you only provide a date (YYYY-MM-DD), the time is assumed to be 00:00:00 of that day.

updatedBefore

string

Filter for accounts updated on or before this date and time, in ISO 8601 format (YYYY-MM-DDTHH:mm:ss). If you only provide a date (YYYY-MM-DD), the time is assumed to be 23:59:59 of that day.

nameContains

string

Filter for accounts whose name contains this substring, case-insensitive. NOTE: If you use this parameter, you cannot also use nameStartsWith or nameEndsWith.

nameStartsWith

string

Filter for accounts whose name starts with this substring, case-insensitive. NOTE: If you use this parameter, you cannot also use nameContains or nameEndsWith.

nameEndsWith

string

Filter for accounts whose name ends with this substring, case-insensitive. NOTE: If you use this parameter, you cannot also use nameContains or nameStartsWith.

nameFrom

string

Filter for accounts whose name is alphabetically greater than or equal to this value.

nameTo

string

Filter for accounts whose name is alphabetically less than or equal to this value.

accountType

enum<string>

Filter for accounts of this type.

Available options:

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

currencyIds

string[]

Filter for accounts in these currencies.

Response

200 - application/json

objectType

string

required

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

Allowed value: "list"

url

string

required

The endpoint URL where this list can be accessed.

data

object[]

required

The array of accounts.

data.id

string

required

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

data.objectType

string

required

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

Allowed value: "qbd_account"

data.createdAt

string

required

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.

data.updatedAt

string

required

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.

data.revisionNumber

string

required

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.

data.name

string

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". Maximum length: 31 characters.

data.fullName

string

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.

data.isActive

boolean

default: truerequired

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

data.parent

object | null

required

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.

data.sublevel

number

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.

data.accountType

enum<string>

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.

Available options:

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

data.specialAccountType

enum<string> | null

required

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

Available options:

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

data.isTaxAccount

boolean | null

required

Indicates whether this account is used for tracking taxes.

data.accountNumber

string | null

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.

data.bankAccountNumber

string | null

required

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

data.description

string | null

required

A description of this account.

data.balance

string | null

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.

data.totalBalance

string | null

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.

data.salesTaxCode

object | null

required

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.

data.taxLineDetails

object | null

required

The account's tax line details, used for tax reporting purposes.

data.cashFlowClassification

enum<string> | null

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

Available options:

financing,

investing,

none,

not_applicable,

operating

data.currency

object | null

required

The account's currency. For built-in currencies, the name and code are standard international values. For user-defined currencies, all values are editable.

data.customFields

object[]

required

The custom fields for the account object, added as user-defined data extensions, not included in the standard QuickBooks object.

Retrieve an account The Bill Check Payment object