Zynk Workflow Documentation

This task will download sales credit notes from your instance of Sage One.

Settings

Sage One Connection

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

Export All

Required
Set to true to export all records from Sage One, 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 One. Increasing this value will reduce the number of requests needed to export the records, which may reduce the time taken.

Optional
Enter a search to filter the records returned.

Zynk Settings

See Common Task Settings.

Example

A sample output file is shown below.

<?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">
  <sales_credit_notes>
    <sales_credit_note>
      <legacy_id>84495763</legacy_id>
      <id>ed497010d64a4920a55a7b868b3e5766</id>
      <displayed_as>SCN-58</displayed_as>
      <path>/sales_credit_notes/ed497010d64a4920a55a7b868b3e5766</path>
      <transaction>
        <legacy_id>199580138</legacy_id>
        <id>546bde878aa047ec8a366e2c1d174a79</id>
        <displayed_as>12235</displayed_as>
        <path>/transactions/546bde878aa047ec8a366e2c1d174a79</path>
        <created_at xsi:nil="true" />
        <updated_at xsi:nil="true" />
        <deleted xsi:nil="true" />
        <total xsi:nil="true" />
      </transaction>
      <created_at>2018-11-23T14:39:30Z</created_at>
      <updated_at>2018-11-23T14:39:30Z</updated_at>
      <contact_name>Zynk Software</contact_name>
      <contact_reference>ZYNK0001</contact_reference>
      <contact>
        <legacy_id>31966735</legacy_id>
        <id>7e6a7104ad2611e8bad90617b3da4b8a</id>
        <displayed_as>Zynk Software (ZYNK0001)</displayed_as>
        <path>/contacts/7e6a7104ad2611e8bad90617b3da4b8a</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>
      <date>2018-11-23T00:00:00</date>
      <reference>12235</reference>
      <notes />
      <net_amount>5</net_amount>
      <tax_amount>1</tax_amount>
      <total_amount>6</total_amount>
      <outstanding_amount>6</outstanding_amount>
      <currency>
        <legacy_id>10</legacy_id>
        <id>GBP</id>
        <displayed_as>Pound Sterling (GBP)</displayed_as>
        <path>/currencies/GBP</path>
      </currency>
      <exchange_rate>1</exchange_rate>
      <base_currency_net_amount>5</base_currency_net_amount>
      <base_currency_tax_amount>1</base_currency_tax_amount>
      <base_currency_total_amount>6</base_currency_total_amount>
      <base_currency_outstanding_amount>6</base_currency_outstanding_amount>
      <status>
        <legacy_id>1</legacy_id>
        <id>UNPAID</id>
        <displayed_as>Unpaid</displayed_as>
        <path>/artefact_statuses/UNPAID</path>
      </status>
      <credit_note_lines>
        <credit_note_line>
          <legacy_id>106020817</legacy_id>
          <id>4ed03450b6134b688a8205d6a68e9fc7</id>
          <displayed_as>50 Coloured Pencils</displayed_as>
          <description>50 Coloured Pencils</description>
          <product>
            <legacy_id>4596393</legacy_id>
            <id>1020a6efe3de11e7aa730a57719b2edb</id>
            <displayed_as>50 Coloured Pencils</displayed_as>
            <path>/products/1020a6efe3de11e7aa730a57719b2edb</path>
            <created_at xsi:nil="true" />
            <updated_at xsi:nil="true" />
            <deleted_at xsi:nil="true" />
            <active xsi:nil="true" />
            <cost_price xsi:nil="true" />
          </product>
          <ledger_account>
            <legacy_id>2654285</legacy_id>
            <id>d959c74d180811e691e20a5d7cf84c3e</id>
            <displayed_as>Sales Type A (4000)</displayed_as>
            <path>/ledger_accounts/d959c74d180811e691e20a5d7cf84c3e</path>
            <created_at xsi:nil="true" />
            <updated_at xsi:nil="true" />
            <included_in_chart xsi:nil="true" />
            <nominal_code xsi:nil="true" />
            <fixed_tax_rate xsi:nil="true" />
            <visible_in_banking xsi:nil="true" />
            <visible_in_expenses xsi:nil="true" />
            <visible_in_journals xsi:nil="true" />
            <visible_in_other_payments xsi:nil="true" />
            <visible_in_other_receipts xsi:nil="true" />
            <visible_in_reporting xsi:nil="true" />
            <visible_in_sales xsi:nil="true" />
            <is_control_account xsi:nil="true" />
          </ledger_account>
          <quantity>1</quantity>
          <unit_price>5</unit_price>
          <net_amount>5</net_amount>
          <tax_rate>
            <legacy_id>1</legacy_id>
            <id>GB_STANDARD</id>
            <displayed_as>Standard 20.00%</displayed_as>
            <path>/tax_rates/GB_STANDARD</path>
            <created_at xsi:nil="true" />
            <updated_at xsi:nil="true" />
            <percentage xsi:nil="true" />
            <is_visible xsi:nil="true" />
            <is_combined_rate xsi:nil="true" />
            <editable xsi:nil="true" />
            <deletable xsi:nil="true" />
          </tax_rate>
          <tax_amount>1</tax_amount>
          <tax_breakdown>
            <tax>
              <tax_rate>
                <legacy_id>1</legacy_id>
                <id>GB_STANDARD</id>
                <displayed_as>Standard 20.00%</displayed_as>
                <path>/tax_rates/GB_STANDARD</path>
                <created_at xsi:nil="true" />
                <updated_at xsi:nil="true" />
                <percentage xsi:nil="true" />
                <is_visible xsi:nil="true" />
                <is_combined_rate xsi:nil="true" />
                <editable xsi:nil="true" />
                <deletable xsi:nil="true" />
              </tax_rate>
              <percentage>20</percentage>
              <amount>1</amount>
            </tax>
          </tax_breakdown>
          <discount_amount>0</discount_amount>
          <total_amount>6</total_amount>
          <base_currency_unit_price>5</base_currency_unit_price>
          <base_currency_net_amount>5</base_currency_net_amount>
          <base_currency_tax_amount>1</base_currency_tax_amount>
          <base_currency_tax_breakdown>
            <tax>
              <tax_rate>
                <legacy_id>1</legacy_id>
                <id>GB_STANDARD</id>
                <displayed_as>Standard 20.00%</displayed_as>
                <path>/tax_rates/GB_STANDARD</path>
                <created_at xsi:nil="true" />
                <updated_at xsi:nil="true" />
                <percentage xsi:nil="true" />
                <is_visible xsi:nil="true" />
                <is_combined_rate xsi:nil="true" />
                <editable xsi:nil="true" />
                <deletable xsi:nil="true" />
              </tax_rate>
              <percentage>20</percentage>
              <amount>1</amount>
            </tax>
          </base_currency_tax_breakdown>
          <base_currency_total_amount>6</base_currency_total_amount>
          <base_currency_discount_amount>0</base_currency_discount_amount>
        </credit_note_line>
      </credit_note_lines>
      <tax_analysis>
        <tax>
          <tax_rate>
            <legacy_id>1</legacy_id>
            <id>GB_STANDARD</id>
            <displayed_as>Standard 20.00%</displayed_as>
            <path>/tax_rates/GB_STANDARD</path>
            <created_at xsi:nil="true" />
            <updated_at xsi:nil="true" />
            <percentage xsi:nil="true" />
            <is_visible xsi:nil="true" />
            <is_combined_rate xsi:nil="true" />
            <editable xsi:nil="true" />
            <deletable xsi:nil="true" />
          </tax_rate>
          <net_amount>5</net_amount>
          <tax_amount>1</tax_amount>
          <total_amount>6</total_amount>
          <goods_amount>0</goods_amount>
          <service_amount>0</service_amount>
        </tax>
      </tax_analysis>
      <main_address_free_form>Zynk Software
