AccountingProfileContactResultModel
Less than to read
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.
An Accounting Profile Contact has a link to a Contact that is associated with your company’s Accounting Profile. These Contacts are secondary contacts to the primary that is on the profile.
Methods
The following API methods use this data model.
- Query Linked Accounting Profile Contacts
Read-Only Fields
These fields are assigned by the API server and cannot be changed.
contactId
uuid, read-only
The unique ID of this record, automatically assigned by Sage Network when this record is added to the Sage Network.
For the ID of this record in its originating financial system, see ErpKey.
groupKey
uuid, read-only
The GroupKey uniquely identifies a single Sage Network 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.
isActive
boolean, read-only
Flag indicating if the contact is active.
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 contact.
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 contact.
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
companyId
The ID of the company to which this contact belongs.
isPrimary
Determines whether the contact is primary or secondary.
accountingProfileId
The ID of the profile this contact belongs to.
accountingProfileContactId
The ID of the accounting profile contact this contact matches.
Optional Fields
erpKey
string, nullable, 0-100 characters
The unique ID of this record as it was known in its originating financial system.
If this contact 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/definitions/countries data set
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.
name
string, nullable
The Name of the profile this contact belongs to.
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 Contact and the ObjectKey set to the ContactId 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 Contact and the ObjectKey set to the ContactId 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 Contact and the ObjectKey set to the ContactId 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 Contact and the ObjectKey set to the ContactId for this record. For
more information on extensibility, see linking extensible metadata to objects.