View as Markdown
QuickBooks icon

QuickBooks ACTION

Update Item

Updates an item. See the documentation
  • Action
  • Writes data
  • Destructive
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's QuickBooks account once, then configure and run Update Item from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "quickbooks-update-item",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    quickbooks: { authProvisionId: "apn_xxxxxxx" },
    itemId: "Item ID",
    name: "Name",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Update Item inputs
Property Type Description
itemId Item ID string
The identifier of an item
Required Dynamic
name Name string
Name of the item. This value must be unique.
Required
trackQtyOnHand Track Quantity on Hand boolean
True if there is quantity on hand to be tracked. Once this value is true, it cannot be updated to false. Applicable for items of type Inventory. Not applicable for Service or NonInventory item types.
Optional
qtyOnHand Quantity on Hand string
Current quantity of the Inventory items available for sale. Not used for Service or NonInventory type items. Required for Inventory type items.
Optional
incomeAccountRefValue Income Account Ref Value string
Reference to the posting account, that is, the account that records the proceeds from the sale of this item. Must be an account with account type of Sales of Product Income. Query the Account name list resource to determine the appropriate Account object for this reference. Use Account.Id from that object for IncomeAccountRef.value. See specifications for the IncomeAccountRef parameters in the Create an item page.
Optional Dynamic
type Type string
Classification that specifies the use of this item. See the description at the top of the Item entity page for details about supported item types. See specifications for the type parameter in the Create an item page.
Optional
assetAccountRefValue Asset Account Ref Value string
Required for Inventory item types. Reference to the Inventory Asset account that tracks the current value of the inventory. If the same account is used for all inventory items, the current balance of this account will represent the current total value of the inventory. Must be an account with account type of Other Current Asset. Query the Account name list resource to determine the appropriate Account object for this reference. Use Account.Id from that object for AssetAccountRef.value.
Optional Dynamic
invStartDate Inventory Start Date string
Date of opening balance for the inventory transaction. Required when creating an Item.Type=Inventory. Required for Inventory item types.
Optional
expenseAccountRefValue Expense Account Ref Value string
Reference to the expense account used to pay the vendor for this item. Must be an account with account type of Cost of Goods Sold. Query the Account name list resource to determine the appropriate Account object for this reference. Use Account.Id from that object for ExpenseAccountRef.value. See specifications for the ExpenseAccountRef parameters in the Create an item page.
Optional Dynamic
sku Sku string
The stock keeping unit (SKU) for this Item. This is a company-defined identifier for an item or product used in tracking inventory.
Optional
salesTaxIncluded Sales Tax Included boolean
True if the sales tax is included in the item amount, and therefore is not calculated for the transaction.
Optional
salesTaxCodeRefValue Sales Tax Code Ref Value string
ID of the referenced sales tax code for the Sales item. Applicable to Service and Sales item types only. Query the TaxCode name list resource to determine the appropriate TaxCode object for this reference. Use TaxCode.Id from that object for SalesTaxCodeRef.value.
Optional Dynamic
purchaseTaxIncluded Purchase Tax Included boolean
True if the purchase tax is included in the item amount, and therefore is not calculated for the transaction.
Optional
description Description string
Description of the item.
Optional
abatementRate Abatement Rate string
Sales tax abatement rate for India locales.
Optional
reverseChargeRate Reverse Charge Rate string
Sales tax reverse charge rate for India locales.
Optional
subItem Sub Item boolean
If true, this is a sub item. If false or null, this is a top-level item. Creating inventory hierarchies with traditional inventory items is being phased out in lieu of using categories and sub categories.
Optional
taxable Taxable boolean
If true, transactions for this item are taxable. Applicable to US companies, only.
Optional
UqcDisplayText UQC Display Text string
Text to be displayed on customer's invoice to denote the Unit of Measure (instead of the standard code).
Optional
reorderPoint Reorder Point string
The minimum quantity of a particular inventory item that you need to restock at any given time. The ReorderPoint value cannot be set to null for sparse updates(sparse=true). It can be set to null only for full updates.
Optional
purchaseDesc Purchase Description string
Purchase description for the item.
Optional
prefVendorRefValue Pref Vendor Ref Value string
Pref vendor ref value
Optional Dynamic
active Active boolean
If true, the object is currently enabled for use by QuickBooks.
Optional
UqcId UQC ID string
ID of Standard Unit of Measure (UQC:Unique Quantity Code) of the item according to GST rule.
Optional
purchaseTaxCodeRefValue Purchase Tax Code Ref Value string

The ID for the referenced purchase tax code object as found in the Id field of the object payload.

Reference to the purchase tax code for the item. Applicable to Service, Other Charge, and Product (Non-Inventory) item types. Query the TaxCode name list resource to determine the appropriate TaxCode object for this reference. Use TaxCode.Id from that object for PurchaseTaxCodeRef.value.

Optional Dynamic
serviceType Service Type string
Sales tax service type for India locales.
Optional
purchaseCost Purchase Cost string
Amount paid when buying or ordering the item, as expressed in the home currency.
Optional
unitPrice Unit Price string
Corresponds to the Price/Rate column on the QuickBooks Online UI to specify either unit price, a discount, or a tax rate for item. If used for unit price, the monetary value of the service or product, as expressed in the home currency. If used for a discount or tax rate, express the percentage as a fraction. For example, specify 0.4 for 40% tax
Optional
taxClassificationRefValue Tax Classification ID string

The ID for the referenced Tax classification object as found in the Id field of the object payload.

Tax classification segregates different items into different classifications and the tax classification is one of the key parameters to determine appropriate tax on transactions involving items. Tax classifications are sourced by either tax governing authorities as in India/Malaysia or externally like Exactor. 'Fuel', 'Garments' and 'Soft drinks' are a few examples of tax classification in layman terms. User can choose a specific tax classification for an item while creating it. A level 1 tax classification cannot be associated to an Item

Optional Dynamic
parentRefValue Parent Ref Value string

The ID for the referenced parent item object as found in the Id field of the object payload.

The immediate parent of the sub item in the hierarchical Category:Sub-category list. If SubItem is true, then ParenRef is required. Query the Item name list resource to determine the appropriate object for this reference. Use Item.Id from that object for ParentRef.value.

Optional Dynamic

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
quickbooks-update-item
Version
0.0.8
App
QuickBooks
Authentication
OAuth
Read-only
No
Destructive
Yes
Open world
Yes