6-8 Charlotte Square
Newcastle upon Type
Tyne &amp; Wear
NE1 4XF</main_address_free_form>
      <main_address>
        <legacy_id>55900275</legacy_id>
        <id>38d5ed7399ae4b0198fa32a50a1a96a4</id>
        <displayed_as>Zynk Software
6-8 Charlotte Square
Newcastle upon Type
Tyne &amp; Wear
NE1 4XF</displayed_as>
        <path>/contacts/38d5ed7399ae4b0198fa32a50a1a96a4</path>
        <created_at xsi:nil="true" />
        <updated_at xsi:nil="true" />
        <deleted_at xsi:nil="true" />
        <address_type>
          <legacy_id>3</legacy_id>
          <id>SALES</id>
          <displayed_as>Sales</displayed_as>
          <path>/address_types/SALES</path>
        </address_type>
        <address_line_1>Zynk Software</address_line_1>
        <address_line_2>6-8 Charlotte Square</address_line_2>
        <city>Newcastle upon Type</city>
        <region>Tyne &amp; Wear</region>
        <postal_code>NE1 4XF</postal_code>
        <country>
          <legacy_id>218</legacy_id>
          <id>GB</id>
          <displayed_as>United Kingdom (GB)</displayed_as>
          <path>/countries/GB</path>
        </country>
        <country_group>
          <legacy_id>4</legacy_id>
          <id>GBIE</id>
          <displayed_as>UK &amp; Ireland</displayed_as>
          <path>/country_groups/GBIE</path>
        </country_group>
        <is_main_address xsi:nil="true" />
      </main_address>
      <delivery_address_free_form>Zynk Software
