Importing Agreements via ConnectWise REST Interface
This task will import activities into the Finance -> Agreements area of ConnectWise from an XML file. See below for a sample input file.
Records are created/updated based on the following rules:
- If an
<id>is specified, the task will update the record with this ID. - If an
<externalId>is specified, and a corresponding entry is found in Zynk's truth table, the task will update the record with this ID. - If one or more
<lookup>elements have been specified, Zynk will search for a match based on each one in turn, and will update the first matching record it finds. - If none of the above conditions are met, the task will create a new record.
When updating existing records, only writeable fields specified in the input file will be updated. Any other fields will keep their existing values.
Settings
ConnectWise REST Interface 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.
Fail File
Required
The XML file to output any records that the task fails to process to. This can be an absolute or relative file path on the local computer or network. This will contain any errors which occur on the import.
Defaults to connectwise_import_agreements_fail.xml
Input File
Required
The file containing the records to import into ConnectWise. This can be an absolute or relative file path on the local computer or network. The file must contain data in an XML format, a sample of which is shown below.
Defaults to (Output from previous task)
Success File
Required
The XML file to output any records that the task successfully processes to. This can be an absolute or relative file path on the local computer or network.
Defaults to connectwise_import_agreements_success.xml
Prevent Reprocessing
Required
Set this option to True to prevent the same record being processed more than once by Zynk. An <externalId> must be provided in the input file for this to work.
Timeout
Optional
The maximum length of time to wait (in seconds) for API requests to be processed. Specifying this value will override the timeout set at the connection level. Leave blank to use the value specified in the connection.
Zynk Settings
Examples
A sample input file is shown below.
<?xml version="1.0" encoding="utf-8"?>
<Agreements xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<Agreement>
<id>1</id>
<externalId />
<lookups>
<lookup>
<matches>
<match>
<type>Field</type><!-- Field | ChildField | CustomField -->
<fieldName>name</fieldName>
<comparison>Equals</comparison><!-- Equals | Contains | GreaterThan | GreaterThanOrEqual | In | Like | LessThan | LessThanOrEqual | NotEqual | NotContains | NotIn | NotLike | IsNull -->
<valueType>String</valueType><!-- String | Bool | DateTime | Numeric -->
<value>Gold Rate</value>
<values><!-- Used in conjunction with 'In' and 'NotIn' comparisons only -->
<value>Gold Rate</value>
</values>
</match>
</matches>
<orderBy>
<fieldName>name</fieldName>
<direction>Ascending</direction><!-- Ascending | Descending -->
</orderBy>
<type>One</type><!-- One | First -->
</lookup>
</lookups>
<name>Gold Rate</name>
<type>
<id>5</id>
<name>Block Time - One time</name>
</type>
<company>
<id>24</id>
<name>Wild Eagle, Inc.</name>
<identifier>WildEagleInc</identifier>
</company>
<contact>
<id>70</id>
<name>Gregg Kegle</name>
</contact>
<customerPO />
<restrictLocationFlag>false</restrictLocationFlag>
<restrictDepartmentFlag>false</restrictDepartmentFlag>
<startDate>2005-04-26T00:00:00Z</startDate>
<endDate xsi:nil="true" />
<noEndingDateFlag>true</noEndingDateFlag>
<cancelledFlag>false</cancelledFlag>
<dateCancelled xsi:nil="true" />
<reasonCancelled />
<workOrder />
<internalNotes>gets guaranteed rate of $100 per hour for all work performed under this agreement. See custom rates on the Work Role and Work Type tabs. This agreement only covers time. Expenses and products will be billed seperately.</internalNotes>
<applicationUnits>Amount</applicationUnits>
<applicationLimit>10000.00</applicationLimit>
<applicationCycle xsi:nil="true" />
<applicationUnlimitedFlag>false</applicationUnlimitedFlag>
<oneTimeFlag>true</oneTimeFlag>
<coverAgreementTime>true</coverAgreementTime>
<coverAgreementProduct>false</coverAgreementProduct>
<coverAgreementExpense>false</coverAgreementExpense>
<coverSalesTax>false</coverSalesTax>
<carryOverUnused>false</carryOverUnused>
<allowOverruns>true</allowOverruns>
<expiredDays>0</expiredDays>
<limit>10</limit>
<expireWhenZero>true</expireWhenZero>
<chargeToFirm>false</chargeToFirm>
<employeeCompRate>Hourly</employeeCompRate>
<employeeCompNotExceed xsi:nil="true" />
<compHourlyRate>0.00</compHourlyRate>
<compLimitAmount>0.00</compLimitAmount>
<billOneTimeFlag>true</billOneTimeFlag>
<invoicingCycle>CalendarYear</invoicingCycle>
<billAmount>10000.00</billAmount>
<taxable>false</taxable>
<prorateFirstBill>0.00</prorateFirstBill>
<billStartDate>2005-04-26T00:00:00Z</billStartDate>
<restrictDownPayment>true</restrictDownPayment>
<prorateFlag>false</prorateFlag>
<invoiceDescription>Gold Plan Prepaid Services:
This plan gives you a guaranteed rate of $100 per hour for all work performed against this agreement.
</invoiceDescription>
<topComment>true</topComment>
<bottomComment>false</bottomComment>
<billTime>Billable</billTime>
<billExpenses>Billable</billExpenses>
<billProducts>Billable</billProducts>
<billableTimeInvoice>true</billableTimeInvoice>
<billableExpenseInvoice>true</billableExpenseInvoice>
<billableProductInvoice>true</billableProductInvoice>
<currency>
<id>4</id>
<name>French Francs</name>
<symbol>FFr</symbol>
<isoCode>EUR</isoCode>
</currency>
<periodType xsi:nil="true" />
<autoInvoiceFlag xsi:nil="true" />
<customFields>
<customField>
<id>13</id>
<caption>Amethyst Start Date</caption>
<type>Date</type>
<entryMethod>EntryField</entryMethod>
<numberOfDecimals>0</numberOfDecimals>
</customField>
</customFields>
<agreementAdditions>
<agreementAddition>
<product>
<id>745</id>
<identifier>Web Site Service</identifier>
</product>
<quantity>3.00</quantity>
<lessIncluded>0.00</lessIncluded>
<unitPrice>1000.000000</unitPrice>
<unitCost xsi:nil="true" />
<billCustomer>Billable</billCustomer>
<effectiveDate>2023-10-01</effectiveDate>
<cancelledDate>2024-09-30</cancelledDate>
<taxableFlag>false</taxableFlag>
<serialNumber>THIS IS A SERIAL NUMBER</serialNumber>
<invoiceDescription>Managed Web Site Service
Dedicated Website Hosting Service
- Domain Name Service Services
- Domain Name Hostting Services
- 8 IP Address
- 100 GB Transfer per month
- Intel Xeon 2.4 GHz w/HyperTHreading
- Windows 2003 Server
- Windows 2003 Terminal Services
Managed Services
- Site monitoring 24 x 7
- Complete Hardware Maintenance
- Security Updates
- Operating System Updates
- Server Reboot- Server Diagnostics</invoiceDescription>
<purchaseItemFlag>false</purchaseItemFlag>
<specialOrderFlag>false</specialOrderFlag>
<description>Web Site Service</description>
<billedQuantity>3.00</billedQuantity>
<uom>Month</uom>
<extPrice>3000.000000</extPrice>
<extCost>0.000000</extCost>
<margin>3000.000000</margin>
<prorateCost>0.000000</prorateCost>
<proratePrice>0.000000</proratePrice>
<extendedProrateCost>0.000000</extendedProrateCost>
<extendedProratePrice>0.000000</extendedProratePrice>
<prorateCurrentPeriodFlag>false</prorateCurrentPeriodFlag>
<agreementStatus>Active</agreementStatus>
<customFields>
<customField>
<id>28</id>
<caption>Renewal Status</caption>
<type>Text</type>
<entryMethod>List</entryMethod>
<numberOfDecimals>0</numberOfDecimals>
<value>3. Ready to Send</value>
</customField>
</customFields>
</agreementAddition>
</agreementAdditions>
</Agreement>
</Agreements>