Sync App アプリケーションの接続 ページに移動し、接続の追加 パネルで対応するアイコンを選択して、Square への接続を作成します。Square アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからSquare コネクタをダウンロードおよびインストールします。

必須プロパティは［設定］タブにリストされています。［Advanced］タブには、通常は必要ない接続プロパティが表示されます。

Square への接続

LocationId プロパティを設定して、デフォルトのビジネスロケーションを指定します。あるいは、クエリの検索条件にLocationId を設定します。

Id を取得するには、認証後にLocations テーブルをクエリします。

Square への認証

パーソナルアクセストークンを使用してSquare への認証を行うか、OAuth 標準を使用できます。パーソナルトークンを使用して、自分のデータにアクセスしたりサンドボックスを介してテストしたりします。OAuth を使って、他のユーザーが自身のデータにアクセスできるようにします。

パーソナルアクセストークン

OAuthAccessToken 接続プロパティをパーソナルトークンに設定します。これは、以下の手順に従って取得できます。

1. Developer Dashboard に移動して作成ガイドのOAuth アプリの作成 を参照してください。
2. アプリが作成されると、トークンは［Credentials］タブにリストされます。

Square サンドボックス

Connect API のバージョン2では、サンドボックス環境でのテストが可能です。サンドボックスで作成されたトランザクションは、カードネットワークには送信されず、カードに課金されることはありません。

サンドボックスに接続するには、OAuthAccessToken をサンドボックスのアクセストークンに設定します。これは、標準のパーソナルアクセストークンと一緒に使用できます。

1. Developer Dashboard に移動して作成ガイドのOAuth アプリの作成 を参照してください。
2. アプリが作成されると、サンドボックストークンは［Credentials］タブにリストされます。

OAuthAccessToken に加えて、Schema を"V2"、UseSandbox を"True" に設定します。

OAuth

OAuth では、認証ユーザーがブラウザを使用してSquare と対話する必要があります。認証についてはSquare への接続 を参照してください。 このOAuth フローでは、ユーザー資格情報の接続プロパティを設定せずに認証できます。［接続］をクリックするとSync App がSquare OAuth エンドポイントを開きます。ログインして、Sync App にアクセス許可を与えます。Sync App がOAuth プロセスを完了します。

The Sync App enables the granular control useful in more complex integrations or network topologies; for example, connecting from behind a firewall. In this section you will find more advanced Sync App configurations, as well as steps to troubleshoot connection errors.

Create an App

You can follow the procedure below to register a custom OAuth app and obtain the OAuth client credentials, the Application Id and Application Secret. You will need to sign up for a Square account before starting this procedure.

1. Navigate to the Developer Dashboard and create an app.
2. Enter a name to be displayed to users when they log in to grant permissions to your app.

3. Click Create App. Set CallbackURL to be equal to the value of the Redirect URL.

Set OAuthClientId to be equal with the Application Id on the Credentials page and set OAuthClientSecret to be equal to the Application Secret on the OAuth tab.

このセクションでは、Square Sync App の高度な機能を厳選して説明します。

ユーザー定義ビュー

Sync App を使用すると、事前設定されたクエリによって内容が決定されるユーザー定義ビューと呼ばれる仮想テーブルを定義できます。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。

SSL の設定

SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。 詳しくは、接続文字列オプションにあるSSLServerCert プロパティを参照してください。

ファイアウォールとプロキシ

Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。

クエリ処理

Sync App は、Square にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。

詳しくはクエリ処理 を参照してください。

ログ

CData ログを調整するために使用可能な設定の概要については、ログ を参照してください。基本的なロギングでは、 次の2つの接続プロパティを設定するだけです。LogModules 接続プロパティを使用してログに記録する情報のサブセットを選択できる、 より洗練されたロギングをサポートする多数の機能があります。

SSL 設定のカスタマイズ

デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。

別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。

Firewall またはProxy 経由の接続

HTTP プロキシ

Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。

さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。

その他のプロキシ

次のプロパティを設定します。

• プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
• 接続をトンネルするには、FirewallType をTUNNEL に設定します。
• 認証するには、FirewallUser とFirewallPassword を設定します。
• SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

The CData Sync App models the Square v1 and Square v2 APIs as relational tables, views, and stored procedures. These are defined in schema files, which are simple, text-based configuration files.

The available entities are documented in Square v1 データモデル and Square v2 Data Model.

Using Query Processing

The Sync App offloads as much of the SELECT statement processing as possible to the Square APIs and then processes the rest of the query within the Sync App. The following sections document API limitations, requirements, or particularities. See SupportEnhancedSQL for more information on how the Sync App circumvents API limitations with in-memory client-side processing.

Querying Several Business Locations

You can query tables/views from different business locations by specifying multiple LocationIds in the "IN" operator. Note however that for tables/views like Customers, Employees, Orders, and OrderItems, this is not possible.

SELECT * FROM Transactions WHERE LocationId IN ('CBASEDbVhLxAJeGrBRLi-BxZ3XcgAQ','CBASEGJDarn_hucmacLdA_iGNGwgAQ','CBASEFsuPlSmrLHXu9a5Lmlv4D4gAQ')

This section documents the ビュー, and ストアドプロシージャ available to connect to the Square v1 APIs.

ビューは、カラムと疑似カラムで構成されます。ビューは、データを示すという点でテーブルに似ていますが、ビューでは更新はサポートされません。通常、ビューとして表されるエンティティは、読み取り専用のエンティティです。多くの場合、これらのデータはストアドプロシージャを使用することで更新できます（その機能がデータソースに適用できる場合）。

ビューに対しては、通常のテーブルと同じようにクエリを実行でき、このときに返されるデータも同様です。

ビューとして公開されるクエリなどの動的ビューや、project_team ワークアイテムの特定の組み合わせを検索するためのビューがサポートされています。

Square Connector for CData Sync ビュー

Name	Description
Settlements	Query summary information for deposits and withdrawals initiated by Square to the Bank Account of a Merchant.

Query summary information for deposits and withdrawals initiated by Square to the Bank Account of a Merchant.

Table Specific Information

Select

Note: LocationId is needed to execute the query.

The Sync App uses the Square API to process search criteria that refer to the Id column, while other filters are processed client side within the Sync App.

Retrieve all Settlements for a given LocationId:

SELECT * FROM Settlements WHERE LocationId = '92BYHNBR6W77E'

Retrieve a specific Settlement by providing a given LocationId and a valid Id:

            SELECT * FROM Settlements WHERE Id = 'abc123' AND LocationId = '92BYHNBR6W77E'
        

Columns

Name	Type	Description
Id [KEY]	String	The Id of the settlement.
LocationId	String	The Id of the location.
Status	String	The status of the settlement. 使用できる値は次のとおりです。SENT, FAILED
BankAccountId	String	The Id of the bank account.
InitiatedAt	Datetime	The date and time a settlement was initiated.
Amount	Integer	The amount of money involved in the settlement.
CurrencyCode	String	The currency code of the money involved in the settlement.
EntriesAggregate	String	The entries included in this settlement.

This section documents the テーブル, ビュー, and ストアドプロシージャ available to connect to the Square v2 aPIs.

Sync App はSquare のデータを、標準のSQL ステートメントを使用してクエリできるテーブルのリストにモデル化します。

一般的には、Square テーブルのクエリは、リレーショナルデータベースのテーブルのクエリと同じです。時には特別なケースもあります。例えば、テーブルの特定のカラムデータを取得するために特定のカラムをWHERE 句に含める必要がある場合などです。これは通常、特定のカラムを取得するために行ごとに個別のリクエストを行う必要がある場合に必要です。これらの特別な状況は、以下にリンクされているテーブルページの上部に明確に文書化されています。

Square Connector for CData Sync テーブル

Name	Description
Cards	Create, update, delete, and query the available Cards in Square.
CatalogCategories	Query the available catalog categories.
CatalogDiscounts	Query the available catalog discounts.
CatalogImages	Query the available catalog images.
CatalogItems	Query the available items.
CatalogItemVariations	Query the available item variations.
CatalogModifierLists	Query the available catalog modifier lists.
CatalogModifiers	Query the available catalog modifiers.
CatalogTaxes	Query the available catalog taxes.
CustomerCards	Create, update, delete, and query the available CustomerCards in Square.
Customers	Create, update, delete, and query the available customers in Square.
InventoryChanges	Query historical physical counts and adjustments on inventory items.
Refunds	Create and query the details for all Refunds initiated by a merchant or any of the mobile staff of the merchant during a date range.

Create, update, delete, and query the available Cards in Square.

Table Specific Information

Select

The Sync App uses the Square API to process search criteria , while other filters are processed client side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will have an unfiltered response.

Select all Cards:

SELECT * FROM Cards

Select all Cards from a specific customer:

 SELECT * FROM Cards WHERE CustomerId='CBASEPlKoFeu4nWm0MX_oHdklAIgAQ'

Insert

To create a card, you will need to specify CustomerId, IdempotencyKey and SourceId.

INSERT INTO Cards(IdempotencyKey,SourceId,CustomerId,BillingAddressAddressLine1,BillingAddressAddressLine2,BillingAddressLocality,BillingAddressPostalCode,BillingAddressCountry,CardholderName) VALUES('aa8f236c-13a6-42fe-a17e-4edf6caa2035','fake-card-nonce-ok','CBASEPlKoFeu4nWm0MX_oHdklAIgAQ','500 Electric Ave','Suite 600','New York','94103','US','CardholderName')

Delete

A card can be removed by providing the Id.

