View as Markdown
QuickBooks icon

QuickBooks ACTION

Sparse Update Invoice

Sparse updating provides the ability to update a subset of properties for a given object; only elements specified in the request are updated. Missing elements are left untouched. The ID of the object to update is specified in the request body.​ 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 Sparse Update Invoice 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-sparse-update-invoice",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    quickbooks: { authProvisionId: "apn_xxxxxxx" },
    invoiceId: "Invoice ID",
    customer: "Customer Reference",
  },
})

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.

Sparse Update Invoice inputs
Property Type Description
invoiceId Invoice ID string
ID of the invoice to get details of
Required Dynamic
customer Customer Reference string
Reference to a customer or job
Required Dynamic
currency Currency Code string
A three letter string representing the ISO 4217 code for the currency. For example, USD, AUD, EUR, and so on. This must be defined if multicurrency is enabled for the company. Multicurrency is enabled for the company if Preferences.MultiCurrencyEnabled is set to true. Read more about multicurrency support here. Required if multicurrency is enabled for the company.
Optional Dynamic
lineItemsAsObjects Enter Line Items as Objects boolean
Enter line items as an array of objects
Required

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-sparse-update-invoice
Version
0.1.11
App
QuickBooks
Authentication
OAuth
Read-only
No
Destructive
Yes
Open world
Yes