ContactModel

A Contact contains information about a person or role within a Company.
You can use Contacts to track information about who is responsible for a specific project,
who handles invoices, or information about which role at a particular customer or
vendor you should speak with about invoices.

Methods

Fields

contactId

uuid, read-only

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

For the ID of this record in its originating financial system, see ErpKey.

companyId

uuid

The ID of the company to which this contact belongs.

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.

erpKey

string, nullable, 0-100 characters

The unique ID of this record as it was known in its originating financial system.

If this company record was imported from a financial system, it will have the value ErpKey
set to the original primary key number of the record as it was known in the originating financial
system. If this record was not imported, this value will be null.

For more information, see Identity Columns.

contactName

string, nullable, 0-100 characters

The name of the contact.

contactCode

string, nullable, 0-20 characters

A friendly human-readable code that describes this Contact.

title

string, nullable, 0-50 characters

The title of the contact.

roleCode

string, nullable, 0-20 characters

The role code for the contact.

emailAddress

email, nullable, 0-200 characters

The email address of the contact.

phone

string, nullable, 0-20 characters

The phone number of the contact.

fax

string, nullable, 0-20 characters

The fax number of the contact.

address1

string, nullable, 0-80 characters

The first line of the address.

address2

string, nullable, 0-80 characters

The second line of the address.

address3

string, nullable, 0-80 characters

The third line of the address.

city

string, nullable, 0-100 characters

The city of the address.

stateRegion

string, nullable, 0-20 characters

The state/region of the address.

postalCode

string, nullable, 0-10 characters

The postal/zip code of the address.

countryCode

string, nullable, 2-2 characters

The two character country code of the address. This will be validated by the /api/v1/countries data set

isActive

boolean, read-only

Flag indicating if the contact is active.

webpageUrl

uri, nullable, 0-512 characters

The webpage url of the contact.

pictureUrl

uri, nullable, 0-512 characters

The picture/avatar url of the contact.

created

date-time, nullable, read-only

The date on which this record was created.

createdUserId

uuid, read-only

The ID of the user who created this contact.

modified

date-time, nullable, read-only

The date on which this record was last modified.

modifiedUserId

uuid, read-only

The ID of the user who last modified this contact.

appEnrollmentId

uuid, nullable, read-only

AppEnrollmentId for this record; used for mapping purposes.

notes

NoteModel[], nullable, read-only

All notes attached to this company.
To retrieve this collection, specify Notes in the "Include" parameter for your query.

attachments

AttachmentModel[], nullable, read-only

All attachments attached to this company.
To retrieve this collection, specify Attachments in the "Include" parameter for your query.

customFieldDefinitions

CustomFieldDefinitionModel[], nullable, read-only

All definitions attached to this contact.
To retrieve this collection, specify CustomFieldValues in the "Include" parameter for your query.

customFieldValues

CustomFieldValueModel[], nullable, read-only

All values attached to this contact.
To retrieve this collection, specify Attachments in the "Include" parameter for your query.


Did this page help you?