ContactSyncModel
Less than to read
The ContactSyncModel represents information coming into Sage Network from an external financial system or other enterprise resource planning system. To import data from an external system, convert your original data into the ContactSyncModel format and call the Upload Sync File API. This API retrieves all of the data you uploaded in a compressed ZIP file and imports it into the Sage Network platform.
Once imported, this record will be available in the Sage Network API as a ContactModel.
For more information on writing your own connector, see Connector Data.
Required Fields
onMatchAction
MatchAction
Indicates what action to take when an existing object has been found during the sync process.
erpKey
This is the primary key of the Contact record. For this field, you should use whatever the contact’s unique identifying number is in the originating system. Search for a unique, non-changing number within the originating financial system for this record.
Example: If you store your contact records in a database, whatever the primary key for the contact table is in the database should be the “ErpKey”.
As some ERP systems don’t maintain a unique key for Contacts, we also support syncing Contacts with ERP keys of the form {prefix}|{index}, for example ContactPrefix|1, ContactPrefix|2 and so on.
For this reason, please ensure that your Contact ERP keys don’t otherwise contain the ‘|’ symbol or that it is replaced by an alternate symbol if they do.
For more information, see Identity Columns.
companyErpKey
The original primary key or unique ID of the company to which this contact belongs. This value should match the Company ErpKey field on the CompanySyncModel.
isActive
True if this contact is considered “active”.
Optional Fields
contactName
string, nullable
The name of the contact.
contactCode
string, nullable
A friendly human-readable code that describes this Contact.
title
string, nullable
The title of the contact.
roleCode
string, nullable
The role code for the contact.
emailAddress
string, nullable
The email address of the contact.
phone
string, nullable
The phone number of the contact.
fax
string, nullable
The fax number of the contact.
address1
string, nullable
The mailing address information for this contact.
address2
string, nullable
The mailing address information for this contact.
address3
string, nullable
The mailing address information for this contact.
city
string, nullable
The mailing address information for this contact.
stateRegion
string, nullable
The mailing address information for this contact.
postalCode
string, nullable
The mailing address information for this contact.
countryCode
string, nullable
The mailing address information for this contact.
webpageUrl
string, nullable
A webpage URL for more information about this contact.
pictureUrl
string, nullable
If available, the URL of a photograph that shows this contact.
created
date-time, nullable
If known, the date when this record was created according to the originating financial system in which this record is maintained. If the originating financial system does not maintain a created-date, leave this field null.
modified
date-time, nullable
If known, the date when this record was most recently modified according to the originating financial system in which this record is maintained. If the originating financial system does not maintain a most-recently-modified-date, leave this field null.