DELETE FROM Cards WHERE Id='eKoFeu4nWm0MX_oed'

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	True	Unique ID for this card. Generated by Square.
BillingAddressAddressLine1	String	False	A civil entity within the address's country. In the US, this is the state.
BillingAddressAddressLine2	String	False	The second line of the address, if any.
BillingAddressAddressLine3	String	False	The third line of the address, if any
BillingAddressAdministrativeDistrictLevel1	String	False	A civil entity within the address's country.
BillingAddressCountry	String	False	The address's country, in the two-letter format of ISO 3166.
BillingAddressLocality	String	False	The city or town of the address.
BillingAddressSubLocality	String	False	A civil region within the address's locality, if any.
BillingAddressPostalCode	String	False	The address's postal code.
Bin	String	True	The first six digits of the card number, known as the Bank Identification Number (BIN).
CardBrand	String	True	The card's brand.
CardType	String	True	The type of the card.
CardholderName	String	False	The name of the cardholder.
CustomerId	String	False	The ID of a customer created using the Customers API to be associated with the card.
MerchantId	String	True	The ID of the merchant associated with the card.
Enabled	Boolean	True	Indicates whether or not a card can be used for payments.
ExpMonth	Integer	False	The expiration month of the associated card as an integer between 1 and 12.
ExpYear	Integer	False	The four-digit year of the card's expiration date.
Fingerprint	String	True	The unique string fingerprint for the card. The fingerprint is based on the credit card number and is unique to the merchant. If a card is used at multiple locations for the same merchant, it will have the same fingerprint in each case.
Last4	String	True	The last 4 digits of the card number.
PrepaidType	String	True	Indicates whether the Card is prepaid or not.
ReferenceId	String	False	An optional user-defined reference ID that associates this card with another entity in an external system.
Version	Integer	False	Current version number of the card.
IdempotencyKey	String	False	A unique string that identifies this CreateCard request.
SourceId	String	False	The ID of the source which represents the card information to be stored. This can be a card nonce or a payment id.
VerificationToken	String	False	An identifying token generated by Payments.verifyBuyer().

Query the available catalog categories.

Table Specific Information

Select

Retrieve all catalog categories:

SELECT * FROM CatalogCategories

Insert

To create an item, you will need to specify the Name column.

INSERT INTO CatalogCategories (Name) VALUES ('Cat Created 2')

Update

Modify the details of an existing CatalogCategories by providing the Id of the Categories:

UPDATE CatalogCategories SET Name = 'Cat Updated' WHERE ID = '1234'

Delete

Delete a category object by providing the Id of the Categories:

DELETE FROM CatalogCategories WHERE Id='32123'

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	False	The category's ID.
Name	String	False	The category's name.
UpdatedAt	Datatime	False	Last modification timestamp.
IsDeleted	Boolean	False	If true, the object has been deleted from the database. When deleted, the UpdatedAt field will equal the deletion time.
PresentAtAllLocations	Boolean	False	If true, this object is present at all locations (including future locations), except where specified in the AbsentAtLocationIds field. If false, this object is not present at any locations (including future locations), except where specified in the PresentAtLocationIds field. If not specified, defaults to true.
PresentAtLocationIds	String	False	A list of locations where the object is present, even if PresentAtAllLocations is false.
AbsentAtLocationIds	String	False	A list of locations where the object is not present, even if PresentAtAllLocations is true.
Version	Int64	False	The version of the object. When updating an object, the version supplied must match the version in the database, otherwise the write will be rejected as conflicting.

Query the available catalog discounts.

Table Specific Information

Select

Retrieve all catalog discounts:

SELECT * FROM CatalogDiscounts

Insert

To create an item, you will need to specify the DiscountType, Name, Amount and Currency columns.

INSERT INTO CatalogDiscounts (PINRequired, DiscountType, Name, Amount, Currency) VALUES (false,'FIXED_PERCENTAGE','Special_Discount1','200000','USD') 

Update

To Update an item, you will need to specify the Id column.

UPDATE CatalogDiscounts SET amount = 1234, currency = 'USD' WHERE Id = '1234'

Delete

Delete a discount object by providing the Id of the discount object:

DELETE FROM CatalogDiscounts WHERE Id = '32123'

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	False	The discount's ID.
Name	String	False	The discount's name.
UpdatedAt	Datatime	False	Last modification timestamp.
IsDeleted	Boolean	False	If true, the object has been deleted from the database. When deleted, the UpdatedAt field will equal the deletion time.
DiscountType	String	False	Indicates whether the discount is a fixed amount or percentage, or entered at the time of sale.
Percentage	String	False	The percentage of the discount as a string representation of a decimal number, using a . as the decimal separator and without a % sign. A value of 7.5 corresponds to 7.5%. Specify a percentage of 0 if DiscountType is VARIABLE_PERCENTAGE.
Amount	Integer	False	The discount's amount.
Currency	String	False	The discount's money currency.
PinRequired	Boolean	False	Indicates whether a mobile staff member needs to enter their PIN to apply the discount to a payment in the Square Point of Sale app.
LabelColor	String	False	The color of the discount's display label in the Square Point of Sale app.
PresentAtAllLocations	Boolean	False	If true, this object is present at all locations (including future locations), except where specified in the AbsentAtLocationIds field. If false, this object is not present at any locations (including future locations), except where specified in the PresentAtLocationIds field. If not specified, defaults to true.
PresentAtLocationIds	String	False	A list of locations where the object is present, even if PresentAtAllLocations is false.
AbsentAtLocationIds	String	False	A list of locations where the object is not present, even if PresentAtAllLocations is true.
Version	Int64	False	The version of the object. When updating an object, the version supplied must match the version in the database, otherwise the write will be rejected as conflicting.

Query the available catalog images.

Table Specific Information

Select

Retrieve all catalog images:

SELECT * FROM CatalogImages

Insert

To create an item, you will need to specify the Name column.

INSERT INTO CatalogImages (Name) VALUES ('Cat Created 2')

Update

Modify the details of an existing catalog by providing the Id of the Images:

UPDATE CatalogImages SET Name = 'Cat Updated' WHERE ID = '1234'

Delete

Delete a category object by providing the Id of the Images:

DELETE FROM CatalogImages WHERE Id='32123'

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	False	The image file ID.
Name	String	False	The internal name of this image.
UpdatedAt	Datatime	False	Last modification timestamp.
IsDeleted	Boolean	False	If true, the object has been deleted from the database. When deleted, the UpdatedAt field will equal the deletion time.
URL	String	False	The URL of this image.
Caption	String	False	A caption that describes what is shown in the image. Displayed in the Square Online Store.
PresentAtAllLocations	Boolean	False	If true, this object is present at all locations (including future locations), except where specified in the AbsentAtLocationIds field. If false, this object is not present at any locations (including future locations), except where specified in the PresentAtLocationIds field. If not specified, defaults to true.
PresentAtLocationIds	String	False	A list of locations where the object is present, even if PresentAtAllLocations is false.
AbsentAtLocationIds	String	False	A list of locations where the object is not present, even if PresentAtAllLocations is true.
Version	Int64	False	The version of the object. When updating an object, the version supplied must match the version in the database, otherwise the write will be rejected as conflicting.

Query the available items.

Table Specific Information

Select

Retrieve all catalog items:

SELECT * FROM CatalogItems

Insert

To create an item, you will need to specify the Name column. All the fields that are not read-only can be specified.

INSERT INTO CatalogItems (Name) VALUES ('MyItem7')

Creating an item, by specifying aggregate columns.

INSERT INTO CatalogItems (Name, Description, IsDeleted, LabelColor,Abbreviation,AvailableOnline, AvailableForPickup, AvailableElectronically, CategoryId, TaxIds, ModifierListInfo, ProductType, SkipModifierScreen, PresentAtAllLocations, PresentAtLocationIds, AbsentAtLocationIds) 
VALUES ('MyItem7','My favorite item',false,'4ab200', 'Abbreviation', true, true, true, 'KJTFGM3N2S6ATTQFUWBO4GRF', 
'[
          "OM6KNVLNASNSVHQ3GG4CJI3E",
          "4XNDTMJBDGCRFOJISE3GV3TZ",
          "THYCNM5QNAX2ZSYQITQ2YFJQ"
        ]',
'[
          {
            "modifier_list_id": "MCBLV4WVUUZ6K3MFI33N3MJB"
          },
          {
            "modifier_list_id": "WHRXTOEYZZI4V6JHTA4PPPTX"
          }
        ]',
'APPOINTMENTS_SERVICE', true, true, 
'[
 "94BYHNBR6W57E",
 "92BYHNBR2W73E"
]',
'[
 "92BYHNBR6W73E"
]')

Update

Modify the details of an existing catalog by providing the Id of the Items object:

UPDATE CatalogItems SET Description = 'TestDesc1', Name = 'TestName1', Abbreviation = 'TestAbbreviation1', AvailableForPickup = true WHERE ID = 'SSURXB52UP6QNMHQ6XD3QY4I'

Delete

Delete a item object by providing the Id of the customer:

DELETE FROM CatalogItems WHERE Id='32123'

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	True	The item's ID.
Name	String	False	The item's name.
UpdatedAt	Datatime	True	Last modification timestamp.
IsDeleted	Boolean	False	If true, the object has been deleted from the database. When deleted, the UpdatedAt field will equal the deletion time.
Description	String	False	The item's description.
Abbreviation	String	False	The text of the item's display label in the Square Point of Sale app. Only up to the first five characters of the string are used.
LabelColor	String	False	The color of the item's display label in the Square Point of Sale app.
AvailableOnline	Boolean	False	If true, the item can be added to shipping orders from the merchant's online store.
AvailableForPickup	Boolean	False	If true, the item can be added to pickup orders from the merchant's online store.
AvailableElectronically	Boolean	False	If true, the item can be added to electronically fulfilled orders from the merchant's online store.
CategoryId	String	False	The ID of the item's category, if any.
TaxIds	String	False	A set of IDs indicating the CatalogTaxes that are enabled for this item.
ModifierListInfo	String	False	Info about the modifier lists that apply to this item.
ProductType	String	False	The product type of the item. May not be changed once an item has been created.
SkipModifierScreen	Boolean	False	If true, the Square Point of Sale app will immediately add the item to the cart with the pre-selected modifiers, and merchants can edit modifiers by drilling down onto the item's details.
PresentAtAllLocations	Boolean	False	If true, this object is present at all locations (including future locations), except where specified in the AbsentAtLocationIds field. If false, this object is not present at any locations (including future locations), except where specified in the PresentAtLocationIds field. If not specified, defaults to true.
PresentAtLocationIds	String	False	A list of locations where the object is present, even if PresentAtAllLocations is false.
AbsentAtLocationIds	String	False	A list of locations where the object is not present, even if PresentAtAllLocations is true.
Version	Int64	False	The version of the object. When updating an object, the version supplied must match the version in the database, otherwise the write will be rejected as conflicting.
ImageId	String	False	The Id of the Image

Query the available item variations.

Table Specific Information

Select

Retrieve all catalog item variations:

SELECT * FROM CatalogItemVariations

Insert

