CData Sync App は、Sage 50 UK データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。
Sage 50 UK コネクタはCData Sync アプリケーションから使用可能で、Sage 50 UK からデータを取得して、サポートされている任意の同期先に移動できます。
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.
必須プロパティについては、設定タブを参照してください。
通常必須ではない接続プロパティについては、高度な設定タブを参照してください。
Sync App は、Sage 50 UK のインストールに含まれるSData REST API 経由でSage 50 UK データに接続します。SData では、ローカルの企業データセットやネットワークドライブ上のデータセットにアクセスできます。
Sage SData Service を設定したのち、以下の手順で接続すると、URL プロパティに希望する企業データセットのアドレスが設定されます。アドレスを取得するには、以下を行います。
User プロパティとPassword プロパティに、有効なSage 50 UK ユーザー資格情報を設定する必要があります。これらの値は、Sage 50 UK ソフトウェアにログインするために使用される値と同じになります。SData サービスへのHTTP ダイジェストで認証するには、AuthScheme をDigest に設定します。それ以外の場合は、Basic AuthScheme が使用されます。
Note:接続先のデータセットが表示されない場合は、Sage 50 UK フォルダの場所の権限が正しくない可能性があります。ネットワークドライブ上のデータセットに接続する場合は、次のことを確認してください。
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.
Once you apply any changes, you can then establish a connection to your Sage 50 UK software.
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 高度な機能 for more information on configuring the Sync App for HTTPS.
The certificate has the following requirements:
You can then configure the SData service to use 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.
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:
<?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 Sync App の高度な機能を厳選して説明します。
Sync App はユーザー定義ビューの使用をサポートします。これは事前設定されたユーザー定義クエリによって内容が決定される仮想テーブルです。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。
SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。詳しくは、「接続文字列オプション」にあるSSLServerCert プロパティを参照してください。
Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。
詳しくは、クエリ処理 を参照してください。
デフォルトでは、Sync App はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。
別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。
HTTP プロキシへの認証には、以下のように設定します。
次のプロパティを設定します。
Sync App はSage 50 UK のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
| 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. |
Create, Update and Query Commodities (Products and Services) within Sage UK 50 Accounts.
The Commodities table allows you to select, insert, and update Commodities (Products and Services) within a Sage 50 UK company dataset.
The Commodities table returns the products and services for a Sage 50 UK company dataset.
SELECT * FROM Commodities WHERE ProductCode LIKE 'ABC%'
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)
Any field that is not read-only can be updated.
UPDATE Commodities SET Description = 'My New Description' WHERE CommodityUUID = '8c47b43a-7115-7419-9679-7c72586e67d1'
| 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 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. |
Create, Update, Delete, and Query Contacts within Sage UK 50 Accounts.
The Contacts table allows you to select, insert, update, and delete contacts within a Sage 50 UK company dataset.
The Contacts table returns the contacts contained within a Sage 50 UK company dataset.
SELECT * FROM Contacts WHERE TradingAccountReference = 'ABC123'
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]')
Any field that is not read-only can be updated. Requirements exist for some fields of a Contact record:
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'
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'
| 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 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. |
Create, Update, Delete, and Query PurchaseOrders within Sage UK 50 Accounts.
The PurchaseOrders table allows you to select, insert, update, and delete purchase orders within a Sage 50 UK company dataset.
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'
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>')
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'
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'
| 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 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. |
Query SalesCredits within Sage UK 50 Accounts.
The SalesCredits table allows you to select, insert, update, and delete sales credits within a Sage 50 UK company dataset.
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'
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>')
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'
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'
| 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 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. |
Query SalesInvoices within Sage UK 50 Accounts.
The SalesInvoices table allows you to select, insert, update, and delete sales invoices within a Sage 50 UK company dataset.
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'
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>')
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'
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'
| 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 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. |
Create, Update, Delete, and Query SalesOrders within Sage UK 50 Accounts.
The SalesOrders table allows you to select, insert, update, and delete sales orders within a Sage 50 UK company dataset.
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'
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>')
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'
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'
| 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 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. |
Create, Update, Delete, and Query TradingAccounts within Sage UK 50 Accounts.
The TradingAccounts table allows you to select, insert, and update trading accounts within a Sage 50 UK company dataset.
The TradingAccounts table returns the trading account information for a Sage 50 UK company dataset.
SELECT * FROM TradingAccounts
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')
Any field that is not read-only can be updated.
UPDATE TradingAccounts SET Analysis3 = 'International' WHERE TradingAccountUUID = '90c7afb4-ad34-41a2-b71d-ef49cc489872'
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.
| 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 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. |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
| 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. |
Query BankAccounts within Sage UK 50 Accounts.
The BankAccounts table returns the bank accounts for a Sage 50 UK company dataset.
SELECT * FROM BankAccounts
| 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 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. |
Query Financial Accounts within Sage UK 50 Accounts.
| 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 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. |
Query Interactions within Sage UK 50 Accounts.
The Interactions table returns the customer interaction information for a Sage 50 UK company dataset.
SELECT * FROM Interactions
| 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 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. |
Query Prices within Sage UK 50 Accounts.
The Prices table returns the product and services pricing information for a Sage 50 UK company dataset.
SELECT * FROM Prices WHERE Price < 10.00
| 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 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. |
Query Projects within Sage UK 50 Accounts.
The Projects table returns project information for a Sage 50 UK company dataset.
SELECT * FROM Projects
| 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 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. |
Query PurchaseOrderDeliveries within Sage UK 50 Accounts.
The PurchaseOrderDeliveries table returns purchase order delivery information for a Sage 50 UK company dataset.
SELECT * FROM PurchaseOrderDeliveries
| 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 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. |
Query PurchaseOrderDeliveryLineItems within Sage UK 50 Accounts.
The PurchaseOrderDeliveryLineItems table returns purchase order delivery line item information for a Sage 50 UK company dataset.
SELECT * FROM PurchaseOrderDeliveryLineItems WHERE GoodsReceivedNumber = '123'
| 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 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. |
Query PurchaseOrderLines within Sage UK 50 Accounts.
The PurchaseOrderLineItems table returns purchase order line item information for a Sage 50 UK company dataset.
SELECT * FROM PurchaseOrderLineItems WHERE PurchaseOrderNumber = 'PO123'
| 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 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. |
Query Receipts within Sage UK 50 Accounts.
The Receipts table returns the receipt information for a Sage 50 UK company dataset.
SELECT * FROM Receipts
| 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 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. |
Query SalesCreditLineItems within Sage UK 50 Accounts.
The SalesCreditLineItems table returns sales credit line item information for a Sage 50 UK company dataset.
SELECT * FROM SalesCreditLineItems WHERE CreditNumber = 'CR123'
| 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 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. |
Query SalesInvoiceLineItems within Sage UK 50 Accounts.
The SalesInvoiceLineItems table returns sales invoice line item information for a Sage 50 UK company dataset.
SELECT * FROM SalesInvoiceLineItems WHERE InvoiceNumber = 'INV123'
| 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 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. |
Query SalesOrderDeliveries within Sage UK 50 Accounts.
The SalesOrderDeliveries table returns sales order delivery information for a Sage 50 UK company dataset.
SELECT * FROM SalesOrderDeliveries
| 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 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. |
Query SalesOrderDeliveryLineItems within Sage UK 50 Accounts.
The SalesOrderDeliveryLineItems table returns sales order delivery line item information for a Sage 50 UK company dataset.
SELECT * FROM SalesOrderDeliveryLineItems WHERE GoodsDespatchedNumber = '987'
| 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 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. |
Query SalesOrderLineItems within Sage UK 50 Accounts.
The SalesOrderLineItems table returns sales order line item information for a Sage 50 UK company dataset.
SELECT * FROM SalesOrderLineItems WHERE SalesOrderNumber = 'SO123'
| 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 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. |
Query Tax Codes within Sage UK 50 Accounts.
| 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 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. |
Query TradingActivities within Sage UK 50 Accounts.
The TradingActivities table returns the trading activity information for a Sage 50 UK company dataset.
SELECT * FROM TradingActivities
| 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 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. |
| プロパティ | 説明 |
| AuthScheme | The scheme used for authentication. Accepted entries are Basic, Digest, or None. |
| URL | URL to the Sage 50 UK SData service. For example, http://MySite:5493/sdata/accounts50/GCRM/MyDatasetId/. |
| User | 認証するSage 50 UK ユーザーアカウントのユーザーID を指定します。 |
| Password | 認証するユーザーアカウントのパスワードを指定します。 |
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
| プロパティ | 説明 |
| FirewallType | provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。 |
| FirewallServer | ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。 |
| FirewallPort | プロキシベースのファイアウォールで使用するTCP ポートを指定します。 |
| FirewallUser | プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。 |
| FirewallPassword | プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。 |
| プロパティ | 説明 |
| ProxyAutoDetect | provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。 |
| ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。 |
| ProxyPort | クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー(ProxyServer 接続プロパティで設定)のTCP ポート。 |
| ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。 |
| ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。 |
| ProxyPassword | ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。 |
| ProxySSLType | ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。 |
| ProxyExceptions | ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
| プロパティ | 説明 |
| LogModules | ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。 |
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。 |
| Views | レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。 |
| プロパティ | 説明 |
| MaxRows | 集計やGROUP BY を使用しないクエリで返される最大行数を指定します。 |
| Other | 特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。 |
| Pagesize | Sage 50 UK から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。 |
| UserDefinedViews | カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
| プロパティ | 説明 |
| AuthScheme | The scheme used for authentication. Accepted entries are Basic, Digest, or None. |
| URL | URL to the Sage 50 UK SData service. For example, http://MySite:5493/sdata/accounts50/GCRM/MyDatasetId/. |
| User | 認証するSage 50 UK ユーザーアカウントのユーザーID を指定します。 |
| Password | 認証するユーザーアカウントのパスワードを指定します。 |
The scheme used for authentication. Accepted entries are Basic, Digest, or None.
Together with Password and User, this field is used to authenticate against the Sage 50 UK Accounts service. Basic is the default option.
URL to the Sage 50 UK SData service. For example, http://MySite:5493/sdata/accounts50/GCRM/MyDatasetId/.
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.
このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。
TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。
このプロパティは、次のフォームを取ります:
| 説明 | 例 |
| フルPEM 証明書(例では省略されています) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
| 証明書を保有するローカルファイルへのパス。 | C:\cert.cer |
| 公開鍵(例では省略されています) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
| MD5 Thumbprint (hex 値はスペースおよびコロン区切り) | ecadbdda5a1529c58a1e9e09828d70e4 |
| SHA1 Thumbprint (hex 値はスペースおよびコロン区切り) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。
すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。
このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。
| プロパティ | 説明 |
| FirewallType | provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。 |
| FirewallServer | ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。 |
| FirewallPort | プロキシベースのファイアウォールで使用するTCP ポートを指定します。 |
| FirewallUser | プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。 |
| FirewallPassword | プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。 |
provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
Note:デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し、次のプロキシタイプのいずれかに接続するには、ProxyAutoDetect をfalse に設定します。
次の表は、サポートされている各プロトコルのポート番号情報です。
| プロトコル | デフォルトポート | 説明 |
| TUNNEL | 80 | Sync App がSage 50 UK への接続を開くポート。トラフィックはこの場所のプロキシを経由して行き来します。 |
| SOCKS4 | 1080 | Sync App がSage 50 UK への接続を開くポート。SOCKS 4 は次にFirewallUser 値をプロキシに渡し、接続リクエストが許容されるかどうかを決定します。 |
| SOCKS5 | 1080 | Sync App がSage 50 UK にデータを送信するポート。SOCKS 5 プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。 |
HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。
ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールで使用するTCP ポートを指定します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。
| プロパティ | 説明 |
| ProxyAutoDetect | provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。 |
| ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。 |
| ProxyPort | クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー(ProxyServer 接続プロパティで設定)のTCP ポート。 |
| ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。 |
| ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。 |
| ProxyPassword | ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。 |
| ProxySSLType | ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。 |
| ProxyExceptions | ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
この接続プロパティをTrue に設定すると、Sync App は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします(プロキシサーバーの詳細を手動で入力する必要はありません)。
この接続プロパティは他のプロキシ設定より優先されます。特定のプロキシサーバーに接続するためにSync App を手動で構成する場合は、False に設定します。
HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。
HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合(デフォルト)、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーを介してHTTP トラフィックをルーティングします。
クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー(ProxyServer 接続プロパティで設定)のTCP ポート。
ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーポートを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合(デフォルト)、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーポートを介してHTTP トラフィックをルーティングします。
その他のプロキシタイプについては、FirewallType を参照してください。
ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
認証タイプは次のいずれかです。
"NONE" 以外のすべての値については、ProxyUser およびProxyPassword 接続プロパティも設定する必要があります。
SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。
ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。
ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。
ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。
| ProxyAuthScheme の値 | ProxyUser に設定する値 |
| BASIC | プロキシサーバーに登録されているユーザーのユーザー名。 |
| DIGEST | プロキシサーバーに登録されているユーザーのユーザー名。 |
| NEGOTIATE | プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。 |
| NTLM | プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。 |
| NONE | ProxyPassword 接続プロパティは設定しないでください。 |
Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このユーザー名を使用します。ProxyAutoDetect がTrue に設定されている場合(デフォルト)、Sync App は代わりにシステムのプロキシ設定で指定されているユーザー名を使用します。
ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。
ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。
ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。
| ProxyAuthScheme の値 | ProxyPassword に設定する値 |
| BASIC | ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。 |
| DIGEST | ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。 |
| NEGOTIATE | ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。 |
| NTLM | ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。 |
| NONE | ProxyPassword 接続プロパティは設定しないでください。 |
SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。
Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このパスワードを使用します。ProxyAutoDetect がTrue に設定されている場合(デフォルト)、Sync App は代わりにシステムのプロキシ設定で指定されているパスワードを使用します。
ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。
このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この接続プロパティには、以下の値を設定できます。
| AUTO | デフォルト設定。ProxyServer がHTTPS URL に設定されている場合、Sync App は、TUNNEL オプションを使用します。ProxyServer がHTTP URL に設定されている場合、コンポーネントはNEVER オプションを使用します。 |
| ALWAYS | 接続は、常にSSL 有効となります。 |
| NEVER | 接続は、SSL 有効になりません。 |
| TUNNEL | 接続はトンネリングプロキシ経由で行われます。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。 |
ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。
ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。
Sync App はデフォルトでシステムプロキシ設定を使用するため、それ以上の設定は必要ありません。この接続にプロキシ例外を明示的に設定する場合は、ProxyAutoDetect をFalse に設定します。
このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。
| プロパティ | 説明 |
| LogModules | ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。 |
ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。
このプロパティは、含めるログモジュールを指定することでログファイルの内容をカスタマイズすることができます。 ログモジュールは、クエリ実行、メタデータ、SSL 通信などの異なる領域にログ情報を分類します。 各モジュールは4文字のコードで表され、文字の名前の場合は末尾にスペースが必要なものもあります。
例えば、EXEC はクエリ実行をログに記録し、INFO は一般的なプロバイダーメッセージをログに記録します。 複数のモジュールを含めるには、次のように名前をセミコロンで区切ります:INFO;EXEC;SSL。
Verbosity 接続プロパティは、このプロパティで指定されたモジュールベースのフィルタリングよりも優先されます。 Verbosity レベルを満たし、指定されたモジュールに属するログエントリのみが記録されます。 利用可能なすべてのモジュールをログファイルに含めるには、このプロパティを空白のままにします。
利用可能なモジュールの完全なリストとログの設定に関する詳細な手引きについては、ログ の「高度なログの記録」セクションを参照してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。 |
| Views | レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。 |
テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
Location プロパティは、定義をカスタマイズしたり(例えば、カラム名を変更する、カラムを無視するなど)、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。
指定しない場合、デフォルトの場所は%APPDATA%\\CData\\Sage50UK Data Provider\\Schema となり、%APPDATA%はユーザーのコンフィギュレーションディレクトリに設定されます:
| プラットフォーム | %APPDATA% |
| Windows | APPDATA 環境変数の値 |
| Linux | ~/.config |
レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
データベースによっては、利用可能なすべてのテーブルをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にテーブルのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
利用可能なテーブルがたくさんあり、すでに作業したいテーブルが決まっている場合、このプロパティを使用して対象のテーブルのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。
Note:複数のスキーマまたはカタログを持つデータソースに接続する場合は、表示する各テーブルを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するテーブルが混同されることを防ぎます。
レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。
データベースによっては、利用可能なすべてのビューをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にビューのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
利用可能なビューがたくさんあり、すでに作業したいビューが決まっている場合、このプロパティを使用して対象のビューのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。
Note:複数のスキーマまたはカタログを持つデータソースに接続する場合は、確認する各ビューを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するビューが混同されることを防ぎます。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
| プロパティ | 説明 |
| MaxRows | 集計やGROUP BY を使用しないクエリで返される最大行数を指定します。 |
| Other | 特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。 |
| Pagesize | Sage 50 UK から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。 |
| UserDefinedViews | カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。 |
集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
このプロパティは、集計やGROUP BY 句を含まないクエリに対してSync App が返す行数の上限を設定します。 この制限により、クエリがデフォルトで過度に大きな結果セットを返さないようにします。
クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。 MaxRows が"-1" に設定されている場合、LIMIT 句が明示的にクエリに含まれていない限り、行の制限は行われません。
このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し過剰なリソース消費を防ぐのに役立ちます。
特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
このプロパティは、シニアユーザーが特定のシナリオに対して隠しプロパティを設定できるようにします。 これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。 複数のプロパティをセミコロン区切りのリストで定義できます。
Note: 特定のシナリオや問題に対処するためにサポートチームから助言があった場合にのみ、これらのプロパティを設定することを強く推奨します。
複数のプロパティをセミコロン区切りリストで指定します。
| DefaultColumnSize | データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。 |
| ConvertDateTimeToGMT | 日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。 |
| RecordToFile=filename | 基底のソケットデータ転送を指定のファイルに記録します。 |
Sage 50 UK から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。
クエリする特定のオブジェクトやサービスエンドポイントの結果を最適化するために、デフォルトのページサイズを調整したい場合があります。 ページサイズを大きくするとパフォーマンスが向上するかもしれませんが、ページあたりのメモリ消費量が増える可能性もあることに注意してください。
テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
このプロパティを使用すると、Sync App がテーブルカラムとして公開する擬似カラムを定義できます。
個々の擬似カラムを指定するには、以下の形式を使用します。"Table1=Column1;Table1=Column2;Table2=Column3"
すべてのテーブルのすべての擬似カラムを含めるには、次のようにします:"*=*"
provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
このプロパティは、Sync App が操作をキャンセルする前に操作の完了を待機する最大時間を秒単位で制御します。 操作の完了前にタイムアウト時間が経過すると、Sync App は操作をキャンセルして例外をスローします。
タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。
このプロパティを0に設定するとタイムアウトが無効になり、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。 このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。
カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。
このプロパティを使用すると、UserDefinedViews.json というJSON 形式の構成ファイルを通じてカスタムビューを定義および管理できます。 これらのビューはSync App によって自動的に認識され、標準のデータベースビューのようにカスタムSQL クエリを実行できるようになります。 JSON ファイルは、各ビューをルート要素として定義し、その子要素として"query" を持ちます。この"query" にはビューのSQL クエリが含まれています。次に例を示します。
{
"MyView": {
"query": "SELECT * FROM TradingAccounts WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
このプロパティを使用して、1つのファイルに複数のビューを定義し、ファイルパスを指定できます。 例:UserDefinedViews=C:\Path\To\UserDefinedViews.json。 このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。
詳しくは、ユーザー定義ビュー を参照してください。