QuickBooks: Read an invoice — response body — Invoice Line item Amount, Custom Extensions, Description, Detail Type, Id, Line Num, Sales Item Line Detail Sales Item Line Detail
Read an invoice: response body, field Invoice / Line / item / Amount, CustomExtensions, Description, DetailType, Id, LineNum, SalesItemLineDetail / SalesItemLineDetail. Complete fields and constraints for contract 2026-10-20.
API reference · Contract 2026-10-20
SDK schema: Read an invoice — response body — Invoice Line item Amount, Custom Extensions, Description, Detail Type, Id, Line Num, Sales Item Line Detail Sales Item Line Detail
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
ClassRef | Model | Optional | Expand Read an item — response body — Item Class Ref Reference to the Class for the line item. Available if Preferences.AccountingInfoPrefs.ClassTrackingPerLine 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. |
ItemAccountRef | Model | Optional | Expand Read an item — response body — Item Class Ref Available with invoice objects, only, and when there is a linkedtxn of type ReimburseCharge for this object. When ItemRef.Id is set to 1, ItemAccountRef maps to the reimbursable charge account. |
ItemRef | Model | Optional | Expand Read an item — response body — Item Class Ref Reference to an Item object. Query the Item name list resource to determine the appropriate Item object for this reference. Use Item.Id and Item.Name from that object for ItemRef.value and ItemRef.name , respectively. Set ItemRef.value to SHIPPING_ITEM_ID when Line.amount represents transaction-wide shipping charges. Valid when Preferences.SalesFormsPrefs.AllowShipping is set to true . Set ItemRef.value to GRATUITY_ITEM_ID when Line.amount represents transaction-wide gratuity amount. Valid when Preferences.OtherPrefs.Name.SalesFormsPrefs.AllowGratuity is set to true . When a line lacks an ItemRef it is treated as documentation and the Line.Amount attribute is ignored. Applicable to invoice objects, only, and when linktxn specifies a ReimburseCharge . When Item.Id is set to 1, ItemAccountRef refers to reimburse expense account Id. |
MarkupInfo | Model | Optional | Expand Read an invoice — response body — Invoice Line item Amount, Custom Extensions, Description, Detail Type, Id, Line Num, Sales Item Line Detail Sales Item Line Detail Markup Info Used to define markup when this line represents a billable expense on the invoice. Markup information for the billable expense line. |
Qty | JSON | Optional | Number of items for the line. Decimal string |
Qty (anyOf 1) | JSON | Alternative | |
Qty (anyOf 1) (anyOf 1) | number | Alternative | |
Qty (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Qty (anyOf 2) | string | Alternative | |
ServiceDate | string | Optional | Date when the service is performed. |
TaxClassificationRef | Model | Optional | Expand Read an item — response body — Item Class Ref Reference to the TaxClassification for this item. Available for companies that have automated sales tax enabled. TaxClassificationRef.Name : Currently not populated. TaxClassificationRef.value : The system-defined Tax Classification code that is applied to this line item. For internal use only. Read only: true |
TaxCodeRef | Model | Optional | Expand Read an item — response body — Item Class Ref Reference to the TaxCode for this item. Query the TaxCode name list resource to determine the appropriate TaxCode object for this reference. Use TaxCode.Id and TaxCode.Name from that object for TaxCodeRef.value and TaxCodeRef.name , respectively. |
TaxInclusiveAmt | JSON | Optional | The total amount of the line item including tax. Decimal string |
TaxInclusiveAmt (anyOf 1) | JSON | Alternative | |
TaxInclusiveAmt (anyOf 1) (anyOf 1) | number | Alternative | |
TaxInclusiveAmt (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
TaxInclusiveAmt (anyOf 2) | string | Alternative | |
UnitPrice | JSON | Optional | Unit price of the subject item as referenced by ItemRef . Corresponds to the Rate column on the QuickBooks Online UI to specify either unit price, a discount, or a tax rate for item. If used for unit price, the monetary value of the service or product, as expressed in the home currency. You can override the unit price of the subject item by supplying a new value with create or update operations. If used for a discount or tax rate, express the percentage as a fraction. For example, specify 0.4 for 40% tax. Decimal string |
UnitPrice (anyOf 1) | JSON | Alternative | |
UnitPrice (anyOf 1) (anyOf 1) | number | Alternative | |
UnitPrice (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
UnitPrice (anyOf 2) | string | Alternative |
Referenced models: Read an invoice — response body — Invoice Line item Amount, Custom Extensions, Description, Detail Type, Id, Line Num, Sales Item Line Detail Sales Item Line Detail Markup Info, Read an item — response body — Item Class Ref