Value Type

GuidValue

Wrapper type for GUID/UUID values

Wraps primitive:Guid

GuidValue

A wrapper type that encapsulates a Guid (globally unique identifier) value in API requests and responses.

Overview

GuidValue is used throughout the Acumatica API to wrap GUID properties. GUIDs are used as unique identifiers for records and for linking related entities.

JSON Structure

{
  "value": "e47a0b2c-1234-5678-abcd-ef1234567890"
}

Examples

Reading a GuidValue

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

{
  "NoteID": {
    "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  "RefNoteID": {
    "value": "98765432-abcd-ef12-3456-7890abcdef12"
  }
}

Setting a GuidValue

When creating or updating an entity, provide the GUID string:

{
  "RefNoteID": {
    "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
}

Properties

PropertyTypeDescription
valueGuidUUID in standard format (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)
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.

GUID Format

GUIDs follow the standard UUID format with 32 hexadecimal characters in 5 groups: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Common Fields Using GuidValue

  • NoteID, RefNoteID
  • Entity reference IDs
  • Attachment and file identifiers
  • Any unique identifier field in the API