Skip to content

Import Contacts to Brightpearl

This task will create new and update existing contacts in Brightpearl from an XML file. Please note that when updating an updating an existing contact, only the following fields can be set in Brightpearl:

  • salutation
  • firstName
  • lastName
  • postalAddresses
  • communication/emails
  • communication/telephones
  • marketingDetails/isReceiveEmailNewsletter
  • leadTime
  • companyId
  • customFields

Settings

Connection

Required
The Brightpearl connection to use. See Connecting to Brightpearl.

Fail File

Required
The file to save failed records to.

Input File

Required
The file containing records to import.

Success File

Required
The file to save successful records to.

Match Addresses On

Optional
Select the fields to use when matching addresses in Brightpearl. This is used when an address ID is not supplied in the input file. If multiple fields are specified, only address where all of the fields match will be considered a match. The following fields can be used for matching:

  • addressLine1
  • postalCode

Match Contacts On

Optional
Select the fields to use when matching contacts in Brightpearl. This is used when an contact ID is not supplied in the input file. If multiple fields are specified, only contacts where all of the fields match will be considered a match. The following fields can be used for matching:

  • companyName
  • firstName
  • lastName
  • primaryEmail
  • secondaryEmail
  • tertiaryEmail

Prevent Reprocessing

Required
Set to true to prevent the same records being processed more than once, based on the value of the externalId element in the XML.

Zynk Settings

See Common Task Settings

Examples

Sample input file is shown below:

<?xml version="1.0"?>
<ArrayOfContact>
  <Contact>
    <externalId>734</externalId>
    <isPrimaryContact>true</isPrimaryContact>
    <salutation>Mr.</salutation>
    <firstName>Joe</firstName>
    <lastName>Bloggs</lastName>
    <postalAddresses>
      <postalAddress>
        <addressLine1>6-8 Charlotte Square</addressLine1>
        <addressLine3>Newcastle upon Tyne</addressLine3>
        <addressLine4>Tyne and Wear</addressLine4>
        <postalCode>NE1 4XF</postalCode>
        <countryIsoCode>GBR</countryIsoCode>
        <countryId>222</countryId>
        <isDefaultAddress>true</isDefaultAddress>
        <isInvoiceAddress>true</isInvoiceAddress>
        <isDeliveryAddress>true</isDeliveryAddress>
      </postalAddress>
    </postalAddresses>
    <communication>
      <emails>
        <PRI>
          <email>[email protected]</email>
        </PRI>
      </emails>
      <telephones>
        <PRI>01913037279</PRI>
      </telephones>
      <messagingVoips>
        <SKP>jb</SKP>
      </messagingVoips>
      <websites>
        <PRI>https://zynk.com/</PRI>
      </websites>
    </communication>
    <relationshipToAccount>
      <isSupplier>false</isSupplier>
      <isStaff>false</isStaff>
    </relationshipToAccount>
    <marketingDetails>
      <isReceiveEmailNewsletter>true</isReceiveEmailNewsletter>
    </marketingDetails>
    <financialDetails>
      <priceList>
        <id>2</id>
        <code>RETAIL</code>
      </priceList>
      <nominalCode>0</nominalCode>
      <creditLimit>1000</creditLimit>
      <creditTermDays>0</creditTermDays>
      <currency>
        <id>1</id>
        <code>GBP</code>
      </currency>
      <discountPercentage>0</discountPercentage>
      <taxCode>
        <id>1</id>
        <code>STANDARD</code>
      </taxCode>
    </financialDetails>
    <assignment>
      <current>
        <accountReference>JOEB0002</accountReference>
      </current>
    </assignment>
    <organisation>
      <organisationId>205</organisationId>
      <name>Zynk Software</name>
    </organisation>
    <leadTime>5</leadTime>
    <aliases>
      <ebay>jb</ebay>
    <aliases>
    <companyId>58</companyId>
  </Contact>
</ArrayOfContact>