Exporting Agreement Types from ConnectWise REST Interface

This task will export agreement types from the System -> Setup Tables -> Agreement Type area of ConnectWise in an XML format. The results can be filtered using the Conditions if required. See below for a sample output file.

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.

Conditions

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

Condition > Comparison

Required
The following types of filter are available:

Equals - Returns records where the field matches the specified value.
Contains - Returns records where the field contains the specified value. This filter type is only valid for String fields on ConnectWise.
GreaterThan - Returns records where the field is greater than the specified value. This filter type is only valid for Numeric and DateTime fields on ConnectWise.
GreaterThanOrEqual - Returns records where the field is greater than or equal to the specified value. This filter type is only valid for Numeric and DateTime fields on ConnectWise.
In - Returns records where the field matches one of the specified values. Must be enclosed in parenthesis, with multiple values separated by a comma. e.g. ("John", "Ben") for string values, (1, 3) for numeric values. See the Condition > Value section below for more information on how different value types should be entered.
Like - Returns records where the field matches the specified value. The asterisk (*) character can be used as a wild card. This filter type is only valid for String fields on ConnectWise.
LessThan - Returns records where the field is less than the specified value. This filter type is only valid for Numeric and DateTime fields on ConnectWise.
LessThanOrEqual - Returns records where the field is less than or equal to the specified value. This filter type is only valid for Numeric and DateTime fields on ConnectWise.
NotContains - Returns records where the field does not contain the specified value. This filter type is only valid for String fields on ConnectWise.
NotEqual - Returns records where the field does not match the specified value.
NotIn - Returns records where the field does not match one of the specified values. Must be enclosed in parenthesis, with multiple values separated by a comma. e.g. ("John", "Ben") for string values, (1, 3) for numeric values etc. See the Condition > Value section below for more information on how different value types should be entered.
NotLike - Returns records where the field does not match the specified value. The asterisk (*) character can be used as a wild card. This filter type is only valid for String fields on ConnectWise.

Condition > Field

Required
The name of the field the condition applies to. 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.

The supported fields are listed below: -

id (Integer)
name (String)
prefixSuffixOption (EnumPrefix, Suffix) nullable
defaultFlag (Boolean) nullable
inactiveFlag (Boolean) nullable
prePaymentFlag (Boolean) nullable
invoicePreSuffix (String)
location/id (Integer) nullable
location/name (String)
department/id (Integer) nullable
department/identifier (String)
department/name (String)
restrictLocationFlag (Boolean) nullable
restrictDepartmentFlag (Boolean) nullable
sla/id (Integer) nullable
sla/name (String)
applicationUnits (EnumAmount, Hours, Incidents) nullable
applicationLimit (Decimal) nullable
applicationCycle (EnumContract2Weeks, Contract4Weeks, ContractYear, CalendarMonth, CalendarQuarter, CalendarWeek, ContractQuarter, CalendarYear) nullable
applicationUnlimitedFlag (Boolean) nullable
oneTimeFlag (Boolean) nullable
coverAgreementTimeFlag (Boolean) nullable
coverAgreementProductFlag (Boolean) nullable
coverAgreementExpenseFlag (Boolean) nullable
coverSalesTaxFlag (Boolean) nullable
carryOverUnusedFlag (Boolean) nullable
allowOverrunsFlag (Boolean) nullable
expiredDays (Integer) nullable
limit (Integer) nullable
expireWhenZero (Boolean) nullable
chargeToFirmFlag (Boolean) nullable
employeeCompRate (EnumActual, Hourly) nullable
employeeCompNotExceed (EnumBilling, Amount, Percent) nullable
compHourlyRate (Decimal) nullable
compLimitAmount (Decimal) nullable
billingCycle/id (Integer) nullable
billingCycle/name (String)
billOneTimeFlag (Boolean) nullable
billingTerms/id (Integer) nullable
billingTerms/name (String)
invoicingCycle (EnumContractYear, CalendarYear) nullable
billAmount (Decimal) nullable
taxableFlag (Boolean) nullable
restrictDownPaymentFlag (Boolean) nullable
invoiceDescription (String)
topCommentFlag (Boolean) nullable
bottomCommentFlag (Boolean) nullable
workRole/id (Integer) nullable
workRole/name (String)
workType/id (Integer) nullable
workType/name (String)
projectType/id (Integer) nullable
projectType/name (String)
invoiceTemplate/id (Integer) nullable
invoiceTemplate/name (String)
billTime (EnumBillable, DoNotBill, NoCharge, NoDefault) nullable
billExpenses (EnumBillable, DoNotBill, NoCharge, NoDefault) nullable
billProducts (EnumBillable, DoNotBill, NoCharge, NoDefault) nullable
billableTimeInvoiceFlag (Boolean) nullable
billableExpenseInvoiceFlag (Boolean) nullable
billableProductInvoiceFlag (Boolean) nullable
copyWorkRolesFlag (Boolean) nullable
copyWorkTypesFlag (Boolean) nullable
exclusionWorkRoleIds (not registered)
addAllWorkRoleExclusions (Boolean) nullable
removeAllWorkRoleExclusions (Boolean) nullable
exclusionWorkTypeIds (not registered)
addAllWorkTypeExclusions (Boolean) nullable
removeAllWorkTypeExclusions (Boolean) nullable
integrationXRef (String)
prorateFlag (Boolean) nullable
emailTemplate/id (Integer) nullable
emailTemplate/name (String)
autoInvoiceFlag (Boolean) nullable

