Zynk Workflow Documentation

This task will download invoices from Magento in Magento XML format. The results can be filtered if required. See below for a sample output file.

Settings

Connection

Required
The Magento connection to use. See the Connecting to Magento article if you require more information on how to create/manage connections.

Download All

Required
Set to true to download all invoices which match the filter, or false to also filter on new/modified invoices.

Download From

Required
The rolling date the download new/modified invoices from. This will update automatically each time the task runs.

Start Date

Optional
No invoices created before this date will be downloaded, even if modified.

Output File

Required
The name of the file to export the invoices to.

Filter Property

Optional
The property the filter is to be based upon. The property name should match the API field name, as seen in the output file.

Filter Type

Optional
The following types of filter are available:

Filter Value

Optional
The value the filter is to be based upon. When using the eq filter type, you can specify multiple values by separating them with commas, or using the ‘Use a list’ option after clicking the ellipsis (…) button.

Invoice Status

Required
Set a filter for the status of the invoices to be downloaded. Select from All, Pending, Paid, Cancelled.

Zynk Settings

See Common Task Settings.

Examples

Sample output file:

<?xml version="1.0"?>
<ArrayOfInvoiceInfo>
  <InvoiceInfo>
    <Fields>
      <Field Name="subtotal_incl_tax" Value="10.0000" />
      <Field Name="base_subtotal_incl_tax" Value="10.0000" />
      <Field Name="base_shipping_hidden_tax_amnt" Value="" />
      <Field Name="shipping_incl_tax" Value="5.0000" />
      <Field Name="base_shipping_incl_tax" Value="5.0000" />
      <Field Name="comments" Value="" />
    </Fields>
    <billing_address_id>1</billing_address_id>
    <invoice_id>1</invoice_id>
    <order_increment_id>100000001</order_increment_id>
    <order_currency_code>GBP</order_currency_code>
    <store_id>1</store_id>
    <created_at>2014-04-22 10:17:23</created_at>
    <increment_id>100000001</increment_id>
    <updated_at>2014-04-22 10:17:23</updated_at>
    <order_id>1</order_id>
    <state>2</state>
    <grand_total>15.0000</grand_total>
    <base_grand_total>15.0000</base_grand_total>
    <shipping_tax_amount>0.0000</shipping_tax_amount>
    <tax_amount>0.0000</tax_amount>
    <base_tax_amount>0.0000</base_tax_amount>
    <store_to_order_rate>1.0000</store_to_order_rate>
    <base_shipping_tax_amount>0.0000</base_shipping_tax_amount>
    <base_discount_amount>0.0000</base_discount_amount>
    <base_to_order_rate>1.0000</base_to_order_rate>
    <shipping_amount>5.0000</shipping_amount>
    <store_to_base_rate>1.0000</store_to_base_rate>
    <base_shipping_amount>5.0000</base_shipping_amount>
    <total_qty>1.0000</total_qty>
    <base_to_global_rate>1.0000</base_to_global_rate>
    <subtotal>10.0000</subtotal>
    <base_subtotal>10.0000</base_subtotal>
    <discount_amount>0.0000</discount_amount>
    <can_void_flag>0</can_void_flag>
    <shipping_address_id>2</shipping_address_id>
    <store_currency_code>GBP</store_currency_code>
    <base_currency_code>GBP</base_currency_code>
    <global_currency_code>GBP</global_currency_code>
    <hidden_tax_amount>0.0000</hidden_tax_amount>
    <base_hidden_tax_amount>0.0000</base_hidden_tax_amount>
    <shipping_hidden_tax_amount>0.0000</shipping_hidden_tax_amount>
    <items>
      <InvoiceProduct>
        <Fields>
          <Field Name="price_incl_tax" Value="10.0000" />
          <Field Name="base_price_incl_tax" Value="10.0000" />
          <Field Name="base_row_total_incl_tax" Value="10.0000" />
          <Field Name="row_total_incl_tax" Value="10.0000" />
          <Field Name="base_weee_tax_applied_row_amnt" Value="0.0000" />
          <Field Name="item_id" Value="1" />
        </Fields>
        <product_id>1</product_id>
        <sku>ABC</sku>
        <name>test</name>
        <price>10.0000</price>
        <qty>1.0000</qty>
        <parent_id>1</parent_id>
        <base_price>10.0000</base_price>
        <base_weee_tax_row_disposition>0.0000</base_weee_tax_row_disposition>
        <weee_tax_applied_row_amount>0.0000</weee_tax_applied_row_amount>
        <base_weee_tax_applied_amount>0.0000</base_weee_tax_applied_amount>
        <tax_amount>0.0000</tax_amount>
        <base_row_total>10.0000</base_row_total>
        <row_total>10.0000</row_total>
        <weee_tax_row_disposition>0.0000</weee_tax_row_disposition>
        <base_weee_tax_disposition>0.0000</base_weee_tax_disposition>
        <weee_tax_applied_amount>0.0000</weee_tax_applied_amount>
        <base_tax_amount>0.0000</base_tax_amount>
        <weee_tax_disposition>0.0000</weee_tax_disposition>
        <base_weee_tax_applied_row_amount>0.0000</base_weee_tax_applied_row_amount>
        <order_item_id>1</order_item_id>
        <weee_tax_applied>a:0:{}</weee_tax_applied>
        <hidden_tax_amount>0.0000</hidden_tax_amount>
        <base_hidden_tax_amount>0.0000</base_hidden_tax_amount>
      </InvoiceProduct>
    </items>
  </InvoiceInfo>
</ArrayOfInvoiceInfo>

Back | Edit on Github