Common Types

Base classes and value wrapper types used throughout the Acumatica API. These types are shared across all API families and versions.

Base Types

Foundational classes that API entities inherit from.

Entity

Base class for all API entities

Value Wrapper Types

Wrapper types used to encapsulate primitive values in API requests and responses. This wrapper pattern allows the API to distinguish between "no value provided" and "explicitly set to null".

BooleanValueboolean

Wrapper type for boolean values

ByteValuebyte

Wrapper type for byte values

DateTimeValueDateTime

Wrapper type for date and time values

DecimalValuedecimal

Wrapper type for decimal values

DoubleValuedouble

Wrapper type for double-precision floating point values

GuidValueGuid

Wrapper type for GUID/UUID values

IntValueint

Wrapper type for integer values

LongValuelong

Wrapper type for long integer values

ShortValueshort

Wrapper type for short integer values

StringValuestring

Wrapper type for string values

How Value Wrappers Work

All property values in the Acumatica API are wrapped in type-specific objects. For example, a string property is returned as: 

{
  "CustomerID": {
    "value": "CUST001"
  }
}

This pattern provides several benefits:

  • Distinguishes between "field not included" and "field set to null"
  • Enables consistent handling of optional fields
  • Supports partial updates without ambiguity

Error Property

All value wrapper types include an inherited error property that contains a description when there is a validation or processing issue with the field. This is critical for understanding field-level errors in API responses.

{
  "CustomerID": {
    "value": "INVALID",
    "error": "Customer 'INVALID' not found"
  }
}

Always check the error property when processing API responses to handle field-level issues appropriately.