Skip to content

QuickBooks: Delete a deposit — request body — body

Delete a deposit: request body, field body. Complete fields and constraints for contract 2026-10-20.

API reference · Contract 2026-10-20

SDK schema: Delete a deposit — request body — body

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
CashBackModelOptionalExpand Create a deposit — request body — body Cash Back
CurrencyRefModelOptionalExpand 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
DepartmentRefModelOptionalExpand 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.
DepositToAccountRefModelOptionalExpand 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.
ExchangeRateJSONOptionalThe 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
ExchangeRate (anyOf 1)numberAlternative
ExchangeRate (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?$
GlobalTaxCalculationstringOptionalMethod in which tax is applied. Allowed values are: TaxExcluded , TaxInclusive , and NotApplicable . Not applicable to US companies; required for non-US companies.
Conditionally required
HomeTotalAmtJSONOptionalTotal 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
HomeTotalAmt (anyOf 1)numberAlternative
HomeTotalAmt (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?$
IdstringRequired within parent
LinearrayOptionalIndividual 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
Line[]JSONEach item
Line[] (anyOf 1)ModelAlternativeExpand Void a payment — request body — body Line item
Line[] (anyOf 2)ModelAlternativeExpand Create a deposit — request body — body Line item
MetaDataModelOptionalExpand 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.
PrivateNotestringOptionalUser 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.
RecurDataRefModelOptionalExpand 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
SyncTokenstringRequired within parent
TotalAmtJSONOptionalIndicates 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
TotalAmt (anyOf 1)numberAlternative
TotalAmt (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?$
TxnDatestringOptionalThe 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.
TxnSourcestringOptionalUsed internally to specify originating source of a credit card transaction.
TxnTaxDetailModelOptionalExpand 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.
idstringOptionalUnique identifier for this object.
Read only: true
domainstringOptional
sparsebooleanOptional

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

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.