Skip to main content

Items, Accounts & Company

Tool types for the reference data everything else is built on: products and services (items), the chart of accounts, and read-only company info and preferences.

Every type on this page requires a QuickBooks connector; connectorId is the ID of that connector. Invoice lines reference items and expense lines reference accounts, so agents that create transactions usually carry one of the lookup tools from this page too. See the QuickBooks overview for connector setup and sandbox behavior.

Create item TOOLQUICKBOOKS_CREATE_ITEM​

Creates a product or service item. type is Service, NonInventory, or Inventory — sales items need an incomeAccountId, purchase items an expenseAccountId, and inventory items additionally need an assetAccountId plus trackQtyOnHand and a starting qtyOnHand. The created item's ID is what invoice and PO lines reference.

Example​

Tool config
{
"toolType": "QUICKBOOKS_CREATE_ITEM",
"connectorId": "V1StGXR8Z5",
"name": "@@{itemName}",
"type": "Service",
"unitPrice": 150.00,
"incomeAccountId": "45",
"taxable": true
}
This tool type requires a connected external account. Pass the connector's ID as connectorId in the tool configuration.

Configuration fields

  • Name
    connectorId
    Type
    string (ID)
    Description
    Required string (ID) value. References a connector by ID.
  • Name
    name
    Type
    string
    Description
    Required
  • Name
    type
    Type
    string
    Description
    Required - Inventory, NonInventory, Service
  • Name
    description
    Type
    string
    Description
    Required string value.
  • Name
    unitPrice
    Type
    number
    Description
    Sales price
  • Name
    purchaseCost
    Type
    number
    Description
    Purchase cost
  • Name
    incomeAccountId
    Type
    string
    Description
    Required for sales items
  • Name
    expenseAccountId
    Type
    string
    Description
    Required for purchase items
  • Name
    assetAccountId
    Type
    string
    Description
    Required for inventory items
  • Name
    trackQtyOnHand
    Type
    boolean
    Description
    Track quantity
  • Name
    qtyOnHand
    Type
    number
    Description
    Starting quantity
  • Name
    sku
    Type
    string
    Description
    SKU/Part number
  • Name
    taxable
    Type
    boolean
    Description
    Is taxable

Update item TOOLQUICKBOOKS_UPDATE_ITEM​

Updates an existing item's name, description, pricing, SKU, or tax flag. Setting active to false retires the item from pick lists without disturbing historical transactions that reference it.

Example​

Tool config
{
"toolType": "QUICKBOOKS_UPDATE_ITEM",
"connectorId": "V1StGXR8Z5",
"itemId": "@@{itemId}",
"unitPrice": 175.00
}
This tool type requires a connected external account. Pass the connector's ID as connectorId in the tool configuration.

Configuration fields

  • Name
    connectorId
    Type
    string (ID)
    Description
    Required string (ID) value. References a connector by ID.
  • Name
    itemId
    Type
    string
    Description
    Required
  • Name
    name
    Type
    string
    Description
    Required string value.
  • Name
    description
    Type
    string
    Description
    Required string value.
  • Name
    unitPrice
    Type
    number
    Description
    Required number value.
  • Name
    purchaseCost
    Type
    number
    Description
    Required number value.
  • Name
    sku
    Type
    string
    Description
    Required string value.
  • Name
    taxable
    Type
    boolean
    Description
    Required boolean value.
  • Name
    active
    Type
    boolean
    Description
    Required boolean value.

Get items TOOLQUICKBOOKS_GET_ITEMS​

Lists items with pagination, filtered by itemType (Inventory, NonInventory, Service, Group, ...) or a raw whereClause. This is how an agent finds the item IDs invoice lines need; QUICKBOOKS_GET_ITEMS_FOR_INVOICE on the Workflows page adds fuzzy name search on top.

Example​

Tool config
{
"toolType": "QUICKBOOKS_GET_ITEMS",
"connectorId": "V1StGXR8Z5",
"maxResults": 50,
"startPosition": 1,
"itemType": "Service",
"activeOnly": true
}
This tool type requires a connected external account. Pass the connector's ID as connectorId in the tool configuration.

Configuration fields

  • Name
    connectorId
    Type
    string (ID)
    Description
    Required string (ID) value. References a connector by ID.
  • Name
    maxResults
    Type
    integer
    Description
    Required integer value.
  • Name
    startPosition
    Type
    integer
    Description
    Required integer value.
  • Name
    whereClause
    Type
    string
    Description
    Required string value.
  • Name
    itemType
    Type
    string
    Description
    Inventory, NonInventory, Service, Group, etc.
  • Name
    activeOnly
    Type
    boolean
    Description
    Required boolean value.

Get item by ID TOOLQUICKBOOKS_GET_ITEM_BY_ID​

Fetches a single item's full record — pricing, linked income/expense/asset accounts, SKU, and quantity on hand for inventory items. Use it to verify pricing before quoting or invoicing.

Example​

Tool config
{
"toolType": "QUICKBOOKS_GET_ITEM_BY_ID",
"connectorId": "V1StGXR8Z5",
"itemId": "@@{itemId}"
}
This tool type requires a connected external account. Pass the connector's ID as connectorId in the tool configuration.

