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

• Retrieve Field Definition
• Update Field Definition
• Delete Field Definition
• Create Field Definitions
• Query Field Definitions

Fields

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.

customFieldDefinitionId

uuid, read-only

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

tableKey

string, nullable, 0-40 characters

Table to which this definition belongs

appId

uuid, nullable

Id of app this definition belongs to

customFieldLabel

string, nullable, 0-256 characters

Text to display in-application for custom field

dataType

string, nullable, 0-10 characters

Data type of this definition

sortOrder

int32

Used for display logic when multiple custom fields exist

created

date-time, read-only

Date created

createdUserId

uuid, read-only

Id of user who created this definition

modified

date-time, read-only

Date modified

modifiedUserId

uuid, read-only

Id of user who modified this definition

appEnrollmentId

uuid, nullable, read-only

AppEnrollmentId for this record; used for mapping purposes.