To create an item variation, you will need to specify the ItemId, PricingType, PriceMoneyAmount and PriceMoneyCurrency column, or ItemId and PricingType if PricingType is set to VARIABLE_PRICING. All the fields that are not read-only can be specified.

INSERT INTO CatalogItemVariations (ItemId, PricingType,PriceMoneyAmount,PriceMoneyCurrency) VALUES ('2I2UELJL4543VQJF4D4EU3EJO','FIXED_PRICING',1,'USD')

Creating an item variation, by specifying aggregate columns.

 INSERT INTO CatalogItemVariations (ItemId, Name, PricingType, PriceMoneyAmount, PriceMoneyCurrency, SKU, Upc, Ordinal, LocationOverrides, TrackInventory, InventoryAlertType,InventoryAlertThreshold,UserData,ServiceDuration,PresentAtAllLocations,AbsentAtLocationIds) VALUES ('YC77SWXPJLTUFUHCCYSGYMYD', 'MyItemVariations14','FIXED_PRICING',1,'USD', 'testSKU', 'testUPC', '2',
'[
  {
  "inventory_alert_threshold": 1, 
  "location_id": "92BYHNBR6W77E",
  }
 ]',
 true,'LOW_QUANTITY',3,'test',3,false,
 '[
   "92BYHNBR6W77E"
  ]')

  

