QuickBooks: Sparse update a deposit

← deposit operations · Get started · OpenAPI downloads

Contract 2026-10-20 · Operation quickbooks.deposit.sparse_update_a_deposit

Provider route: POST /v3/company/{realmID}/deposit. 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["deposit"]["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.deposit.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.deposit.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.CashBack	Model	Optional	Expand Create a deposit — request body — body Cash Back
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 . The CurrencyRef can be overwritten by the Line.DepositLineDetail Entity. If the customer that you are referring to has a default currency of USD then the currency for this Deposit will always be set as USD. Conditionally required
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, as defined using location tracking in QuickBooks Online. 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.DepositToAccountRef	Model	Optional	Expand Create a purchase order — request body — body Ship To Identifies the account to be used for this deposit. 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 DepostiToAccountRef.name , respectively.
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.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.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.Line	array	Optional	Individual line items comprising the deposit. Specify a Line.LinkedTxn element along with DepositLine detail type if this line is to record a deposit for an existing transaction. Select UndepositedFunds account on the existing transaction to make it available for the Deposit. Possible types of transactions that can be linked to a Deposit include: Transfer , Payment (for Cash, CreditCard, and Check payment method types), SalesReceipt , RefundReceipt , JournalEntry . In addition, any expense object whose line item has AccountReceivable can be linked to a Payment and then that Payment can be linked to a Deposit object. Use Line.LinkedTxn.TxnId as the ID in a separate read request for the specific resource to retrieve details of the linked object. Valid Line types include: LinkedTxn and DepositLine
body.Line[]	JSON	Each item
body.Line[] (anyOf 1)	Model	Alternative	Expand Void a payment — request body — body Line item
body.Line[] (anyOf 2)	Model	Alternative	Expand Create a deposit — request body — body Line 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.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 Memo field on the Invoice form.
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 Deposit was created from. Read only: true
body.SyncToken	string	Required within parent
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.TxnDate	string	Optional	The date entered by the user when this transaction occurred. 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

Referenced models: Read a bill — response body — Bill Meta Data, Create a deposit — request body — body Cash Back, Create a bill — request body — body Currency Ref, Create a deposit — request body — body Line item, Void a payment — request body — body Line item, Create a purchase order — request body — body Ship To, Create a bill — request body — body Txn Tax Detail

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
Deposit	Model	Optional	Expand Read a deposit — response body — Deposit

Referenced models: Read a deposit — response body — Deposit

Policy, approvals and errors

SDK function policy ID: quickbooks.deposit.sparse_update_a_deposit. Catalog operation: deposit/create_a_deposit. 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