Zynk Workflow Documentation

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

Settings

Connection

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

Export Settings > Date Created

Required
When the ‘Export Modified, New or All Records’ setting is set to ‘New’, only invoices created after this date will be exported. This date will update automatically each time the task runs, to ensure only new invoices are exported each time.

Export Settings > Date Modified

Required
When the ‘Export Modified, New or All Records’ setting is set to ‘Modified’, only invoices updated after this date will be downloaded. This date will update automatically each time the task runs, to ensure only modified invoices are exported each time.

Export Settings > Export Modified, New or All Records

Required
Choose which records should be downloaded. The available options are:

Export Settings > Page Size

Required
The number of records to include in each page of results. Defaults to 100. Increasing this value will reduce the number of requests made to the API. The maximum value is 1000.

Output File

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

References To Fetch

Optional
The exported data may include fields which reference other records in ConnectWise. If you specify the reference field names here, and the task will fetch the related records and include them in the exported data.

Where Settings > Child Conditions

Optional
Use this setting to specify where clauses to filter the records returned. This setting is used to specify conditions surrounding standard fields which are part of an array.

Where Settings > Conditions

Optional
Use this setting to specify where clauses to filter the records returned. This setting is used to specify conditions surrounding standard fields.

Where Settings > Custom Field Conditions

Optional
Use this setting to specify where clauses to filter the records returned. This setting is used to specify conditions surrounding custom fields.

Where Settings > Condition > Comparison

Required
The following types of filter are available:

Where Settings > Condition > Field

Required
The name of the field the condition is to be based upon. The name should match the API field name, as seen in the output file. If using a reference field, include the name of the reference field followed by a slash, then the field to filter on. e.g. defaultContact/name

Filter Groups > Condition > Logic Operator

Optional
The logic operator to use with the next condition when building the where clause. Choose from:

Filter Groups > Condition > Value

Optional
The value the filter is to be based upon.

Zynk Settings

See Common Task Settings.

Examples

A sample output file is shown below.

<?xml version="1.0" encoding="utf-8"?>
<Invoices xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Invoice>
    <id>206</id>
    <externalId>23f13s</externalId>
    <_info>
      <dateEntered>2016-10-04T14:00:58Z</dateEntered>
      <enteredBy>Admin1</enteredBy>
      <lastUpdated>2018-02-08T10:36:47Z</lastUpdated>
      <updatedBy>Admin1</updatedBy>
    </_info>
    <invoiceNumber>197</invoiceNumber>
    <type>Miscellaneous</type>
    <status>
      <id>3</id>
      <name>Closed</name>
    </status>
    <company>
      <id>143</id>
      <name>TESTNEW</name>
      <identifier>TESTNEW</identifier>
    </company>
    <billToCompany>
      <id>143</id>
      <name>TESTNEW</name>
      <identifier>TESTNEW</identifier>
    </billToCompany>
    <shipToCompany>
      <id>143</id>
      <name>TESTNEW</name>
      <identifier>TESTNEW</identifier>
    </shipToCompany>
    <applyToId xsi:nil="true" />
    <attention>TT TT</attention>
    <billingSite>
      <id>146</id>
      <name>Main</name>
    </billingSite>
    <shippingSite>
      <id>146</id>
      <name>Main</name>
    </shippingSite>
    <billingTerms>
      <id>2</id>
      <name>Net 10</name>
    </billingTerms>
    <reference />
    <templateSetupId>1</templateSetupId>
    <emailTemplateId>1</emailTemplateId>
    <addToBatchEmailList>false</addToBatchEmailList>
    <date>2016-10-04T00:00:00Z</date>
    <restrictDownpaymentFlag>false</restrictDownpaymentFlag>
    <locationId>2</locationId>
    <departmentId>10</departmentId>
    <territoryId>39</territoryId>
    <topComment />
    <bottomComment />
    <taxableFlag>false</taxableFlag>
    <taxCode>
      <id>21</id>
      <name>UK VAT Rates</name>
    </taxCode>
    <internalNotes />
    <downpaymentPreviouslyTaxedFlag>false</downpaymentPreviouslyTaxedFlag>
    <serviceTotal>444</serviceTotal>
    <currency>
      <id>4</id>
      <name>French Francs</name>
      <symbol>FFr</symbol>
      <isoCode>EUR</isoCode>
    </currency>
    <dueDate>2016-10-14T00:00:00Z</dueDate>
    <expenseTotal>0</expenseTotal>
    <productTotal>0</productTotal>
    <previousProgressApplied>0</previousProgressApplied>
    <serviceAdjustmentAmount>0</serviceAdjustmentAmount>
    <agreementAmount>0</agreementAmount>
    <downpaymentApplied>0</downpaymentApplied>
    <subtotal>444</subtotal>
    <total>444</total>
    <remainingDownpayment>0</remainingDownpayment>
    <salesTax>0</salesTax>
    <payments>350</payments>
    <credits>0</credits>
    <balance>94</balance>
    <specialInvoiceFlag>true</specialInvoiceFlag>
  </Invoice>
</Invoices>

Back | Edit on Github