CustomFieldValueModel

A Custom Field represents metadata added to an object within the Lockstep Platform. Lockstep provides a
core definition for each object. The core definition is intended to represent a level of compatibility
that provides support across most accounting systems and products. When a user or developer requires
information beyond this core definition, you can use Custom Fields to represent this information.

See Extensibility for more information.

Methods

The following API methods use this data model.

Read-Only Fields

These fields are assigned by the API server and cannot be changed.

groupKey

uuid, read-only

The GroupKey uniquely identifies a single Lockstep Platform account. All records for this
account will share the same GroupKey value. GroupKey values cannot be changed once created.

For more information, see Accounts and GroupKeys.

created

date-time, read-only

Date created

createdUserId

uuid, read-only

Id of user who created this value

modified

date-time, read-only

Date modified

modifiedUserId

uuid, read-only

Id of user who modified this value

appEnrollmentId

uuid, nullable, read-only

The AppEnrollmentId of the application that imported this attachment record. For accounts
with more than one financial system connected, this field identifies the originating
financial system that produced this record. This value is null if this record
was not loaded from an external ERP or financial system.

customFieldDefinition

CustomFieldDefinitionModel, nullable, read-only

Definition of the value

Required Fields

customFieldDefinitionId

uuid

The unique ID of this record, automatically assigned by Lockstep when this record is
added to the Lockstep platform.

recordKey

uuid

Additional key if source table doesn't have a unique id

Optional Fields

value

string, nullable, 0-2048 characters

The value of this custom field.

Deprecated Fields

Deprecated fields are maintained for backwards compatibility with previous versions of the API. Deprecated fields may be removed in a future release of the API.

stringValue

string, nullable, max 2048 characters

String of data for field

numericValue

double, nullable

Number data for field


Did this page help you?