Create an Item variation using TEMP Table.

 insert into catalogitemvariations(name,PricingType,itemid,pricemoneyamount,pricemoneycurrency) values ('hello','FIXED_PRICING','GZSJP2V2SE4KS2ZU7AJCLX5P',19900,USD  

 insert into catalogitemvariations(name,PricingType,itemid,pricemoneyamount,pricemoneycurrency) values ('test55','FIXED_PRICING','RSQPFRKIZZFWO3IV3UX3M5LM',20001,USD  

 INSERT INTO CatalogItems (Name, Description, ModifierListInfo) VALUES ('Jeep Rentals NEW', 'Our Daily Jeep Rates','CatalogItemVariations#Temp'  

Update

To Update an item, you will need to specify the Id column.

UPDATE CatalogItemVariations SET name='TestName1', PricingType = 'FIXED_PRICING', PriceMoneyAmount = 1010, PriceMoneyCurrency = 'USD', ItemId = 'OLCXWRVE7JD22TCS6NIRST6G', UserData = 'SEASONAL=TRUE' WHERE id='WNT7535N7AEJHJBMLRGGZXIK'

Delete

Delete a discount object by providing the Id of the discount object:

DELETE FROM CatalogItemVariations WHERE Id='32123'

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	False	The item variation's ID.
ItemId [KEY]	String	False	The ID of the CatalogItem associated with this item variation.
Name	String	False	The item variation's name.
UpdatedAt	Datatime	True	Last modification timestamp.
IsDeleted	Boolean	False	If true, the object has been deleted from the database. When deleted, the UpdatedAt field will equal the deletion time.
Sku	String	False	The item variation's SKU.
Upc	String	False	The item variation's UPC.
Ordinal	Integer	False	The order in which this item variation should be displayed.
PricingType	String	False	Indicates whether the item variation's price is fixed or determined at the time of sale.
PriceMoneyAmount	Integer	False	The item variation's price amount, if fixed pricing is used.
PriceMoneyCurrency	String	False	The item variation's price currency, if fixed pricing is used.
LocationOverrides	String	False	Per-location price and inventory overrides.
TrackInventory	Boolean	False	If true, inventory tracking is active for the variation.
InventoryAlertType	String	False	Indicates whether the item variation displays an alert when its inventory quantity is less than or equal to its InventoryAlertThreshold.
InventoryAlertThreshold	Integer	False	If the inventory quantity for the variation is less than or equal to this value and InventoryAlertType is LOW_QUANTITY, the variation displays an alert in the merchant dashboard.
UserData	String	False	Arbitrary user metadata to associate with the item variation.
ServiceDuration	Integer	False	If the CatalogItem that owns this item variation is of type APPOINTMENTS_SERVICE, then this is the duration of the service in milliseconds.
CatalogMeasurementUnitId	String	True	Represents the unit used to measure a CatalogItemVariation and specifies the precision for decimal quantities.
MeasurementUnitId	String	False	ID of the 'CatalogMeasurementUnit' that is used to measure the quantity sold of this item variation. If left unset, the item will be sold in whole quantities.
PresentAtAllLocations	Boolean	False	If true, this object is present at all locations (including future locations), except where specified in the AbsentAtLocationIds field. If false, this object is not present at any locations (including future locations), except where specified in the PresentAtLocationIds field. If not specified, defaults to true.
PresentAtLocationIds	String	False	A list of locations where the object is present, even if PresentAtAllLocations is false.
AbsentAtLocationIds	String	False	A list of locations where the object is not present, even if PresentAtAllLocations is true.
Version	Int64	False	The version of the object. When updating an object, the version supplied must match the version in the database, otherwise the write will be rejected as conflicting.

Query the available catalog modifier lists.

Table Specific Information

Select

Retrieve all catalog modifier lists:

SELECT * FROM CatalogModifierLists

Insert

To create an item, you will need to specify the Name column and modifier object.

INSERT INTO CatalogModifierLists (Name,selectiontype,Modifiers) VALUES ('Type','MULTIPLE','[\n" +
        "\t{\n" +
        "\t  \"id\" : \"DSVHFBTUXMNTKUFSXMODS7HO\",\n" +
        "      \"type\": \"MODIFIER\",\n" +
        "      \"version\": 1489411961853,\n" +
        "      \"modifier_data\":{\n" +
        "\t  \"name\" : \"4 floor\",\n" +
        "\t  \"on_by_default\": false,\n" +
        "      \"price_money\": {\n" +
        "        \"currency\": \"USD\",\n" +
        "        \"amount\": 23900\n" +
        "      }\n" +
        "      }\n" +
        "    }]' 

Create a modifierlist object using TEMP table.

 INSERT INTO CatalogModifiers#Temp (Id,Type, Version,Name, PriceMoneyCurrency, PriceMoneyAmount) VALUES ('Y2R6VS3ZCF4GCLO2IJBJWMYR','MODIFIER',1591591604813,'4 door','USD', 23900) 

 INSERT INTO CatalogModifierLists (Name, SelectionType, Modifiers) VALUES ('Type Updated', 'MULTIPLE', 'CatalogModifiers#Temp' 

Update

To Update an item, you will need to specify the Id column.

UPDATE CatalogModifierLists SET Name = 'list1' WHERE Id = '1234'

Delete

Delete a modifierlist object by providing the Id of the modifierlist:

DELETE FROM CatalogModifierLists WHERE Id = '32123'

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	False	The CatalogModifierList's ID.
Name	String	False	The CatalogModifierList's name.
UpdatedAt	Datetime	False	Last modification timestamp.
IsDeleted	Boolean	False	If true, the object has been deleted from the database. When deleted, the UpdatedAt field will equal the deletion time.
Modifiers	String	False	The options included in the CatalogModifierList. Each CatalogObject must have type MODIFIER and contain CatalogModifier data.
PresentAtAllLocations	Boolean	False	If true, this object is present at all locations (including future locations), except where specified in the AbsentAtLocationIds field. If false, this object is not present at any locations (including future locations), except where specified in the PresentAtLocationIds field. If not specified, defaults to true.
PresentAtLocationIds	String	False	A list of locations where the object is present, even if PresentAtAllLocations is false.
AbsentAtLocationIds	String	False	A list of locations where the object is not present, even if PresentAtAllLocations is true.
SelectionType	String	False	Indicates whether multiple options from the modifier list can be applied to a single CatalogItem..
Version	Int64	False	The version of the object. When updating an object, the version supplied must match the version in the database, otherwise the write will be rejected as conflicting.

Query the available catalog modifiers.

Table Specific Information

Select

Retrieve all catalog modifiers:

SELECT * FROM CatalogModifiers

Insert

To create an item, you will need to specify the Name column.

INSERT INTO CatalogModifiers (Name) VALUES ('Cat Created 2')

Update

Modify the details of an existing CatalogModifiers by providing the Id of the Modifier:

UPDATE CatalogModifiers SET Name = 'Cat Updated' WHERE ID = '1234'

Delete

Delete a category object by providing the Id of the Categories:

DELETE FROM CatalogModifiers WHERE Id='32123'

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	False	The modifier's ID.
Name	String	False	The modifier's name.
UpdatedAt	Datatime	False	Last modification timestamp.
IsDeleted	Boolean	False	If true, the object has been deleted from the database. When deleted, the UpdatedAt field will equal the deletion time.
PriceMoneyAmount	Integer	False	The modifier's price amount.
PriceMoneyCurrency	String	False	The modifier's price currency.
PresentAtAllLocations	Boolean	False	If true, this object is present at all locations (including future locations), except where specified in the AbsentAtLocationIds field. If false, this object is not present at any locations (including future locations), except where specified in the PresentAtLocationIds field. If not specified, defaults to true.
PresentAtLocationIds	String	False	A list of locations where the object is present, even if PresentAtAllLocations is false.
AbsentAtLocationIds	String	False	A list of locations where the object is not present, even if PresentAtAllLocations is true.
Version	Int64	False	The version of the object. When updating an object, the version supplied must match the version in the database, otherwise the write will be rejected as conflicting.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name	Type	Description
Type	String	The catalog object type to be modified.

Query the available catalog taxes.

Table Specific Information

Select

Retrieve all catalog taxes:

SELECT * FROM CatalogTaxes

Insert

To create an item, you will need to specify the Name column.

INSERT INTO CatalogTaxes (Name) VALUES ('Cat Created 2')

Update

Modify the details of an existing CatalogTaxes by providing the Id of the tax:

UPDATE CatalogTaxes SET Name = 'Cat Updated' WHERE ID = '1234'

Delete

Delete a category object by providing the Id of the Categories:

DELETE FROM CatalogTaxes WHERE Id='32123'

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	False	The Id of the tax.
Name	String	False	The tax's name.
UpdatedAt	Datatime	False	Last modification timestamp.
IsDeleted	Boolean	False	If true, the object has been deleted from the database. When deleted, the UpdatedAt field will equal the deletion time.
CalculationPhase	String	False	Whether the tax is calculated based on a payment's subtotal or total.
InclusionType	String	False	Whether the tax is ADDITIVE or INCLUSIVE.
Percentage	String	False	The percentage of the discount as a string representation of a decimal number, using a . as the decimal separator and without a % sign. A value of 7.5 corresponds to 7.5%.
AppliesToCustomAmounts	Boolean	False	If true, the fee applies to custom amounts entered into the Square Point of Sale app that are not associated with a particular CatalogItem.
Enabled	Boolean	False	If true, the tax will be shown as enabled in the Square Point of Sale app.
PresentAtAllLocations	Boolean	False	If true, this object is present at all locations (including future locations), except where specified in the AbsentAtLocationIds field. If false, this object is not present at any locations (including future locations), except where specified in the PresentAtLocationIds field. If not specified, defaults to true.
PresentAtLocationIds	String	False	A list of locations where the object is present, even if PresentAtAllLocations is false.
AbsentAtLocationIds	String	False	A list of locations where the object is not present, even if PresentAtAllLocations is true.
Version	Int64	False	The version of the object. When updating an object, the version supplied must match the version in the database, otherwise the write will be rejected as conflicting.

Create, update, delete, and query the available CustomerCards in Square.

Table Specific Information

Select

The Sync App uses the Square API to process search criteria that refer to the CustomerId column, while other filters are processed client side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will have an unfiltered response.

Select all CustomerCards from all customers:

SELECT * FROM CustomerCards

Select all CustomerCards from a specific customer:

 SELECT * FROM CustomerCards WHERE CustomerId = 'CBASEPlKoFeu4nWm0MX_oHdklAIgAQ'

Insert

To create a customer card, you will need to specify CustomerId and CardNonce.

INSERT INTO CustomerCards (CardNonce,CustomerId,BillingAddressLine1,BillingAddressLine2,BillingAddressLocality,BillingAddressPostalCode,BillingAddressCountry,CardholderName) VALUES ('fake-card-nonce-ok','CBASEPlKoFeu4nWm0MX_oHdklAIgAQ','500 Electric Ave','Suite 600','New York','94103','US','CardholderName')

Delete

A customer card can be removed by providing the Id and CustomerId.

DELETE FROM CustomerCards WHERE Id = 'eKoFeu4nWm0MX_oed' AND CustomerId = 'CBASEPlKoFeu4nWm0MX_oHdklAIgAQ'

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	True	The card's unique ID, if any.
CustomerId [KEY]	String	False	The customer's unique ID.
CardBrand	String	True	The card's brand (such as VISA).
Last4Digits	String	True	The last 4 digits of the card's number.
ExpireMonth	Integer	True	The month of the card's expiration date. This value is always between 1 and 12, inclusive.
ExpireYear	Integer	True	The four-digit year of the card's expiration date.
CardholderName	String	False	The cardholder name. This value is present only if this object represents a customer's card on file.
PhoneNumber	String	True	The customer's phone number.
Fingerprint	String	True	The unique string fingerprint for the card. The fingerprint is based on the credit card number and is unique to the merchant. If a card is used at multiple locations for the same merchant, it will have the same fingerprint in each case.
CardNonce	String	False	A card nonce representing the credit card to link to the customer.
BillingAddressLine1	String	False	The first line of the address.
BillingAddressLine2	String	False	The second line of the address.
BillingAddressLine3	String	False	The third line of the address.
BillingAddressLocality	String	False	The city or town of the address.
BillingAddressSubLocality	String	False	A civil region within the address's locality.
BillingAddressSubLocality2	String	False	A civil region within the address's sublocality.
BillingAddressSubLocality3	String	False	A civil region within the address's sublocality_2.
BillingAddressAdministrativeDistrictLevel1	String	False	A civil entity within the address's country. In the US, this is the state.
BillingAddressAdministrativeDistrictLevel2	String	False	A civil entity within the address's administrative_district_level_1. In the US, this is the county.
BillingAddressAdministrativeDistrictLevel3	String	False	A civil entity within the address's administrative_district_level_2.
BillingAddressPostalCode	String	False	The address's postal code.
BillingAddressCountry	String	False	The address's country, in ISO 3166-1-alpha-2 format.
BillingAddressFirstName	String	False	Optional first name when it's representing recipient.
BillingAddressLastName	String	False	Optional last name when it's representing recipient.
BillingAddressOrganization	String	False	Optional organization name when it's representing recipient.

Create, update, delete, and query the available customers in Square.

Table Specific Information

Select

The Sync App uses the Square API to process search criteria that refer to the Id column, while other filters are processed client side within the Sync App.

Retrieve all customers:

SELECT * FROM Customers

Retrieve only one customer:

SELECT * FROM Customers WHERE Id = '0SY145EEWD0YXCW489VV386KH8'

Insert

To create a customer, you will need to specify at least one of the following values: GivenName, FamilyName, CompanyName, EmailAddress, and PhoneNumber.

INSERT INTO Customers (GivenName,FamilyName,Email,PhoneNumber,AddressLine1,AddressLine2,AddressLocality,AddressAdministrativeDistrictLevel1,AddressPostalCode,AddressCountry) VALUES ('John', 'Doe', '[email protected]','1-212-555-4240','500 Electric Ave', 'Suite 600', 'New York', 'NY', '10003', 'US')

Update

Modify the details of an existing customer by providing the Id of the customer:

UPDATE Customers SET GivenName = 'Amelia', FamilyName = 'Earhart' WHERE Id = '32123'

Delete

Delete a customer from a business, along with any linked cards on file, by providing the Id of the customer:

DELETE FROM Customers WHERE Id = '32123'

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	True	The Id of the customer.
GivenName	String	False	The customer's given (i.e., first) name.
FamilyName	String	False	The customer's family (i.e., last) name.
Nickname	String	False	The customer's nickname.
Email	String	False	The customer's email address.
CompanyName	String	False	The name of the customer's company.
PhoneNumber	String	False	The customer's phone number.
AddressLine1	String	False	The first line of the address.
AddressLine2	String	False	The second line of the address.
AddressLine3	String	False	The third line of the address.
AddressLocality	String	False	The city or town of the address.
AddressSubLocality	String	False	A civil region within the address's locality.
AddressSubLocality2	String	False	A civil region within the address's sublocality.
AddressSubLocality3	String	False	A civil region within the address's sublocality_2.
AddressAdministrativeDistrictLevel1	String	False	A civil entity within the address's country. In the US, this is the state.
AddressAdministrativeDistrictLevel2	String	False	A civil entity within the address's administrative_district_level_1. In the US, this is the county.
AddressAdministrativeDistrictLevel3	String	False	A civil entity within the address's administrative_district_level_2.
AddressPostalCode	String	False	The address's postal code.
AddressCountry	String	False	The address's country, in ISO 3166-1-alpha-2 format.
AddressFirstName	String	False	Optional first name when it's representing recipient.
AddressLastName	String	False	Optional last name when it's representing recipient.
AddressOrganization	String	False	Optional organization name when it's representing recipient.
Birthday	Datetime	False	The birthday associated with the customer profile, in RFC 3339 format. Year is optional, timezone and times are not allowed
CreatedAt	Datetime	True	The time when the customer was created.
UpdatedAt	Datetime	True	The time when the customer was last updated.
ReferenceId	String	False	A second ID you can set to associate the customer with an entity in another system.
Note	String	False	A note to associate with the customer.
CardsAggregate	String	True	The non-confidential details of the customer's cards on file.
Preferences	String	True	The customer's preferences.
Segments	String	True	The IDs of segments the customer belongs to.

Query historical physical counts and adjustments on inventory items.

Table Specific Information

Select

The Sync App uses the Square API to process search criteria that refer to the Type, CatalogObjectId, State and LocationId column, while other filters are processed client side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will have an unfiltered response.

Select all the inventory changes:

SELECT * FROM InventoryChanges

Select all the inventory changes from a specific location ID:

SELECT * FROM InventoryChanges WHERE LocationId='Sandbox_Location_Id'

Select all the inventory changes with a specific type:

SELECT * FROM InventoryChanges WHERE Type='ADJUSTMENT'

Select all the inventory changes in a specific state:

SELECT * FROM InventoryChanges WHERE State='IN_STOCK'

Select all the inventory changes for a specific catalog object:

SELECT * FROM InventoryChanges WHERE CatalogObjectId='5QJP4XMEN5TQ4W4UY7YL'

Insert

To create an inventory change, you will need to specify the Type, CatalogObjectId, Quantity column.
Insert an inventory change of type 'PHYSICAL_COUNT' :

Insert INTO InventoryChanges(Type,CatalogObjectId,State,Quantity) Values('PHYSICAL_COUNT','5QJP4XMEN5TQ4W4UY7YL','IN_STOCK',16)

Insert an inventory change of type 'ADJUSTMENT' :

Insert INTO InventoryChanges(Type,CatalogObjectId,FromState,ToState,Quantity) Values('ADJUSTMENT','5QJP4XMEN5TQ4W4UY7YL','IN_STOCK','SOLD',5)

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	False	A unique ID generated by Square for the Inventory change.
ReferenceId	String	False	An optional ID provided by the application to tie the Inventory change to an external system.
Type	String	False	Indicates how the inventory change was applied. 使用できる値は次のとおりです。PHYSICAL_COUNT, ADJUSTMENT
CatalogObjectId	String	False	The Square generated ID of the CatalogObject being tracked.
CatalogObjectType	String	False	The CatalogObjectType of the CatalogObject being tracked. Tracking is only supported for the ITEM_VARIATION type.
State	String	False	The current InventoryState for the related quantity of items.
LocationId	String	False	The Square ID of the Location where the related quantity of items are being tracked.
Quantity	String	False	The number of items affected by the physical count as a decimal string.
EmployeeId	String	False	The Square ID of the Employee responsible for the physical count.
OccurredAt	Datetime	False	A client-generated timestamp in RFC 3339 format that indicates when the physical count took place. For write actions, the occurred_at timestamp cannot be older than 24 hours or in the future relative to the time of the request.
CreatedAt	Datetime	False	A read-only timestamp in RFC 3339 format that indicates when Square received the physical count.
FromState	String	False	The InventoryState of the related quantity of items before the adjustment.
ToState	String	False	The InventoryState of the related quantity of items before the adjustment.
TotalPriceMoneyAmount	Integer	False	The amount of the total price paid for goods associated with the adjustment. Present if and only if to_state is SOLD. Always non-negative.
TotalPriceMoneyCurrency	String	False	The currency of the total price paid for goods associated with the adjustment. Present if and only if to_state is SOLD. Always non-negative.
TransactionId	String	False	The read-only Square ID of the [Transaction][#type-transaction] that caused the adjustment. Only relevant for payment-related state transitions.
RefundId	String	False	The read-only Square ID of the Transaction that caused the adjustment. Only relevant for payment-related state transitions.
PurchaseOrderId	String	False	The read-only Square ID of the Refund that caused the adjustment. Only relevant for refund-related state transitions.
GoodsReceiptId	String	False	The read-only Square ID of the Square goods receipt that caused the adjustment. Only relevant for state transitions from the Square for Retail app.
FromLocationId	String	False	The Square ID of the Location where the related quantity of items were tracked before the transfer.
ToLocationId	String	False	The Square ID of the Location where the related quantity of items were tracked before the transfer.

Create and query the details for all Refunds initiated by a merchant or any of the mobile staff of the merchant during a date range.

Table Specific Information

Select

By default this table returns all refunds initiated by a merchant or any of the merchants mobile staff starting from January 1, 2013, as in the following query:

SELECT * FROM Refunds WHERE Id = '12345'
SELECT * FROM Refunds WHERE Status = 'COMPLETED' AND LocationId = '92BYHNBR6W77E'
SELECT * FROM Refunds WHERE LocationId = '9J0M984DXGA7W' // To get the refund for a given location

Insert

To insert a Refund, specify the PaymentId, RefundedMoneyAmount, RefundedMoneyCurrency.

INSERT INTO Refunds (PaymentId, RefundedMoneyAmount, RefundedMoneyCurrency) VALUES ('UNOE3kv2BZwqHlJ830RCt5YCuaB', 100, 'USD')

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	False	The unique ID for this refund, generated by Square.
TenderId	String	False	The Square-issued Id of the transaction tender the refund is applied to.
RefundedMoneyAmount	Int64	False	The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.
RefundedMoneyCurrency	String	False	The type of currency, in ISO 4217 format. For example, the currency code for US dollars is USD.
RefundedAppFeeMoneyAmount	Int64	False	The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.
RefundedAppFeeMoneyCurrency	String	False	The type of currency, in ISO 4217 format. For example, the currency code for US dollars is USD.
CreatedAt	Datetime	False	The time when the merchant initiated the refund for Square to process.
LocationId	String	False	The Id of the location.
OrderId	String	False	The ID of the order associated with the refund.
PaymentId	String	False	The ID of the payment associated with this refund.
ProcessingFeeMoneyAmount	Int64	False	Processing fees and fee adjustments assessed by Square for this refund. The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.
ProcessingFeeMoneyCurrency	String	False	Processing fees and fee adjustments assessed by Square for this refund. The type of currency, in ISO 4217 format. For example, the currency code for US dollars is USD.
ProcessingFeeEffectiveAt	Datetime	False	Processing fees and fee adjustments assessed by Square for this refund. The timestamp of when the fee takes effect, in RFC 3339 format.
ProcessingFeeType	String	False	Processing fees and fee adjustments assessed by Square for this refund. The type of fee assessed or adjusted. The fee type can be INITIAL or ADJUSTMENT.
Reason	String	False	The merchant-specified reason for the refund.
Status	String	False	The refund's status 使用できる値は次のとおりです。COMPLETED, FAILED, PENDING, REJECTED
UpdatedAt	Datetime	False	The timestamp of when the refund was last updated, in RFC 3339 format.

ビューは、カラムと疑似カラムで構成されます。ビューは、データを示すという点でテーブルに似ていますが、ビューでは更新はサポートされません。通常、ビューとして表されるエンティティは、読み取り専用のエンティティです。多くの場合、これらのデータはストアドプロシージャを使用することで更新できます（その機能がデータソースに適用できる場合）。

ビューに対しては、通常のテーブルと同じようにクエリを実行でき、このときに返されるデータも同様です。

ビューとして公開されるクエリなどの動的ビューや、project_team ワークアイテムの特定の組み合わせを検索するためのビューがサポートされています。

Square Connector for CData Sync ビュー

Name	Description
BankAccounts	Query the Bank Accounts of the merchant.
Locations	Query Location information for a Merchant.
Merchants	Query the available merchants in Square.
OrderItems	The order items included in the order. Every order has at least one order item.
Orders	Orders specify products for purchase, along with discounts, taxes, and other settings to apply to the purchase.
Payments	Query the available card Payments in Square. Cash and other tenders payments will not be returned.
Teams	Query the available list of TeamMember for a business in Square.

Query the Bank Accounts of the merchant.

Columns

Name	Type	Description
Id [KEY]	String	The Square-issued Id of the bank account.
LocationId	String	The Id of the location.
BankName	String	The name of the bank that manages the account.
Name	String	The name associated with the bank account.
Type	String	The type of the bank account. For example, savings or checking.
Country	String	The ISO 3166 Alpha 2 country code where the bank account is based.
AccountNumberSuffix	String	The last few digits of the bank account number.
CurrencyCode	String	The code of the currency associated with the bank account.
PrimaryBankIdentificationNumber	String	Primary identifier for the bank.
Status	String	The current verification status of this BankAccount object.
Creditable	Boolean	Indicates whether it is possible for Square to send money to this bank account.
Debitable	Boolean	Indicates whether it is possible for Square to take money from this bank account.
Version	Integer	The current version of the BankAccount.

Query Location information for a Merchant.

Table Specific Information

Select

The Sync App will execute all filters to this table client-side, in memory. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria will have an unfiltered response.

Retrieve all Locations:

SELECT * FROM Locations

Columns

Name	Type	Description
Id [KEY]	String	The location's unique ID.
Name	String	The location's name. Location names are set by the account owner and displayed in the dashboard as the location's nickname
Address	String	The location's physical address.
TimeZone	String	The IANA Timezone Database identifier for the location's timezone.
Capabilities	String	Indicates which Square features are enabled for the location.
Status	String	The location's status.
CreatedAt	Datetime	The time when the location was created, in RFC 3339 format.
MerchantId	String	The identifier of the merchant that owns the location.
Country	String	The location's country, in ISO 3166-1-alpha-2 format.
LanguageCode	String	The language associated with the location in BCP 47 format.
Currency	String	The currency used for all transactions at this location, specified in ISO 4217 format.
PhoneNumber	String	The location's phone_number.
BusinessName	String	The location's business_name which is shown to its customers.
Type	String	The location's type, as set by the account owner in the Square dashboard.
WebsiteUrl	String	The location's website, as set by the account owner in the Square dashboard.

Query the available merchants in Square.

Table Specific Information

Select

The Sync App uses the Square API to process search criteria that refer to the Id column, while other filters are processed client side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will have an unfiltered response.

Retrieve all the merchants in your Square account.

SELECT * FROM Merchants

Specify Id in the WHERE clause using the = operator:

SELECT * FROM Merchants WHERE Id='CD215R7H3340KCD'

Columns

Name	Type	Description
Id [KEY]	String	The Id of the merchant.
BusinessName	String	The merchant's business name.
Country	String	The merchant's country.
Currency	String	The merchant's currency.
Status	String	The merchant's status.
LanguageCode	String	Code of the language.
MainLocationId	String	The ID of the main Location for this merchant.
CreatedAt	Datetime	The time when the location was created, in RFC 3339 format.

The order items included in the order. Every order has at least one order item.

Table Specific Information

Select

The Sync App uses the Square API to process search criteria that refer to the OrderId column, while other filters are processed client side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will have an unfiltered response.

Retrieve all the OrderItems found in every order of your Square account. Only orders that have been successfully charged are included in the response.

SELECT * FROM OrderItems

You can retrieve all order items from an order by specifying the OrderId.

 SELECT * FROM OrderItems WHERE OrderId='TzratjkPk9rhOuLYvSXeznmVvIx5PVlZpg72GfPQGBxckDeeWNBN8yqnf11qTrg3W3AelXC1kB' 

You can also use the IN operator to specify multiple OrderIds in the WHERE clause.

SELECT * FROM OrderItems WHERE OrderId IN ('XKKB7LD30TpfNyW3e843ziklKh4vWEvweQyL5l4ESJLH3N2XXNBN8yqnf11qTrg3W3AelXC1kB','pxICohrEXPDtoUitiZhG1um5uhp5WI7CRMHknbuKpaj53PXfWNBN8yqnf11qTrg3W3AelXC1kB','6j8avtXB5fIaPZ9H12beiZP7sCSiqguGhHpwmECsEaENswJnWNBN8yqnf11qTrg3W3AelXC1kB')

Columns

Name	Type	Description
OrderId [KEY]	String	The order's unique ID.
OrderItemNumber [KEY]	Integer	The nth item of the order.
LocationId	String	The Id of the location.
Name	String	The name of the order item.
Quantity	String	The quantity purchased, as a string representation of a number.
Note	String	The note of the order item.
CatalogObjectId	String	The CatalogItemVariation id applied to this order item.
VariationName	String	The name of the variation applied to this order item.
Taxes	String	The taxes applied to this order item.
Discounts	String	The discounts applied to this order item.
Modifiers	String	The CatalogModifiers applied to this order item.
BasePriceMoneyAmount	Integer	The base price for a single unit of the order item.
BasePriceMoneyCurrency	String	The currency of the base price for a single unit of the order item.
GrossSalesMoneyAmount	Integer	The gross sales amount of money calculated as (item base price + modifiers price) * quantity.
GrossSalesMoneyCurrency	String	The currency of the gross sales.
TotalTaxMoney	Integer	The total tax amount of money to collect for the order item.
TotalTaxMoneyCurrency	String	The currency of the total tax amount of money to collect for the order item.
TotalDiscountMoneyAmount	Integer	The total discount amount of money to collect for the order item.
TotalDiscountMoneyCurrency	String	The currency of the total discount amount of money to collect for the order item.
TotalMoneyAmount	Integer	The total amount of money to collect for this order item.
TotalMoneyCurrency	String	The currency of the total amount of money to collect for this order item.

Orders specify products for purchase, along with discounts, taxes, and other settings to apply to the purchase.

Table Specific Information

Select

The Sync App uses the Square API to process search criteria that refer to the Id column, while other filters are processed client side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will have an unfiltered response.

Retrieve all the orders in your Square account. Only orders that have been successfully charged are included in the response.

SELECT * FROM Orders

Specify multiple Ids in the WHERE clause using the IN operator:

SELECT * FROM Orders WHERE Id IN ('XKKB7LD30TpfNyW3e843ziklKh4vWEvweQyL5l4ESJLH3N2XXNBN8yqnf11qTrg3W3AelXC1kB','pxICohrEXPDtoUitiZhG1um5uhp5WI7CRMHknbuKpaj53PXfWNBN8yqnf11qTrg3W3AelXC1kB','6j8avtXB5fIaPZ9H12beiZP7sCSiqguGhHpwmECsEaENswJnWNBN8yqnf11qTrg3W3AelXC1kB')

Columns

Name	Type	Description
Id [KEY]	String	The order's unique ID.
ReferenceId	String	A client specified identifier to associate an entity in another system with this order.
LocationId	String	The Id of the location.
TaxesCatalogObjectId	String	Only used for catalog taxes. The catalog object ID of an existing CatalogTax.
TaxesName	String	Only used for ad hoc taxes. The tax's name. Do not provide a value for this field if you set catalogobjectid.
TaxesPercentage	String	Only used for ad hoc taxes. The percentage of the tax, as a string representation of a decimal number.
TaxesMoneyAmount	Integer	Only used for ad hoc discounts. The monetary amount of the discount.
TaxesMoneyCurrency	String	Only used for ad hoc discounts. The currency of the discount monetary amount.
DiscountsCatalogObjectId	String	Only used for catalog taxes. The catalog object ID from exsiting CatalogDiscount.
DiscountsName	String	Only used for ad hoc discounts. The discount's name.
DiscountsPercentage	String	Only used for ad hoc discounts. The percentage of the discount, as a string representation of a decimal number.
DiscountsMoneyAmount	Integer	Only used for ad hoc discounts. The monetary amount of the discount.
DiscountsMoneyCurrency	String	Only used for ad hoc discounts. The currency of the discount monetary amount.
TotalTaxMoney	Integer	The total tax amount of money to collect for this order.
TotalTaxMoneyCurrency	String	The currency of the total tax amount of money to collect for this order.
TotalDiscountMoneyAmount	Integer	The total discount amount of money to collect for this order.
TotalDiscountMoneyCurrency	String	The currency of the total discount amount of money to collect for this order.
TotalMoneyAmount	Integer	The total amount of money to collect for this order.
TotalMoneyCurrency	String	The currency of the total amount of money to collect for this order.
CreatedAt	Datetime	The time when the location was created, in RFC 3339 format.
UpdatedAt	Datetime	The time when the location was updated, in RFC 3339 format.

Query the available card Payments in Square. Cash and other tenders payments will not be returned.

Table Specific Information

Select

The following queries show the filters that are processed server side, while other filters are processed client side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will have an unfiltered response.

Retrieve all Payments:

SELECT * FROM Payments

Retrieve a single payment by providing a valid Id:

    SELECT * FROM Payments WHERE Id = '5xNDT7Sd6qFHsLyKlugpZIqeV'
   

Filter by the creation date of a Payment:

  SELECT * FROM Payments WHERE CreatedAt > '2015-08-15'
  SELECT * FROM Payments WHERE CreatedAt < '2015-08-15'
  

Columns

Name	Type	Description
Id [KEY]	String	The Id of the payment.
MoneyAmount	Int64	The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.
MoneyCurrency	String	The type of currency, in ISO 4217 format. For example, the currency code for US dollars is USD.
AppFeeMoneyAmount	Int64	The amount the developer is taking as a fee for facilitating the payment on behalf of the seller.
AppFeeMoneyCurrency	String	The type of currency, in ISO 4217 format. For example, the currency code for US dollars is USD.
ApprovedMoneyAmount	Int64	The initial amount of money approved for this payment. The amount the developer is taking as a fee for facilitating the payment on behalf of the seller.
ApprovedMoneyCurrency	String	The type of currency, in ISO 4217 format. For example, the currency code for US dollars is USD.
BankAccountOwnershipType	String	The ownership type of the bank account performing the transfer. 使用できる値は次のとおりです。INDIVIDUAL, COMPANY, UNKNOWN
ACHDetailsAccountNumberSuffix	String	The last few digits of the bank account number.
ACHDetailsAccountType	String	The type of the bank account performing the transfer. 使用できる値は次のとおりです。CHECKING, SAVINGS, UNKNOWN
ACHDetailsRoutingNumber	String	The routing number for the bank account.
BankName	String	The name of the bank associated with the bank account.
BankAccountCountry	String	The two-letter ISO code representing the country the bank account is located in.
BankAccountFingerprint	String	Uniquely identifies the bank account for this seller and can be used to determine if payments are from the same bank account.
BankAccountStatementDescription	String	The statement description as sent to the bank.
BankAccountTransferType	String	The type of the bank transfer. 使用できる値は次のとおりです。ACH, UNKNOWN
BillingAddressLine1	String	The first line of the address.
BillingAddressLine2	String	The second line of the address, if any.
BillingAddressLine3	String	The third line of the address, if any.
BillingAddressAdministrativeDistrictLevel1	String	A civil entity within the address's country. In the US, this is the state.
BillingAddressAdministrativeDistrictLevel2	String	A civil entity within the address's administrative_district_level_1. In the US, this is the county.
BillingAddressAdministrativeDistrictLevel3	String	A civil entity within the address's administrative_district_level_2, if any.
BillingAddressCountry	String	The address's country, in ISO 3166-1-alpha-2 format.
BillingAddressFirstName	String	Optional first name when it's representing recipient.
BillingAddressLastName	String	Optional last name when it's representing recipient.
BillingAddressLocality	String	The city or town of the address.
BillingAddressOrganization	String	Optional organization name when it's representing recipient.
BillingAddressPostalCode	String	The address's postal code.
BillingAddressSubLocality	String	A civil region within the address's locality, if any.
BillingAddressSubLocality2	String	A civil region within the address's sublocality, if any.
BillingAddressSubLocality3	String	A civil region within the address's sublocality_2, if any.
BuyerEmailAddress	String	The buyer's email address.
Capabilities	String	Actions that can be performed on this payment:EDIT_AMOUNT_UP,EDIT_AMOUNT_DOWN,EDIT_TIP_AMOUNT_UP,EDIT_TIP_AMOUNT_DOWN
CardDetailsApplicationCryptogram	String	For EMV payments, the cryptogram generated for the payment.
CardDetailsApplicationIdentifier	String	For EMV payments, the application ID identifies the EMV application used for the payment.
CardDetailsApplicationName	String	For EMV payments, the human-readable name of the EMV application used for the payment.
CardDetailsAuthResultCode	String	The status code returned by the card issuer that describes the payment's authorization status.
CardDetailsAverageStatus	String	The status code returned from the Address Verification System (AVS) check. 使用できる値は次のとおりです。AVS_ACCEPTED, AVS_REJECTED, AVS_NOT_CHECKED
CardId	String	Unique ID for this card. Generated by Square.
CardBillingAddressLine1	String	The first line of the address.
CardBillingAddressLine2	String	The second line of the address, if any.
CardBillingAddressLine3	String	The third line of the address, if any.
CardBillingAddressAdministrativeDistrictLevel1	String	A civil entity within the address's country. In the US, this is the state.
CardBillingAddressAdministrativeDistrictLevel2	String	A civil entity within the address's administrative_district_level_1. In the US, this is the county.
CardBillingAddressAdministrativeDistrictLevel3	String	A civil entity within the address's administrative_district_level_2, if any.
CardBillingAddressCountry	String	The address's country, in ISO 3166-1-alpha-2 format.
CardBillingAddressFirstName	String	Optional first name when it's representing recipient.
CardBillingAddressLastName	String	Optional last name when it's representing recipient.
CardBillingAddressLocality	String	The city or town of the address.
CardBillingAddressOrganization	String	Optional organization name when it's representing recipient.
CardBillingAddressPostalCode	String	The address's postal code.
CardBillingAddressSubLocality	String	A civil region within the address's locality, if any.
CardBillingAddressSubLocality2	String	A civil region within the address's sublocality, if any.
CardBillingAddressSubLocality3	String	A civil region within the address's sublocality_2, if any.
CardBin	String	The first six digits of the card number, known as the Bank Identification Number (BIN). Only the Payments API returns this field.
CardType	String	The type of the card. The Card object includes this field only in response to Payments API calls. 使用できる値は次のとおりです。UNKNOWN_CARD_TYPE, CREDIT, DEBIT
CardholderName	String	The name of the cardholder.
CardCustomerId	String	The ID of a customer created using the Customers API to be associated with the card.
CardEnabled	Boolean	Indicates whether or not a card can be used for payments.
CardExpiryMonth	Int64	The expiration month of the associated card as an integer between 1 and 12.
CardExpiryYear	Int64	The four-digit year of the card's expiration date.
CardFingerprint	String	Intended as a Square-assigned identifier, based on the card number, to identify the card across multiple locations within a single application.
CardLast4	String	The last 4 digits of the card number.
CardPrepaidType	String	Indicates whether the Card is prepaid or not. The Card object includes this field only in response to Payments API calls
CardReferenceId	String	An optional user-defined reference ID that associates this card with another entity in an external system.
CardVersion	Int64	Current version number of the card. Increments with each card update.
CardTimelineAuthorizedAt	Datetime	The timestamp when the payment was authorized, in RFC 3339 format.
CardTimelineCapturedAt	Datetime	The timestamp when the payment was captured, in RFC 3339 format.
CardTimelineVoidedAt	Datetime	The timestamp when the payment was voided, in RFC 3339 format.
CardCVVStatus	String	The status code returned from the Card Verification Value (CVV) check. 使用できる値は次のとおりです。CVV_ACCEPTED, CVV_REJECTED, CVV_NOT_CHECKED
CardDeviceId	String	The Square-issued ID of the device.
CardDeviceInstallationId	String	The Square-issued installation ID for the device.
CardDeviceName	String	The name of the device set by the seller.
CardEntryMethod	String	The method used to enter the card's details for the payment. 使用できる値は次のとおりです。KEYED, SWIPED, EMV, ON_FILE, CONTACTLESS
RefundRequiresCardPresence	Boolean	Whether the card must be physically present for the payment to be refunded. If set to true, the card must be present.
CardStatementDescription	String	The statement description sent to the card networks.
CardStatus	String	The card payment's current state. 使用できる値は次のとおりです。AUTHORIZED, CAPTURED, VOIDED, FAILED
CardVerificationMethod	String	For EMV payments, the method used to verify the cardholder's identity. 使用できる値は次のとおりです。PIN, SIGNATURE, PIN_AND_SIGNATURE, ON_DEVICE, NONE
CardVerificationResults	String	For EMV payments, the results of the cardholder verification. 使用できる値は次のとおりです。SUCCESS, FAILURE, UNKNOWN
CashBuyerSupplierMoneyAmount	Int64	The amount of money, in the smallest denomination of the currency indicated by currency.
CashBuyerSupplierMoneyCurrency	String	The type of currency, in ISO 4217 format. For example, the currency code for US dollars is USD.
CashChangeBackMoneyAmount	Int64	The amount of change due back to the buyer. This read-only field is calculated from the amount_money and buyer_supplied_money fields.
CashChangeBackMoneyCurrency	String	The type of currency, in ISO 4217 format. For example, the currency code for US dollars is USD.
CreatedAt	Datetime	The timestamp of when the payment was created, in RFC 3339 format.
CustomerId	String	The Customer ID of the customer associated with the payment.
DelayAction	String	The action to be applied to the payment when the delay_duration has elapsed.
DelayDuration	String	The duration of time after the payment's creation when Square automatically applies the delay_action to the payment.
DelayedUntil	Datetime	The timestamp of when the delay_action is automatically applied, in RFC 3339 format.
EmployeeId	String	An optional ID of the employee associated with taking the payment.
ExternalDetailsSource	String	A description of the external payment source. For example, 'Food Delivery Service'.
ExternalDetailsType	String	The type of external payment the seller received. 使用できる値は次のとおりです。CHECK, BANK_TRANSFER, OTHER_GIFT_CARD, CRYPTO, SQUARE_CASH, SOCIAL, EXTERNAL, EMONEY, CARD, STORED_BALANCE, OTHER
ExternalDetailsSourceFeeMoneyAmount	Int64	The fees paid to the source. The amount_money minus this field is the net amount seller receives.
ExternalDetailsSourceFeeMoneyCurrency	String	The type of currency, in ISO 4217 format. For example, the currency code for US dollars is USD.
ExternalDetailsSourceId	String	An ID to associate the payment to its originating source.
LocationId	String	The ID of the location associated with the payment.
Note	String	An optional note to include when creating a payment.
OrderId	String	The ID of the order associated with the payment.
ProcessingFee	String	The processing fees and fee adjustments assessed by Square for this payment.
ReceiptNumber	String	The payment's receipt number. The field is missing if a payment is canceled.
ReceiptURL	String	The URL for the payment's receipt. The field is only populated for COMPLETED payments.
ReferenceId	String	An optional ID that associates the payment with an entity in another system.
RefundIds	String	A list of refund_ids identifying refunds for the payment.
RefundedMoneyAmount	Int64	The total amount of the payment refunded to date.
RefundedMoneyCurrency	String	The type of currency, in ISO 4217 format. For example, the currency code for US dollars is USD.
RiskEvaluationCreatedAt	Datetime	Provides information about the risk associated with the payment, as determined by Square.
RiskEvaluationLevel	String	The risk level associated with the payment. 使用できる値は次のとおりです。PENDING, NORMAL, MODERATE, HIGH
ShippingAddressLine1	String	The first line of the address.
ShippingAddressLine2	String	The second line of the address, if any.
ShippingAddressLine3	String	The third line of the address, if any.
ShippingAddressAdministrativeDistrictLevel1	String	A civil entity within the address's country. In the US, this is the state.
ShippingAddressAdministrativeDistrictLevel2	String	A civil entity within the address's administrative_district_level_1. In the US, this is the county.
ShippingAddressAdministrativeDistrictLevel3	String	A civil entity within the address's administrative_district_level_2, if any.
ShippingAddressCountry	String	The address's country, in ISO 3166-1-alpha-2 format.
ShippingAddressFirstName	String	Optional first name when it's representing recipient.
ShippingAddressLastName	String	Optional last name when it's representing recipient.
ShippingAddressLocality	String	The city or town of the address.
ShippingAddressOrganization	String	Optional organization name when it's representing recipient.
ShippingAddressPostalCode	String	The address's postal code.
ShippingAddressSubLocality	String	A civil region within the address's locality, if any.
ShippingAddressSubLocality2	String	A civil region within the address's sublocality, if any.
ShippingAddressSubLocality3	String	A civil region within the address's sublocality_2, if any.
SourceType	String	The source type for this payment. 使用できる値は次のとおりです。CARD, BANK_ACCOUNT, CASH, EXTERNAL
StatementDescriptionIdentifier	String	Additional payment information that gets added to the customer's card statement as part of the statement description.
Status	String	Indicates whether the payment is APPROVED, PENDING, COMPLETED, CANCELED, or FAILED.
TipMoneyAmount	Int64	The amount designated as a tip.
TipMoneyCurrency	String	The type of currency, in ISO 4217 format. For example, the currency code for US dollars is USD.
TotalMoneyAmount	Int64	The total amount for the payment, including amount_money and tip_money.
TotalMoneyCurrency	String	The type of currency, in ISO 4217 format. For example, the currency code for US dollars is USD.
UpdatedAt	Datetime	The timestamp of when the payment was last updated, in RFC 3339 format.
VersionToken	String	Used for optimistic concurrency. This opaque token identifies a specific version of the Payment object.
TeamMemberId	String	An optional ID of the TeamMember associated with taking the payment. other:OutputName=

Query the available list of TeamMember for a business in Square.

Table Specific Information

Select

The Sync App uses the Square API to process search criteria that refer to the Id, LocationId and Status column, while other filters are processed client side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will have an unfiltered response.

Retrieve a specific team member:

SELECT * FROM Teams WHERE Id = '1ccaibDk3FapStf997Qi'

Retrieve the team member for a specific location:

SELECT * FROM Teams WHERE LocationId = ' 92BYHNBR6W77E'

Retrieve list of team members for specified locations:

SELECT * FROM Teams WHERE LocationId IN ('92BYHNBR6W77E', '92BYHNBR6W77EABCD', '92BYHNBR6W77EABCDEFGH')

Retrieve list of Active team members:

SELECT * FROM Teams WHERE Status = 'ACTIVE'

Retrieve list of Active team members in a given location:

SELECT * FROM Teams WHERE LocationId = '92BYHNBR6W77E' AND Status = 'ACTIVE'

Columns

Name	Type	Description
Id [KEY]	String	The Id of the team member.
FirstName	String	The first name of the team member.
LastName	String	The last name of the team member.
Email	String	The email address of the team member.
Status	String	Whether the team member is ACTIVE or INACTIVE. 使用できる値は次のとおりです。ACTIVE, INACTIVE
CreatedAt	Datetime	The time when the team member entity was created.
UpdatedAt	Datetime	The time when the team member entity was last updated.
PhoneNumber	String	The phone number of the team member.
ReferenceId	String	A second ID used to associate the team member with an entity in another system.
IsOwner	Boolean	Whether the team member is the owner of the Square account.
AssignmentType	String	The current assignment type of the team member.
LocationId	String	The locations that the team member is assigned to.

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

接続を確立する方法について詳しくは、接続の確立を参照してください。

Authentication

---

プロパティ	説明
LocationId	The Id of a business location that will be set as default.
UseSandbox	A boolean indicating whether you are using a Sandbox account. The provider makes requests to the production environment by default.

OAuth

---

プロパティ	説明
OAuthClientId	OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecret	OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
OAuthAccessToken	OAuth を使用して接続するためのアクセストークン。

SSL

---

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

Firewall

---

プロパティ	説明
FirewallType	プロキシベースのファイアウォールで使われるプロトコル。
FirewallServer	プロキシベースのファイアウォールの名前もしくはIP アドレス。
FirewallPort	プロキシベースのファイアウォールのTCP ポート。
FirewallUser	プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallPassword	プロキシベースのファイアウォールへの認証に使われるパスワード。

Proxy

---

プロパティ	説明
ProxyAutoDetect	これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
ProxyServer	HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
ProxyPort	ProxyServer プロキシが起動しているTCP ポート。
ProxyAuthScheme	ProxyServer プロキシへの認証で使われる認証タイプ。
ProxyUser	ProxyServer プロキシへの認証に使われるユーザー名。
ProxyPassword	ProxyServer プロキシへの認証に使われるパスワード。
ProxySSLType	ProxyServer プロキシへの接続時に使用するSSL タイプ。
ProxyExceptions	ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

Logging

---

プロパティ	説明
LogModules	ログファイルに含めるコアモジュール。

Schema

---

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
BrowsableSchemas	このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
Views	使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。
Schema	Specify the Square server version to connect with.

Miscellaneous

---

プロパティ	説明
MaxRows	クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
Other	これらの隠しプロパティは特定のユースケースでのみ使用されます。
PseudoColumns	このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UserDefinedViews	カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。

---

プロパティ	説明
LocationId	The Id of a business location that will be set as default.
UseSandbox	A boolean indicating whether you are using a Sandbox account. The provider makes requests to the production environment by default.

The Id of a business location that will be set as default.

解説

The Id of one of your business locations that will be set as default. This can also be set in the search criteria of the query. A value set in the query overrides the value set in this connection property. You can retrieve the Ids for your Locations by querying the Locations table.

A boolean indicating whether you are using a Sandbox account. The provider makes requests to the production environment by default.

解説

If you are using a production account, this property can be left blank.

このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。

---

プロパティ	説明
OAuthClientId	OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecret	OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
OAuthAccessToken	OAuth を使用して接続するためのアクセストークン。

OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。

解説

OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId 値、およびクライアントシークレットOAuthClientSecret が提供されます。

OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。

解説

OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId が提供されます。また、コンシューマーシークレットと呼ばれるクライアントシークレットも提供されます。クライアントシークレットをOAuthClientSecret プロパティに設定します。

OAuth を使用して接続するためのアクセストークン。

解説

OAuth を使用して接続するには、OAuthAccessToken プロパティが使用されます。認証プロセスにおいてOAuth サーバーからOAuthAccessToken が取得されます。このプロパティは、サーバーに依存するタイムアウトがあり、要求の間で再利用することができます。

アクセストークンは、ユーザー名とパスワードの代わりに使用されます。サーバー上で維持することで、認証情報が保護されます。

このセクションでは、本プロバイダーの接続文字列で設定可能な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	プロキシベースのファイアウォールで使われるプロトコル。
FirewallServer	プロキシベースのファイアウォールの名前もしくはIP アドレス。
FirewallPort	プロキシベースのファイアウォールのTCP ポート。
FirewallUser	プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallPassword	プロキシベースのファイアウォールへの認証に使われるパスワード。

プロキシベースのファイアウォールで使われるプロトコル。

解説

このプロパティは、Sync App がFirewallServer プロキシ経由でトンネルトラフィックを使うためのプロトコルを指定します。デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し次のプロキシタイプのどれかで接続するには、ProxyAutoDetect をfalse に設定します。

タイプ	デフォルトポート	説明
TUNNEL	80	これが設定されている場合、Sync App はSquare への接続を開き、プロキシを経由して通信が行われます。
SOCKS4	1080	これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 4 プロキシ経由で送信し、接続リクエストが許容されるかどうかを決定します。
SOCKS5	1080	これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 5 プロキシ経由で送信します。プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。

HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。

プロキシベースのファイアウォールの名前もしくはIP アドレス。

解説

ファイアウォールトラバーサルを許容するために設定するIP アドレス、DNS 名、もしくはプロキシホスト名を指定するプロパティです。プロトコルはFirewallType で指定されます。このプロパティとFirewallServer を使って、SOCKS 経由での接続、もしくはトンネリングが可能です。HTTP プロキシへの接続には、ProxyServer を使用します。

Sync App はデフォルトでシステムプロキシを使うので注意してください。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定してください。

プロキシベースのファイアウォールのTCP ポート。

解説

ファイアウォールトラバーサルを許容するために設定するプロキシベースのファイアウォールのTCP ポート。名前もしくはIP アドレスを指定するには、FirewallServer を使います。FirewallType でプロトコルを指定します。

プロキシベースのファイアウォールに認証するために使うユーザー名。

解説

FirewallUser およびFirewallPassword プロパティは、FirewallType により指定された認証方式に則り、FirewallServer、およびFirewallPort で指定されたプロキシに対しての認証に使われます。

プロキシベースのファイアウォールへの認証に使われるパスワード。

解説

このプロパティは、FirewallType により指定された認証メソッドに則り、FirewallServer およびFirewallPort で指定されたプロキシに渡されます。

このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。

---

プロパティ	説明
ProxyAutoDetect	これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
ProxyServer	HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
ProxyPort	ProxyServer プロキシが起動しているTCP ポート。
ProxyAuthScheme	ProxyServer プロキシへの認証で使われる認証タイプ。
ProxyUser	ProxyServer プロキシへの認証に使われるユーザー名。
ProxyPassword	ProxyServer プロキシへの認証に使われるパスワード。
ProxySSLType	ProxyServer プロキシへの接続時に使用するSSL タイプ。
ProxyExceptions	ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。

解説

これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。

HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。

HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。

解説

HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。HTTP プロキシへの認証には、Sync App はHTTP、Windows(NTLM)、もしくはKerberos 認証タイプを使用することができます。

SOCKS プロキシを経由して接続する、もしくは接続をトンネルするには、FirewallType を参照してください。

デフォルトで、Sync App はsystem プロキシを使います。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定します。

ProxyServer プロキシが起動しているTCP ポート。

解説

HTTP トラフィックをリダイレクトするHTTP プロキシが実行されているポート。ProxyServer でHTTP プロキシを指定します。その他のプロキシタイプについては、FirewallType を参照してください。

ProxyServer プロキシへの認証で使われる認証タイプ。

解説

この値は、ProxyServer およびProxyPort で指定されるHTTP プロキシに認証するために使われる認証タイプを指定します。

Sync App は、デフォルトでsystem proxy settings を使い、追加での設定が不要です。他のプロキシへの接続をする場合には、ProxyServer およびProxyPort に加え、ProxyAutoDetect をfalse に設定します。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。

認証タイプは、次のどれかになります。

• BASIC： Sync App はHTTP BASIC 認証を行います。
• DIGEST： Sync App はHTTP DIGEST 認証を行います。
• NEGOTIATE： Sync App は認証において有効なプロトコルに応じて、NTLM もしくはKereros トークンを取得します。
• PROPRIETARY： Sync App はNTLM もしくはKerberos トークンを発行しません。このトークンを、HTTP リクエストのAuthorization ヘッダーに含める必要があります。

SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。

ProxyServer プロキシへの認証に使われるユーザー名。

解説

ProxyUser および ProxyPassword オプションは、ProxyServer で指定されたHTTP プロキシに対して接続および認証するために使用されます。

ProxyAuthScheme で使用可能な認証タイプを選択することができます。HTTP 認証を使う場合、これをHTTP プロキシで識別可能なユーザーのユーザー名に設定します。Windows もしくはKerberos 認証を使用する場合、このプロパティを次の形式のどれかでユーザー名に設定します。

user@domain
domain\user

ProxyServer プロキシへの認証に使われるパスワード。

解説

このプロパティは、NTLM(Windows)、Kerberos、もしくはHTTP 認証をサポートするHTTP プロキシサーバーに認証するために使われます。HTTP プロキシを指定するためには、ProxyServer およびProxyPort を設定します。認証タイプを指定するためにはProxyAuthScheme を設定します。

HTTP 認証を使う場合、さらにHTTP プロキシにProxyUser およびProxyPassword を設定します。

NTLM 認証を使う場合、Windows パスワードにProxyUser およびProxyPassword を設定します。Kerberos 認証には、これらを入力する必要があります。

SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。

デフォルトで、Sync App はsystem プロキシを使います。他のプロキシに接続する場合には、これをfalse に設定します。

ProxyServer プロキシへの接続時に使用するSSL タイプ。

解説

このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この値は、AUTO、ALWAYS、NEVER、TUNNEL のいずれかです。有効な値は次のとおりです。

AUTO	デフォルト設定。URL がHTTPS URL の場合、Sync App は、TUNNEL オプションを使います。URL がHTTP URL の場合、コンポーネントはNEVER オプションを使います。
ALWAYS	接続は、常にSSL 有効となります。
NEVER	接続は、SSL 有効になりません。
TUNNEL	接続は、トンネリングプロキシを経由します。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。

ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

解説

ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。

Sync App は、追加設定なしにデフォルトでシステムのプロキシ設定を使います。この接続のプロキシ例外を明示的に構成するには、ProxyAutoDetect をfalse に設定して、ProxyServer およびProxyPort を設定する必要があります。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。

---

プロパティ	説明
LogModules	ログファイルに含めるコアモジュール。

ログファイルに含めるコアモジュール。

解説

指定された（';' で区切られた）モジュールのみがログファイルに含まれます。デフォルトではすべてのモジュールが含まれます。

概要はログ ページを参照してください。

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。

---

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
BrowsableSchemas	このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
Views	使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。
Schema	Specify the Square server version to connect with.

テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。

解説

Sync App のスキーマファイル（テーブルとビューの場合は.rsd ファイル、ストアドプロシージャの場合は.rsb ファイル）を含むディレクトリへのパス。このフォルダの場所は、実行ファイルの場所からの相対パスにすることができます。Location プロパティは、定義をカスタマイズしたり（例えば、カラム名を変更する、カラムを無視するなど）、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。

Note： このSync App は複数のスキーマをサポートするため、Square カスタムスキーマファイルの構造は以下のようになります。

• 各スキーマには、そのスキーマ名に対応するフォルダが作られます。
• これらのスキーマフォルダは親フォルダに含まれています。
• 親フォルダは、個々のスキーマのフォルダではなく、Location として設定する必要があります。

指定しない場合、デフォルトの場所は"%APPDATA%\\CData\\Square Data Provider\\Schema" となり、%APPDATA% はユーザーのコンフィギュレーションディレクトリに設定されます：

このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

解説

スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、 パフォーマンスが向上します。

このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。

解説

テーブルを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でテーブルのリストを提供すると、Sync App のパフォーマンスが向上します。

このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。

カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。

複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。

使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

解説

ビューを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でビューのリストを提供すると、Sync App のパフォーマンスが向上します。

このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。

カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。

複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。

Specify the Square server version to connect with.

解説

Set this property to v1 to use the Square Connect API v1 or v2 to use the Square Connect API v2.

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。

---

プロパティ	説明
MaxRows	クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
Other	これらの隠しプロパティは特定のユースケースでのみ使用されます。
PseudoColumns	このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UserDefinedViews	カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。

解説

クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。

これらの隠しプロパティは特定のユースケースでのみ使用されます。

解説

以下にリストされているプロパティは、特定のユースケースで使用可能です。通常のドライバーのユースケースおよび機能では、これらのプロパティは必要ありません。

複数のプロパティをセミコロン区切りリストで指定します。

統合およびフォーマット

DefaultColumnSize	データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。
ConvertDateTimeToGMT	日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。
RecordToFile=filename	基底のソケットデータ転送を指定のファイルに記録します。

このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。

解説

Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。

タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。

解説

Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。

Timeout の有効期限が切れても処理が完了していない場合は、Sync App は例外をスローします。

カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

解説

ユーザー定義ビューは、UserDefinedViews.json というJSON 形式のコンフィギュレーションファイルで定義されています。Sync App は、このファイルで指定されたビューを自動的に検出します。

また、複数のビュー定義を持ち、UserDefinedViews 接続プロパティを使用して制御することも可能です。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。

このユーザー定義ビューのコンフィギュレーションファイルは、次のようにフォーマットされています。

• 各ルートエレメントはビューの名前を定義します。
• 各ルートエレメントには、query と呼ばれる子エレメントが含まれており、この子エレメントにはビューのカスタムSQL クエリが含まれています。

次に例を示します。

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

UserDefinedViews 接続プロパティを使用して、JSON コンフィギュレーションファイルの場所を指定します。次に例を示します。

"UserDefinedViews", "C:\\Users\\yourusername\\Desktop\\tmp\\UserDefinedViews.json"