QuickBooks: 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 deposit: response body, field Deposit / Line / item / Amount, CustomExtensions, CustomField, DepositLineDetail, Description, DetailType, Id, LineNum, ProjectRef. Complete fields and constraints for contract 2026-10-20.
API reference · Contract 2026-10-20
SDK schema: Read a deposit — response body — Deposit Line item Amount, Custom Extensions, Custom Field, Deposit Line Detail, Description, Detail Type, Id, Line Num, Project Ref
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
Amount | JSON | Optional | The amount of the line item. Decimal string |
Amount (anyOf 1) | JSON | Alternative | |
Amount (anyOf 1) (anyOf 1) | number | Alternative | |
Amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Amount (anyOf 2) | string | Alternative | |
CustomExtensions | Model | Optional | Expand Read an item — response body — Item Custom Extensions Array of custom extension objects that associate additional attributes with the line. The ExtensionType field specifies the type of extension. The currently supported value is DIMENSION . The AssociatedValues array contains key/value pairs referencing Dimensions DefinitionID/Dimension ValueID. Multiple key/value pairs per extension type are supported. This field is designed to support additional extension types in the future. Dimensions is available for Intuit Enterprise Suite. |
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. |
CustomField[] | Model | Each item | Expand Read an invoice — response body — Invoice Custom Field item |
DepositLineDetail | Model | Optional | 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 Deposit Line Detail |
Description | string | Optional | Free form text description of the line item that appears in the printed record. |
DetailType | string | Optional | Set to DepositLineDetail for this type of line. |
Id | string | Optional | The Id of the line item. Its use in requests is as folllows: If Id is greater than zero and exists for the company, the request is considered an update operation for a line item. If no Id is provided, the Id provided is less than or equal to zero, or the Id provided is greater than zero and does not exist for the company then the request is considered a create operation for a line item. Available in all objects that use lines and support the update operation. Read only: true |
LineNum | JSON | Optional | Specifies the position of the line in the collection of transaction lines. Positive integer Decimal string |
LineNum (anyOf 1) | JSON | Alternative | |
LineNum (anyOf 1) (anyOf 1) | number | Alternative | |
LineNum (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
LineNum (anyOf 2) | string | Alternative | |
ProjectRef | Model | Optional | Expand Read an item — response body — Item Class Ref Reference to the Project ID associated with this transaction. Conditionally required |
Referenced models: Read an item — response body — Item Custom Extensions, Read an invoice — response body — Invoice Custom Field item, Read a deposit — response body — Deposit Line item Amount, Custom Extensions, Custom Field, Deposit Line Detail, Description, Detail Type, Id, Line Num, Project Ref Deposit Line Detail, Read an item — response body — Item Class Ref