Value Type

ByteValue

Wrapper type for byte values

Wraps primitive:byte

ByteValue

A wrapper type that encapsulates a byte (8-bit unsigned integer) value in API requests and responses.

Overview

ByteValue is used in the Acumatica API to wrap 8-bit unsigned integer properties. This type is used for fields with very small value ranges.

JSON Structure

{
  "value": 255
}

Examples

Reading a ByteValue

{
  "Priority": {
    "value": 1
  }
}

Setting a ByteValue

{
  "Priority": {
    "value": 2
  }
}

Properties

PropertyTypeDescription
valuebyte8-bit unsigned integer (0 to 255)
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: 0
  • Maximum: 255

Common Fields Using ByteValue

  • Priority levels
  • Status codes
  • Small flag or option values