Value Type

ShortValue

Wrapper type for short integer values

Wraps primitive:short

ShortValue

A wrapper type that encapsulates a short (16-bit integer) value in API requests and responses.

Overview

ShortValue is used in the Acumatica API to wrap 16-bit integer properties. This type is less common than IntValue but is used for fields with smaller value ranges.

JSON Structure

{
  "value": 123
}

Examples

Reading a ShortValue

{
  "SortOrder": {
    "value": 10
  }
}

Setting a ShortValue

{
  "SortOrder": {
    "value": 20
  }
}

Properties

PropertyTypeDescription
valueshort16-bit signed integer (-32,768 to 32,767)
errorstringError message describing validation or processing issues with this field

Error Handling

All value wrapper types inherit an error property that contains a description when there is an issue with the field. Always check this property when processing API responses.

Value Range

  • Minimum: -32,768
  • Maximum: 32,767

Common Fields Using ShortValue

  • Sort order fields
  • Sequence numbers with limited range
  • Small counter fields