QuickBooks: Read a deposit — response body — Deposit

API reference · Contract 2026-10-20

SDK schema: Read a deposit — response body — Deposit

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: allowed
CashBack	Model	Optional	Expand Read a deposit — response body — Deposit Cash Back
CurrencyRef	Model	Optional	Expand Read a bill — response body — Bill 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
DepartmentRef	Model	Optional	Expand Read an item — response body — Item Class Ref 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.
DepositToAccountRef	Model	Optional	Expand Read an item — response body — Item Class Ref 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.
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
ExchangeRate (anyOf 1)	JSON	Alternative
ExchangeRate (anyOf 1) (anyOf 1)	number	Alternative
ExchangeRate (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
ExchangeRate (anyOf 2)	string	Alternative
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
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
HomeTotalAmt (anyOf 1)	JSON	Alternative
HomeTotalAmt (anyOf 1) (anyOf 1)	number	Alternative
HomeTotalAmt (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
HomeTotalAmt (anyOf 2)	string	Alternative
Id	string	Optional	Unique identifier for this object. Read only: true
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
Line[]	JSON	Each item
Line[] (anyOf 1)	Model	Alternative	Expand Read a payment — response body — Payment Line item
Line[] (anyOf 2)	Model	Alternative	Expand Read a deposit — response body — Deposit Line item Amount, Custom Extensions, Custom Field, Deposit Line Detail, Description, Detail Type, Id, Line Num, Project Ref
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.
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.
RecurDataRef	Model	Optional	Expand Read an item — response body — Item Class Ref A reference to the Recurring Transaction. It captures what recurring transaction template the Deposit was created from. Read only: true
SyncToken	string	Optional	Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online. Read only: true
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
TotalAmt (anyOf 1)	JSON	Alternative
TotalAmt (anyOf 1) (anyOf 1)	number	Alternative
TotalAmt (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
TotalAmt (anyOf 2)	string	Alternative
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.
TxnSource	string	Optional	Used internally to specify originating source of a credit card transaction.
TxnTaxDetail	Model	Optional	Expand Read a bill — response body — Bill 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.

Referenced models: Read a deposit — response body — Deposit Cash Back, Read a bill — response body — Bill Currency Ref, Read a deposit — response body — Deposit Line item Amount, Custom Extensions, Custom Field, Deposit Line Detail, Description, Detail Type, Id, Line Num, Project Ref, Read a payment — response body — Payment Line item, Read a bill — response body — Bill Meta Data, Read an item — response body — Item Class Ref, Read a bill — response body — Bill Txn Tax Detail