Sage 50 UK Connector for CData Sync

Build 24.0.9175
  • Sage 50 UK
    • Establishing a Connection
    • Advanced Features
      • SSL Configuration
      • Firewall and Proxy
    • Data Model
      • Tables
        • Commodities
        • Contacts
        • PurchaseOrders
        • SalesCredits
        • SalesInvoices
        • SalesOrders
        • TradingAccounts
      • Views
        • BankAccounts
        • FinancialAccounts
        • Interactions
        • Prices
        • Projects
        • PurchaseOrderDeliveries
        • PurchaseOrderDeliveryLineItems
        • PurchaseOrderLineItems
        • Receipts
        • SalesCreditLineItems
        • SalesInvoiceLineItems
        • SalesOrderDeliveries
        • SalesOrderDeliveryLineItems
        • SalesOrderLineItems
        • TaxCodes
        • TradingActivities
    • Connection String Options
      • Authentication
        • AuthScheme
        • URL
        • User
        • Password
      • SSL
        • SSLServerCert
      • Firewall
        • FirewallType
        • FirewallServer
        • FirewallPort
        • FirewallUser
        • FirewallPassword
      • Proxy
        • ProxyAutoDetect
        • ProxyServer
        • ProxyPort
        • ProxyAuthScheme
        • ProxyUser
        • ProxyPassword
        • ProxySSLType
        • ProxyExceptions
      • Logging
        • LogModules
      • Schema
        • Location
        • BrowsableSchemas
        • Tables
        • Views
      • Miscellaneous
        • MaxRows
        • Other
        • Pagesize
        • PseudoColumns
        • Timeout
        • UserDefinedViews

Sage 50 UK Connector for CData Sync

Overview

The CData Sync App provides a straightforward way to continuously pipeline your Sage 50 UK data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.

The Sage 50 UK connector can be used from the CData Sync application to pull data from Sage 50 UK and move it to any of the supported destinations.

Sage 50 UK Version Support

The Sync App models data in Sage 50 UK 2012 and above as relational tables. Note that for v28 and later, you must install the Sdata adapter prior to using Sage 50 UK driver. See the Sage 50 UK documentation for more information.

Sage 50 UK Connector for CData Sync

Establishing a Connection

Adding a Connection to Sage 50 UK

To add a connection to Sage 50 UK:

  1. In the application console, navigate to the Connections page.
  2. At the Add Connections panel, select the icon for the connection you want to add.
  3. If the Sage 50 UK icon is not available, click the Add More icon to download and install the Sage 50 UK connector from the CData site.

For required properties, see the Settings tab.

For connection properties that are not typically required, see the Advanced tab.

Before You Connect

For v28 and later, you must install the Sdata adapter prior to using Sage 50 UK driver. See the Sage 50 UK documentation for more information.

Connecting to Sage 50 UK

The Sync App connects to Sage 50 UK data through the SData REST API included in the Sage 50 UK installation. SData allows access to local company datasets as well as datasets on network drives.

After Configuring the Sage SData Service, connect with the below steps, the URL property should be set to the address of the company dataset desired. To obtain the address, do the following:

  1. If you have not already done so, open the Sage 50 UK software.
  2. Select Tools > Internet Options .
  3. Select the Sdatasettings tab.
  4. Click Details next to the Sage 50 software application you want to connect to. A window opens containing a list of company names along with the addresses to their corresponding datasets.
  5. Set the URL property to the value in the address field next to the company desired.

Authenticating to Sage 50 UK

The User and Password properties must be set to valid Sage 50 UK user credentials. These values are the same values used to log in to the Sage 50 UK software. To authenticate with HTTP digest to the SData service, set AuthScheme to Digest. Otherwise, Basic AuthScheme will be used.

Note: If the dataset you want to connect to is not displayed, the permissions on the Sage 50 UK folder location may not be correct. If you are connecting to a dataset on a networked drive, ensure:

  • You are using UNC paths to the folder on the machine you are using as your SData provider.
  • You set the SData service login rights to a user who has full rights over the network share or map drive.

Starting the SData Service

