Export Contacts from Brightpearl

This task will download contacts from Brightpearl in XML format.

Settings

Connection

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

Contact Type

Required
Select the type of contacts to export from Brightpearl. The available options are:

Any - All types of contact will be downloaded
Customers - Only customer contacts will be downloaded
Suppliers - Only supplier contacts will be downloaded
Staff - Only staff contacts will be downloaded

Export Custom Fields

Required
Set to true to download the values of any custom fields that have been set up on the records.

Export Details

Required
Set to true to export related data for each record.

This will include the address, currency, price list and tax code.

Export Settings -> Date Created

Required
When the 'Export Modified, New or All Records' setting is set to 'New', only records created after this date will be exported. This date will update automatically each time the task runs.

Export Settings -> Date Modified

Required
When the 'Export Modified, New or All Records' setting is set to 'Modified', only records updated after this date will be exported. This date will update automatically each time the task runs.

Export Settings -> Export Modified, New or All

Required
Choose which records should be included in the export. The available options are:

New - Only records created since the date specified in the 'Date Created' setting will be exported.
Modified - Only records modified since the date specified in the 'Date Modified' setting will be exported.
All - Records will not be filtered based on date created or modified.

Filter

Optional
Specify criteria to filter the results returned e.g. firstName=John&lastName=Smith.

ID Set

Optional
Specify the record ID numbers and/or ranges to export. The ID numbers must be provided in numerical order. For example, the ID set 1,3,5-8,10 would download the records with ID 1, 3, 5, 6, 7, 8 and 10. Please note that this setting overrides the Filter and Export Settings.

Output File

Required
The XML file to save the downloaded records to. A sample of the XML format is shown below.

Zynk Settings

See Common Task Settings

Examples

Sample output file:

<?xml version="1.0"?>
<ArrayOfContact>
  <Contact>
    <externalId />
    <createdOn>2010-08-17T13:57:14+01:00</createdOn>
    <updatedOn>2016-11-24T10:11:22Z</updatedOn>
    <contactId>200</contactId>
    <isPrimaryContact>true</isPrimaryContact>
    <salutation>Mr.</salutation>
    <firstName>Demo</firstName>
    <lastName>Customer</lastName>
    <postalAddresses>
      <postalAddress>
        <addressId>107</addressId>
        <addressLine1>34 Lime St</addressLine1>
        <addressLine2>Barton</addressLine2>
        <addressLine3>Sheffield</addressLine3>
        <addressLine4>South Yorkshire</addressLine4>
        <postalCode>S1 4RT</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>01245 845632</PRI>
      </telephones>
      <messagingVoips />
      <websites />
    </communication>
    <contactStatus>
      <current>
        <contactStatusId>0</contactStatusId>
      </current>
    </contactStatus>
    <relationshipToAccount>
      <isSupplier>false</isSupplier>
      <isStaff>false</isStaff>
    </relationshipToAccount>
    <marketingDetails>
      <isReceiveEmailNewsletterStaff xsi:nil="true" />
    </marketingDetails>
    <financialDetails>
      <priceList>
        <id>1</id>
        <name>
          <languageCode>en</languageCode>
          <text>Cost</text>
          <format>PLAINTEXT</format>
        </name>
        <code>COST</code>
        <currencyCode>GBP</currencyCode>
        <currencySymbol>£</currencySymbol>
        <currencyId>1</currencyId>
        <priceListTypeCode>BUY</priceListTypeCode>
        <gross>false</gross>
      </priceList>
      <nominalCode>0</nominalCode>
      <creditLimit>1000</creditLimit>
      <creditTermDays>30</creditTermDays>
      <currency>
        <id>1</id>
        <title>British Pound Sterling</title>
        <code>GBP</code>
        <symbol>£</symbol>
        <exchangeRate>1.000000</exchangeRate>
        <isDefault>true</isDefault>
      </currency>
      <discountPercentage>0</discountPercentage>
    </financialDetails>
    <assignment>
      <current>
        <staffOwnerContactId xsi:nil="true" />
        <departmentId xsi:nil="true" />
        <leadSourceId xsi:nil="true" />
        <channelId xsi:nil="true" />
        <projectId xsi:nil="true" />
      </current>
    </assignment>
    <organisation>
      <organisationId xsi:nil="true" />
      <name>Customer Company Ltd.</name>
    </organisation>
    <createdByid>2</createdByid>
    <contactTags>1</contactTags>
    <customFields />
  </Contact>
</ArrayOfContact>