Configuration fields

  • Name
    connectorId
    Type
    string (ID)
    Description
    Required string (ID) value. References a connector by ID.
  • Name
    itemId
    Type
    string
    Description
    Required string value.

Create account TOOLQUICKBOOKS_CREATE_ACCOUNT​

Adds an account to the chart of accounts. accountType (e.g. Bank, Expense, Income, OtherCurrentAsset) is required and pairs with an optional accountSubType like Checking or AdvertisingPromotional; parentAccountId nests it as a sub-account. Changing the chart of accounts affects reporting, so give this tool only to agents that are meant to restructure books.

Example​

Tool config
{
"toolType": "QUICKBOOKS_CREATE_ACCOUNT",
"connectorId": "V1StGXR8Z5",
"name": "@@{accountName}",
"accountType": "Expense",
"accountSubType": "AdvertisingPromotional",
"description": "@@{accountDescription}"
}
This tool type requires a connected external account. Pass the connector's ID as connectorId in the tool configuration.

Configuration fields

  • Name
    connectorId
    Type
    string (ID)
    Description
    Required string (ID) value. References a connector by ID.
  • Name
    name
    Type
    string
    Description
    Required
  • Name
    accountType
    Type
    string
    Description
    Required - Bank, Expense, Income, OtherCurrentAsset, etc.
  • Name
    accountSubType
    Type
    string
    Description
    Sub-type like Checking, Savings, AdvertisingPromotional, etc.
  • Name
    description
    Type
    string
    Description
    Required string value.
  • Name
    acctNum
    Type
    string
    Description
    Account number
  • Name
    parentAccountId
    Type
    string
    Description
    For sub-accounts

Get accounts TOOLQUICKBOOKS_GET_ACCOUNTS​

Lists the chart of accounts with pagination, filtered by accountType, classification (Asset, Liability, Equity, Revenue, Expense), or a raw whereClause. Agents use it to find the account IDs that bills, payments, and deposits reference.

Example​

Tool config
{
"toolType": "QUICKBOOKS_GET_ACCOUNTS",
"connectorId": "V1StGXR8Z5",
"maxResults": 100,
"startPosition": 1,
"classification": "Expense",
"activeOnly": true
}
This tool type requires a connected external account. Pass the connector's ID as connectorId in the tool configuration.

Configuration fields

  • Name
    connectorId
    Type
    string (ID)
    Description
    Required string (ID) value. References a connector by ID.
  • Name
    maxResults
    Type
    integer
    Description
    Required integer value.
  • Name
    startPosition
    Type
    integer
    Description
    Required integer value.
  • Name
    whereClause
    Type
    string
    Description
    Required string value.
  • Name
    accountType
    Type
    string
    Description
    Bank, Expense, Income, etc.
  • Name
    classification
    Type
    string
    Description
    Asset, Liability, Equity, Revenue, Expense
  • Name
    activeOnly
    Type
    boolean
    Description
    Required boolean value.

Get account by ID TOOLQUICKBOOKS_GET_ACCOUNT_BY_ID​

Fetches a single account's details — type, sub-type, current balance, and parent relationship. Handy for confirming an account is the right target before booking transactions against it.

Example​

Tool config
{
"toolType": "QUICKBOOKS_GET_ACCOUNT_BY_ID",
"connectorId": "V1StGXR8Z5",
"accountId": "@@{accountId}"
}
This tool type requires a connected external account. Pass the connector's ID as connectorId in the tool configuration.

Configuration fields

  • Name
    connectorId
    Type
    string (ID)
    Description
    Required string (ID) value. References a connector by ID.
  • Name
    accountId
    Type
    string
    Description
    Required string value.

Get company info TOOLQUICKBOOKS_GET_COMPANY_INFO​

Returns the connected QuickBooks company's profile: legal name, addresses, fiscal-year start, and contact details. Takes only the connectorId, which also makes it a cheap way to verify a connector is alive and pointed at the right company.

Example​

Tool config
{
"toolType": "QUICKBOOKS_GET_COMPANY_INFO",
"connectorId": "V1StGXR8Z5"
}
This tool type requires a connected external account. Pass the connector's ID as connectorId in the tool configuration.

Configuration fields

  • Name
    connectorId
    Type
    string (ID)
    Description
    Required string (ID) value. References a connector by ID.

Get preferences TOOLQUICKBOOKS_GET_PREFERENCES​

Returns the company's QuickBooks settings — sales-tax configuration, multi-currency, class tracking, default terms, and email preferences. Agents should read this before assuming a feature is on; for example, tax-code references on invoice lines only apply when sales tax is enabled here.

Example​

Tool config
{
"toolType": "QUICKBOOKS_GET_PREFERENCES",
"connectorId": "V1StGXR8Z5"
}
This tool type requires a connected external account. Pass the connector's ID as connectorId in the tool configuration.

Configuration fields

  • Name
    connectorId
    Type
    string (ID)
    Description
    Required string (ID) value. References a connector by ID.