View as Markdown
QuickBooks Sandbox icon

QuickBooks Sandbox ACTION

Update Invoice

Updates an invoice. 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 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-update-invoice",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    quickbooks_sandbox: { authProvisionId: "apn_xxxxxxx" },
    invoiceId: "Invoice ID",
    customerRefValue: "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.

Update Invoice inputs
Property Type Description
invoiceId Invoice ID string
ID of the invoice to get details of
Required Dynamic
customerRefValue Customer Reference string
Reference to a customer or job
Required Dynamic
billEmail Bill Email string
Email address where the invoice should be sent
Optional
dueDate Due Date string
Date when the payment of the transaction is due (YYYY-MM-DD)
Optional
allowOnlineCreditCardPayment Allow Online Credit Card Payment boolean
Allow online credit card payment
Optional
allowOnlineACHPayment Allow Online Bank Transfer Payment boolean
Allow online bank transfer payment
Optional
currencyRefValue 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
docNumber Document Number string
Reference number for the transaction
Optional
billingStreetAddress Billing Street Address string
The street address of the billing address
Optional
billingCity Billing City string
The city of the billing address
Optional
billingState Billing State string
The state of the billing address
Optional
billingZip Billing Zip string
The zip code of the billing address
Optional
billingLatitude Billing Latitude string
The latitude of the billing address
Optional
billingLongitude Billing Longitude string
The longitude of the billing address
Optional
shippingStreetAddress Shipping Street Address string
The street address of the shipping address
Optional
shippingCity Shipping City string
The city of the shipping address
Optional
shippingState Shipping State string
The state of the shipping address
Optional
shippingZip Shipping Zip string
The zip code of the shipping address
Optional
shippingLatitude Shipping Latitude string
The latitude of the shipping address
Optional
shippingLongitude Shipping Longitude string
The longitude of the shipping address
Optional
trackingNum Tracking Number string
Shipping tracking number
Optional
privateNote Private Note string
Private note for internal use
Optional
customerMemo Customer Memo string
Memo visible to customer
Optional
taxCodeId Tax Code ID string
The identifier of a tax code
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-update-invoice
Version
0.0.2
App
QuickBooks Sandbox
Authentication
OAuth
Behavior
May modify external data