CustomFieldDefinitionModel

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.

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

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 definition

modified

date-time, read-only

Date modified

modifiedUserId

uuid, read-only

Id of user who modified this definition

appEnrollmentId

uuid, nullable, read-only

The AppEnrollmentId of the application that imported this 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.

Required Fields

sortOrder

int32

Used for display logic when multiple custom fields exist

Optional Fields

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

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.

customFieldDefinitionId

uuid, read-only

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