Export Contact Payments from Sage Business Cloud Accounting

This task will download contact payments from your instance of Sage Business Cloud Accounting in a Sage Business Cloud Accounting Contact Payment XML format.

Settings

Sage Business Cloud Accounting Connection

Required
The connection to Sage Business Cloud Accounting to use. See Connecting To Sage Business Cloud Accounting if you require more information on how to create/manage connections.

Export All

Required
Set to true to export all records from Sage Business Cloud Accounting, or false to only export those updated since the date specified in the 'Export From' setting.

Export From

Required
The date to export new/modified records from. This setting only takes effect when 'Export All' is set to false. The date will update automatically each time the task runs.

Output File

Required
The file to save the downloaded records to.

Items Per Page

Required
The number records to fetch per request to Sage Business Cloud Accounting. Increasing this value will reduce the number of requests needed to export the records, which may reduce the time taken.

Transaction Type

Required
Filters the export to the chosen transaction type. Choose 'ALL' to export transactions of any type.

Zynk Settings

See Common Task Settings

Example

A sample output file is shown below. See Sage Business Cloud Accounting Contact Payment XML for full documentation of the XML format.

<?xml version="1.0" encoding="utf-8"?>
<sage_one_company xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <contact_payments>
    <contact_payment>
      <external_id>215316</external_id>
      <legacy_id>332651813</legacy_id>
      <id>198040b2de5c4932a5fca686db839f06</id>
      <displayed_as />
      <path>/contact_payments/198040b2de5c4932a5fca686db839f06</path>
      <transaction>
        <legacy_id>638120988</legacy_id>
        <id>5ce1f10c6fe0437488f84fac190504ce</id>
        <displayed_as />
        <path>/transactions/5ce1f10c6fe0437488f84fac190504ce</path>
        <created_at xsi:nil="true" />
        <updated_at xsi:nil="true" />
        <deleted xsi:nil="true" />
        <total xsi:nil="true" />
      </transaction>
      <created_at>2021-10-01T11:54:01Z</created_at>
      <updated_at>2021-10-01T11:54:01Z</updated_at>
      <deleted_at xsi:nil="true" />
      <transaction_type>
        <legacy_id>7</legacy_id>
        <id>CUSTOMER_RECEIPT</id>
        <displayed_as>Customer Receipt</displayed_as>
        <path>/transaction_types/CUSTOMER_RECEIPT</path>
      </transaction_type>
      <payment_method>
        <legacy_id>6</legacy_id>
        <id>CREDIT_DEBIT</id>
        <displayed_as>Credit/Debit Card</displayed_as>
        <path>/payment_methods/CREDIT_DEBIT</path>
      </payment_method>
      <contact>
        <legacy_id>91978108</legacy_id>
        <id>20ad90621c474923b08262bc373f1772</id>
        <displayed_as>Zynk Software</displayed_as>
        <path>/contacts/20ad90621c474923b08262bc373f1772</path>
        <created_at xsi:nil="true" />
        <updated_at xsi:nil="true" />
        <credit_limit xsi:nil="true" />
        <credit_days xsi:nil="true" />
        <deletable xsi:nil="true" />
      </contact>
      <bank_account>
        <legacy_id>2203081</legacy_id>
        <id>565541926ee74ad3948d339765fb496b</id>
        <displayed_as>Bank Account (1200)</displayed_as>
        <path>/bank_accounts/565541926ee74ad3948d339765fb496b</path>
        <created_at xsi:nil="true" />
        <updated_at xsi:nil="true" />
        <balance xsi:nil="true" />
        <nominal_code xsi:nil="true" />
        <editable xsi:nil="true" />
        <deletable xsi:nil="true" />
      </bank_account>
      <date>2021-10-01T00:00:00</date>
      <net_amount>559.02</net_amount>
      <tax_amount>128.58</tax_amount>
      <total_amount>687.6</total_amount>
      <currency>
        <legacy_id>9</legacy_id>
        <id>EUR</id>
        <displayed_as>Euro (EUR)</displayed_as>
        <path>/currencies/EUR</path>
      </currency>
      <exchange_rate>1</exchange_rate>
      <base_currency_net_amount>559.02</base_currency_net_amount>
      <base_currency_tax_amount>128.58</base_currency_tax_amount>
      <base_currency_total_amount>687.6</base_currency_total_amount>
      <base_currency_currency_charge>0</base_currency_currency_charge>
      <allocated_artefacts>
        <allocated_artefact>
          <legacy_id>233419042</legacy_id>
          <id>e53cb54d44be4008bac55c99df78a7e8</id>
          <artefact>
            <legacy_id>254207919</legacy_id>
            <id>668189cba5074fafbdd585c03a79fa30</id>
            <displayed_as>SI-223</displayed_as>
            <path>/sales_invoices/668189cba5074fafbdd585c03a79fa30</path>
          </artefact>
          <amount>687.6</amount>
          <discount>0</discount>
        </allocated_artefact>
      </allocated_artefacts>
      <editable>true</editable>
    </contact_payment>
  </contact_payments>
</sage_one_company>