QuickBooks: Void an invoice — request body — body Line item Amount, Description, Detail Type, Id, Line Num, Sub Total Line Detail
Void an invoice: request body, field body / Line / item / Amount, Description, DetailType, Id, LineNum, SubTotalLineDetail. 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, Detail Type, Id, Line Num, Sub Total Line Detail
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
Amount | JSON | Required within parent | The amount of the line item. Decimal string |
Amount (anyOf 1) | number | Alternative | |
Amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?$ |
Description | string | Optional | Free form text description of the line item that appears in the printed record. |
DetailType | string | Required within parent | Set to SubTotalLineDetail 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) | number | Alternative | |
LineNum (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?$ |
SubTotalLineDetail | Model | Required within parent | Expand Void an invoice — request body — body Line item Amount, Description, Detail Type, Id, Line Num, Sub Total Line Detail Sub Total Line Detail Subtotal LineDetail |
Referenced models: Void an invoice — request body — body Line item Amount, Description, Detail Type, Id, Line Num, Sub Total Line Detail Sub Total Line Detail