CompanySyncModel
Less than to read
The CompanySyncModel 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 CompanySyncModel 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 CompanyModel.
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 Company record. For this field, you should use whatever the company’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 company records in a database, whatever the primary key for the company table is
in the database should be the ErpKey.
Example: If you use a financial system such as QuickBooks or Xero, look for the primary ID number of the company record within that financial system.
For more information, see Identity Columns.
companyName
A friendly, short name of the company.
companyType
This field indicates the type of company. It can be one of a limited number of values: Company,
Customer, Group, Vendor, or Third Party. A company that represents both a customer and a vendor is
identified as a CustomerVendor.
When loading data into Sage Network, you should focus on the distinction between a company that is part of your own enterprise, or a company that is external to your enterprise.
For a company that is within your enterprise, you should set this value to be Company.
For a company that is external to your enterprise, you should set this value to either Customer,
Vendor, Third Party, or CustomerVendor. If you don’t know what value to choose, select
CustomerVendor.
isActive
This flag indicates whether the company is currently active. An inactive company will be hidden from the user interface but will still be available for querying.
Optional Fields
parentCompanyErpKey
string, nullable
If this company has a parent company, identify the parent company’s ErpKey value here. This value should
be the original primary key or unique ID of the parent company to this company belongs. This value should
match the original ErpKey field on the parent company.
If this company is not a child company, leave this field null.
defaultCurrencyCode
string, nullable
The default currency code for transactions related to this company. For a list of currency codes, see Query Currencies.
companyLogoUrl
string, nullable
The URL of this company’s logo, if known.
primaryContactErpKey
string, nullable
The ErpKey of the primary contact for this company. This value should match the ErpKey value of the
ContactModel record for the contact table.
address1
string, nullable
The company’s primary mailing address information
address2
string, nullable
The company’s primary mailing address information
address3
string, nullable
The company’s primary mailing address information
city
string, nullable
The company’s primary mailing address information
stateRegion
string, nullable
The company’s primary mailing address information
postalCode
string, nullable
The company’s primary mailing address information
country
string, nullable
The company’s primary mailing address information
phoneNumber
string, nullable
The main phone number of this company.
faxNumber
string, nullable
The main fax number of this company.
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.
taxId
string, nullable
The company’s Tax ID number for the appropriate government for this company.
dunsNumber
string, nullable
The Dun and Bradstreet number for this company, if known.
preferredDeliveryMethod
string, nullable
Indicates the preferred invoice delivery method. Examples include Print, Email, Fax
emailAddress
string, nullable
The company email address.
externalReference
string, nullable
An external reference that identifies the Company from the originating ERP system, separate from the ErpKey.
companyRegistrationNumber
string, nullable
A unique identification number assigned to the company by the national registration office.
Deprecated Fields
Deprecated fields are maintained for backwards compatibility with previous versions of the API. Deprecated fields may be removed in a future release of the API.
apEmailAddress
string, nullable
If you know the AP (accounts payable) email address of this company, fill it in here. This is the email address where you would send questions to the company if the company owed you money.
arEmailAddress
string, nullable
If you know the AR (accounts receivable) email address of this company, fill it in here. This is the email address where you would send questions to the company if you owed this company money.