Skip to content

Import Customer Payments into Brightpearl

This task will create new customer payments in Brightpearl from an XML file. Please note that the task does not support updating existing customer payments.

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.

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 containing the minimum information required to create a customer payment:

<?xml version="1.0"?>
<ArrayOfCustomerPayment>
  <CustomerPayment>
    <externalId>121234</externalId>
    <transactionRef>8173093254</transactionRef>
    <transactionCode>8173093254</transactionCode>
    <paymentMethodCode>ACME_PAY</paymentMethodCode>
    <paymentType>RECEIPT</paymentType>
    <order>
      <id>17</id>
      <reference>ORDER-048134</reference>
    </order>
    <currencyIsoCode>GBP</currencyIsoCode>
    <exchangeRate>1.000</exchangeRate>
    <amountPaid>10.00</amountPaid>
    <journalRef>Online order 048134 prepaid</journalRef>
    <paymentDate>2026-03-03T15:00:00</paymentDate>
  </CustomerPayment>
</ArrayOfCustomerPayment>