Skip to content

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

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
CustomExtensionsModelOptionalExpand 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.
DescriptionstringOptionalFree form text description of the line item that appears in the printed record.
DetailTypestringRequired within parentSet to GroupLineDetail for this type of line.
GroupLineDetailModelRequired within parentExpand Void an invoice — request body — body Line item Custom Extensions, Description, Detail Type, Group Line Detail, Id, Line Num Group Line Detail
IdstringOptionalThe 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
LineNumJSONOptionalSpecifies the position of the line in the collection of transaction lines. Positive integer
Decimal string
LineNum (anyOf 1)numberAlternative
LineNum (anyOf 2)stringAlternativePattern: ^-?[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

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.