QuickBooks: Void an invoice — request body — body Line item Custom Extensions, Description, Detail Type, Group Line Detail, Id, Line Num
Void an invoice: request body, field body / Line / item / CustomExtensions, Description, DetailType, GroupLineDetail, 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 Custom Extensions, Description, Detail Type, Group Line Detail, Id, Line Num
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
CustomExtensions | Model | Optional | Expand Create an item — request body — body 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. |
Description | string | Optional | Free form text description of the line item that appears in the printed record. |
DetailType | string | Required within parent | Set to GroupLineDetail for this type of line. |
GroupLineDetail | Model | Required within parent | Expand Void an invoice — request body — body Line item Custom Extensions, Description, Detail Type, Group Line Detail, Id, Line Num Group Line Detail |
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]+)?$ |
Referenced models: Create an item — request body — body Custom Extensions, Void an invoice — request body — body Line item Custom Extensions, Description, Detail Type, Group Line Detail, Id, Line Num Group Line Detail