Importing Companies via ConnectWise REST Interface

This task will import companies into the Companies -> Companies area of ConnectWise from an XML file. See below for a sample input file.

Records are created/updated based on the following rules:

• If an <id> is specified, the task will update the record with this ID.
• If an <externalId> is specified, and a corresponding entry is found in Zynk's truth table, the task will update the record with this ID.
• If one or more <lookup> elements have been specified, Zynk will search for a match based on each one in turn, and will update the first matching record it finds.
• If none of the above conditions are met, the task will create a new record.

When updating existing records, only writeable fields specified in the input file will be updated. Any other fields will keep their existing values.

Settings

ConnectWise REST Interface Connection

Required
The ConnectWise REST Interface connection to use. See the Connecting to ConnectWise REST Interface article if you require more information on how to create/manage connections.

Fail File

Required
The XML file to output any records that the task fails to process to. This can be an absolute or relative file path on the local computer or network. This will contain any errors which occur on the import.

Defaults to connectwise_import_companies_fail.xml

Input File

Required
The file containing the records to import into ConnectWise. This can be an absolute or relative file path on the local computer or network. The file must contain data in an XML format, a sample of which is shown below.

Defaults to (Output from previous task)

Success File

Required
The XML file to output any records that the task successfully processes to. This can be an absolute or relative file path on the local computer or network.

Defaults to connectwise_import_companies_success.xml

Match Companies On

Optional
Use this setting to select the fields companies should be matched on. If more than one is specified, the task will search for companies where all of the fields match. The following fields are available:

• identifier - This corresponds with the Company ID shown in ConnectWise Manage.
• accountNumber - This corresponds with the Account ID shown in ConnectWise Manage.
• vendorIdentifier - This corresponds with the Vendor ID shown in ConnectWise Manage.
• name - This corresponds with the company name shown in ConnectWise Manage.
• zip - This corresponds with the zip shown in the site in ConnectWise Manage.

Prevent Reprocessing

Required
Set this option to True to prevent the same record being processed more than once by Zynk. An <externalId> must be provided in the input file for this to work.

Timeout

Optional
The maximum length of time to wait (in seconds) for API requests to be processed. Specifying this value will override the timeout set at the connection level. Leave blank to use the value specified in the connection.

Zynk Settings

See Common Task Settings

Examples

A sample input file is shown below.

<?xml version="1.0" encoding="utf-8"?>
<Companies xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Company>
    <id>2</id>
    <externalId>MYCOM</externalId>
    <identifier>YourCompany</identifier>
    <name>Your Company</name>
    <status>
      <id>1</id>
      <name>Active</name>
    </status>
    <type>
      <id>5</id>
      <name>Partner</name>
    </type>
    <addressLine1>test</addressLine1>
    <addressLine2>test</addressLine2>
    <city>test</city>
    <state>MS</state>
    <zip>NE1 4XF</zip>
    <country>
      <id>1</id>
      <name>United States</name>
    </country>
    <phoneNumber>0191 820 1484</phoneNumber>
    <faxNumber />
    <website>http://www.example.com</website>
    <territoryId>38</territoryId>
    <marketId>23</marketId>
    <accountNumber>MYCOM</accountNumber>
    <defaultContact>
      <id>77</id>
      <name>Arnie Bellini</name>
    </defaultContact>
    <dateAcquired>2002-08-20T18:04:26Z</dateAcquired>
    <annualRevenue>0</annualRevenue>
    <numberOfEmployees xsi:nil="true" />
    <timeZone>
      <id>1</id>
      <name>US Eastern</name>
    </timeZone>
    <leadFlag>false</leadFlag>
    <unsubscribeFlag>false</unsubscribeFlag>
    <calendarId xsi:nil="true" />
    <vendorIdentifier />
    <taxIdentifier />
    <taxCode>
      <id>11</id>
      <name>Standard VAT</name>
    </taxCode>
    <billingTerms>
      <id>2</id>
      <name>Net 10</name>
    </billingTerms>
    <billToCompany>
      <id>2</id>
      <name>Your Company</name>
      <identifier>YourCompany</identifier>
    </billToCompany>
    <invoiceDeliveryMethod>
      <id>1</id>
      <name>Mail</name>
    </invoiceDeliveryMethod>
    <deletedFlag>false</deletedFlag>
    <dateDeleted xsi:nil="true" />
    <mobileGuid>f3bd951a-f535-446d-ba4e-fccb1f7ac954</mobileGuid>
    <customFields>
      <customField>
        <caption>Sage Ref</caption>
        <value>MYC001</value>
      </customField>
      <customField>
        <caption>CustomNumber</caption>
        <value>3.5</value>
      </customField>
    </customFields>
    <teams>
      <team>
        <teamRole>
          <name>Account Mgr</name>
        </teamRole>
        <member>
          <identifier>Admin1</identifier>
        </member>
        <locationId>0</locationId>
        <businessUnitId>0</businessUnitId>
      </team>
    </teams>
    <companyFinance>
        <customFields>
            <customField>
                <caption>Balance</caption>
                <value>100</value>
            </customField>
        </customFields>
    </companyFinance>
  </Company>
</Companies>