QuickBooks: Sparse update an invoice

QuickBooks invoice.updateSparse: arguments, response, policy and SDK examples.

← invoice operations · Get started · OpenAPI downloads

Contract 2026-10-20 · Operation quickbooks.invoice.sparse_update_an_invoice

Provider route: POST /v3/company/{realmID}/invoice. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/quickbooks with npm, or alter-sdk-quickbooks with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { QuickBooksIntegration } from "@alter-ai/quickbooks";

async function execute(input: Parameters<QuickBooksIntegration["invoice"]["updateSparse"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new QuickBooksIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.invoice.updateSparse(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_quickbooks import QuickBooksIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = QuickBooksIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.invoice.update_sparse(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`query`	object	Optional	Additional keys: not allowed
`query.minorversion`	integer	Optional	Must equal: 75
`query.requestid`	string	Optional	Minimum length: 1
`body`	object	Required within parent	Fields not accepted: sparse Additional keys: not allowed
`body.AllowIPNPayment`	JSON	Optional	Flag to allow payments from legacy Intuit Payment Network (IPN). Provided to maintain backward compatibility and must always be set to false . Do not modify
`body.AllowIPNPayment (anyOf 1)`	boolean	Alternative
`body.AllowIPNPayment (anyOf 2)`	string	Alternative	One of: true, false
`body.AllowOnlineACHPayment`	JSON	Optional	Specifies if this invoice can be paid with online bank transfers and corresponds to the Bank transfer check box on the QuickBooks UI. Active when the company is payments-enabled, i.e., Preferences.SalesFormsPrefs.ETransactionPaymentEnabled is set to true . If set to true , allow invoice to be paid with online bank transfers. The Bank transfer check box is checked on the QuickBooks UI for this invoice. True by default if the company allows invoices to be paid with ACH. If set to false , online bank transfers are not allowed. The Bank transfer check box is not checked on the QuickBooks UI for this invoice.
`body.AllowOnlineACHPayment (anyOf 1)`	boolean	Alternative
`body.AllowOnlineACHPayment (anyOf 2)`	string	Alternative	One of: true, false
`body.AllowOnlineAffirmPayment`	JSON	Optional	Specifies if online Affirm payments are allowed for this invoice and corresponds to the Affirm check box on the QuickBooks UI. Active when the company is payments-enabled, i.e., Preferences.SalesFormsPrefs.ETransactionPaymentEnabled is set to true and the company has been onboarded for Affirm with an ACTIVE subscription status. If set to true , allow invoice to be paid with online Affirm payments. The Affirm check box is checked on the QuickBooks UI for this invoice. True by default if the company allows invoices to be paid with Affirm. If set to false , online Affirm payments are not allowed. The Affirm check box is not checked on the QuickBooks UI for this invoice. Defaults to the active subscription status. If a value is explicitly sent, that value is used. If no value is sent, the default value is used.
`body.AllowOnlineAffirmPayment (anyOf 1)`	boolean	Alternative
`body.AllowOnlineAffirmPayment (anyOf 2)`	string	Alternative	One of: true, false
`body.AllowOnlineCreditCardPayment`	JSON	Optional	Specifies if online credit card payments are allowed for this invoice and corresponds to the Credit card check box on the QuickBooks UI. Active when the company is payments-enabled, i.e., Preferences.SalesFormsPrefs.ETransactionPaymentEnabled is set to true . If set to true , allow invoice to be paid with online credit card payments. The Credit card check box is checked on the QuickBooks UI for this invoice. True by default if the company allows invoices to be paid with credit cards. If set to false , online credit card payments are not allowed. The Credit card check box is not checked on the QuickBooks UI for this invoice.
`body.AllowOnlineCreditCardPayment (anyOf 1)`	boolean	Alternative
`body.AllowOnlineCreditCardPayment (anyOf 2)`	string	Alternative	One of: true, false
`body.AllowOnlinePayPalPayment`	JSON	Optional	Specifies if online PayPal/Venmo payments are allowed for this invoice and corresponds to the PayPal check box on the QuickBooks UI. Active when the company is payments-enabled, i.e., Preferences.SalesFormsPrefs.ETransactionPaymentEnabled is set to true and the company has been onboarded for PayPal with an ACTIVE subscription status. If set to true , allow invoice to be paid with online PayPal payments. The PayPal check box is checked on the QuickBooks UI for this invoice. True by default if the company allows invoices to be paid with PayPal. If set to false , online PayPal payments are not allowed. The PayPal check box is not checked on the QuickBooks UI for this invoice. Defaults to the active subscription status. If a value is explicitly sent, that value is used. If no value is sent, the default value is used.
`body.AllowOnlinePayPalPayment (anyOf 1)`	boolean	Alternative
`body.AllowOnlinePayPalPayment (anyOf 2)`	string	Alternative	One of: true, false
`body.AllowOnlinePayment`	JSON	Optional	Deprecated flag to allow online payments. In use before AllowOnlineCreditCardPayment and AllowOnlineACHPayment flags existed and provided to maintain backward compatibility. If set to true , this invoice was created before AllowOnlinePayment was deprecated and denotes both CC and ACH payments are allowed. In addition, the AllowOnlineCreditCardPayment and AllowOnlineACHPayment flags must be set to true . If set to false , this invoice was created after the AllowOnlinePayment flag was deprecated and is not used. Do not modify.
`body.AllowOnlinePayment (anyOf 1)`	boolean	Alternative
`body.AllowOnlinePayment (anyOf 2)`	string	Alternative	One of: true, false
`body.ApplyTaxAfterDiscount`	JSON	Optional	If false or null, calculate the sales tax first, and then apply the discount. If true, subtract the discount first and then calculate the sales tax.
`body.ApplyTaxAfterDiscount (anyOf 1)`	boolean	Alternative
`body.ApplyTaxAfterDiscount (anyOf 2)`	string	Alternative	One of: true, false
`body.Balance`	JSON	Optional	The balance reflecting any payments made against the transaction. Initially set to the value of TotalAmt . A Balance of 0 indicates the invoice is fully paid. Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. If you process a linked transaction against a specific transaction, the balance value won’t change. It will remain the same. Decimal string Read only: true
`body.Balance (anyOf 1)`	number	Alternative
`body.Balance (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`body.BillAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Bill-to address of the Invoice. If BillAddr is not specified, and a default Customer:BillingAddr is specified in QuickBooks for this customer, the default bill-to address is used by QuickBooks. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings. If you update the CustomerRef , the address passed using BillAddr will be honored.
`body.BillEmail`	Model	Optional	Expand Full update companyinfo — request body — body Email Identifies the e-mail address where the invoice is sent. If EmailStatus=NeedToSend , BillEmail is a required input. Conditionally required
`body.BillEmailBcc`	Model	Optional	Expand Full update companyinfo — request body — body Email Identifies the blind carbon copy e-mail address where the invoice is sent. If not specified, this field is populated from that defined in Preferences.SalesFormsPrefs.SalesEmailBcc . If this email address is invalid, blind carbon copy email is not sent.
`body.BillEmailCc`	Model	Optional	Expand Full update companyinfo — request body — body Email Identifies the carbon copy e-mail address where the invoice is sent. If not specified, this field is populated from that defined in Preferences.SalesFormsPrefs.SalesEmailCc . If this email address is invalid, carbon copy email is not sent.
`body.ClassRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the Class associated with the transaction. Available if Preferences.AccountingInfoPrefs.ClassTrackingPerTxn is set to true . Query the Class name list resource to determine the appropriate Class object for this reference. Use Class.Id and Class.Name from that object for ClassRef.value and ClassRef.name , respectively.
`body.CurrencyRef`	Model	Optional	Expand Create a bill — request body — body Currency Ref Reference to the currency in which all amounts on the associated transaction are expressed. 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 . Applicable if multicurrency is enabled for the company. Conditionally required
`body.CustomField`	array	Optional	One of, up to three custom fields for the transaction. Available for custom fields so configured for the company. Check Preferences.SalesFormsPrefs.CustomField and Preferences.VendorAndPurchasesPrefs.POCustomField for custom fields currenly configured. Click here to learn about managing custom fields.
`body.CustomField[]`	Model	Each item	Expand Void an invoice — request body — body Custom Field item
`body.CustomerMemo`	Model	Optional	Expand Void an invoice — request body — body Customer Memo User-entered message to the customer; this message is visible to end user on their transactions.
`body.CustomerRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to a customer or job. Query the Customer name list resource to determine the appropriate Customer object for this reference. Use Customer.Id and Customer.DisplayName from that object for CustomerRef.value and CustomerRef.name , respectively.
`body.DeliveryInfo`	Model	Optional	Expand Void an invoice — request body — body Delivery Info Email delivery information. Returned when a request has been made to deliver email with the send operation. Read only: true
`body.DepartmentRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to a Department object specifying the location of the transaction. Available if Preferences.AccountingInfoPrefs.TrackDepartments is set to true . Query the Department name list resource to determine the appropriate department object for this reference. Use Department.Id and Department.Name from that object for DepartmentRef.value and DepartmentRef.name , respectively.
`body.Deposit`	JSON	Optional	The deposit made towards this invoice. Decimal string
`body.Deposit (anyOf 1)`	number	Alternative
`body.Deposit (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`body.DepositToAccountRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Account to which money is deposited. Query the Account name list resource to determine the appropriate Account object for this reference, where Account.AccountType is Other Current Asset or Bank . Use Account.Id and Account.Name from that object for DepositToAccountRef.value and DepositToAccountRef.name , respectively. Before you can use this field ensure that the company allows deposits in their invoices first. This can be found by querying the Preferences endpoint . SalesFormsPrefs.AllowDeposit must be equal to true. If you do not specify this account the payment is applied to the Undeposited Funds account.
`body.DocNumber`	string	Optional	Reference number for the transaction. If not explicitly provided at create time, this field is populated based on the setting of Preferences:CustomTxnNumber as follows: If Preferences:CustomTxnNumber is true a custom value can be provided. If no value is supplied, the resulting DocNumber is null. If Preferences:CustomTxnNumber is false, resulting DocNumber is system generated by incrementing the last number by 1. If Preferences:CustomTxnNumber is false then do not send a value as it can lead to unwanted duplicates. If a DocNumber value is sent for an Update operation, then it just updates that particular invoice and does not alter the internal system DocNumber. Note: DocNumber is an optional field for all locales except France. For France locale if Preferences:CustomTxnNumber is enabled it will not be automatically generated and is a required field. If a duplicate DocNumber needs to be supplied, add the query parameter name/value pair, include=allowduplicatedocnum to the URI. Conditionally required
`body.DueDate`	string	Optional	Date when the payment of the transaction is due. If date is not provided, the number of days specified in SalesTermRef added the transaction date will be used.
`body.EmailStatus`	string	Optional	Email status of the invoice. Valid values: NotSet , NeedToSend , EmailSent
`body.ExchangeRate`	JSON	Optional	The number of home currency units it takes to equal one unit of currency specified by CurrencyRef . Applicable if multicurrency is enabled for the company. Decimal string
`body.ExchangeRate (anyOf 1)`	number	Alternative
`body.ExchangeRate (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`body.FreeFormAddress`	JSON	Optional	Denotes how ShipAddr is stored: formatted or unformatted. The value of this flag is system defined based on format of shipping address at object create time. If set to false , shipping address is returned in a formatted style using City, Country, CountrySubDivisionCode, Postal code. If set to true , shipping address is returned in an unformatted style using Line1 through Line5 attributes.
`body.FreeFormAddress (anyOf 1)`	boolean	Alternative
`body.FreeFormAddress (anyOf 2)`	string	Alternative	One of: true, false
`body.GlobalTaxCalculation`	string	Optional	Method in which tax is applied. Allowed values are: TaxExcluded , TaxInclusive , and NotApplicable . Not applicable to US companies; required for non-US companies. Conditionally required
`body.HomeBalance`	JSON	Optional	Convenience field containing the amount in Balance expressed in terms of the home currency. Calculated by QuickBooks business logic. Value is valid only when CurrencyRef is specified. Applicable if multicurrency is enabled for the company. Decimal string Read only: true
`body.HomeBalance (anyOf 1)`	number	Alternative
`body.HomeBalance (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`body.HomeTotalAmt`	JSON	Optional	Total amount of the transaction in the home currency. Includes the total of all the charges, allowances and taxes. Calculated by QuickBooks business logic. Value is valid only when CurrencyRef is specified. Applicable if multicurrency is enabled for the company. Decimal string Read only: true
`body.HomeTotalAmt (anyOf 1)`	number	Alternative
`body.HomeTotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`body.Id`	string	Required within parent
`body.InvoiceLink`	string	Optional	Sharable link for the invoice sent to external customers. The link is generated only for invoices with online payment enabled and having a valid customer email address. Include query param `include=invoiceLink` to get the link back on query response. Read only: true
`body.Line`	array	Optional	Individual line items of a transaction. Valid Line types include SalesItemLine , GroupLine , DescriptionOnlyLine (also used for inline Subtotal lines), DiscountLine and SubTotalLine (used for the overall transaction). If the transaction is taxable there is a limit of 750 lines per transaction.
`body.Line[]`	JSON	Each item
`body.Line[] (anyOf 1)`	Model	Alternative	Expand Create a change order — request body — body Line item
`body.Line[] (anyOf 2)`	Model	Alternative	Expand Void an invoice — request body — body Line item Custom Extensions, Description, Detail Type, Group Line Detail, Id, Line Num
`body.Line[] (anyOf 3)`	Model	Alternative	Expand Void an invoice — request body — body Line item Amount, Description, Description Line Detail, Detail Type, Id, Line Num
`body.Line[] (anyOf 4)`	Model	Alternative	Expand Void an invoice — request body — body Line item Amount, Description, Detail Type, Discount Line Detail, Id, Line Num
`body.Line[] (anyOf 5)`	Model	Alternative	Expand Void an invoice — request body — body Line item Amount, Description, Detail Type, Id, Line Num, Sub Total Line Detail
`body.LinkedTxn`	array	Optional	Zero or more related transactions to this Invoice object. The following linked relationships are supported: Links to Estimate and TimeActivity objects can be established directly to this Invoice object with UI or with the API. Create, Read, Update, and Query operations are avaialble at the API level for these types of links. Only one link can be made to an Estimate . Progress Invoicing is not supported via the API. Links to expenses incurred on behalf of the customer are returned in the response with LinkedTxn.TxnType set to ReimburseCharge , ChargeCredit or StatementCharge corresponding to billable customer expenses of type Cash , Delayed Credit , and Delayed Charge , respectively. Links to these types of transactions are established within the QuickBooks UI, only, and are available as read-only at the API level. Links to payments applied to an Invoice object are returned in the response with LinkedTxn.TxnType set to Payment . Links to Payment transactions are established within the QuickBooks UI, only, and are available as read-only at the API level. Use LinkedTxn.TxnId as the ID in a separate read request for the specific resource to retrieve details of the linked object.
`body.LinkedTxn[]`	Model	Each item	Expand Create a bill — request body — body Linked Txn item
`body.MetaData`	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
`body.PrintStatus`	string	Optional	Printing status of the invoice. Valid values: NotSet , NeedToPrint , PrintComplete .
`body.PrivateNote`	string	Optional	User entered, organization-private note about the transaction. This note does not appear on the invoice to the customer. This field maps to the Statement Memo field on the Invoice form in the QuickBooks Online UI.
`body.ProjectRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the Project ID associated with this transaction. Conditionally required
`body.RecurDataRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to the Recurring Transaction. It captures what recurring transaction template the Invoice was created from. Read only: true
`body.SalesTermRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the sales term associated with the transaction. Query the Term name list resource to determine the appropriate Term object for this reference. Use Term.Id and Term.Name from that object for SalesTermRef.value and SalesTermRef.name , respectively.
`body.ShipAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Identifies the address where the goods must be shipped. If ShipAddr is not specified, and a default Customer:ShippingAddr is specified in QuickBooks for this customer, the default ship-to address will be used by QuickBooks. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
`body.ShipDate`	string	Optional	Date for delivery of goods or services.
`body.ShipFromAddr`	Model	Optional	Expand Create a vendor — request body — body Bill Addr Identifies the address where the goods are shipped from. For transactions without shipping, it represents the address where the sale took place. If automated sales tax is enabled ( Preferences.TaxPrefs.PartnerTaxEnabled is set to true ) and automated tax calculations are being used, this field is required for an accurate sales tax calculation. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings. Conditionally required
`body.ShipMethodRef`	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the ShipMethod associated with the transaction. There is no shipping method list. Reference resolves to a string. Reference to the ShipMethod associated with the transaction. There is no shipping method list. Reference resolves to a string.
`body.SyncToken`	string	Required within parent
`body.TaxExemptionRef`	JSON	Optional
`body.TaxExemptionRef (anyOf 1)`	Model	Alternative	Expand Create a purchase order — request body — body Ship To Reference to the TaxExepmtion ID associated with this object. Available for companies that have automated sales tax enabled. TaxExemptionRef.Name : The Tax Exemption Id for the customer to which this object is associated. This Id is typically issued by the state. TaxExemptionRef.value : The system-generated Id of the exemption type. For internal use only Read only: true
`body.TaxExemptionRef (anyOf 2)`	object	Alternative	Maximum fields: 0
`body.TotalAmt`	JSON	Optional	Indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes. Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. Decimal string Read only: true
`body.TotalAmt (anyOf 1)`	number	Alternative
`body.TotalAmt (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
`body.TrackingNum`	string	Optional	Shipping provider’s tracking number for the delivery of the goods associated with the transaction.
`body.TransactionLocationType`	string	Optional	The account location. For UAE, valid values include ABUDHABI AJMAN SHARJAH DUBAI FUJAIRAH RAS_AL_KHAIMAH UMM_AL_QUWAIN OTHER_GCC
`body.TxnDate`	string	Optional	The date entered by the user when this transaction occurred. yyyy/MM/dd is the valid date format. For posting transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used. Sort order is ASC by default.
`body.TxnSource`	string	Optional	Used internally to specify originating source of a credit card transaction.
`body.TxnTaxDetail`	Model	Optional	Expand Create a bill — request body — body Txn Tax Detail This data type provides information for taxes charged on the transaction as a whole. It captures the details sales taxes calculated for the transaction based on the tax codes referenced by the transaction. This can be calculated by QuickBooks business logic or you may supply it when adding a transaction. See Global tax model for more information about this element. If sales tax is disabled ( Preferences.TaxPrefs.UsingSalesTax is set to false ) then TxnTaxDetail is ignored and not stored.
`body.domain`	string	Optional
`body.sparse`	boolean	Required within parent	Must equal: true

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: allowed
`time`	string	Optional
`Invoice`	Model	Optional	Expand Read an invoice — response body — Invoice

Referenced models: Read an invoice — response body — Invoice

Policy, approvals and errors

SDK function policy ID: quickbooks.invoice.sparse_update_an_invoice. Catalog operation: invoices/create. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source

Report an issue with this page