QuickBooks Sandbox 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
- OAuth
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's QuickBooks Sandbox 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_sandbox-sparse-update-invoice",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
quickbooks_sandbox: { authProvisionId: "apn_xxxxxxx" },
invoiceId: "Invoice ID",
customer: "Customer Reference",
},
})
console.log(result)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "quickbooks_sandbox-sparse-update-invoice",
"configured_props": {
"quickbooks_sandbox": { "authProvisionId": "apn_xxxxxxx" },
"invoiceId": "Invoice ID",
"customer": "Customer Reference"
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "quickbooks_sandbox",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "quickbooks_sandbox-sparse-update-invoice",
arguments: {
invoiceId: "Invoice ID",
customer: "Customer Reference",
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| 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_sandbox-sparse-update-invoice
- Version
- 0.0.4
- App
- QuickBooks Sandbox
- Authentication
- OAuth
- Behavior
- May modify external data
- Source
- View on GitHub ↗