Export Journals from Brightpearl

This task will download journals from Brightpearl in XML format.

Settings

Connection

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

Export Details

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

Export Settings -> Journal Date From

Required
Only journals dated from this date will be exported. This date will update automatically each time the task runs.

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" encoding="utf-8"?>
<ArrayOfJournal xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Journal>
    <externalId />
    <createdOn>2026-05-12T00:00:00+01:00</createdOn>
    <updatedOn xsi:nil="true" />
    <id>24</id>
    <contactId xsi:nil="true" />
    <journalTypeCode>JJ</journalTypeCode>
    <taxDate>2026-05-12T00:00:00+01:00</taxDate>
    <dueDate>2026-05-12T00:00:00+01:00</dueDate>
    <createdByContactId>4</createdByContactId>
    <currencyId>1</currencyId>
    <exchangeRate>1.000000</exchangeRate>
    <taxReconciliation>
      <date xsi:nil="true" />
      <taxPeriodId xsi:nil="true" />
    </taxReconciliation>
    <credits>
      <credit>
        <nominalCode>4000</nominalCode>
        <change>
          <value>100.00</value>
        </change>
        <assignment>
          <projectId xsi:nil="true" />
          <channelId xsi:nil="true" />
          <leadSourceId xsi:nil="true" />
        </assignment>
        <orderId xsi:nil="true" />
        <taxCode>T9</taxCode>
        <transactionAmount>100.00</transactionAmount>
      </credit>
    </credits>
    <debits>
      <debit>
        <nominalCode>1200</nominalCode>
        <change>
          <value>100.00</value>
        </change>
        <assignment>
          <projectId xsi:nil="true" />
          <channelId xsi:nil="true" />
          <leadSourceId xsi:nil="true" />
        </assignment>
        <orderId xsi:nil="true" />
        <taxCode>T9</taxCode>
        <transactionAmount>100.00</transactionAmount>
      </debit>
    </debits>
  </Journal>
</ArrayOfJournal>