QuickBooks: Void an invoice — request body — body Line item Amount, Description, Description Line Detail, Detail Type, Id, Line Num
Void an invoice: request body, field body / Line / item / Amount, Description, DescriptionLineDetail, DetailType, Id, LineNum. Complete fields and constraints for contract 2026-10-20.
API reference · Contract 2026-10-20
SDK schema: Void an invoice — request body — body Line item Amount, Description, Description Line Detail, Detail Type, Id, Line Num
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
Amount | JSON | Optional | The amount of the line item. Available when Amount is set via the QuickBooks UI. Returned only for Description Only line items that have a non-empty amount associated with them. Decimal string Read only: true |
Amount (anyOf 1) | number | Alternative | |
Amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?$ |
Description | string | Optional | A string representing one of the following: Free form text description of the line item that appears in the printed record. A subtotal line inline with other lines on the sales form and holds the sum of amounts on all lines above it. This is distinct from the overall transaction subtotal represented with a SubTotal detail line. In create requests, set to Subtotal: (case sensitive) to create the subtotal line; the amount is generated by QuickBooks Online business logic. In read requests, lines with Subtotal: nn.nn returned in this field denote subtotal lines in the object. |
DescriptionLineDetail | Model | Required within parent | Expand Void an invoice — request body — body Line item Amount, Description, Description Line Detail, Detail Type, Id, Line Num Description Line Detail |
DetailType | string | Required within parent | Set to DescriptionOnly 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 transaction, the request is considered an update operation for the description 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 transaction then the request is considered a create operation for the description 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) | number | Alternative | |
LineNum (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?$ |
Referenced models: Void an invoice — request body — body Line item Amount, Description, Description Line Detail, Detail Type, Id, Line Num Description Line Detail