GroupAccountModel
Represents an account for an entire group
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
The date this group account was created
createdUserId
uuid, read-only
The ID of the user who created this group account
modified
date-time, read-only
The date this group account was last modified
modifiedUserId
uuid, read-only
The ID of the user who last modified this group account
Required Fields
groupName
string, 1-99 characters
The name of the group
primaryUserId
uuid, min 1 characters
The primary user for the group
groupCompanyId
uuid, min 1 characters
The CompanyId of the Company the group is associated with
baseCurrencyCode
string, 3-3 characters
Base Currency of the group
isActive
The active status of the group
onboardingScheduled
The onboarding session status of the group
countryCode
string, 2-2 characters
The 2-letter ISO country code for the group
Updated about 1 month ago