AccountingProfileModel
An Accounting Profile is a child of a Company Profile, and collectively,
they comprise the identity and necessary information for an accounting team
to work with trading partners, financial institutions, auditors, and others.
You can use Accounting Profiles to define an accounting function by what
the function does and how to interface with the function.
Methods
The following API methods use this data model.
- Retrieve Accounting Profile
- Update Accounting Profile
- Create Accounting Profiles
- Query Accounting Profiles
Read-Only Fields
These fields are assigned by the API server and cannot be changed.
accountingProfileId
uuid, read-only
The unique ID of this record, automatically assigned by Lockstep when this record is
added to the Lockstep platform.
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 on which this record was created.
createdUserId
uuid, read-only
The ID of the user who created this accounting profile.
modified
date-time, read-only
The date on which this record was last modified.
modifiedUserId
uuid, read-only
The ID of the user who last modified this accounting profile.
Required Fields
companyId
uuid, min 1 characters
The ID of the company profile to which this accounting profile belongs.
name
string, 1-100 characters
The name of the accounting profile.
type
string, 1-50 characters
The type of the accounting profile.
Some examples include 'AR', 'AP', 'AR+AP', 'General Accounting', 'Treasury', 'Payroll', 'Finance'
emailAddress
email, 1-200 characters
The email address associated with the accounting profile.
Optional Fields
phone
string, nullable, max 20 characters
The phone number associated with the accounting profile.
address1
string, nullable, max 100 characters
The first line of the address.
address2
string, nullable, max 100 characters
The second line of the address.
address3
string, nullable, max 100 characters
The third line of the address.
city
string, nullable, max 100 characters
The city of the address.
region
string, nullable, max 20 characters
The state/region of the address.
postalCode
string, nullable, max 10 characters
The postal/zip code of the address.
country
string, nullable, 2-2 characters
The two character country code of the address.
Included Collections
These fields are available when using Retrieve or Query API calls if you specify the associated Include
parameter.
notes
NoteModel[], nullable, read-only
A collection of notes linked to this record. To retrieve this collection, specify Notes
in the
include
parameter when retrieving data.
To create a note, use the Create Note
endpoint with the TableKey
to AccountingProfile
and the ObjectKey
set to the AccountingProfileId
for this record. For
more information on extensibility, see linking extensible metadata to objects.
attachments
AttachmentModel[], nullable, read-only
A collection of attachments linked to this record. To retrieve this collection, specify Attachments
in
the include
parameter when retrieving data.
To create an attachment, use the Upload Attachment
endpoint with the TableKey
to AccountingProfile
and the ObjectKey
set to the AccountingProfileId
for this record. For
more information on extensibility, see linking extensible metadata to objects.
customFieldDefinitions
CustomFieldDefinitionModel[], nullable, read-only
A collection of custom fields linked to this record. To retrieve this collection, specify
CustomFieldDefinitions
in the include
parameter when retrieving data.
To create a custom field, use the Create Custom Field
endpoint with the TableKey
to AccountingProfile
and the ObjectKey
set to the AccountingProfileId
for this record. For
more information on extensibility, see linking extensible metadata to objects.
customFieldValues
CustomFieldValueModel[], nullable, read-only
A collection of custom fields linked to this record. To retrieve this collection, specify
CustomFieldValues
in the include
parameter when retrieving data.
To create a custom field, use the Create Custom Field
endpoint with the TableKey
to AccountingProfile
and the ObjectKey
set to the AccountingProfileId
for this record. For
more information on extensibility, see linking extensible metadata to objects.
Updated 20 days ago