Condition > Logic Operator

Optional
The logic operator to use for the condition being added when building the where clause. Choose from:

And - Will return records which meet both of the conditions specified.
Or - Will return records which meet at least of the conditions specified.

Condition > Value

Optional
The value to use in the filter.

String values should be surrounded by quotes. e.g. "John"
Boolean values should be specified as either True or False, with no quotes.
Datetime values should be specified in ISO8601 format, surrounded by square brackets. e.g. [2000-01-31T14:51:00Z]
Null is specified as null.
When using the In or NotIn comparison, values must be separated by a comma and be surrounded by rounded brackets. e.g. ("John", "Ben"). See how different values types should be specified above.

Export Settings > Date Created

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

Defaults to the current date and time.

Export Settings > Date Modified

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

Defaults to the current date and time.

Export Settings > Export Modified, New or All Records

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

Modified - Only records updated after the date shown in the 'Date Modified' setting will be downloaded.
New - Only records created after the date shown in the 'Date Created' setting will be downloaded.
All - All records will be downloaded, regardless of when they were created or updated.

Defaults to Modified.

Export Settings > Page Size

Required
The number of records to include in each page of results. Increasing this value will reduce the number of requests made to the API but will increase the amount of memory needed while making each request.

Defaults to 100.
The maximum value is 1000.

Output File

Required
The name of the file to save the exported records to.

Defaults to connectwise_export_agreement_types.xml

References To Fetch

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

The supported record types are listed below: -

workRole
workType

References To Fetch Page Size

Required
The number of referenced records to fetch per page. Increasing this value will reduce the number of requests made to the API but will increase the amount of memory needed while making each request.

Defaults to 100.
The maximum value is 1000.

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

See Common Task Settings

Examples

A sample output file is shown below.

<?xml version="1.0" encoding="utf-8"?>
<AgreementTypes xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <AgreementType>
    <id>1</id>
    <externalId />
    <_info>
      <dateEntered>2004-07-29T18:49:27Z</dateEntered>
      <enteredBy>CONVERSION</enteredBy>
      <lastUpdated>2004-07-29T18:49:27Z</lastUpdated>
      <updatedBy>zadmin</updatedBy>
    </_info>
    <name>Monitoring</name>
    <prefixSuffixOption>Prefix</prefixSuffixOption>
    <defaultFlag>false</defaultFlag>
    <inactiveFlag>false</inactiveFlag>
    <prePaymentFlag>false</prePaymentFlag>
    <invoicePreSuffix xsi:nil="true" />
    <locationId>0</locationId>
    <businessUnitId>0</businessUnitId>
    <restrictLocationFlag>false</restrictLocationFlag>
    <restrictDepartmentFlag>false</restrictDepartmentFlag>
    <slaId xsi:nil="true" />
    <applicationUnits xsi:nil="true" />
    <applicationLimit xsi:nil="true" />
    <applicationCycle xsi:nil="true" />
    <applicationUnlimitedFlag>false</applicationUnlimitedFlag>
    <oneTimeFlag>false</oneTimeFlag>
    <coverAgreementTimeFlag>false</coverAgreementTimeFlag>
    <coverAgreementProductFlag>false</coverAgreementProductFlag>
    <coverAgreementExpenseFlag>false</coverAgreementExpenseFlag>
    <coverSalesTaxFlag>false</coverSalesTaxFlag>
    <carryOverUnusedFlag>false</carryOverUnusedFlag>
    <allowOverrunsFlag>false</allowOverrunsFlag>
    <expiredDays xsi:nil="true" />
    <limit xsi:nil="true" />
    <expireWhenZero>false</expireWhenZero>
    <chargeToFirmFlag>false</chargeToFirmFlag>
    <employeeCompRate>Actual</employeeCompRate>
    <compHourlyRate xsi:nil="true" />
    <compLimitAmount xsi:nil="true" />
    <billCycleId>0</billCycleId>
    <billOneTimeFlag>false</billOneTimeFlag>
    <billTermsId xsi:nil="true" />
    <invoicingCycle>CalendarYear</invoicingCycle>
    <billAmount>0.00</billAmount>
    <taxableFlag>false</taxableFlag>
    <restrictDownPaymentFlag>true</restrictDownPaymentFlag>
    <invoiceDescription />
    <topCommentFlag>false</topCommentFlag>
    <bottomCommentFlag>false</bottomCommentFlag>
    <projectTypeId xsi:nil="true" />
    <invoiceTemplateSetupId xsi:nil="true" />
    <billTime>Billable</billTime>
    <billExpenses>Billable</billExpenses>
    <billProducts>Billable</billProducts>
    <billableTimeInvoiceFlag>false</billableTimeInvoiceFlag>
    <billableExpenseInvoiceFlag>false</billableExpenseInvoiceFlag>
    <billableProductInvoiceFlag>false</billableProductInvoiceFlag>
    <copyWorkRolesFlag>true</copyWorkRolesFlag>
    <copyWorkTypesFlag>true</copyWorkTypesFlag>
  </AgreementType>
</AgreementTypes>