Export Deliveries from webCRM
This task will export deliveries (orders) from webCRM, including any related line information, in webCRM Delivery XML format to a file.
Settings
webCRM Connection
Required
The connection to webCRM to use, see Connecting to WebCRM for information on how to manage connections.
Export Delivery Lines
Required
Set to False
to only export delivery header information, set to True
to include related delivery lines if you have them enabled on your webCRM instance. Defaults to False
.
Export Settings > Export Date
Required
When the 'Export Type' setting is set to 'Modified' or 'New', only records modified or created after this date will be downloaded. The date will update automatically each time the task runs.
Export Settings > Export Type
Required
Used to choose which records should be included in the download. The available options are:
- All - All records will be downloaded, regardless of whether or not they have been updated since the task last ran.
- Modified - Only records created or updated since the task last ran will be downloaded.
- New - Only records created since the task last ran will be downloaded.
Export Settings > Where Clauses
Optional
Allows filters to be added to the export to limit the data returned. The Field Name needs to exist from the source table in webCRM e.g. Status on the Delivery table, this can be specified with or without the table name prepended.
Include Field Metadata
Required
Set to true to include names of custom fields in the output XML.
Page Size
Required
Used to control the number of records that will be downloaded in each page from webCRM. Defaults to 25
.
Output File
Required
The name of the file to save the downloaded records to.
Defaults to webcrm_export_deliveries.xml
.
Zynk Settings
Example XML
A sample showing all available fields for a delivery, see webCRM Delivery XML for detailed information.
<?xml version="1.0" encoding="utf-8"?>
<Deliveries
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<Delivery ExactMatch="true">
<Id>2</Id>
<CreatedAt>2016-12-08T14:42:14+00:00</CreatedAt>
<UpdatedAt>2018-08-07T14:36:33+01:00</UpdatedAt>
<AssignedTo>3</AssignedTo>
<AssignedTo2>0</AssignedTo2>
<Comment />
<CreatedBy>webCRM System</CreatedBy>
<CurrencyName>00</CurrencyName>
<Description>Order</Description>
<Discount>0</Discount>
<ErpId>000000001</ErpId>
<ErpReadOnly>false</ErpReadOnly>
<ErpStatus>NotReadyForSynchronization</ErpStatus>
<ErpSyncDateTime>2018-01-01T00:00:00+00:00</ErpSyncDateTime>
<GmRevenue1>1</GmRevenue1>
<GmRevenue2>2</GmRevenue2>
<GmRevenue3>3</GmRevenue3>
<GmRevenue4>4</GmRevenue4>
<GmRevenue5>5</GmRevenue5>
<GmRevenue6>6</GmRevenue6>
<GmRevenue7>7</GmRevenue7>
<GmRevenue8>8</GmRevenue8>
<GmRevenue9>9</GmRevenue9>
<GmRevenue10>10</GmRevenue10>
<GmRevenue11>11</GmRevenue11>
<GmRevenue12>12</GmRevenue12>
<History><tr><td>07-08-2018&nbsp;14:09&nbsp;</td><td>JS&nbsp;</td><td>(JS)&nbsp;6000&nbsp;</td><td colspan="2">New / General&nbsp;</td><td>No risk</td></tr><tr><td>08-12-2016&nbsp;14:43&nbsp;</td><td>SYS&nbsp;</td><td>(JR)&nbsp;9000&nbsp;</td><td colspan="2">New&nbsp;</td><td>No risk</td></tr><tr><td>08-12-2016&nbsp;14:42&nbsp;</td><td>SYS&nbsp;</td><td>(SYS)&nbsp;9000&nbsp;</td><td colspan="2">New&nbsp;</td><td>No risk</td></tr> </History>
<NextFollowUp>2018-01-01T00:00:00+00:00</NextFollowUp>
<Note>Partial delivery</Note>
<Number>1001</Number>
<OpportunityCustom1>12345</OpportunityCustom1>
<OpportunityCustom2>Quote</OpportunityCustom2>
<OpportunityCustom3 />
<OpportunityCustom4 />
<OpportunityCustom5 />
<OpportunityCustom6 />
<OpportunityCustom7 />
<OpportunityCustom8 />
<OpportunityCustom9 />
<OpportunityCustom10 />
<OpportunityCustom11 />
<OpportunityCustom12 />
<OpportunityCustom13 />
<OpportunityCustom14 />
<OpportunityCustom15 />
<OpportunityMemo>Partial delivery</OpportunityMemo>
<OrderDate>2018-03-01T00:00:00+00:00</OrderDate>
<OrderGmValue>300</OrderGmValue>
<OrderValue>6000</OrderValue>
<OrganisationId>1</OrganisationId>
<Organisation ExactMatch="true">
<Id>1</Id>
<CreatedAt>2006-04-07T15:51:39+01:00</CreatedAt>
<UpdatedAt>2016-12-08T14:37:56+00:00</UpdatedAt>
<Address>Courtyard Business Centre</Address>
<Alert />
<ApprovalStatus>0</ApprovalStatus>
<City>Nottingham</City>
<Comment />
<CompareName>WEBCRMUKLIMITEDMIDLANDS</CompareName>
<Country>United Kingdom</Country>
<CreatedBy>Jørgen Rode</CreatedBy>
<DivisionName>Midlands</DivisionName>
<Domain />
<ExtraCustom1></ExtraCustom1>
<ExtraCustom2></ExtraCustom2>
<ExtraCustom3></ExtraCustom3>
<ExtraCustom4></ExtraCustom4>
<ExtraCustom5></ExtraCustom5>
<ExtraCustom6></ExtraCustom6>
<ExtraCustom7></ExtraCustom7>
<ExtraCustom8></ExtraCustom8>
<Fax />
<Gps />
<ImageFileExtension>No</ImageFileExtension>
<Industry>IT</Industry>
<LastDisplayedAt>2018-08-07T10:40:13+01:00</LastDisplayedAt>
<LastItemType>Opportunity</LastItemType>
<LastItemUpdatedAt>2018-08-06T15:22:58+01:00</LastItemUpdatedAt>
<MarketDataId />
<Name>webCRM UK Limited</Name>
<NoAds>false</NoAds>
<History />
<OutlookSync>0</OutlookSync>
<OverlayUrl />
<Owner>3</Owner>
<Owner2>0</Owner2>
<PostCode>NG8 1PA</PostCode>
<ReportTemp>0</ReportTemp>
<Sla>0</Sla>
<State>Nottinghamshire</State>
<Status>Not relevant</Status>
<Telephone>01158713702</Telephone>
<TelephoneSearch>-01158713702-</TelephoneSearch>
<TerritoryId>1</TerritoryId>
<Type>Supplier</Type>
<UpdatedBy>webCRM System</UpdatedBy>
<VatCountry />
<VatGroup />
<VatNumber />
<VatStatus />
<VatVerifiedAt>0001-01-01T00:00:00+00:00</VatVerifiedAt>
<Www>www.webcrm.com/uk</Www>
<XDate1>01/01/0001 00:00:00</XDate1>
<XDate2>01/01/0001 00:00:00</XDate2>
<XInt1>0</XInt1>
<XInt2>0</XInt2>
<XInt3>0</XInt3>
<XInt4>0</XInt4>
<XInt5>0</XInt5>
<XInt6>0</XInt6>
<XInt7>0</XInt7>
<XInt8>0</XInt8>
<XMemo1></XMemo1>
<XMemo2></XMemo2>
<XText1></XText1>
<XText2></XText2>
<XText3></XText3>
<XText4></XText4>
<XText5></XText5>
<XText6></XText6>
<XText7></XText7>
<XText8></XText8>
<Custom1>Website</Custom1>
<Custom2>51 to 100</Custom2>
<Custom3></Custom3>
<Custom4></Custom4>
<Custom5></Custom5>
<Custom6></Custom6>
<Custom7></Custom7>
<Custom8></Custom8>
<Custom9></Custom9>
<Custom10></Custom10>
<Custom11></Custom11>
<Custom12></Custom12>
<Custom13></Custom13>
<Custom14></Custom14>
<Custom15></Custom15>
<Memo />
</Organisation>
<Percent>55</Percent>
<PersonId>1</PersonId>
<Product>Your product 1</Product>
<ProductId>0</ProductId>
<QuotationLanguageId>2</QuotationLanguageId>
<Responsible>3</Responsible>
<Revenue1>1</Revenue1>
<Revenue2>2</Revenue2>
<Revenue3>3</Revenue3>
<Revenue4>4</Revenue4>
<Revenue5>5</Revenue5>
<Revenue6>6</Revenue6>
<Revenue7>7</Revenue7>
<Revenue8>8</Revenue8>
<Revenue9>9</Revenue9>
<Revenue10>10</Revenue10>
<Revenue11>11</Revenue11>
<Revenue12>12</Revenue12>
<Risk>NoRisk</Risk>
<Search1>test</Search1>
<Search2 />
<SpentTime>01:30:00</SpentTime>
<Status>New</Status>
<Type>0</Type>
<UpdatedBy>api2 Zynk</UpdatedBy>
<UserGroupId>0</UserGroupId>
<WinPercent>0</WinPercent>
<WinPercent2>0</WinPercent2>
<WinYesNo>false</WinYesNo>
<WonDate>2018-01-01T00:00:00+00:00</WonDate>
<Custom1 />
<Custom2 />
<Custom3 />
<Custom4 />
<Custom5 />
<Custom6 />
<Custom7 />
<Custom8 />
<Custom9 />
<Custom10 />
<Custom11 />
<Custom12 />
<Custom13 />
<Custom14 />
<Custom15 />
<Memo>First order</Memo>
<Lines>
<QuotationLine ExactMatch="true">
<Id>8</Id>
<CreatedAt>2018-08-07T10:47:16+01:00</CreatedAt>
<UpdatedAt>2018-08-07T10:47:16+01:00</UpdatedAt>
<Comment />
<CostPrice>50</CostPrice>
<CreatedBy>James Shaw</CreatedBy>
<Data1>End User</Data1>
<Data2>Product 1</Data2>
<Data3>12345</Data3>
<Discount>0</Discount>
<ListPrice>100</ListPrice>
<Memo>Product 1 - Description Here</Memo>
<OpportunityId>2</OpportunityId>
<OrganisationId>1</OrganisationId>
<PersonId>0</PersonId>
<Price>100</Price>
<Quantity>2</Quantity>
<SortOrder>10</SortOrder>
<StockStatus />
<UpdatedBy>James Shaw</UpdatedBy>
<VatPercentage>20</VatPercentage>
</QuotationLine>
<QuotationLine ExactMatch="true">
<Id>9</Id>
<CreatedAt>2018-08-07T10:47:16+01:00</CreatedAt>
<UpdatedAt>2018-08-07T10:47:16+01:00</UpdatedAt>
<Comment />
<CostPrice>200</CostPrice>
<CreatedBy>James Shaw</CreatedBy>
<Data1>End User</Data1>
<Data2>Service 1</Data2>
<Data3>12353</Data3>
<Discount>0</Discount>
<ListPrice>400</ListPrice>
<Memo>Product 9 - Description Here</Memo>
<OpportunityId>2</OpportunityId>
<OrganisationId>1</OrganisationId>
<PersonId>0</PersonId>
<Price>400</Price>
<Quantity>1</Quantity>
<SortOrder>20</SortOrder>
<StockStatus />
<UpdatedBy>James Shaw</UpdatedBy>
<VatPercentage>20</VatPercentage>
</QuotationLine>
</Lines>
</Delivery>
</Deliveries>