The CData Sync App connects to Sage 50 UK via the Sage SData service (which is Sage's Web toolkit for connecting to Sage instances) that is built into the Sage 50 UK software. SData allows for remote access to Sage software applications. By default, Sage UK 2015 instances will have SData turned on and ready for use.

You can follow the steps below to verify that the SData service is started.

  1. If you have not already done so, open Sage 50.
  2. Navigate to Tools > Internet Options. The Internet Options window is displayed.
  3. Select the Sdatasettings tab. A list is displayed of Sage software applications that are currently available.
  4. To turn the SData service on for the application, select the On option.
  5. If the SData Service Status does not read "SData is currently running", click the Advanced button.
  6. In the dialog that is displayed, specify the Port Number desired when making the connection and click the Restart button.
  7. If the Windows Firewall button is enabled, click this button to unblock the port. If you have any additional firewalls on the machine, ensure that they are configured to allow connections to be made on the specified port number.

Once you apply any changes, you can then establish a connection to your Sage 50 UK software.

Enabling HTTPS Support

The Sage SData service provides secure and encrypted connections via HTTPS. Data confidentiality and the authenticity of the server are provided by digital certificates. If you do not have a certificate, use IIS to generate a self-signed certificate.

You can follow the steps below to configure the SData service to use a certificate; the Sync App will validate this certificate against the system trust store by default. If you generated a self-signed certificate, you can add the certificate to this certificate store or set SSLServerCert.

See Advanced Features for more information on configuring the Sync App for HTTPS.

Fulfilling the Certificate Requirements

The certificate has the following requirements:

  • The certificate must have a full valid trust chain.
  • The common name (CN) for the certificate must match the machine/domain name where the SData service is running. To ensure that the CN is correct, generate the self-signed certificate on the machine where Sage 50 SData is running.
  • The certificate must be added to the personal My certificate store for the Local Machine account.

Configuring the SData Service for TLS/SSL

You can then configure the SData service to use the certificate:

  1. Navigate to C:\Program Files (x86)\Common Files\Sage SData and open Sage.SData.Service.Config.UI.exe.
  2. Click the Advanced button. The SData Configuration window is displayed.
  3. Select the Enable HTTPS Access option and select the port desired.
  4. If you have any firewalls on your machine, make sure the ports specified are not blocked.
  5. Click the button next to the Certificate box.
  6. In the resulting dialog, select the certificate.

    If you select a certificate and do not see the certificate name populated in the Certificate textbox, this is most likely due to missing extended properties within the certificate. The extended properties include thumbprint, thumbprint algorithm, key usage, and enhanced key usage.

    Use IIS to avoid this issue: IIS automatically populates these fields when generating a self-signed certificate.

  7. Click OK to restart the server.
  8. Verify that the Enable HTTPS option is selected in the SData configuration window.

Troubleshooting

If the SData configuration window is closed and reopened but the Enable HTTPS option is not enabled, this is most likely caused by the Sage.SData.Service.exe.config file not being updated properly. Follow the steps below to use the alternate configuration file below.

You will need the certificate thumbprint. Note that the thumbprint data includes spaces. The thumbprint data can be obtained using Windows services. You can also access the thumbprint in the SData configuration window:

  1. If you have not already done so, open the Sage.SData.Service.Config.UI.exe application and open the advanced settings.
  2. Click the button next to the Certificate box.
  3. In the Windows security dialog, click "Click here to view certificate properties". The Certificate Details window is displayed.
  4. On the Details tab, copy the value in the Thumbprint field.
Use this value in the CertificateLookupValue setting in the configuration file. For example:
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<configSections>
<sectionGroup name="applicationSettings" type="System.Configuration.ApplicationSettingsGroup, System, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" >
<section name="Sage.SData.Service.Properties.Settings" type="System.Configuration.ClientSettingsSection, System, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" requirePermission="false" />
<section name="Sage.Integration.Server.Properties.Settings" type="System.Configuration.ClientSettingsSection, System, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" requirePermission="false" />
<section name="Sage.Common.Syndication.Properties.Settings" type="System.Configuration.ClientSettingsSection, System, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" requirePermission="false" />
</sectionGroup>
</configSections>
<applicationSettings>
<Sage.SData.Service.Properties.Settings>
<setting name="DigestTimeout" serializeAs="String">
<value>12000000000</value>
</setting>
<setting name="EnableBasicAuthentication" serializeAs="String">
<value>True</value>
</setting>
<setting name="WebAppPath" serializeAs="String">
<value />
</setting>
<setting name="EnableSSL" serializeAs="String">
<value>True</value>
</setting>
<setting name="Port" serializeAs="String">
<value>443</value>
</setting>
</Sage.SData.Service.Properties.Settings>
<Sage.Integration.Server.Properties.Settings>
<setting name="EnableBroadcast" serializeAs="String">
<value>False</value>
</setting>
</Sage.Integration.Server.Properties.Settings>
<Sage.Common.Syndication.Properties.Settings>
<setting name="IPAddress" serializeAs="String">
<value />
</setting>
<setting name="Server" serializeAs="String">
<value>sdata</value>
</setting>
<setting name="EnableSSLPort" serializeAs="String">
<value>True</value>
</setting>
<setting name="Port" serializeAs="String">
<value>5493</value>
</setting>
<setting name="SettingsProviderType" serializeAs="String">
<value>Sage.Common.Syndication.ConfigurationSyndicationSettings, Sage.Common.Syndication</value>
</setting>
<setting name="PathPrefix" serializeAs="String">
<value />
</setting>
<setting name="DoNotUseRegistry" serializeAs="String">
<value>False</value>
</setting>
<setting name="EnableStandardPort" serializeAs="String">
<value>True</value>
</setting>
<setting name="SSLPort" serializeAs="String">
<value>5494</value>
</setting>
<setting name="CertificateLookupValue" serializeAs="String">
<value>ENTER YOUR CERTIFICATE THUMBPRINT HERE</value>
</setting>
<setting name="CertificateLookupType" serializeAs="String">
<value>Thumbprint</value>
</setting>
</Sage.Common.Syndication.Properties.Settings>
</applicationSettings>
</configuration>

Sage 50 UK Connector for CData Sync

Advanced Features

This section details a selection of advanced features of the Sage 50 UK Sync App.

User Defined Views

The Sync App supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views .

SSL Configuration

Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats;. For further information, see the SSLServerCert property under "Connection String Options" .

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

The Sync App offloads as much of the SELECT statement processing as possible to Sage 50 UK and then processes the rest of the query in memory (client-side).

For further information, see Query Processing.

Logging

For an overview of configuration settings that can be used to refine CData logging, see Logging. Only two connection properties are required for basic logging, but there are numerous features that support more refined logging, which enables you to use the LogModules connection property to specify subsets of information to be logged.

Sage 50 UK Connector for CData Sync

SSL Configuration

Customizing the SSL Configuration

By default, the Sync App attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

Sage 50 UK Connector for CData Sync

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

  • ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
  • ProxyPort: the TCP port that the proxy server is running on.
  • ProxyAuthScheme: the authentication method the Sync App uses when authenticating to the proxy server.
  • ProxyUser: the username of a user account registered with the proxy server.
  • ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

  • To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
  • To tunnel the connection, set FirewallType to TUNNEL.
  • To authenticate, specify FirewallUser and FirewallPassword.
  • To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

Sage 50 UK Connector for CData Sync

Data Model

The CData Sync App models Sage 50 UK entities in relational Tables and Views.

Tables

Tables describes the available tables.

Views

Views are tables that cannot be modified. Typically, read-only data are shown as views.

Sage 50 UK Connector for CData Sync

Tables

The Sync App models the data in Sage 50 UK as a list of tables in a relational database that can be queried using standard SQL statements.

Sage 50 UK Connector for CData Sync Tables

Name Description
Commodities Create, Update and Query Commodities (Products and Services) within Sage UK 50 Accounts.
Contacts Create, Update, Delete, and Query Contacts within Sage UK 50 Accounts.
PurchaseOrders Create, Update, Delete, and Query PurchaseOrders within Sage UK 50 Accounts.
SalesCredits Query SalesCredits within Sage UK 50 Accounts.
SalesInvoices Query SalesInvoices within Sage UK 50 Accounts.
SalesOrders Create, Update, Delete, and Query SalesOrders within Sage UK 50 Accounts.
TradingAccounts Create, Update, Delete, and Query TradingAccounts within Sage UK 50 Accounts.

Sage 50 UK Connector for CData Sync

Commodities

Create, Update and Query Commodities (Products and Services) within Sage UK 50 Accounts.

Table Specific Information

The Commodities table allows you to select, insert, and update Commodities (Products and Services) within a Sage 50 UK company dataset.

Select

The Commodities table returns the products and services for a Sage 50 UK company dataset.

SELECT * FROM Commodities WHERE ProductCode LIKE 'ABC%'

Insert

To create a new Commodity record, the Description field is required.


INSERT INTO Commodities (ProductCode, Description, SupplierReference, CatalogueNumber, WebDescription, Cost)
VALUES ('MNP', 'MyNewProduct', 'UNI001', 'U143', 'My Web Description', 5.49)

Update

Any field that is not read-only can be updated.


UPDATE Commodities SET Description = 'My New Description' WHERE CommodityUUID = '8c47b43a-7115-7419-9679-7c72586e67d1'

Columns

Name Type ReadOnly Description
CommodityUUID [KEY] String True

Commodity UUID

CommodityIdentifierType String False

Commodity CommodityIdentifier Type

ProductCode String False

Commodity Product Code

Reference2 String False

Commodity Reference2

Status String False

Commodity Status

Description String False

Commodity Description

WebDescription String False

Commodity Web Description

AlternativeDescription2 String False

Commodity Alternative Description 2

Type String True

Commodity Type (Category)

BuyingAllowedFlag Boolean False

Commodity Buying Allowed Flag

SellingAllowedFlag Boolean False

Commodity Selling Allowed Flag

CatalogueNumber String False

Commodity Catalogue (Part) Number

SupplierReference String False

Commodity Supplier reference

ManufacturerCompany String False

Commodity Manufacturer Company

Weight Decimal False

Commodity Weight

Classification String False

Commodity Classification

Cost Decimal False

Commodity Cost

InStock Decimal True

Commodity Amount in Stock

Allocated Decimal True

Commodity Amount Allocated

FreeStock Decimal True

Commodity Free Stock

OnOrder Decimal True

Commodity Amount on Order

SalesPrice Decimal True

Commodity Sales Price in base currency

UnitDescription String True

Commodity UnitOfMeasure Description

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
Updated Datetime

An input used internally to filter records updated at a specific datetime.

Sage 50 UK Connector for CData Sync

Contacts

Create, Update, Delete, and Query Contacts within Sage UK 50 Accounts.

Table Specific Information

The Contacts table allows you to select, insert, update, and delete contacts within a Sage 50 UK company dataset.

Select

The Contacts table returns the contacts contained within a Sage 50 UK company dataset.

SELECT * FROM Contacts WHERE TradingAccountReference = 'ABC123'

Insert

To create a new Contacts record, the TradingAccountReference and Type fields are required.


INSERT INTO Contacts (Title, FirstName, MiddleName, FamilyName, Suffix, TradingAccountReference, Type, PostalAddressAddress1, PostalAddressTownCity, PostalAddressStateRegion, PostalAddressZipPostCode, PostalAddressType, PostalAddressDescription, Phone1Text, Phone1Type, Phone2Text, Phone2Type, EmailAddress) 
VALUES (True, 'Dr.', 'INSERT', 'ME', 'NOW', 'Jr.', 'CNTCTEST', 'Customer Delivery Contact', '123 Main St', 'Durham', 'NC', '12345', 'Shipping', 'NEW Description', '123-456-7890', 'Business Phone', '555-444-1111', 'Fax', '[email protected]')

Update

Any field that is not read-only can be updated. Requirements exist for some fields of a Contact record:

  • To update an existing postal address, PostalAddressUUID is required. Otherwise if postal address is null, specify the details and leave the UUID empty.
  • To update an existing Phone1, Phone1UUID is required. Otherwise if Phone1 is empty, specify the details and leave the UUID empty.
  • To update an existing Phone2, Phone2UUID is required. Otherwise if Phone2 is empty, specify the details and leave the UUID empty.
  • To update an existing email address, EmailUUID is required. Otherwise if email is empty, specify the details and leave the UUID empty.


UPDATE Contacts SET EmailAddress = '[email protected]', Phone1Text = '999-999-9999'
WHERE ContactUUID = '96df2e1e-72c6-4b52-b39a-eeb42c840f87' AND Phone1UUID = 'bd621624-f78e-4dec-abf3-b8b94d8fe7a3' AND EmailUUID = 'a3f6ff1b-a80b-4019-ae5e-b1fa1bb4044d'

Delete

Deleting a Contact record will also delete all postal addresses, phone numbers, and emails associated with the Contact.


DELETE FROM Contacts WHERE ContactUUID = '96df2e1e-72c6-4b52-b39a-eeb42c840f87'

Columns

Name Type ReadOnly Description
ContactUUID [KEY] String True

Contact UUID

TradingAccountReference String False

Contact Trading Account Reference

Reference2 String False

Contact Reference2

Type String False

Contact Type

FullName String False

Contact Full Name. In the form: [Title] [FirstName] [MiddleName] [FamilyName] [Suffix].

Title String False

Contact Title

FirstName String False

Contact First Name

MiddleName String False

Contact Middle Name

FamilyName String False

Contact Family Name

Suffix String False

Contact Suffix

TaxReference String False

Contact Tax Reference

PrimacyIndicator Boolean False

Contact Primacy Indicator

PostalAddressUUID String True

Contact PostalAddress UUID

PostalAddressActive Boolean False

Contact PostalAddress Active Flag

PostalAddressReference String False

Contact PostalAddress Reference

PostalAddressName String False

Contact PostalAddress Name

PostalAddressDescription String False

Contact PostalAddress Description

PostalAddressAddress1 String False

Contact PostalAddress Address 1

PostalAddressAddress2 String False

Contact PostalAddress Address 2

PostalAddressTownCity String False

Contact PostalAddress TownCity

PostalAddressCounty String False

Contact PostalAddress StateRegion

PostalAddressZipPostCode String False

Contact PostalAddress ZipPost Code

PostalAddressCountry String False

Contact PostalAddress Country

PostalAddressPrimacyIndicator Boolean False

Contact PostalAddress Primacy Indicator

PostalAddressType String False

Contact PostalAddress Type

Phone1UUID String True

Contact PhoneNumber UUID

Phone1Active Boolean False

Contact PhoneNumber Active Flag

Phone1Reference String False

Contact PhoneNumber Reference

Phone1Reference2 String False

Contact PhoneNumber Reference2

Phone1Type String False

Contact PhoneNumber Type

Phone1Name String False

Contact PhoneNumber Name

Phone1Text String False

Contact PhoneNumber Text

Phone1PrimacyIndicator Boolean False

Contact PhoneNumber Primacy Indicator

Phone2UUID String True

Contact PhoneNumber UUID

Phone2Active Boolean False

Contact PhoneNumber Active Flag

Phone2Reference String False

Contact PhoneNumber reference

Phone2Reference2 String False

Contact PhoneNumber Reference2

Phone2Type String False

Contact PhoneNumber Type

Phone2Name String False

Contact PhoneNumber Name

Phone2Text String False

Contact PhoneNumber Text

Phone2PrimacyIndicator Boolean False

Contact PhoneNumber Primacy Indicator

EmailUUID String True

Contact Email UUID

EmailActive Boolean False

Contact Email Active Flag

EmailReference String False

Contact Email Reference

EmailReference2 String False

Contact Email Reference

EmailType String False

Contact Email Type

EmailAddress String False

Contact Email Address

EmailUrl String False

Contact Email mailto:URL

EmailPrimacyIndicator Boolean False

Contact Email Primacy Indicator

EmailLabel String False

Contact Email Label

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
Updated Datetime

An input used internally to filter records updated at a specific datetime.

Sage 50 UK Connector for CData Sync

PurchaseOrders

Create, Update, Delete, and Query PurchaseOrders within Sage UK 50 Accounts.

Table Specific Information

The PurchaseOrders table allows you to select, insert, update, and delete purchase orders within a Sage 50 UK company dataset.

Select

The PurchaseOrders table returns the purchase orders for a Sage 50 UK company dataset.

SELECT * FROM PurchaseOrders WHERE Date >= '1/1/2015' AND Date < '2/1/2015'

Insert

To create a new PurchaseOrder record, the TradingAccountUUID field is required.

Purchase Order Line Items are specified via an XML aggregate within the ItemsAggregate column. The columns that may be used in these aggregates are defined in the PurchaseOrderLineItems table.

The following example demonstrates how to insert a new PurchaseOrder with two line items:

INSERT INTO PurchaseOrders (TradingAccountUUID, DeliveryDate, PostalAddressName, PostalAddressType, PostalAddressAddress1, PostalAddressTownCity, PostalAddressStateRegion, ItemsAggregate) 
VALUES ('b83c940f-9d2b-4a35-bf42-28bbe07ef994', '05/05/2015', 'Purchase Order Billing Address', 'Billing', '123 Main St', 'Chapel Hill', 'NC', 
'<PurchaseOrderLineItems>
<Row><CommodityUUID>0a47b43d-7115-4863-9689-1a53123e67c8</CommodityUUID><Quantity>1</Quantity><ActualPrice>1.99</ActualPrice></Row>
<Row><CommodityUUID>586df2bb-7702-4228-b464-e8d509148547</CommodityUUID><Quantity>4</Quantity><ActualPrice>4.99</ActualPrice></Row>
</PurchaseOrderLineItems>')

Update

Any field that is not read-only can be updated.

When updating a PurchaseOrder record, PostalAddressUUID is required when updating a postal address. Note that purchase order line items cannot be updated nor deleted.


UPDATE PurchaseOrders SET PostalAddressZipPostCode = '12345'
WHERE PurchaseOrderUUID = '1b47b43a-7115-4863-9679-1a78636e67c1' AND PostalAddressUUID = '28915e09-b2a1-47e1-b193-741b32ba8ba0'

Delete

Deleting a PurchaseOrder record will also delete all line items and postal addresses associated with the PurchaseOrder.


DELETE FROM PurchaseOrders WHERE PurchaseOrderUUID = '1b47b43a-7115-4863-9679-1a78636e67c1'

Columns

Name Type ReadOnly Description
PurchaseOrderUUID [KEY] String True

PurchaseOrder UUID

TradingAccountUUID String False

Trading Account UUID associated with the PurchaseOrder

ContactUUID String True

PurchaseOrder Seller Contact UUID

PurchaseOrderNumber String False

PurchaseOrder Reference

Reference2 String False

PurchaseOrder Reference2

Status String False

PurchaseOrder Status

StatusFlagText String False

PurchaseOrder Status Flag Text

SupplierReference String False

PurchaseOrder Supplier Reference

CopyFlag Boolean False

PurchaseOrder Copy Flag

DeliveryDate Date False

PurchaseOrder Delivery Date

CarrierNetPrice Decimal False

PurchaseOrder Carrier Net Price

CarrierTaxPrice Decimal False

PurchaseOrder Carrier Tax Price

CarrierTotalPrice Decimal False

PurchaseOrder Carrier Gross Price

CarrierReference String False

PurchaseOrder Carrier reference

Currency String False

PurchaseOrder Currency

OCCurrencyExchangeRate Decimal False

PurchaseOrder Operating Company Currency Exchange Rate

OCCurrencyExchangeRateOperator String False

PurchaseOrder Operating Company Currency Exchange Rate Operator

Date Date False

PurchaseOrder Date

User String False

PurchaseOrder User

LineCount Decimal True

PurchaseOrder Line Count

Text1 String False

PurchaseOrder Text1

Text2 String False

PurchaseOrder Text2

NetTotal Decimal True

PurchaseOrder Net Total

TaxTotal Decimal True

PurchaseOrder Tax Total

GrossTotal Decimal True

PurchaseOrder Gross Total

OnOrder String False

PurchaseOrder On Order Status

ItemsAggregate String False

An aggregate of the line item data, which is used for adding a purchase order and its line items.

PostalAddressUUID String True

PurchaseOrder PostalAddress UUID

PostalAddressActive Boolean False

PurchaseOrder PostalAddress Active Flag

PostalAddressReference String False

PurchaseOrder PostalAddress Reference

PostalAddressName String False

PurchaseOrder PostalAddress Name

PostalAddressDescription String False

PurchaseOrder PostalAddress Description

PostalAddressAddress1 String False

PurchaseOrder PostalAddress Address 1

PostalAddressAddress2 String False

PurchaseOrder PostalAddress Address 2

PostalAddressAddress3 String False

PurchaseOrder PostalAddress Address 3

PostalAddressAddress4 String False

PurchaseOrder PostalAddress Address 4

PostalAddressTownCity String False

PurchaseOrder PostalAddress TownCity

PostalAddressCounty String False

PurchaseOrder PostalAddress County

PostalAddressStateRegion String False

PurchaseOrder PostalAddress StateRegion

PostalAddressZipPostCode String False

PurchaseOrder PostalAddress ZipPost Code

PostalAddressCountry String False

PurchaseOrder PostalAddress Country

PostalAddressPrimacyIndicator Boolean False

PurchaseOrder PostalAddress Primacy Indicator

PostalAddressType String False

PurchaseOrder PostalAddress Type. Sample values: Billing, Shipping.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
Updated Datetime

An input used internally to filter records updated at a specific datetime.

Sage 50 UK Connector for CData Sync

SalesCredits

Query SalesCredits within Sage UK 50 Accounts.

Table Specific Information

The SalesCredits table allows you to select, insert, update, and delete sales credits within a Sage 50 UK company dataset.

Select

The SalesCredits table returns the sales credits for a Sage 50 UK company dataset.

SELECT * FROM SalesCredits WHERE Date >= '1/1/2015' AND Date < '2/1/2015'

Insert

To create a new SalesCredits record, the TradingAccountUUID field is required.

Sales Credit Line Items are specified via an XML aggregate within the ItemsAggregate column. The columns that may be used in these aggregates are defined in the SalesCreditLineItems table.

The following example demonstrates how to insert a new PurchaseOrder with two line items:

INSERT INTO SalesCredits (TradingAccountUUID, Type,  PostalAddress1Name, PostalAddress1Type, PostalAddress1Address1, PostalAddress1TownCity, PostalAddress1StateRegion, PostalAddress2Name, PostalAddress2Type, PostalAddress2Address1, PostalAddress2TownCity, PostalAddress2StateRegion, ItemsAggregate) 
VALUES ('b83c940f-9d2b-4a35-bf42-28bbe07ef994', 'Product Credit Note',  'Sales Order Delivery Address', 'Shipping', '123 Main St', 'Chapel Hill', 'NC', 'Sales Order Billing Address', 'Billing', '987 Center Road', 'Chapel Hill', 'NC', 
'<SalesCreditLineItems>
<Row><CommodityUUID>03ecf74f-0f08-4667-8a59-07e6338a8b32</CommodityUUID><Quantity>1</Quantity><ActualPrice>2.99</ActualPrice></Row>
<Row><CommodityUUID>0a47b43d-7115-4863-9689-1a53123e67c8</CommodityUUID><Quantity>2</Quantity><ActualPrice>3.99</ActualPrice></Row>
</SalesCreditLineItems>')

Update

Any field that is not read-only can be updated.

When updating a SalesCredits record, PostalAddress1UUID or PostalAddress2UUID are required when updating the respective postal address. Note that sales credit line items cannot be updated nor deleted.


UPDATE SalesCredits SET PostalAddress2ZipPostCode = '12345'
WHERE SalesCreditUUID = '392235af-f45a-4c43-a275-897130e4fdc4' AND PostalAddress2UUID = '28915e09-b2a1-47e1-b193-741b32ba8ba0'

Delete

Deleting a SalesCredit record will also delete all line items and postal addresses associated with the SalesCredit.


DELETE FROM SalesCredits WHERE SalesCreditUUID = '392235af-f45a-4c43-a275-897130e4fdc4'

Columns

Name Type ReadOnly Description
SalesCreditUUID [KEY] String True

SalesCredit UUID

TradingAccountUUID String False

SalesCredit Trading Account UUID

ContactUUID String True

SalesCredit Buyer Contact UUID

CreditNumber String False

SalesCredit Reference

SalesOrderNumber String False

SalesCredit Invoice Reference

Status String False

SalesCredit Status

Type String False

SalesCredit Type

CustomerOrderNumber String False

SalesCredit Customer Reference

CopyFlag Boolean False

SalesCredit Copy Flag

Date Date False

SalesCredit Date

TaxDate Date False

SalesCredit Tax Date

CarrierNetPrice Decimal False

SalesCredit Carrier Net Price

CarrierTaxPrice Decimal False

SalesCredit Carrier Tax Price

CarrierTotalPrice Decimal False

SalesCredit Carrier Gross Price

Currency String False

SalesCredit Currency

OCCurrencyExchangeRate Decimal False

SalesCredit OperatingCompany Currency Exchange Rate

OCCurrencyExchangeRateOperator String False

SalesCredit OperatingCompany Currency Exchange Rate Operator

LineCount Decimal False

SalesCredit Line Count

SettlementDiscountAmount Decimal False

SalesCredit Settlement Discount Amount

SettlementDiscountPercent Decimal False

SalesCredit Settlement Discount Percent

SettlementDiscountIncludedInTotal Boolean False

SalesCredit Settlement Discount Included In Total

InvoiceDiscountAmount Decimal False

SalesCredit Invoice Discount Amount

InvoiceDiscountPercent Decimal False

SalesCredit Invoice Discount Percent

NetTotal Decimal True

SalesCredit Net Total

TaxTotal Decimal True

SalesCredit Tax Total

GrossTotal Decimal True

SalesCredit Gross Total

Text1 String False

SalesCredit Text1

Text2 String False

SalesCredit Text2

User String False

SalesCredit User

ItemsAggregate String False

An aggregate of the line item data, which can be used for adding a purchase order and its line items.

PostalAddress1UUID String True

SalesCredit PostalAddress UUID

PostalAddress1Active Boolean False

SalesCredit PostalAddress Active Flag

PostalAddress1Reference String False

SalesCredit PostalAddress Reference

PostalAddress1Name String False

SalesCredit PostalAddress Name

PostalAddress1Description String False

SalesCredit PostalAddress Description

PostalAddress1Address1 String False

SalesCredit PostalAddress Address 1

PostalAddress1Address2 String False

SalesCredit PostalAddress Address 2

PostalAddress1Address3 String False

SalesCredit PostalAddress Address 3

PostalAddress1Address4 String False

SalesCredit PostalAddress Address 4

PostalAddress1TownCity String False

SalesCredit PostalAddress TownCity

PostalAddress1County String False

SalesCredit PostalAddress County

PostalAddress1StateRegion String False

SalesCredit PostalAddress StateRegion

PostalAddress1ZipPostCode String False

SalesCredit PostalAddress ZipPost Code

PostalAddress1Country String False

SalesCredit PostalAddress Country

PostalAddress1PrimacyIndicator Boolean False

SalesCredit PostalAddress Primacy Indicator

PostalAddress1Type String False

SalesCredit PostalAddress Type. Sample values: Billing, Shipping.

PostalAddress2UUID String True

SalesCredit PostalAddress UUID

PostalAddress2Active Boolean False

SalesCredit PostalAddress Active Flag

PostalAddress2Reference String False

SalesCredit PostalAddress Reference

PostalAddress2Name String False

SalesCredit PostalAddress Name

PostalAddress2Description String False

SalesCredit PostalAddress Description

PostalAddress2Address1 String False

SalesCredit PostalAddress Address 1

PostalAddress2Address2 String False

SalesCredit PostalAddress Address 2

PostalAddress2Address3 String False

SalesCredit PostalAddress Address 3

PostalAddress2Address4 String False

SalesCredit PostalAddress Address 4

PostalAddress2TownCity String False

SalesCredit PostalAddress TownCity

PostalAddress2County String False

SalesCredit PostalAddress County

PostalAddress2StateRegion String False

SalesCredit PostalAddress StateRegion

PostalAddress2ZipPostCode String False

SalesCredit PostalAddress ZipPost Code

PostalAddress2Country String False

SalesCredit PostalAddress Country

PostalAddress2PrimacyIndicator Boolean False

SalesCredit PostalAddress Primacy Indicator

PostalAddress2Type String False

SalesCredit PostalAddress Type. Sample values: Billing, Shipping.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
Updated Datetime

An input used internally to filter records updated at a specific datetime.

Sage 50 UK Connector for CData Sync

SalesInvoices

Query SalesInvoices within Sage UK 50 Accounts.

Table Specific Information

The SalesInvoices table allows you to select, insert, update, and delete sales invoices within a Sage 50 UK company dataset.

Select

The SalesInvoices table returns the sales invoices for a Sage 50 UK company dataset.

SELECT * FROM SalesInvoices WHERE Date >= '1/1/2015' AND Date < '2/1/2015'

Insert

To create a new SalesInvoices record, the TradingAccountUUID field is required.

Sales Invoice Line Items are specified via an XML aggregate within the ItemsAggregate column. The columns that may be used in these aggregates are defined in the SalesInvoiceLineItems table.
Note: For text column in SalesInvoiceLineItems, length of the string must be equal or less than 61 characters, otherwise driver will use first 61 characters.

The following example demonstrates how to insert a new SalesInvoice with two line items:

INSERT INTO SalesInvoices (TradingAccountUUID, Type, PostalAddress1Name, PostalAddress1Type, PostalAddress1Address1, PostalAddress1TownCity, PostalAddress1StateRegion, PostalAddress2Name, PostalAddress2Type, PostalAddress2Address1, PostalAddress2TownCity, PostalAddress2StateRegion, ItemsAggregate) 
VALUES ('b83c940f-9d2b-4a35-bf42-28bbe07ef994', 'Product Invoice', 'Sales Order Delivery Address', 'Shipping', '123 Main St', 'Chapel Hill', 'NC', 'Sales Order Billing Address', 'Billing', '987 Center Road', 'Chapel Hill', 'NC', '<SalesInvoiceLineItems> <Row><CommodityUUID>03ecf74f-0f08-4667-8a59-07e6338a8b32</CommodityUUID><Quantity>2</Quantity><ActualPrice>2.99</ActualPrice></Row> <Row><CommodityUUID>0a47b43d-7115-4863-9689-1a53123e67c8</CommodityUUID><Quantity>1</Quantity><ActualPrice>4.99</ActualPrice></Row>
</SalesInvoiceLineItems>')

Update

Any field that is not read-only can be updated.

When updating a SalesInvoices record, PostalAddress1UUID and PostalAddress2UUID are required when updating a postal address (respectively). Note that sales invoice line items cannot be updated nor deleted.


UPDATE SalesInvoices SET PostalAddress2ZipPostCode = '12345'
WHERE SalesInvoiceUUID = '392235af-f45a-4c43-a275-897130e4fdc4' AND PostalAddress2UUID = '28915e09-b2a1-47e1-b193-741b32ba8ba0'

Delete

Deleting a SalesInvoice record will also delete all line items and postal addresses associated with the SalesInvoice.


DELETE FROM SalesInvoices WHERE SalesInvoiceUUID = '392235af-f45a-4c43-a275-897130e4fdc4'

Columns

Name Type ReadOnly Description
SalesInvoiceUUID [KEY] String True

SalesInvoice UUID

TradingAccountUUID String False

SalesOrder Trading Account UUID

ContactUUID String True

SalesOrder Buyer Contact UUID

InvoiceNumber String False

SalesInvoice Reference

SalesOrderNumber String False

SalesInvoice Reference2

Status String False

SalesInvoice Status

Type String False

SalesInvoice Type

CustomerOrderNumber String False

SalesInvoice Customer Reference

Date Date False

SalesInvoice Date

TaxDate Date False

SalesInvoice Tax Date

CarrierNetPrice Decimal False

SalesInvoice Carrier Net Price

CarrierTaxPrice Decimal False

SalesInvoice Carrier Tax Price

CarrierTotalPrice Decimal False

SalesInvoice Carrier Gross Price

Currency String False

SalesInvoice Currency

OCCurrencyExchangeRate Decimal False

SalesInvoice Operating Company Currency Exchange Rate

OCCurrencyExchangeRateOperator String False

SalesInvoice Operating Company Currency Exchange Rate Operator

LineCount Decimal True

SalesInvoice Line Count

SettlementDiscountAmount Decimal False

SalesInvoice Settlement Discount Amount

SettlementDiscountPercent Decimal False

SalesInvoice Settlement Discount Percent

SettlementDiscountIncludedInTotal Boolean False

SalesInvoice Settlement Discount Included In Total

InvoiceDiscountAmount Decimal False

SalesInvoice Invoice Discount Amount

InvoiceDiscountPercent Decimal False

SalesInvoice Invoice Discount Percent

NetTotal Decimal True

SalesInvoice Net Total

TaxTotal Decimal True

SalesInvoice Tax Total

GrossTotal Decimal True

SalesInvoice Gross Total

Text1 String False

SalesInvoice Text1

Text2 String False

SalesInvoice Text2

User String False

SalesInvoice User

PaymentDue Date True

SalesInvoice Payment Due

ItemsAggregate String False

An aggregate of the line item data, which can be used for adding a purchase order and its line items.

PostalAddress1UUID String True

SalesOrder PostalAddress UUID

PostalAddress1Active Boolean False

SalesOrder PostalAddress Active Flag

PostalAddress1Reference String False

SalesOrder PostalAddress Reference

PostalAddress1Name String False

SalesOrder PostalAddress Name

PostalAddress1Description String False

SalesOrder PostalAddress Description

PostalAddress1Address1 String False

SalesOrder PostalAddress Address 1

PostalAddress1Address2 String False

SalesOrder PostalAddress Address 2

PostalAddress1Address3 String False

SalesOrder PostalAddress Address 3

PostalAddress1Address4 String False

SalesOrder PostalAddress Address 4

PostalAddress1TownCity String False

SalesOrder PostalAddress TownCity

PostalAddress1County String False

SalesOrder PostalAddress County

PostalAddress1StateRegion String False

SalesOrder PostalAddress StateRegion

PostalAddress1ZipPostCode String False

SalesOrder PostalAddress ZipPost Code

PostalAddress1Country String False

SalesOrder PostalAddress Country

PostalAddress1PrimacyIndicator Boolean False

SalesOrder PostalAddress Primacy Indicator

PostalAddress1Type String False

SalesOrder PostalAddress Type. Sample values: Billing, Shipping.

PostalAddress2UUID String True

SalesOrder PostalAddress UUID

PostalAddress2Active Boolean False

SalesOrder PostalAddress Active Flag

PostalAddress2Reference String False

SalesOrder PostalAddress Reference

PostalAddress2Name String False

SalesOrder PostalAddress Name

PostalAddress2Description String False

SalesOrder PostalAddress Description

PostalAddress2Address1 String False

SalesOrder PostalAddress Address 1

PostalAddress2Address2 String False

SalesOrder PostalAddress Address 2

PostalAddress2Address3 String False

SalesOrder PostalAddress Address 3

PostalAddress2Address4 String False

SalesOrder PostalAddress Address 4

PostalAddress2TownCity String False

SalesOrder PostalAddress TownCity

PostalAddress2County String False

SalesOrder PostalAddress County

PostalAddress2StateRegion String False

SalesOrder PostalAddress StateRegion

PostalAddress2ZipPostCode String False

SalesOrder PostalAddress ZipPost Code

PostalAddress2Country String False

SalesOrder PostalAddress Country

PostalAddress2PrimacyIndicator Boolean False

SalesOrder PostalAddress Primacy Indicator

PostalAddress2Type String False

SalesOrder PostalAddress Type. Sample values: Billing, Shipping.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
Updated Datetime

An input used internally to filter records updated at a specific datetime.

Sage 50 UK Connector for CData Sync

SalesOrders

Create, Update, Delete, and Query SalesOrders within Sage UK 50 Accounts.

Table Specific Information

The SalesOrders table allows you to select, insert, update, and delete sales orders within a Sage 50 UK company dataset.

Select

The SalesOrders table returns the sales orders for a Sage 50 UK company dataset.

SELECT * FROM SalesOrders WHERE Date >= '1/1/2015' AND Date < '2/1/2015'

Insert

To create a new SalesOrder record, the TradingAccountUUID field is required.

Sales Order Line Items are specified via an XML aggregate within the ItemsAggregate column. The columns that may be used in these aggregates are defined in the SalesOrderLineItems table. Note: a CommodityUUID must be set when adding a SalesOrderLineItem, as only existing Commodities can be referenced (to create a new Commodity, the Commodities table can be used).

The following example demonstrates how to insert a new SalesOrder with two line items:

INSERT INTO SalesOrders (TradingAccountUUID, DueDate, PostalAddress1Name, PostalAddress1Type, PostalAddress1Address1, PostalAddress1TownCity, PostalAddress1StateRegion, ItemsAggregate) 
VALUES ('b83c940f-9d2b-4a35-bf42-28bbe07ef994', True, '05/05/2015', 'Sales Order Delivery Address', 'Shipping', '123 Main St', 'Chapel Hill', 'NC', 
'<SalesOrderLineItems>
<Row><CommodityUUID>0a47b43d-7115-4863-9689-1a53123e67c8</CommodityUUID><Quantity>1</Quantity><ActualPrice>1.99</ActualPrice></Row>
<Row><CommodityUUID>586df2bb-7702-4228-b464-e8d509148547</CommodityUUID><Quantity>4</Quantity><ActualPrice>4.99</ActualPrice></Row>
</SalesOrderLineItems>')

Update

Any field that is not read-only can be updated.

When updating a SalesOrder record, PostalAddress1UUID and PostalAddress2UUID are required when updating the respective postal address. Note that sales order line items cannot be updated nor deleted.


UPDATE SalesOrders SET PostalAddress1ZipPostCode = '12345'
WHERE SalesOrderUUID = '957af245-4678-4ca9-904a-162dcce87e5b' AND PostalAddress1UUID = '28915e09-b2a1-47e1-b193-741b32ba8ba0'

Delete

Deleting a SalesOrder record will also delete all line items and postal addresses associated with the SalesOrder.


DELETE FROM SalesOrders WHERE SalesOrderUUID = '957af245-4678-4ca9-904a-162dcce87e5b'

Columns

Name Type ReadOnly Description
SalesOrderUUID [KEY] String True

SalesOrder UUID

TradingAccountUUID String False

SalesOrder Trading Account UUID

ContactUUID String True

SalesOrder Buyer Contact UUID

SalesOrderNumber String False

SalesOrder Reference

InvoiceNumber String False

SalesOrder Invoice Reference

AllocationStatus String False

SalesOrder Allocation Status

DeliveryStatus String False

SalesOrder Delivery Status

InvoiceStatus String False

SalesOrder Invoice Status

CustomerReference String False

SalesOrder Customer reference

Type String False

SalesOrder Type

CopyFlag Boolean False

SalesOrder Copy Flag

DueDate Date False

SalesOrder Due Date

CarrierNetPrice Decimal False

SalesOrder Carrier Net Price

CarrierTaxPrice Decimal False

SalesOrder Carrier Tax Price

CarrierTotalPrice Decimal False

SalesOrder Carrier Gross Price

CarrierReference String False

SalesOrder Carrier Reference

Currency String False

SalesOrder Currency

OCCurrency String False

SalesOrder Operating Company Currency

OCCurrencyExchangeRate Decimal False

SalesOrder Operating Company Currency Exchange Rate

OCCurrencyExchangeRateOperator String False

SalesOrder Operating Company Currency Exchange Rate Operator

Date Date False

SalesOrder Date

User String False

SalesOrder User

LineCount Decimal False

SalesOrder Line Count

OrderDiscountType String False

SalesOrder Order Discount Type

OrderDiscountAmount Decimal False

SalesOrder Order Discount Amount

OrderDiscountPercent Decimal False

SalesOrder Order Discount Percent

Text1 String False

SalesOrder Text1

Text2 String False

SalesOrder Text2

NetTotal Decimal False

SalesOrder Net Total

TaxTotal Decimal False

SalesOrder Tax Total

GrossTotal Decimal False

SalesOrder Gross Total

ItemsAggregate String False

An aggregate of the line item data, which can be used for adding a purchase order and its line items.

PostalAddress1UUID String True

SalesOrder PostalAddress UUID

PostalAddress1Active Boolean False

SalesOrder PostalAddress Active Flag

PostalAddress1Reference String False

SalesOrder PostalAddress Reference

PostalAddress1Name String False

SalesOrder PostalAddress Name

PostalAddress1Description String False

SalesOrder PostalAddress Description

PostalAddress1Address1 String False

SalesOrder PostalAddress Address 1

PostalAddress1Address2 String False

SalesOrder PostalAddress Address 2

PostalAddress1Address3 String False

SalesOrder PostalAddress Address 3

PostalAddress1Address4 String False

SalesOrder PostalAddress Address 4

PostalAddress1TownCity String False

SalesOrder PostalAddress TownCity

PostalAddress1County String False

SalesOrder PostalAddress County

PostalAddress1StateRegion String False

SalesOrder PostalAddress StateRegion

PostalAddress1ZipPostCode String False

SalesOrder PostalAddress ZipPost Code

PostalAddress1Country String False

SalesOrder PostalAddress Country

PostalAddress1PrimacyIndicator Boolean False

SalesOrder PostalAddress Primacy Indicator

PostalAddress1Type String False

SalesOrder PostalAddress Type. Sample values: Billing, Shipping.

PostalAddress2UUID String True

SalesOrder PostalAddress UUID

PostalAddress2Active Boolean False

SalesOrder PostalAddress Active Flag

PostalAddress2Reference String False

SalesOrder PostalAddress Reference

PostalAddress2Name String False

SalesOrder PostalAddress Name

PostalAddress2Description String False

SalesOrder PostalAddress Description

PostalAddress2Address1 String False

SalesOrder PostalAddress Address 1

PostalAddress2Address2 String False

SalesOrder PostalAddress Address 2

PostalAddress2Address3 String False

SalesOrder PostalAddress Address 3

PostalAddress2Address4 String False

SalesOrder PostalAddress Address 4

PostalAddress2TownCity String False

SalesOrder PostalAddress TownCity

PostalAddress2County String False

SalesOrder PostalAddress County

PostalAddress2StateRegion String False

SalesOrder PostalAddress StateRegion

PostalAddress2ZipPostCode String False

SalesOrder PostalAddress ZipPost Code

PostalAddress2Country String False

SalesOrder PostalAddress Country

PostalAddress2PrimacyIndicator Boolean False

SalesOrder PostalAddress Primacy Indicator

PostalAddress2Type String False

SalesOrder PostalAddress Type. Sample values: Billing, Shipping.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
Updated Datetime

An input used internally to filter records updated at a specific datetime.

Sage 50 UK Connector for CData Sync

TradingAccounts

Create, Update, Delete, and Query TradingAccounts within Sage UK 50 Accounts.

Table Specific Information

The TradingAccounts table allows you to select, insert, and update trading accounts within a Sage 50 UK company dataset.

Select

The TradingAccounts table returns the trading account information for a Sage 50 UK company dataset.

SELECT * FROM TradingAccounts

Insert

To create a new Trading Account record, the Name and CustomerSupplierFlag fields are required.


INSERT INTO TradingAccounts (Name, CustomerSupplierFlag, OpenedDate, Website, FinanceBalance, FinanceLimit, Analysis1, Analysis2, Analysis3)
VALUES ('My Trading Account', 'Customer', '05/10/2015', 'www.cdata.com', 100.00, 1000.00, 'Trade', 'Jenkins', 'National')

Update

Any field that is not read-only can be updated.


UPDATE TradingAccounts SET Analysis3 = 'International' WHERE TradingAccountUUID = '90c7afb4-ad34-41a2-b71d-ef49cc489872'

Delete


DELETE FROM TradingAccounts WHERE TradingAccountUUID = '90c7afb4-ad34-41a2-b71d-ef49cc489872'

Note: When additional resources are tied to the account, the record is not deleted. However, the Sage API will still return an OK response, signalling the record has been deleted. The actual error message can be viewed by attempting to delete the account within the software itself.

Columns

Name Type ReadOnly Description
TradingAccountUUID [KEY] String True

TradingAccount UUID

CustomerSupplierFlag String False

TradingAccount Customer Supplier Flag

CompanyPersonFlag String False

TradingAccount Company Person Flag. Valid values: Company or Person

OpenedDate Date False

TradingAccount Opened Date

TradingAccountReference String True

TradingAccount Reference

Status String False

TradingAccount Status

Name String False

TradingAccount Name

Type String False

TradingAccount Type

Website String False

TradingAccount Web site

DeliveryRule Boolean False

TradingAccount Delivery Rule

Currency String False

TradingAccount Currency

TaxReference String False

TradingAccount Tax reference

TaxationCountry String False

TradingAccount Taxation Country

FinanceBalance Decimal False

TradingAccount Finance Balance

FinanceLimit Decimal False

TradingAccount Finance Limit

FinanceStatusFlag Boolean False

TradingAccount Finance Status Flag

FinanceStatusText String False

TradingAccount Finance Status Text

SettlementDiscountType String False

TradingAccount Settlement Discount Type

SettlementDiscountPercent Decimal False

TradingAccount Settlement Discount Percent

SettlementDiscountTerms String False

TradingAccount Settlement Discount Terms

SettlementDiscountIncludedInTotal Boolean False

TradingAccount Settlement Discount Included In Total

PaymentTerms String False

TradingAccount Payment Terms

OrderLineDiscountPercent Decimal False

TradingAccount Order Line Discount Percent

InvoiceDiscountPercent Decimal False

TradingAccount Invoice Discount Percent

PrimacyIndicator Boolean False

TradingAccount Primacy Indicator

Balance Decimal False

TradingAccount Balance

CreditLimit Decimal False

TradingAccount Credit Limit

MTDTurnover Decimal True

TradingAccount Month To Date Turnover

YTDTurnover Decimal True

TradingAccount Year To Date Turnover

PriorYTDTurnover Decimal True

TradingAccount Prior Year To Date Turnover

FirstInvoiceDate Date True

TradingAccount First Invoice Date

LastInvoiceDate Date True

TradingAccount Last Invoice Date

LastPaymentDate Date True

TradingAccount Last Payment Date

LastCreditReviewDate Date False

TradingAccount Last Credit Review Date

TradingTerms String True

TradingAccount Trading Terms

StandardDiscount Decimal False

TradingAccount Standard Discount

AccountOnHold Boolean False

TradingAccount On Hold

Analysis1 String False

TradingAccount Analysis (Custom) Field 1

Analysis2 String False

TradingAccount Analysis (Custom) Field 2

Analysis3 String False

TradingAccount Analysis (Custom) Field 3

CanChargeCredit Boolean True

TradingAccount Can Charge Credit

NextCreditReviewDate Date False

TradingAccount Next Credit Review Date

AdditionalDiscount String True

TradingAccount Additional Discount Type

CreditAppliedDate Date False

TradingAccount Credit Applied date

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
Updated Datetime

An input used internally to filter records updated at a specific datetime.

Sage 50 UK Connector for CData Sync

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

Sage 50 UK Connector for CData Sync Views

Name Description
BankAccounts Query BankAccounts within Sage UK 50 Accounts.
FinancialAccounts Query Financial Accounts within Sage UK 50 Accounts.
Interactions Query Interactions within Sage UK 50 Accounts.
Prices Query Prices within Sage UK 50 Accounts.
Projects Query Projects within Sage UK 50 Accounts.
PurchaseOrderDeliveries Query PurchaseOrderDeliveries within Sage UK 50 Accounts.
PurchaseOrderDeliveryLineItems Query PurchaseOrderDeliveryLineItems within Sage UK 50 Accounts.
PurchaseOrderLineItems Query PurchaseOrderLines within Sage UK 50 Accounts.
Receipts Query Receipts within Sage UK 50 Accounts.
SalesCreditLineItems Query SalesCreditLineItems within Sage UK 50 Accounts.
SalesInvoiceLineItems Query SalesInvoiceLineItems within Sage UK 50 Accounts.
SalesOrderDeliveries Query SalesOrderDeliveries within Sage UK 50 Accounts.
SalesOrderDeliveryLineItems Query SalesOrderDeliveryLineItems within Sage UK 50 Accounts.
SalesOrderLineItems Query SalesOrderLineItems within Sage UK 50 Accounts.
TaxCodes Query Tax Codes within Sage UK 50 Accounts.
TradingActivities Query TradingActivities within Sage UK 50 Accounts.

Sage 50 UK Connector for CData Sync

BankAccounts

Query BankAccounts within Sage UK 50 Accounts.

Table Specific Information

Select

The BankAccounts table returns the bank accounts for a Sage 50 UK company dataset.

SELECT * FROM BankAccounts

Columns

Name Type Description
BankAccountUUID [KEY] String BankAccount UUID
TradingAccountUUID String BankAccount Trading Account UUID
Type String BankAccount Type
TradingAccountReference String BankAccount Reference to the associated Trading Account
Name String BankAccount Name
BranchIdentifier String BankAccount Branch Identifier
AccountNumber String BankAccount Account Number
IBANNumber String BankAccount IBAN Number
BICSwiftCode String BankAccount BIC Swift Code
RollNumber String BankAccount Roll Number
Currency String BankAccount Currency
OperatingCompanyCurrency String BankAccount OperatingCompany Currency
Website String BankAccount Web site
CompanyReference String BankAccount Company Reference. Example values: 'Operating Company Bank Account', 'Supplier Bank Account', 'Customer Bank Account'
PaymentAllowedFlag Boolean BankAccount Payment Allowed Flag
ReceiptAllowedFlag Boolean BankAccount Receipt Allowed Flag
Reference2 String BankAccount Reference2
Balance Decimal BankAccount Balance
Limit Decimal BankAccount Limit
PrimacyIndicator Boolean BankAccount Primacy Indicator
PostalAddressUUID String BankAccount PostalAddress UUID
PostalAddressActive Boolean BankAccount PostalAddress Active Flag
PostalAddressTradingAccountReference String BankAccount PostalAddress Reference
PostalAddressName String BankAccount PostalAddress Name
PostalAddressDescription String BankAccount PostalAddress Description
PostalAddressAddress1 String BankAccount PostalAddress Address 1
PostalAddressAddress2 String BankAccount PostalAddress Address 2
PostalAddressAddress3 String BankAccount PostalAddress Address 3
PostalAddressAddress4 String BankAccount PostalAddress Address 4
PostalAddressTownCity String BankAccount PostalAddress TownCity
PostalAddressCounty String BankAccount PostalAddress County
PostalAddressStateRegion String BankAccount PostalAddress StateRegion
PostalAddressZipPostCode String BankAccount PostalAddress ZipPost Code
PostalAddressCountry String BankAccount PostalAddress Country
PostalAddressPrimacyIndicator Boolean BankAccount PostalAddress Primacy Indicator
PostalAddressType String BankAccount PostalAddress Type

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
Updated Datetime An input used internally to filter records updated at a specific datetime.

Sage 50 UK Connector for CData Sync

FinancialAccounts

Query Financial Accounts within Sage UK 50 Accounts.

Columns

Name Type Description
FinancialAccountUUID [KEY] String FinancialAccount UUID
NominalCode String FinancialAccount Nominal Code
AccountName String FinancialAccount Type
Currency String FinancialAccount Currency
Balance Decimal FinancialAccount Balance
PrimacyIndicator Boolean FinancialAccount Primacy Indicator

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
Updated Datetime An input used internally to filter records updated at a specific datetime.

Sage 50 UK Connector for CData Sync

Interactions

Query Interactions within Sage UK 50 Accounts.

Table Specific Information

Select

The Interactions table returns the customer interaction information for a Sage 50 UK company dataset.

SELECT * FROM Interactions

Columns

Name Type Description
InteractionUUID [KEY] String Interaction UUID
TradingAccountUUID String Interaction Trading Account UUID
Type String Interaction Type
Status String Interaction Status
TradingAccountReference String Interaction Reference
Description String Interaction Description
User String Interaction User
Date Date Interaction Date
Time Time Interaction Time
EndDate Date Interaction End Date
EndTime Time Interaction End Time
Recurrence Boolean Interaction Recurrence
PrivacyFlag Boolean Interaction Privacy Flag
PromisedPaymentDate Date Interaciton Promised Payment Date
FollowUpDate Date Interaction Follow Up Date

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
Updated Datetime An input used internally to filter records updated at a specific datetime.

Sage 50 UK Connector for CData Sync

Prices

Query Prices within Sage UK 50 Accounts.

Table Specific Information

Select

The Prices table returns the product and services pricing information for a Sage 50 UK company dataset.

SELECT * FROM Prices WHERE Price < 10.00

Columns

Name Type Description
PriceUUID [KEY] String Price UUID
ProductCode String Price Reference
Price Decimal Price
IncludesTax Boolean Price Includes Tax
Currency String Price Currency
DecimalPlaces Decimal Price Decimal Places
CustomerSupplierFlag String Price Customer Supplier Flag
OCCurrency String PurchaseOrderDelivery Operating Company Currency
OCCurrencyExchangeRate Decimal PurchaseOrderDelivery Operating Company Currency Exchange Rate
OCCurrencyExchangeRateOperator String PurchaseOrderDelivery Operating Company Currency Exchange Rate Operator

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
Updated Datetime An input used internally to filter records updated at a specific datetime.

Sage 50 UK Connector for CData Sync

Projects

Query Projects within Sage UK 50 Accounts.

Table Specific Information

Select

The Projects table returns project information for a Sage 50 UK company dataset.

SELECT * FROM Projects

Columns

Name Type Description
ProjectUUID [KEY] String Project UUID
ProjectReference String Project Reference
TradingAccountReference String Project Reference2
Name String Project Name
Description String Project Description
Status String Project Status
StartDate Date Project Start Date
EndDate Date Project End Date
Currency String Project Currency
OperatingCompanyCurrency String Project OperatingCompany Currency
OperatingCompanyCurrencyExchangeRate Decimal Project OperatingCompany Currency Exchange Rate
OperatingCompanyCurrencyExchangeRateOperator String Project OperatingCompany Currency Exchange Rate Operator
CurrentCostBalance Decimal Project Current Cost Balance
LastCostTransactionDate Date Project Last Cost Transaction Date
CurrentRevenueBalance Decimal Project Current Revenue Balance
LastRevenueTransactionDate Date Project Last Revenue Transaction Date
CurrentCostBudget Decimal Project Current Cost Budget
CurrentRevenueBudget Decimal Project Current Revenue Budget
CurrentCommittedCostBalance Decimal Project Current Committed Cost Balance

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
Updated Datetime An input used internally to filter records updated at a specific datetime.

Sage 50 UK Connector for CData Sync

PurchaseOrderDeliveries

Query PurchaseOrderDeliveries within Sage UK 50 Accounts.

Table Specific Information

Select

The PurchaseOrderDeliveries table returns purchase order delivery information for a Sage 50 UK company dataset.

SELECT * FROM PurchaseOrderDeliveries

Columns

Name Type Description
PODeliveryUUID [KEY] String PurchaseOrderDelivery UUID
PurchaseOrderUUID String PurchaseOrderDelivery PurchaseOrder UUID
TradingAccountUUID String PurchaseOrderDelivery Trading Account UUID
GoodsReceivedNumber String PurchaseOrderDelivery Reference
SupplierReference String PurchaseOrderDelivery Supplier reference
CarrierReference String PurchaseOrderDelivery Carrier reference
Currency String PurchaseOrderDelivery Currency
OCCurrency String PurchaseOrderDelivery Operating Company Currency
OCCurrencyExchangeRate Decimal PurchaseOrderDelivery Operating Company Currency Exchange Rate
OCCurrencyExchangeRateOperator String PurchaseOrderDelivery Operating Company Currency Exchange Rate Operator
RequestedDeliveryDate Date PurchaseOrderDelivery Requested Delivery Date
ActualDeliveryDate Date PurchaseOrderDelivery Actual Delivery Date
LineCount Decimal PurchaseOrderDelivery Line Count
PostalAddressUUID String PurchaseOrderDelivery PostalAddress UUID
PostalAddressActive Boolean PurchaseOrderDelivery PostalAddress Active Flag
PostalAddressReference String PurchaseOrderDelivery PostalAddress Reference
PostalAddressName String PurchaseOrderDelivery PostalAddress Name
PostalAddressDescription String PurchaseOrderDelivery PostalAddress Description
PostalAddressAddress1 String PurchaseOrderDelivery PostalAddress Address 1
PostalAddressAddress2 String PurchaseOrderDelivery PostalAddress Address 2
PostalAddressAddress3 String PurchaseOrderDelivery PostalAddress Address 3
PostalAddressAddress4 String PurchaseOrderDelivery PostalAddress Address 4
PostalAddressTownCity String PurchaseOrderDelivery PostalAddress TownCity
PostalAddressCounty String PurchaseOrderDelivery PostalAddress County
PostalAddressStateRegion String PurchaseOrderDelivery PostalAddress StateRegion
PostalAddressZipPostCode String PurchaseOrderDelivery PostalAddress ZipPost Code
PostalAddressCountry String PurchaseOrderDelivery PostalAddress Country
PostalAddressPrimacyIndicator Boolean PurchaseOrderDelivery PostalAddress Primacy Indicator
PostalAddressType String PurchaseOrderDelivery PostalAddress Type. Sample values: Billing, Shipping.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
Updated Datetime An input used internally to filter records updated at a specific datetime.

Sage 50 UK Connector for CData Sync

PurchaseOrderDeliveryLineItems

Query PurchaseOrderDeliveryLineItems within Sage UK 50 Accounts.

Table Specific Information

Select

The PurchaseOrderDeliveryLineItems table returns purchase order delivery line item information for a Sage 50 UK company dataset.

SELECT * FROM PurchaseOrderDeliveryLineItems WHERE GoodsReceivedNumber = '123'

Columns

Name Type Description
PODeliveryLineItemUUID [KEY] String PurchaseOrderDeliveryLine UUID
CommodityUUID String PurchaseOrderDeliveryLine Commodity UUID
CommodityProductCode String PurchaseOrderDeliveryLine Commodity Product Code
CommodityName String PurchaseOrderDeliveryLine Commodity Name
GoodsReceivedNumber String PurchaseOrderDeliveryLine Reference
Reference2 String PurchaseOrderDeliveryLine Reference2
LineNumber Decimal PurchaseOrderDeliveryLine Number
Text String PurchaseOrderDeliveryLine Text
RequestedQuantity Decimal PurchaseOrderDeliveryLine Requested Quantity
DeliveredQuantity Decimal PurchaseOrderDeliveryLine Delivered Quantity
UnitDescription String PurchaseOrderLine UnitOfMeasure Description

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
Updated Datetime An input used internally to filter records updated at a specific datetime.

Sage 50 UK Connector for CData Sync

PurchaseOrderLineItems

Query PurchaseOrderLines within Sage UK 50 Accounts.

Table Specific Information

Select

The PurchaseOrderLineItems table returns purchase order line item information for a Sage 50 UK company dataset.

SELECT * FROM PurchaseOrderLineItems WHERE PurchaseOrderNumber = 'PO123'

Columns

Name Type Description
PurchaseOrderLineItemUUID [KEY] String PurchaseOrderLine UUID
CommodityUUID String PurchaseOrderLine Commodity UUID
CommodityProductCode String PurchaseOrderLine Commodity Product Code
CommodityName String PurchaseOrderLine Commodity Name
PurchaseOrderNumber String PurchaseOrderLine Reference
LineNumber Decimal PurchaseOrderLine Number
DueDate Date PurchaseOrderLine Due Date
Description String PurchaseOrderLine Text
Quantity Decimal PurchaseOrderLine Quantity
InitialPrice Decimal PurchaseOrderLine Initial Price
ActualPrice Decimal PurchaseOrderLine Actual Price
NetTotal Decimal PurchaseOrderLine Net Total
DiscountTotal Decimal PurchaseOrderLine Discount Total
TaxTotal Decimal PurchaseOrderLine Tax Total
GrossTotal Decimal PurchaseOrderLine Gross Total
UnitDescription String PurchaseOrderLine UnitOfMeasure Description

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
Updated Datetime An input used internally to filter records updated at a specific datetime.

Sage 50 UK Connector for CData Sync

Receipts

Query Receipts within Sage UK 50 Accounts.

Table Specific Information

Select

The Receipts table returns the receipt information for a Sage 50 UK company dataset.

SELECT * FROM Receipts

Columns

Name Type Description
ReceiptUUID [KEY] String Receipt UUID
TradingAccountUUID String Receipt Trading Account UUID
BankAccountUUID String Receipt BankAccount UUID
Type String Receipt Type
Reference String Receipt Reference
Reference2 String Receipt Reference2
Date Date Receipt Date
TradingAccountReference String Receipt TradingAccount reference
Currency String Receipt Currency
OCCurrency String Receipt OperatingCompany Currency
OCCurrencyExchangeRate Decimal Receipt OperatingCompany Currency Exchange Rate
OCCurrencyExchangeRateOperator String Receipt OperatingCompany Currency Exchange Rate Operator
OCCurrencyExchangeRateDate Date Receipt OperatingCompany Currency Exchange Rate Date
BACurrency String Receipt Bank Account Currency
BACurrencyExchangeRate Decimal Receipt Bank Account Currency Exchange Rate
BACurrencyExchangeRateOperator String Receipt Bank Account Currency Exchange Rate Operator
TaxTotal Decimal Receipt Tax Total
GrossTotal Decimal Receipt Gross Total
Description String Receipt Description
LineCount Decimal Receipt Line Count
User String Receipt User

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
Updated Datetime An input used internally to filter records updated at a specific datetime.

Sage 50 UK Connector for CData Sync

SalesCreditLineItems

Query SalesCreditLineItems within Sage UK 50 Accounts.

Table Specific Information

Select

The SalesCreditLineItems table returns sales credit line item information for a Sage 50 UK company dataset.

SELECT * FROM SalesCreditLineItems WHERE CreditNumber = 'CR123'

Columns

Name Type Description
SalesCreditLineItemsUUID [KEY] String SalesCreditLine UUID
CommodityUUID String SalesCreditLine Commodity UUID
CommodityProductCode String SalesCreditLine Commodity Product Code
CommodityName String SalesCreditLine Commodity Name
CreditNumber String SalesCredit Reference
Reference2 String SalesCreditLine Reference2
Type String SalesCreditLine Type
Number Decimal SalesCreditLine Number
Description String SalesCreditLine Text
DeliveryDate Date SalesCreditLine Delivery Date
Quantity Decimal SalesCreditLine Quantity
InitialPrice Decimal SalesCreditLine Initial Price
InvoiceLineDiscountAmount Decimal SalesCreditLine Invoice Line Discount Amount
InvoiceLineDiscountPercent Decimal SalesCreditLine Invoice Line Discount Percent
ActualPrice Decimal SalesCreditLine Actual Price
NetTotal Decimal SalesCreditLine Net Total
DiscountTotal Decimal SalesCreditLine Discount Total
TaxTotal Decimal SalesCreditLine Tax Total
GrossTotal Decimal SalesCreditLine Gross Total
UnitDescription String SalesCreditLine UnitOfMeasure Description

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
Updated Datetime An input used internally to filter records updated at a specific datetime.

Sage 50 UK Connector for CData Sync

SalesInvoiceLineItems

Query SalesInvoiceLineItems within Sage UK 50 Accounts.

Table Specific Information

Select

The SalesInvoiceLineItems table returns sales invoice line item information for a Sage 50 UK company dataset.

SELECT * FROM SalesInvoiceLineItems WHERE InvoiceNumber = 'INV123'

Columns

Name Type Description
SalesInvoiceLineItemUUID [KEY] String SalesInvoiceLine UUID
CommodityUUID String SalesInvoiceLine Commodity UUID
CommodityProductCode String SalesInvoiceLine Commodity Product Code
CommodityName String SalesInvoiceLine Commodity Name
InvoiceNumber String SalesInvoice Reference
Reference2 String SalesInvoice Reference2
Type String SalesInvoiceLine Type
LineNumber Integer SalesInvoiceLine Number
Text String SalesInvoiceLine Text
DeliveryDate Date SalesInvoiceLine Delivery Date
Quantity Decimal SalesInvoiceLine Quantity
InitialPrice Decimal SalesInvoiceLine Initial Price
InvoiceLineDiscountAmount Decimal SalesInvoiceLine Invoice Line Discount Amount
InvoiceLineDiscountPercent Decimal SalesInvoiceLine Invoice Line Discount Percent
ActualPrice Decimal SalesInvoiceLine Actual Price
NetTotal Decimal SalesInvoiceLine Net Total
ChargesTotal Decimal SalesInvoiceLine Charges Total
DiscountTotal Decimal SalesInvoiceLine Discount Total
TaxTotal Decimal SalesInvoiceLine Tax Total
GrossTotal Decimal SalesInvoiceLine Gross Total
UnitDescription String SalesInvoiceLine UnitOfMeasure Description
TaxCodeUUID String SalesOrderLine Tax Code UUID
TaxCodeReference String SalesOrderLine Tax Code
TaxCodeValue Decimal SalesOrderLine Tax Code Value
TaxCodeDescription String SalesOrderLine Tax Code Description
TaxCodeType String SalesOrderLine Tax Code Type

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
Updated Datetime An input used internally to filter records updated at a specific datetime.

Sage 50 UK Connector for CData Sync

SalesOrderDeliveries

Query SalesOrderDeliveries within Sage UK 50 Accounts.

Table Specific Information

Select

The SalesOrderDeliveries table returns sales order delivery information for a Sage 50 UK company dataset.

SELECT * FROM SalesOrderDeliveries

Columns

Name Type Description
SODeliveryUUID [KEY] String SalesOrderDelivery UUID
SalesOrderUUID String SalesOrderDelivery SalesOrder UUID
TradingAccountUUID String SalesOrderDelivery Trading Account UUID
SalesOrderNumber String SalesOrderDelivery Reference
TradingAccountReference String SalesOrderDelivery Reference2
CustomerReference String SalesOrderDelivery Customer reference
CarrierReference String SalesOrderDelivery Carrier reference
Currency String SalesOrderDelivery Currency
OCCurrency String SalesOrderDelivery Operating Company Currency
CustomerCurrencyExchangeRate Decimal SalesOrderDelivery Customer Trading Account Currency Exchange Rate
CustomerCurrencyExchangeRateOperator String SalesOrderDelivery Customer Trading Account Currency Exchange Rate Operator
RequestedDeliveryDate Date SalesOrderDelivery Requested Delivery Date
ActualDeliveryDate Date SalesOrderDelivery Actual Delivery Date
LineCount Decimal SalesOrderDelivery Line Count
PostalAddressUUID String SalesOrderDelivery PostalAddress UUID
PostalAddressActive Boolean SalesOrderDelivery PostalAddress Active Flag
PostalAddressReference String SalesOrderDelivery PostalAddress Reference
PostalAddressName String SalesOrderDelivery PostalAddress Name
PostalAddressDescription String SalesOrderDelivery PostalAddress Description
PostalAddressAddress1 String SalesOrderDelivery PostalAddress Address 1
PostalAddressAddress2 String SalesOrderDelivery PostalAddress Address 2
PostalAddressAddress3 String SalesOrderDelivery PostalAddress Address 3
PostalAddressAddress4 String SalesOrderDelivery PostalAddress Address 4
PostalAddressTownCity String SalesOrderDelivery PostalAddress TownCity
PostalAddressCounty String SalesOrderDelivery PostalAddress County
PostalAddressStateRegion String SalesOrderDelivery PostalAddress StateRegion
PostalAddressZipPostCode String SalesOrderDelivery PostalAddress ZipPost Code
PostalAddressCountry String SalesOrderDelivery PostalAddress Country
PostalAddressPrimacyIndicator Boolean SalesOrderDelivery PostalAddress Primacy Indicator
PostalAddressType String SalesOrderDelivery PostalAddress Type. Sample values: Billing, Shipping.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
Updated Datetime An input used internally to filter records updated at a specific datetime.

Sage 50 UK Connector for CData Sync

SalesOrderDeliveryLineItems

Query SalesOrderDeliveryLineItems within Sage UK 50 Accounts.

Table Specific Information

Select

The SalesOrderDeliveryLineItems table returns sales order delivery line item information for a Sage 50 UK company dataset.

SELECT * FROM SalesOrderDeliveryLineItems WHERE GoodsDespatchedNumber = '987'

Columns

Name Type Description
SODeliveryLineItemUUID [KEY] String SalesOrderDeliveryLine UUID
CommodityUUID String SalesOrderDeliveryLine Commodity UUID
CommodityProductCode String SalesOrderDeliveryLine Commodity Product Code
CommodityName String SalesOrderDeliveryLine Commodity Name
SalesOrderNumber String SalesOrderDeliveryLine Sales Order Number
GoodsDespatchedNumber String SalesOrderDeliveryLine Reference
Reference2 String SalesOrderDeliveryLine Reference2
LineNumber Decimal SalesOrderDeliveryLine Number
Text String SalesOrderDeliveryLine Text
RequestedDeliveryDate Date SalesOrderDeliveryLine Requested Delivery Date
ActualDeliveryDate Date SalesOrderDeliveryLine Actual Delivery Date
RequestedQuantity Decimal SalesOrderDeliveryLine Requested Quantity
DeliveredQuantity Decimal SalesOrderDeliveryLine Delivered Quantity
UnitDescription String SalesOrderDeliveryLine UnitOfMeasure Description

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
Updated Datetime An input used internally to filter records updated at a specific datetime.

Sage 50 UK Connector for CData Sync

SalesOrderLineItems

Query SalesOrderLineItems within Sage UK 50 Accounts.

Table Specific Information

Select

The SalesOrderLineItems table returns sales order line item information for a Sage 50 UK company dataset.

SELECT * FROM SalesOrderLineItems WHERE SalesOrderNumber = 'SO123'

Columns

Name Type Description
SalesOrderLineItemUUID [KEY] String SalesOrderLine UUID
CommodityUUID String SalesOrderLine Commodity UUID
CommodityProductCode String SalesOrderLine Commodity Product Code
CommodityName String SalesOrderLine Commodity Name
SalesOrderNumber String SalesOrderLine Reference
Reference2 String SalesOrderLine Reference2
LineNumber Decimal SalesOrderLine Number
Type String SalesOrderLine Type
Description String SalesOrderLine Text
DueDate Date SalesOrderLine Due Date
CarrierReference String SalesOrderLine Carrier reference
Quantity Decimal SalesOrderLine Quantity
InitialPrice Decimal SalesOrderLine Initial Price
OrderLineDiscountAmount Decimal SalesOrderLine Order Line Discount Amount
OrderLineDiscountPercent Decimal SalesOrderLine Order Line Discount Perecent
ActualPrice Decimal SalesOrderLine Actual Price
NetTotal Decimal SalesOrderLine Net Total
DiscountTotal Decimal SalesOrderLine Discount Total
TaxTotal Decimal SalesOrderLine Tax Total
GrossTotal Decimal SalesOrderLine Gross Total
UnitDescription String SalesOrderLine UnitOfMeasure Description
TaxCodeUUID String SalesOrderLine Tax Code UUID
TaxCodeReference String SalesOrderLine Tax Code
TaxCodeValue Decimal SalesOrderLine Tax Code Value
TaxCodeDescription String SalesOrderLine Tax Code Description
TaxCodeType String SalesOrderLine Tax Code Type

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
Updated Datetime An input used internally to filter records updated at a specific datetime.

Sage 50 UK Connector for CData Sync

TaxCodes

Query Tax Codes within Sage UK 50 Accounts.

Columns

Name Type Description
TaxCodeUUID [KEY] String Tax Code UUID
TaxCode String Tax Code Reference
Description String Tax Code Description
Type String Tax Code Type
Value Decimal Tax Code Value

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
Updated Datetime An input used internally to filter records updated at a specific datetime.

Sage 50 UK Connector for CData Sync

TradingActivities

Query TradingActivities within Sage UK 50 Accounts.

Table Specific Information

Select

The TradingActivities table returns the trading activity information for a Sage 50 UK company dataset.

SELECT * FROM TradingActivities

Columns

Name Type Description
TradingActivityUUID [KEY] String TradingActivity UUID
ApplicationID String TradingActivity Application ID
Deleted Boolean TradingActivity Deleted
Label String TradingActivity Label
Reference String TradingActivity Reference
TransactionType String TradingActivity TransactionType
Date Date TradingActivity Date
Details String TradingActivity Details
AmountNet Decimal TradingActivity NetAmount
AmountTax Decimal TradingActivity TaxAmount
AmountGross Decimal TradingActivity GrossAmount
Currency String TradingActivity Currency
AmountPaid Decimal TradingActivity PaidAcmount
TradingAccountReference String TradingActivity AccountReference
DueDate Date TradingActivity Due Date
HeaderNumber String TradingActivity Header Number

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
Updated Datetime An input used internally to filter records updated at a specific datetime.

Sage 50 UK Connector for CData Sync

Connection String Options

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication


PropertyDescription
AuthSchemeThe scheme used for authentication. Accepted entries are Basic, Digest, or None.
URLURL to the Sage 50 UK SData service. For example, http://MySite:5493/sdata/accounts50/GCRM/MyDatasetId/.
UserSpecifies the user ID of the authenticating Sage 50 UK user account.
PasswordSpecifies the password of the authenticating user account.

SSL


PropertyDescription
SSLServerCertSpecifies the certificate to be accepted from the server when connecting using TLS/SSL.

Firewall


PropertyDescription
FirewallTypeSpecifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServerIdentifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPortSpecifies the TCP port to be used for a proxy-based firewall.
FirewallUserIdentifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPasswordSpecifies the password of the user account authenticating to a proxy-based firewall.

Proxy


PropertyDescription
ProxyAutoDetectSpecifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServerThe hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPortThe TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthSchemeSpecifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUserThe username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPasswordThe password associated with the user specified in the ProxyUser connection property.
ProxySSLTypeThe SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptionsA semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Logging


PropertyDescription
LogModulesSpecifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Schema


PropertyDescription
LocationSpecifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemasOptional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
TablesOptional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
ViewsOptional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Miscellaneous


PropertyDescription
MaxRowsSpecifies the maximum rows returned for queries without aggregation or GROUP BY.
OtherSpecifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
PagesizeSpecifies the maximum number of results to return from Sage 50 UK, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UserDefinedViewsSpecifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.
Sage 50 UK Connector for CData Sync

Authentication

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.


PropertyDescription
AuthSchemeThe scheme used for authentication. Accepted entries are Basic, Digest, or None.
URLURL to the Sage 50 UK SData service. For example, http://MySite:5493/sdata/accounts50/GCRM/MyDatasetId/.
UserSpecifies the user ID of the authenticating Sage 50 UK user account.
PasswordSpecifies the password of the authenticating user account.
Sage 50 UK Connector for CData Sync

AuthScheme

The scheme used for authentication. Accepted entries are Basic, Digest, or None.

Remarks

Together with Password and User, this field is used to authenticate against the Sage 50 UK Accounts service. Basic is the default option.

  • Basic: Set this to use HTTP Basic authentication.
  • Digest: Set this to use HTTP Digest authentication.

Sage 50 UK Connector for CData Sync

URL

URL to the Sage 50 UK SData service. For example, http://MySite:5493/sdata/accounts50/GCRM/MyDatasetId/.

Remarks

URL to the Sage 50 UK SData service. For example, http://MySite:5493/sdata/accounts50/GCRM/MyDatasetId/.

The URL can be obtained directly from your Sage 50 UK Accounts software by navigating to Tools > Internet Options > SData Settings > Details (Next to Sage 50 UK Accounts). The address can then be copied for the company dataset desired.

Sage 50 UK Connector for CData Sync

User

Specifies the user ID of the authenticating Sage 50 UK user account.

Remarks

The authenticating server requires both User and Password to validate the user's identity.

Sage 50 UK Connector for CData Sync

Password

Specifies the password of the authenticating user account.

Remarks

The authenticating server requires both User and Password to validate the user's identity.

Sage 50 UK Connector for CData Sync

SSL

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.


PropertyDescription
SSLServerCertSpecifies the certificate to be accepted from the server when connecting using TLS/SSL.
Sage 50 UK Connector for CData Sync

SSLServerCert

Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

Description Example
A full PEM Certificate (example shortened for brevity) -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate C:\cert.cer
The public key (example shortened for brevity) -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space or colon separated) ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space or colon separated) 34a929226ae0819f2ec14b4a3d904f801cbb150d

If not specified, any certificate trusted by the machine is accepted.

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

Sage 50 UK Connector for CData Sync

Firewall

This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.


PropertyDescription
FirewallTypeSpecifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServerIdentifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPortSpecifies the TCP port to be used for a proxy-based firewall.
FirewallUserIdentifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPasswordSpecifies the password of the user account authenticating to a proxy-based firewall.
Sage 50 UK Connector for CData Sync

FirewallType

Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Note: By default, the Sync App connects to the system proxy. To disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

The following table provides port number information for each of the supported protocols.

Protocol Default Port Description
TUNNEL 80 The port where the Sync App opens a connection to Sage 50 UK. Traffic flows back and forth via the proxy at this location.
SOCKS4 1080 The port where the Sync App opens a connection to Sage 50 UK. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted.
SOCKS5 1080 The port where the Sync App sends data to Sage 50 UK. If the SOCKS 5 proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

Sage 50 UK Connector for CData Sync

FirewallServer

Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Sage 50 UK Connector for CData Sync

FirewallPort

Specifies the TCP port to be used for a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Sage 50 UK Connector for CData Sync

FirewallUser

Identifies the user ID of the account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Sage 50 UK Connector for CData Sync

FirewallPassword

Specifies the password of the user account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Sage 50 UK Connector for CData Sync

Proxy

This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.


PropertyDescription
ProxyAutoDetectSpecifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServerThe hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPortThe TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthSchemeSpecifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUserThe username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPasswordThe password associated with the user specified in the ProxyUser connection property.
ProxySSLTypeThe SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptionsA semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.
Sage 50 UK Connector for CData Sync

ProxyAutoDetect

Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.

Remarks

When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).

This connection property takes precedence over other proxy settings. Set to False if you want to manually configure the Sync App to connect to a specific proxy server.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

Sage 50 UK Connector for CData Sync

ProxyServer

The hostname or IP address of the proxy server that you want to route HTTP traffic through.

Remarks

The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.

Sage 50 UK Connector for CData Sync

ProxyPort

The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.

Remarks

The Sync App only routes HTTP traffic through the proxy server port specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.

For other proxy types, see FirewallType.

Sage 50 UK Connector for CData Sync

ProxyAuthScheme

Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.

Remarks

The authentication type can be one of the following:

  • BASIC: The Sync App performs HTTP BASIC authentication.
  • DIGEST: The Sync App performs HTTP DIGEST authentication.
  • NTLM: The Sync App retrieves an NTLM token.
  • NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
  • NONE: Set this when the ProxyServer does not require authentication.

For all values other than "NONE", you must also set the ProxyUser and ProxyPassword connection properties.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

Sage 50 UK Connector for CData Sync

ProxyUser

The username of a user account registered with the proxy server specified in the ProxyServer connection property.

Remarks

The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:

ProxyAuthScheme Value Value to set for ProxyUser
BASIC The user name of a user registered with the proxy server.
DIGEST The user name of a user registered with the proxy server.
NEGOTIATE The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user.
NTLM The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user.
NONE Do not set the ProxyPassword connection property.

The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the username specified in your system proxy settings.

Sage 50 UK Connector for CData Sync

ProxyPassword

The password associated with the user specified in the ProxyUser connection property.

Remarks

The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:

ProxyAuthScheme Value Value to set for ProxyPassword
BASIC The password associated with the proxy server user specified in ProxyUser.
DIGEST The password associated with the proxy server user specified in ProxyUser.
NEGOTIATE The password associated with the Windows user account specified in ProxyUser.
NTLM The password associated with the Windows user account specified in ProxyUser.
NONE Do not set the ProxyPassword connection property.

For SOCKS 5 authentication or tunneling, see FirewallType.

The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the password specified in your system proxy settings.

Sage 50 UK Connector for CData Sync

ProxySSLType

The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.

Remarks

This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :

AUTODefault setting. If ProxyServer is set to an HTTPS URL, the Sync App uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option.
ALWAYSThe connection is always SSL enabled.
NEVERThe connection is not SSL enabled.
TUNNELThe connection is made through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

Sage 50 UK Connector for CData Sync

ProxyExceptions

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that the Sync App uses the system proxy settings by default, without further configuration needed. If you want to explicitly configure proxy exceptions for this connection, set ProxyAutoDetect to False.

Sage 50 UK Connector for CData Sync

Logging

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.


PropertyDescription
LogModulesSpecifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.
Sage 50 UK Connector for CData Sync

LogModules

Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Remarks

This property lets you customize the log file content by specifying the logging modules to include. Logging modules categorize logged information into distinct areas, such as query execution, metadata, or SSL communication. Each module is represented by a four-character code, with some requiring a trailing space for three-letter names.

For example, EXEC logs query execution, and INFO logs general provider messages. To include multiple modules, separate their names with semicolons as follows: INFO;EXEC;SSL.

The Verbosity connection property takes precedence over the module-based filtering specified by this property. Only log entries that meet the verbosity level and belong to the specified modules are logged. Leave this property blank to include all available modules in the log file.

For a complete list of available modules and detailed guidance on configuring logging, refer to the Advanced Logging section in Logging.

Sage 50 UK Connector for CData Sync

Schema

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.


PropertyDescription
LocationSpecifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemasOptional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
TablesOptional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
ViewsOptional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
Sage 50 UK Connector for CData Sync

Location

Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.

Remarks

The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is %APPDATA%\\CData\\Sage50UK Data Provider\\Schema, where %APPDATA% is set to the user's configuration directory:

Platform %APPDATA%
Windows The value of the APPDATA environment variable
Linux ~/.config

Sage 50 UK Connector for CData Sync

BrowsableSchemas

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

Sage 50 UK Connector for CData Sync

Tables

Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .

Remarks

Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.

If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.

Sage 50 UK Connector for CData Sync

Views

Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Remarks

Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.

If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.

Sage 50 UK Connector for CData Sync

Miscellaneous

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.


PropertyDescription
MaxRowsSpecifies the maximum rows returned for queries without aggregation or GROUP BY.
OtherSpecifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
PagesizeSpecifies the maximum number of results to return from Sage 50 UK, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UserDefinedViewsSpecifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.
Sage 50 UK Connector for CData Sync

MaxRows

Specifies the maximum rows returned for queries without aggregation or GROUP BY.

Remarks

This property sets an upper limit on the number of rows the Sync App returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.

When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

Sage 50 UK Connector for CData Sync

Other

Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.

Remarks

This property allows advanced users to configure hidden properties for specialized scenarios. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. Multiple properties can be defined in a semicolon-separated list.

Note: It is strongly recommended to set these properties only when advised by the support team to address specific scenarios or issues.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

DefaultColumnSizeSets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMTDetermines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filenameRecords the underlying socket data transfer to the specified file.

Sage 50 UK Connector for CData Sync

Pagesize

Specifies the maximum number of results to return from Sage 50 UK, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.

Remarks

You may want to adjust the default pagesize to optimize results for a particular object or service endpoint you are querying. Be aware that increasing the page size may improve performance, but it could also result in higher memory consumption per page.

Sage 50 UK Connector for CData Sync

PseudoColumns

Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.

Remarks

This property allows you to define which pseudocolumns the Sync App exposes as table columns.

To specify individual pseudocolumns, use the following format: "Table1=Column1;Table1=Column2;Table2=Column3"

To include all pseudocolumns for all tables use: "*=*"

Sage 50 UK Connector for CData Sync

Timeout

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.

Remarks

This property controls the maximum time, in seconds, that the Sync App waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the Sync App cancels the operation and throws an exception.

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.

Setting this property to 0 disables the timeout, allowing operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

Sage 50 UK Connector for CData Sync

UserDefinedViews

Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

Remarks

This property allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the SQL query for the view. For example:


{
	"MyView": {
		"query": "SELECT * FROM TradingAccounts WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

You can define multiple views in a single file and specify the filepath using this property. For example: UserDefinedViews=C:\Path\To\UserDefinedViews.json. When you use this property, only the specified views are seen by the Sync App.

Refer to User Defined Views for more information.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 24.0.9175