BooleanValue

A wrapper type that encapsulates a boolean value in API requests and responses.

Overview

BooleanValue is used throughout the Acumatica API to wrap boolean (true/false) properties. This wrapper pattern allows the API to distinguish between "no value provided" (field omitted) and "explicitly set to false".

JSON Structure

{
  "value": true
}

Examples

Reading a BooleanValue

When retrieving an entity, boolean properties are returned as objects:

{
  "Active": {
    "value": true
  },
  "Hold": {
    "value": false
  }
}

Setting a BooleanValue

When creating or updating an entity, provide the value in the wrapper:

{
  "Hold": {
    "value": true
  }
}

Properties

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.

Common Fields Using BooleanValue

• Active, Hold, Approved
• IsDefault, IsRequired, IsTaxable
• Override flags (e.g., BillToAddressOverride)
• Any yes/no or on/off field in the API