6-8 Charlotte Square
Newcastle upon Type
Tyne &amp; Wear
NE1 4XF</delivery_address_free_form>
      <delivery_address>
        <legacy_id>55900276</legacy_id>
        <id>c7dcff1f61474a29825f99383367608a</id>
        <displayed_as>Zynk Software
6-8 Charlotte Square
Newcastle upon Type
Tyne &amp; Wear
NE1 4XF</displayed_as>
        <path>/contacts/c7dcff1f61474a29825f99383367608a</path>
        <created_at xsi:nil="true" />
        <updated_at xsi:nil="true" />
        <deleted_at xsi:nil="true" />
        <address_type>
          <legacy_id>1</legacy_id>
          <id>DELIVERY</id>
          <displayed_as>Delivery</displayed_as>
          <path>/address_types/DELIVERY</path>
        </address_type>
        <address_line_1>Zynk Software</address_line_1>
        <address_line_2>6-8 Charlotte Square</address_line_2>
        <city>Newcastle upon Type</city>
        <region>Tyne &amp; Wear</region>
        <postal_code>NE1 4XF</postal_code>
        <country>
          <legacy_id>218</legacy_id>
          <id>GB</id>
          <displayed_as>United Kingdom (GB)</displayed_as>
          <path>/countries/GB</path>
        </country>
        <country_group>
          <legacy_id>4</legacy_id>
          <id>GBIE</id>
          <displayed_as>UK &amp; Ireland</displayed_as>
          <path>/country_groups/GBIE</path>
        </country_group>
        <is_main_address xsi:nil="true" />
      </delivery_address>
      <shipping_net_amount>0</shipping_net_amount>
      <shipping_tax_rate>
        <legacy_id>1</legacy_id>
        <id>GB_STANDARD</id>
        <displayed_as>Standard 20.00%</displayed_as>
        <path>/tax_rates/GB_STANDARD</path>
        <created_at xsi:nil="true" />
        <updated_at xsi:nil="true" />
        <percentage xsi:nil="true" />
        <is_visible xsi:nil="true" />
        <is_combined_rate xsi:nil="true" />
        <editable xsi:nil="true" />
        <deletable xsi:nil="true" />
      </shipping_tax_rate>
      <shipping_tax_amount>0</shipping_tax_amount>
      <shipping_tax_breakdown />
      <shipping_total_amount>0</shipping_total_amount>
      <base_currency_shipping_net_amount>0</base_currency_shipping_net_amount>
      <base_currency_shipping_tax_amount>0</base_currency_shipping_tax_amount>
      <base_currency_shipping_tax_breakdown />
      <base_currency_shipping_total_amount>0</base_currency_shipping_total_amount>
    </sales_credit_note>
  </sales_credit_notes>
</sage_one_company>

Back | Edit on Github