Getting Started

This page provides a guide to Establishing a Connection to Square in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.

Connecting to Square

Establishing a Connection shows how to authenticate to Square and configure any necessary connection properties to create a database in CData Cloud

Accessing Data from CData Cloud Services

Accessing data from Square through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.

Establishing a Connection

Connect to Square by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.

Connecting to Square

Square provides two different ways to connect:

Via personal acess token -- to connect to your own data or test data through the sandbox.
Via OAuth -- to connect to shared Square data over a browser.

Both of the above methods make use of OAuth functionality that is embedded in the CData Square driver.

Before You Connect

Set the OAuthAccessToken connection property as described below, for the way you want to access data.
Set the LocationId property to specify a default business location.

Personal Access Token

To connect to personal data, obtain your personal access token, then set the OAuthAccessToken connection property to that token:

Navigate to the Square Developer Dashboard at "https://developer.squareup.com/apps".
After the app is created, open the Credentials tab to find the personal token.

Square Sandbox

Version 2 of the Connect API permits you to test in a sandbox environment. Transactions created in the sandbox are not sent through to card networks, and cards are never charged.

To connect to the sandbox, obtain the sandbox access token, then set the OAuthAccessToken connection property to that token:

Navigate to the Square Developer Dashboard at "https://developer.squareup.com/apps".
After the app is created, open the Credentials tab to find the sandbox token.

OAuth

service; supports OAuth authentication only. To enable this authentication from all OAuth flows, you must set AuthScheme to OAuth.

The following subsections describe how to authenticate to Square from three common authentication flows:

Desktop: a connection to a server on the user's local machine, frequently used for testing and prototyping. Authenticated via either embedded OAuth or custom OAuth.
Web: access to data via a shared website. Authenticated via custom OAuth only.
Headless Server: a dedicated computer that provides services to other computers and their users, which is configured to operate without a monitor and keyboard. Authenticated via embedded OAuth or custom OAuth.

For information about how to create a custom OAuth application, and why you might want to create one even for auth flows that have embedded OAuth credentials, see Creating a Custom OAuth Application.

For a complete list of connection string properties available in Square, see Connection.

When the access token expires, the Cloud refreshes it automatically.

Automatic refresh of the OAuth access token:

To have the Cloud automatically refresh the OAuth access token, do the following:

The first time you connect to data, set the following connection parameters:
- InitiateOAuth = REFRESH.
- OAuthClientId = the client Id in your application settings.
- OAuthClientSecret = the client secret in your application settings.
- OAuthAccessToken = the access token returned by GetOAuthAccessToken.
- OAuthSettingsLocation = the path where you want the Cloud to save the OAuth values, which persist across connections.
On subsequent data connections, set the following:
- InitiateOAuth
- OAuthSettingsLocation

Manual refresh of the OAuth Access Token:

The only value needed to manually refresh the OAUth access token is the OAuth refresh token.

To manually refresh the OAuthAccessToken after the ExpiresIn period (returned by GetOAuthAccessToken) has elapsed, call the GetOAuthAccessToken stored procedure.
Set the following connection properties:
- OAuthClientId = the Client Id in your application settings.
- OAuthClientSecret = the Client Secret in your application settings.
Call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken.
After the new tokens have been retrieved, set the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken. This opens a new connection.

Store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.

Post-Authentication Options

After you authenticate to Square, you can retrieve the Locations table, then set the LocationId to confine your search criteria to a chosen location.

SSL Configuration

Customizing the SSL Configuration

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

To specify another certificate, see the SSLServerCert connection property.

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

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

Other Proxies

Set the following properties:

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

Data Model

The CData Cloud 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 Data Model and Square v2 Data Model.

Using Query Processing

The Cloud offloads as much of the SELECT statement processing as possible to the Square APIs and then processes the rest of the query within the Cloud. The following sections document API limitations, requirements, or particularities.

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')

Square v1 Data Model

This section documents the Stored Procedures available to connect to the Square v1 APIs.

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with Square.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Square, along with an indication of whether the procedure succeeded or failed.

CData Cloud - Square Stored Procedures


Name	Description
ApplyFeeToItem	Apply a Fee to an Item.
RemoveFeeFromItem	Remove a Fee from an Item.

ApplyFeeToItem

Apply a Fee to an Item.

Input


Name	Type	Required	Description
ItemId	String	True	The item Id the fee will be applied to.
FeeId	String	True	The fee Id that will be applied to the item.

Result Set Columns


Name	Type	Description
Result	String	Whether the fee was applied successfully.

RemoveFeeFromItem

Remove a Fee from an Item.

Input


Name	Type	Required	Description
ItemId	String	True	The Id of the item the fee will be removed from.
FeeId	String	True	The Id of the fee that will be removed from the item.

Result Set Columns


Name	Type	Description
Result	String	The Id of the item with the fee removed.

Square v2 Data Model

This section documents the Tables, Views, and Stored Procedures available to connect to the Square v2 aPIs.

Tables

The Cloud models the data in Square as a list of tables in a relational database that can be queried using standard SQL statements.

CData Cloud - Square Tables


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.
CustomerGroups	Retrieves, creates, updates, deletes customer groups of a business.
Customers	Create, update, delete, and query the available customers in Square.
DeviceCodes	Creates and lists DeviceCode that can be used to login to a Square Terminal device to enter the connected terminal mode.
GiftCardActivities	Creates and lists gift card activities.
GiftCards	Lists, creates, and updates gift cards.
InventoryChanges	Query historical physical counts and adjustments on inventory items.
Invoices	Create, configure, and publish invoices for orders that were created.
Locations	Query Location information for a Merchant.
PaymentLinks	Lists, Creates, Updates, Deletes payment links.
Payments	Query the available card Payments in Square. Cash and other tenders payments will not be returned.
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.
Shifts	Create, update, delete, and query the available shifts in Square..
Subscriptions	Create and manage subscriptions.
Teams	Query the available list of TeamMember for a business in Square.

Cards

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

Table Specific Information

Select

The Cloud uses the Square API to process search criteria , while other filters are processed client side within the Cloud.

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	Int64	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().
CardCoBrand	String	True	Current version number of the card.
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, if any.
BillingAddressSubLocality2	String	False	A civil region within the address's sublocality, if any.
BillingAddressSubLocality3	String	False	A civil region within the address's sublocality_2, if any.

CatalogCategories

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	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.
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.
CreatedAt	Datetime	True	Created timestamp.
CategoryIsTopLevel	Boolean	False	Is Top Level.
CatalogV1Ids	String	True	The Connect v1 IDs for this object at each location where it is present, where they differ from the object's Connect V2 ID.

CatalogDiscounts

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	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.
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.
CreatedAt	Datetime	True	Created timestamp.
CatalogV1Ids	String	True	The Connect v1 IDs for this object at each location where it is present, where they differ from the object's Connect V2 ID.

CatalogImages

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	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.
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.
CreatedAt	Datetime	True	Created timestamp.

CatalogItems

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	Datetime	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
Variations	String	False	It represents a product for sale in the Catalog object model. While updating, provide the whole Variations aggregate object otherwise it will override with the new value.
CreatedAt	Datetime	True	Created timestamp.
CatalogV1Ids	String	True	The Connect v1 IDs for this object at each location where it is present, where they differ from the object's Connect V2 ID.
Channels	String	True	A list of IDs representing channels, such as a Square Online site, where the item can be made visible or available.
EcomAvailable	Boolean	False	Availabilty for Ecom.
EcomImageURIs	String	True	Ecom Image URIs
EcomVisibility	String	True	Ecom Visibility
IsTaxable	Boolean	False	Indicates whether the item is taxable (true) or non-taxable (false).
Visibility	String	False	Visibility for the item.

CatalogItemVariations

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	Datetime	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.
Type	String	False	The item variation's type.
CreatedAt	Datetime	True	Created timestamp.
CatalogV1Ids	String	True	The Connect v1 IDs for this object at each location where it is present, where they differ from the object's Connect V2 ID.
Channels	String	True	A list of IDs representing channels, such as a Square Online site, where the item can be made visible or available.

CatalogModifierLists

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.
CreatedAt	Datetime	True	Created timestamp.
CatalogV1Ids	String	True	The Connect v1 IDs for this object at each location where it is present, where they differ from the object's Connect V2 ID.

CatalogModifiers

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	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.
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.
CreatedAt	Datetime	True	Created timestamp.
CatalogV1Ids	String	True	The Connect v1 IDs for this object at each location where it is present, where they differ from the object's Connect V2 ID.
OnByDefault	Boolean	False	If true, this CatalogModifier should be selected by default for this CatalogItem.
Ordinal	Integer	True	The position of this CatalogItemModifierListInfo object within the modifier_list_info list applied to a CatalogItem instance

Pseudo-Columns

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


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

CatalogTaxes

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	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.
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.
CreatedAt	Datetime	True	Created timestamp.
CatalogV1Ids	String	True	The Connect v1 IDs for this object at each location where it is present, where they differ from the object's Connect V2 ID.

CustomerGroups

Retrieves, creates, updates, deletes customer groups of a business.

Table Specific Information

Select

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

Retrieve all CustomerGroups.

SELECT * from CustomerGroups

Retrieve a specific customer group as identified by the Id column.

SELECT * from CustomerGroups where id = '6Q87X9N44ACHCSX1NJSEQMAVAJ'

Insert

To create a customer group, you will need to specify the name value of the group.

INSERT INTO CustomerGroups(Name) values('TestName')

Update

Modify the details of an existing Customer group by providing the Id of the Customer group.

UPDATE CustomerGroups SET Name = 'Name@01' where id = '6Q87X9N44ACHCSX1NJSEQMAVAJ'

Delete

Delete a customer group by providing the Id of the customer group.

DELETE from CustomerGroups where id = '2T3JZYXKYBV2YN48JSNXPKFAQF'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	A unique Square-generated ID for the customer group.
Name	String	False	The name of the customer group.
CreatedAt	Datetime	True	The timestamp when the customer group was created, in RFC 3339 format.
UpdatedAt	Datetime	True	The timestamp when the customer group was last updated, in RFC 3339 format.

Customers

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

Table Specific Information

Select

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

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	String	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.
CreationSource	String	True	The method used to create the customer profile.
GroupIds	String	True	The IDs of customer groups the customer belongs to.
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.
TaxIds	String	True	The tax ID associated with the customer profile.

DeviceCodes

Creates and lists DeviceCode that can be used to login to a Square Terminal device to enter the connected terminal mode.

Table Specific Information

Select

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

Retrieve all DeviceCodes associated with the merchant.

SELECT * from DeviceCodes

Retrieve a DeviceCode with the associated ID.

SELECT * from DeviceCodes where id = 'E4RB0XKDX01A1'

Insert

To create a device code, you will need to specify the targeting product type of the device code.

INSERT INTO DeviceCodes(ProductType, Name) Values('TERMINAL_API','TestName@001')

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	The unique id for this device code.
Name	String	False	An optional user-defined name for the device code.
Code	String	True	The unique code that can be used to login.
DeviceId	String	True	The unique id of the device that used this code. Populated when the device is paired up.
ProductType	String	False	The targeting product type of the device code.
LocationId	String	False	The location assigned to this code.
PairBy	String	True	When this DeviceCode will expire and no longer login. Timestamp in RFC 3339 format.
CreatedAt	String	True	When this DeviceCode was created. Timestamp in RFC 3339 format.
StatusChangedAt	String	True	When this DeviceCode's status was last changed. Timestamp in RFC 3339 format.
PairedAt	String	True	When this DeviceCode was paired. Timestamp in RFC 3339 format.
Status	String	True	The pairing status of the device code.

GiftCardActivities

Creates and lists gift card activities.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	The Square-assigned ID of the gift card activity.
Type	String	False	The type of gift card activity.
LocationId	String	False	The ID of the business location where the activity occurred.
GiftCardId	String	False	The gift card ID. When creating a gift card activity, gift_card_id is not required if gift_card_gan is specified.
GiftCardAccountNumber	String	False	The gift card account number (GAN). When creating a gift card activity, gift_card_gan is not required if gift_card_id is specified.
GiftCardBalanceMoneyAmount	Int64	True	The final balance amount on the gift card after the action is completed.
GiftCardBalanceMoneyCurrency	String	True	The type of balance amount currency, in ISO 4217 format.
CreatedAt	Datetime	True	The timestamp when the gift card activity was created, in RFC 3339 format.
GiftCardActivityLoadMoneyAmount	Int64	False	The amount of money added to the gift card. This value is a positive integer.
GiftCardActivityLoadMoneyCurrency	String	False	The type of currency, in ISO 4217 format.
GiftCardActivityLoadOrderId	String	False	The ID of the order that contains the GIFT_CARD line item.
GiftCardActivityLoadLineItemUid	String	False	The UID of the GIFT_CARD line item in the order that represents the additional funds for the gift card.
GiftCardActivityLoadReferenceId	String	False	A client-specified ID that associates the gift card activity with an entity in another system.
GiftCardActivityLoadBuyerPaymentInstrumentIds	String	False	The payment instrument IDs used to process the order for the additional funds, such as a credit card ID or bank account ID.
GiftCardActivityActivateMoneyAmount	Int64	False	The amount of money added to the gift card. This value is a positive integer.
GiftCardActivityActivateMoneyCurrency	String	False	The type of currency, in ISO 4217 format.
GiftCardActivityActivateOrderId	String	False	The ID of the order that contains the GIFT_CARD line item.
GiftCardActivityActivateLineItemUid	String	False	The UID of the GIFT_CARD line item in the order that represents the gift card purchase.
GiftCardActivityActivateReferenceId	String	False	A client-specified ID that associates the gift card activity with an entity in another system.
GiftCardActivityActivateBuyerPaymentInstrumentIds	String	False	The payment instrument IDs used to process the gift card purchase, such as a credit card ID or bank account ID.
GiftCardActivityRedeemMoneyAmount	Int64	False	The amount of money deducted from the gift card for the redemption. This value is a positive integer.
GiftCardActivityRedeemMoneyCurrency	String	False	The type of currency, in ISO 4217 format.
GiftCardActivityRedeemMoneyPaymentId	String	False	The ID of the payment that represents the gift card redemption.
GiftCardActivityRedeemMoneyReferenceId	String	False	A client-specified ID that associates the gift card activity with an entity in another system.
GiftCardActivityRedeemMoneyStatus	String	False	The status of the gift card redemption.
GiftCardActivityClearBalanceReason	String	False	The reason the gift card balance was cleared.
GiftCardActivityDeactivateReason	String	False	The reason the gift card was deactivated.
GiftCardActivityAdjustIncrementMoneyAmount	Int64	False	The amount of money added to the gift card balance. This value is a positive integer.
GiftCardActivityAdjustIncrementMoneyCurrency	String	False	The type of currency, in ISO 4217 format.
GiftCardActivityAdjustIncrementReason	String	False	The reason the gift card balance was adjusted.
GiftCardActivityAdjustDecrementMoneyAmount	Int64	False	The amount of money deducted from the gift card balance. This value is a positive integer.
GiftCardActivityAdjustDecrementMoneyCurrency	String	False	The type of currency, in ISO 4217 format.
GiftCardActivityAdjustDecrementReason	String	False	The reason the gift card balance was adjusted.
GiftCardActivityRefundRedeemActivityId	String	False	The ID of the refunded REDEEM gift card activity.
GiftCardActivityRefundMoneyAmount	Int64	False	The amount of money added to the gift card for the refund. This value is a positive integer.
GiftCardActivityRefundMoneyCurrency	String	False	The type of currency, in ISO 4217 format.
GiftCardActivityRefundReferenceId	String	False	A client-specified ID that associates the gift card activity with an entity in another system.
GiftCardActivityRefundPaymentId	String	False	The ID of the refunded payment.
GiftCardActivityUnlinkedActivityRefundMoneyAmount	Int64	False	The amount added to the gift card for the refund. This value is a positive integer.
GiftCardActivityUnlinkedActivityRefundMoneyCurrency	String	False	The type of currency, in ISO 4217 format.
GiftCardActivityUnlinkedActivityRefundReferenceId	String	False	A client-specified ID that associates the gift card activity with an entity in another system.
GiftCardActivityUnlinkedActivityRefundPaymentId	String	False	The ID of the refunded payment.
GiftCardActivityImportMoneyAmount	Int64	False	The balance amount on the imported gift card.
GiftCardActivityImportMoneyCurrency	String	False	The type of currency, in ISO 4217 format.
GiftCardActivityBlockReason	String	False	The reason the gift card was blocked.
GiftCardActivityUnblockReason	String	False	The reason the gift card was unblocked.
GiftCardActivityImportReversalMoneyAmount	Int64	False	The amount of money cleared from the third-party gift card when the import was reversed.
GiftCardActivityImportReversalMoneyCurrency	String	False	The type of currency, in ISO 4217 format.
GiftCardActivityTransferBalanceToTransferFromGiftCardId	String	False	The ID of the gift card from which the specified amount was transferred.
GiftCardActivityTransferBalanceToMoneyAmount	Int64	False	The amount of money added to the gift card balance for the transfer. This value is a positive integer.
GiftCardActivityTransferBalanceToMoneyCurrency	String	False	The type of currency, in ISO 4217 format.
GiftCardActivityTransferBalanceFromTransferToGiftCardId	String	False	The ID of the gift card to which the specified amount was transferred.
GiftCardActivityTransferBalanceFromMoneyAmount	Int64	False	The amount of money deducted from the gift card for the transfer. This value is a positive integer.
GiftCardActivityTransferBalanceFromMoneyCurrency	String	False	The type of currency, in ISO 4217 format.

GiftCards

Lists, creates, and updates gift cards.

Table Specific Information

Select

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

Retrieve all GiftCards.

SELECT * from GiftCards

Retrieve a gift card using the gift card ID.

SELECT * from GiftCards where id = 'gftc:3c0c38e043a742c58431e3cca603c5b9'

Insert

To create a gift card, you will need to specify the LocationId and gift card type. LocationId is a pseudo column used only while creating new gift card.

INSERT INTO GiftCards(LocationId, Type) VALUES('92BYHNBR6W77E','DIGITAL')

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	The Square-assigned ID of the gift card.
Type	String	False	The gift card type.
GiftCardAccountNumberSource	String	False	The source that generated the gift card account number (GAN). The default value is SQUARE.
State	String	True	The current gift card state.
BalanceMoneyAmount	Int64	True	The current gift card balance amount. This balance is always greater than or equal to zero.
BalanceMoneyCurrency	String	True	The type of balance amount currency, in ISO 4217 format.
GiftCardAccountNumber	String	False	The gift card account number (GAN). Buyers can use the GAN to make purchases or check the gift card balance.
CreatedAt	Datetime	True	The timestamp when the gift card was created, in RFC 3339 format. In the case of a digital gift card, it is the time when you create a card (using the Square Point of Sale application, Seller Dashboard, or Gift Cards API).
CustomerIds	String	True	The IDs of the customer profiles to whom this gift card is linked.

Pseudo-Columns

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


Name	Type	Description
LocationId	String	The ID of the location where the gift card should be registered for reporting purposes.

InventoryChanges

Query historical physical counts and adjustments on inventory items.

Table Specific Information

Select

The Cloud 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 Cloud.

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. The allowed values are 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.

Invoices

Create, configure, and publish invoices for orders that were created.

Table Specific Information

Select

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

Retrieve all invoices from a location specified in the filter.

SELECT * from Invoices where locationid = '92BYHNBR6W77E'

Retrieve an invoice by invoice ID.

SELECT * from Invoices where id = 'inv:0-ChCEwgC9pIyJcHaTpPUDOxHLEL0M'

Insert

To create a draft invoice for an order, you will need to specify OrderId, DeliveryMethod columns and PaymentRequests pseudo columns.

INSERT INTO Invoices(OrderId,AcceptedPaymentMethodCashAppPay,DeliveryMethod,PaymentRequestsRequestType,PaymentRequestsDueDate) VALUES('ASXK4JVIMPx33BTJ2iLEzaTXwxZZY',true,'EMAIL','BALANCE','2024-10-12')

Update

To update an invoice, you will need to set current version number of the invoice in the query.

UPDATE Invoices SET Title = 'Testing@001', Version = 7 where id = 'inv:0-ChC4p4-kE0gkhzWD2-NPhXiuEL0M'

Delete

Delete the specified invoice.

DELETE from invoices where id = 'inv:0-ChCFV-a1tLofCBvdpj5UA4qgEL0M'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	The Square-assigned ID of the invoice.
Version	Int32	False	The Square-assigned version number, which is incremented each time an update is committed to the invoice.
LocationId	String	False	The ID of the location that this invoice is associated with.
OrderId	String	False	The ID of the order for which the invoice is created.
PrimaryRecipientCustomerId	String	False	TThe ID of the customer who receives the invoice.
PrimaryRecipientGivenName	String	True	The recipient's given (that is, first) name.
PrimaryRecipientFamilyName	String	True	The recipient's family (that is, last) name.
PrimaryRecipientEmail	String	True	The recipient's email address.
PrimaryRecipientAddress	String	True	The recipient's physical address.
PrimaryRecipientPhoneNumber	String	True	The recipient's phone number.
PrimaryRecipientCompanyName	String	True	The name of the recipient's company.
PrimaryRecipientTaxIds	String	True	The recipient's tax IDs. The country of the seller account determines whether this field is available for the customer.
PaymentRequests	String	False	The payment schedule for the invoice, represented by one or more payment requests that define payment settings, such as amount due and due date.
DeliveryMethod	String	False	The delivery method that Square uses to send the invoice, reminders, and receipts to the customer.
InvoiceNumber	String	False	A user-friendly invoice number that is displayed on the invoice. The value is unique within a location.
Title	String	False	The title of the invoice, which is displayed on the invoice.
Description	String	False	The description of the invoice, which is displayed on the invoice.
ScheduledAt	Datetime	False	The timestamp when the invoice is scheduled for processing, in RFC 3339 format.
PublicUrl	String	True	The URL of the Square-hosted invoice page.
NextPaymentMoneyAmount	Int64	True	The current amount due for the invoice. In addition to the amount due on the next payment request, this includes any overdue payment amounts.
NextPaymentMoneyCurrency	String	True	The type of currency of the current amount due for the invoice, in ISO 4217 format.
Status	String	True	The status of the invoice.
Timezone	String	True	The time zone used to interpret calendar dates on the invoice, such as due_date. When an invoice is created, this field is set to the timezone specified for the seller location. The value cannot be changed.
CreatedAt	Datetime	True	The timestamp when the invoice was created, in RFC 3339 format.
UpdatedAt	Datetime	True	The timestamp when the invoice was last updated, in RFC 3339 format.
AcceptedPaymentMethodCard	Boolean	False	Indicates whether credit card or debit card payments are accepted.
AcceptedPaymentMethodSquareGiftCard	Boolean	False	Indicates whether Square gift card payments are accepted.
AcceptedPaymentMethodBankAccount	Boolean	False	Indicates whether ACH bank transfer payments are accepted.
AcceptedPaymentMethodBuyNowPayLater	Boolean	False	Indicates whether Afterpay (also known as Clearpay) payments are accepted.
AcceptedPaymentMethodCashAppPay	Boolean	False	Indicates whether Cash App payments are accepted.
CustomFields	String	False	Additional seller-defined fields that are displayed on the invoice.
SubscriptionId	String	True	The ID of the subscription associated with the invoice.
SaleOrServiceDate	Datetime	False	The date of the sale or the date that the service is rendered, in YYYY-MM-DD format.
PaymentConditions	String	False	France only. The payment terms and conditions that are displayed on the invoice. For countries other than France, Square returns an INVALID_REQUEST_ERROR with a BAD_REQUEST code.
StorePaymentMethodEnabled	Boolean	False	Indicates whether to allow a customer to save a credit or debit card as a card on file or a bank transfer as a bank account on file.
Attachments	String	True	Metadata about the attachments on the invoice.

Pseudo-Columns

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


Name	Type	Description
PaymentRequestsRequestType	String	Identifies the payment request type. This type defines how the payment request amount is determined. The allowed values are BALANCE, DEPOSIT, INSTALLMENT.
PaymentRequestsDueDate	Datetime	The due date (in the invoice's time zone) for the payment request, in YYYY-MM-DD format.

Locations

Query Location information for a Merchant.

Table Specific Information

Select

The Cloud will execute all filters to this table client-side, in memory.

Retrieve all Locations:

SELECT * FROM Locations

Insert

To create a location, you will need to specify Address and Name.

INSERT INTO locations (Address, Name) VALUES ('{ "address_line_1": "1234 Peachtree St. NE", "locality": "Atlanta", "administrative_district_level_1": "GA", "postal_code": "30309"}', 'Midtown')

UPDATE

A location can be updated by providing the Id.

UPDATE locations set name='testlocation' where id='LNX1YQ5C29K9A'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	False	The location's unique ID.
Name	String	False	The location's name. Location names are set by the account owner and displayed in the dashboard as the location's nickname
Address	String	False	The location's physical address.
TimeZone	String	False	The IANA Timezone Database identifier for the location's timezone.
Capabilities	String	False	Indicates which Square features are enabled for the location.
Status	String	False	The location's status.
CreatedAt	Datetime	False	The time when the location was created, in RFC 3339 format.
MerchantId	String	False	The identifier of the merchant that owns the location.
Country	String	False	The location's country, in ISO 3166-1-alpha-2 format.
LanguageCode	String	False	The language associated with the location in BCP 47 format.
Currency	String	False	The currency used for all transactions at this location, specified in ISO 4217 format.
PhoneNumber	String	False	The location's phone_number.
BusinessName	String	False	The location's business_name which is shown to its customers.
Type	String	False	The location's type, as set by the account owner in the Square dashboard.
WebsiteUrl	String	False	The location's website, as set by the account owner in the Square dashboard.
BusinessHours	String	False	The hours of operation for the location.
Coordinates	String	False	The physical coordinates (latitude and longitude) of the location.
MCC	String	False	A four-digit number that describes the kind of goods or services sold at the location. The merchant category code (MCC) of the location as standardized by ISO 18245.

PaymentLinks

Lists, Creates, Updates, Deletes payment links.

Table Specific Information

Select

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

Retrieve all payment links.

SELECT * from PaymentLinks

Retrieve a particular payment link.

SELECT * from PaymentLinks where id = 'CB45QHA2FDP6C24Q'

Insert

To create a payment link, you will need to specify the Quick Pay columns exposed as pseudo columns.

INSERT INTO PaymentLinks(QuickPayName,QuickPayPriceMoney,QuickPayPriceCurrency,QuickPayLocationId, Description) VALUES('TestPaymentLink@001',350,'USD','92BYHNBR6W77E', 'Hello!!')

Update

To update a payment link, you will need to set current version number of the payment link in the query.

UPDATE PaymentLinks SET Description = 'Demo Description', Version = 4 where Id = 'UN6GN576E3SHVL3R'

Delete

Delete a payment link.

DELETE from PaymentLinks where Id = 'CB45QHA2FDP6C24Q'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	The Square-assigned ID of the payment link.
Version	Int32	False	The Square-assigned version number, which is incremented each time an update is committed to the payment link.
Description	String	False	The optional description of the payment_link object. It is primarily for use by your application and is not used anywhere.
OrderId	String	True	The ID of the order associated with the payment link.
CheckoutAllowTipping	Boolean	False	Indicates whether the payment allows tipping.
CheckoutCustomFields	String	False	The custom fields requesting information from the buyer.
CheckoutSubscriptionPlanId	String	False	The ID of the subscription plan for the buyer to pay and subscribe.
CheckoutRedirectUrl	String	False	The confirmation page URL to redirect the buyer to after Square processes the payment.
CheckoutMerchantSupportEmail	String	False	The email address that buyers can use to contact the seller.
CheckoutAskForShippingAddress	Boolean	False	Indicates whether to include the address fields in the payment form.
CheckoutPaymentMethodApplePay	Boolean	False	Whether Apple Pay is accepted at checkout.
CheckoutPaymentMethodGooglePay	Boolean	False	Whether Google Pay is accepted at checkout.
CheckoutPaymentMethodCashAppPay	Boolean	False	Whether Cash App Pay is accepted at checkout.
CheckoutPaymentMethodAfterPayClearPay	Boolean	False	Whether Afterpay/Clearpay is accepted at checkout.
CheckoutAppFeeMoneyAmount	Int64	False	The amount of money that the developer is taking as a fee for facilitating the payment on behalf of the seller.
CheckoutAppFeeMoneyCurrency	String	False	The type of currency, in ISO 4217 format.
CheckoutShippingFeeName	String	False	The name for the shipping fee.
CheckoutShippingFeeChargeAmount	Int64	False	The amount for the shipping fee.
CheckoutShippingFeeChargeCurrency	String	False	The currency for the shipping fee.
CheckoutEnableCoupon	Boolean	False	Indicates whether to include the Add coupon section for the buyer to provide a Square marketing coupon in the payment form.
CheckoutEnableLoyalty	Boolean	False	Indicates whether to include the REWARDS section for the buyer to opt in to loyalty, redeem rewards in the payment form, or both.
PrePoulatedDataBuyerEmail	String	False	The buyer email to prepopulate in the payment form.
PrePoulatedDataBuyerPhoneNumber	String	False	The buyer phone number to prepopulate in the payment form.
PrePoulatedDataBuyerAddress	String	False	The buyer address to prepopulate in the payment form.
Url	String	True	The shortened URL of the payment link.
LongUrl	String	True	The long URL of the payment link.
CreatedAt	Datetime	False	The timestamp when the payment link was created, in RFC 3339 format.
UpdatedAt	Datetime	False	The timestamp when the payment link was last updated, in RFC 3339 format.
PaymentNote	String	False	An optional note. After Square processes the payment, this note is added to the resulting Payment.

Pseudo-Columns

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


Name	Type	Description
QuickPayName	String	The ad hoc item name. In the resulting Order, this name appears as the line item name.
QuickPayPriceMoney	Int64	The price amount of the item, in the smallest denomination of the currency indicated by currency.
QuickPayPriceCurrency	String	The type of currency, in ISO 4217 format.
QuickPayLocationId	String	The ID of the business location the checkout is associated with.

Payments

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 Cloud.

Retrieve all 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'

Insert

To create a Payment, you will need to specify IdempotencyKey, SourceId, MoneyAmount and MoneyCurrency.

INSERT INTO Payments (IdempotencyKey,SourceId, MoneyAmount,MoneyCurrency) VALUES ('390a7d22-49d6-4ff3-ae1e-755455d03b50','cnon:card-nonce-ok',100, 'USD')

UPDATE

A Payment can be updated by providing the Id.

UPDATE payments set IdempotencyKey='b741f5a5-c041-4bd6-9e79-dfefcf69c4b7', MoneyAmount =200 , BuyerEmailAddress= '[email protected]' where Id='390a7d22-49d6-4ff3-ae1e-755455d03b50'

Columns


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

Pseudo-Columns

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


Name	Type	Description
IdempotencyKey	String	A unique string that identifies this CreatePayment request. Keys can be any valid string but must be unique for every CreatePayment request.
SourceId	String	The ID for the source of funds for this payment.

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.

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 The allowed values are COMPLETED, FAILED, PENDING, REJECTED.
UpdatedAt	Datetime	False	The timestamp of when the refund was last updated, in RFC 3339 format.

Shifts

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

Table Specific Information

Select

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

Retrieve all shifts:

SELECT * FROM Shifts

Retrieve only one Shift:

SELECT * FROM Customers WHERE Id = 'T35HMQSN89SV4'

Insert

To create a Shift, you will need to specify the following values: EmployeeId, LocationId, and StartAt.

INSERT INTO Shifts(EmployeeId,LocationId,StartAt) VALUES('_77Nq6SzK0cH2YRX-q9a','92BYHNBR6W77E',StartAt='2022-02-23T18:00:00-05:00')

Update

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

UPDATE Shifts SET Version=5, LocationId='92BYHNBR6W77E', StartAt='2022-02-23T18:00:00-05:00', EmployeeId='_77Nq6SzK0cH2YRX-q9a'  where Id='T35HMQSN89SV4'

Delete

Delete a Shift by providing the Id of the shift:

DELETE FROM Shifts WHERE Id = 'T35HMQSN89SV4'

Columns


Name	Type	ReadOnly	Description
Breaks	String	False	A list of all the paid or unpaid breaks that were taken during this shift.
CreatedAt	Datetime	True	A read-only timestamp in RFC 3339 format; presented in UTC.
DeclaredCashTipMoney	String	False	The tips declared by the team member for the shift.
EmployeeId	String	False	The tips declared by the team member for the shift.
EndAt	String	False	RFC 3339; shifted to the timezone + offset. Precision up to the minute is respected; seconds are truncated.
Id	String	True	The UUID for this object.
LocationId	String	False	The ID of the location this shift occurred at. The location should be based on where the employee clocked in.
StartAt	String	False	RFC 3339; shifted to the location timezone + offset. Precision up to the minute is respected; seconds are truncated.
Status	String	False	Describes the working state of the current Shift. The allowed values are OPEN, CLOSED.
TeammemberId	String	False	The ID of the team member this shift belongs to.
TimeZone	String	False	The read-only convenience value that is calculated from the location based on the location_id. Format: the IANA timezone database identifier for the location timezone.
UpdatedAt	Datetime	True	A read-only timestamp in RFC 3339 format; presented in UTC.
Version	Integer	False	Used for resolving concurrency issues. The request fails if the version provided does not match the server version at the time of the request. If not provided, Square executes a blind write; potentially overwriting data from another write.
Wage	String	False	Job and pay related information. If the wage is not set on create, it defaults to a wage of zero. If the title is not set on create, it defaults to the name of the role the employee is assigned to, if any.

Pseudo-Columns

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


Name	Type	Description
DateRangeEndDate	String	String in YYYY-MM-DD format, e.g. 2017-10-31 per the ISO 8601 extended format for calendar dates. The end of a date range (inclusive)
DateRangeStartDate	String	String in YYYY-MM-DD format, e.g. 2017-10-31 per the ISO 8601 extended format for calendar dates. The beginning of a date range (inclusive).
StartEndAt	String	A datetime value in RFC-3339 format indicating when the time range ends.
StartStartAt	String	A datetime value in RFC-3339 format indicating when the time range starts.
EndEndAt	String	A datetime value in RFC-3339 format indicating when the time range ends.
EndStartAt	String	A datetime value in RFC-3339 format indicating when the time range starts.

Subscriptions

Create and manage subscriptions.

Table Specific Information

Select

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

Retrieve all subscriptions.

SELECT * from Subscriptions

Retrieve a specific subscription.

SELECT * FROM Subscriptions where id = 'f29e36f4-9732-4d31-8d23-d1ca6b2273f5'

Insert

To create a subscription, you will need to specify the LocationId, CustomerId, PlanId columns and pseudo columns: Ordinal and OrderTemplateId.

INSERT INTO Subscriptions(LocationId, CustomerId,PlanId,Ordinal,OrderTemplateId) VALUES('92BYHNBR6W77E','37V9WES5A57VJV5S9PNC2PCPB0','AF3H4KOG4HK54EPPTE7YIAK7',0,'sQTMsDhjLSPgZRrWDEcalgb7zUaZY')

Update

Updates a subscription.

UPDATE Subscriptions SET Note = 'New Note' where id = '52eb5160-1eeb-45c3-bf81-b02beb1824d2'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	The Square-assigned ID of the subscription.
LocationId	String	True	The ID of the location associated with the subscription.
CustomerId	String	True	The ID of the subscribing customer profile.
PlanId	String	True	The ID of the subscribed-to subscription plan variation.
SourceName	String	False	An optional note to include when creating a payment.
StartDate	Datetime	True	The YYYY-MM-DD-formatted date to start the subscription.
CanceledDate	Datetime	False	The YYYY-MM-DD-formatted date to cancel the subscription, when the subscription status changes to CANCELED and the subscription billing stops.
ChargedThroughDate	Datetime	True	The YYYY-MM-DD-formatted date up to when the subscriber is invoiced for the subscription.
Note	String	False	An optional note to include when creating a payment.
Status	String	True	The current status of the subscription.
TaxPercentage	String	False	The tax amount applied when billing the subscription.
InvoiceIds	String	True	The IDs of the invoices created for the subscription, listed in order when the invoices were created.
PriceOverrideMoneyAmount	Int64	False	The amount of money, in the smallest denomination of the currency indicated by currency, which overrides the cost of a subscription plan variation with STATIC pricing.
PriceOverrideMoneyCurrency	String	False	The type of currency, in ISO 4217 format used to indicate the type of currency for the amount which overrides the cost of a subscription plan variation with STATIC pricing.
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.
CreatedAt	Datetime	True	The timestamp when the subscription was created, in RFC 3339 format.
CardId	String	False	The ID of the subscriber's card used to charge for the subscription.
Timezone	String	True	Timezone that will be used in date calculations for the subscription. Defaults to the timezone of the location based on location_id.
Phases	String	False	An array of phases for this subscription

Pseudo-Columns

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


Name	Type	Description
Ordinal	Int64	The index of phase in total subscription plan.
OrderTemplateId	String	The id of order to be used in billing.

Teams

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

Table Specific Information

Select

The Cloud 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 Cloud.

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'

Insert

To create a Team, you will need to specify IdempotencyKey and FirstName or LastName.

INSERT INTO Teams (IdempotencyKey, FirstName) VALUES ('b741f5a5-c041-4bd6-9e79-dfefcf69c4b7','testing')

UPDATE

A Team can be updated by providing the Id.

UPDATE teams set FirstName='testteams' where id='TMiAkBLr8BOrtOCr'

BULKUPDATE

A Team can be Bulk updated by providing the Id.

INSERT INTO Teams#TEMP (FirstName,LastName,Id) VALUES ('UpdatedFirstName1','UpdatedLastName1','TMD64VkEfI47Vm3G')

INSERT INTO Teams#TEMP (FirstName,LastName,Id) VALUES ('UpdatedFirstName2','UpdatedLastName2','TMHxLjeRSHhwzx3T')

UPDATE Teams (FirstName,LastName,Id) SELECT FirstName, LastName,Id FROM Teams#TEMP

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	False	The Id of the team member.
FirstName	String	False	The first name of the team member.
LastName	String	False	The last name of the team member.
Email	String	False	The email address of the team member.
Status	String	False	Whether the team member is ACTIVE or INACTIVE. The allowed values are ACTIVE, INACTIVE.
CreatedAt	Datetime	False	The time when the team member entity was created.
UpdatedAt	Datetime	False	The time when the team member entity was last updated.
PhoneNumber	String	False	The phone number of the team member.
ReferenceId	String	False	A second ID used to associate the team member with an entity in another system.
IsOwner	Boolean	False	Whether the team member is the owner of the Square account.
AssignmentType	String	False	The current assignment type of the team member.
LocationId	String	False	The locations that the team member is assigned to.

Pseudo-Columns

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


Name	Type	Description
IdempotencyKey	String	A unique string that identifies this CreatePayment request. Keys can be any valid string but must be unique for every CreatePayment request.

Views

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

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

CData Cloud - Square Views


Name	Description
BankAccounts	Query the Bank Accounts of the merchant.
Bookings	Lists all bookings.
BusinessBookingProfile	Retrieves a seller's booking profile.
Catalog	Returns a list of all CatalogObjects.
LocationBookingProfiles	Lists location booking profiles of a seller.
Merchants	Query the available merchants in Square.
OrderDiscounts	The list of all discounts associated with the order.
OrderEntries	A list of OrderEntries that fit the query conditions.
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.
OrderTaxes	The list of all taxes associated with the order.
PayoutEntries	Retrieves a list of all payout entries for a specific payout.
Payouts	Retrieves a list of all payouts for the default location.
Sites	Lists the Square Online sites that belong to a seller.
SubscriptionEvents	Lists all events for a specific subscription.
TeamMemberBookingProfiles	Lists booking profiles for team members.

BankAccounts

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	Int64	The current version of the BankAccount.

Bookings

Lists all bookings.

Table Specific Information

Select

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

Retrieve all the bookings.

SELECT * from Bookings

Retrieve a booking.

SELECT * from Bookings where Id = 'zkras0xv0xwswx'

Columns


Name	Type	Description
Id [KEY]	String	A unique ID of this object representing a booking.
LocationId	String	The ID of the Location object representing the location where the booked service is provided.
CustomerId	String	The ID of the Customer object representing the customer receiving the booked service.
CustomerNote	String	The free-text field for the customer to supply notes about the booking.
SellerNote	String	The free-text field for the seller to supply notes about the booking.
Status	String	The status of the booking, describing where the booking stands with respect to the booking state machine.
AppointmentSegmentsDurationMinutes	Int32	The time span in minutes of an appointment segment for this booking.
AppointmentSegmentsServiceVariationId	String	The ID of the CatalogItemVariation object representing the service booked in this segment.
AppointmentSegmentsTeamMemberId	String	The ID of the TeamMember object representing the team member booked in this segment.
AppointmentSegmentsServiceVariationVersion	Int64	The current version of the item variation representing the service booked in this segment.
AppointmentSegmentsIntermissionMinutes	Int32	Time between the end of this segment and the beginning of the subsequent segment.
AppointmentSegmentsAnyTeamMember	Boolean	Whether the customer accepts any team member, instead of a specific one, to serve this segment.
AppointmentSegmentsResourceIds	String	The IDs of the seller-accessible resources used for this appointment segment.
TransitionTimeMinutes	Int32	Additional time at the end of a booking.
AllDay	Boolean	Whether the booking is of a full business day.
LocationType	String	The type of location where the booking is held.
CreatorType	String	The seller-accessible type of the creator of the booking.
CreatorTeamMemberId	String	The ID of the team member who created the booking, when the booking creator is of the TEAM_MEMBER type. Access to this field requires seller-level permissions.
CreatorCustomerId	String	The ID of the customer who created the booking, when the booking creator is of the CUSTOMER type. Access to this field requires seller-level permissions.
Version	Int32	The revision number for the booking used for optimistic concurrency.
CreatedAt	Datetime	The RFC 3339 timestamp specifying the creation time of this booking.
UpdatedAt	Datetime	The RFC 3339 timestamp specifying the most recent update time of this booking.
StartAt	Datetime	The RFC 3339 timestamp specifying the starting time of this booking.
Source	String	The source of the booking. Access to this field requires seller-level permissions.

BusinessBookingProfile

Retrieves a seller's booking profile.

Table Specific Information

Select

The Cloud will execute all filters to this view client-side, in memory.

Retrieve a seller's booking profile attached to your Square account.

SELECT * from BusinessBookingProfile

Columns


Name	Type	Description
SellerId [KEY]	String	The ID of the seller.
CreatedAt	Datetime	The RFC 3339 timestamp specifying the booking's creation time.
BookingEnabled	Boolean	Indicates whether the seller is open for booking.
CustomerTimezoneChoice	String	The Square online booking site and all notifications to customers uses either the seller location’s time zone or the time zone the customer chooses at booking.
BookingPolicy	String	The policy for the seller to automatically accept booking requests (ACCEPT_ALL) or not (REQUIRES_ACCEPTANCE).
AllowUserCancel	Boolean	Indicates whether customers can cancel or reschedule their own bookings (true) or not (false).
BusinessAppointmentSettings	String	Settings for appointment-type bookings.
SupportSellerLevelWrites	Boolean	Indicates whether the seller's subscription to Square Appointments supports creating, updating or canceling an appointment through the API (true) or not (false) using seller permission.

Catalog

Returns a list of all CatalogObjects.

Table Specific Information

Select

The Cloud will execute all filters to this view client-side, in memory.

Retrieve the list of all CatalogObjects.

SELECT * from Catalog

Columns


Name	Type	Description
Id [KEY]	String	A unique identifier to reference this object in the catalog.
Type	String	The catalog type of this object. The allowed values are ITEM, IMAGE, CATEGORY, ITEM_VARIATION, TAX, DISCOUNT, MODIFIER_LIST, MODIFIER, PRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT, SUBSCRIPTION_PLAN_VARIATION, ITEM_OPTION, ITEM_OPTION_VAL, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNTS_SETTINGS, SUBSCRIPTION_PLAN, AVAILABILITY_PERIOD.
UpdatedAt	Datetime	Last modification timestamp in RFC 3339 format.
Version	Int64	The version of the object.
IsDeleted	Boolean	If true, the object has been deleted from the database. When deleted, the UpdatedAt field will equal the deletion time.
PresentAtAllLocations	Boolean	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	A list of locations where the object is present, even if PresentAtAllLocations is false.
AbsentAtLocationIds	String	A list of locations where the object is not present, even if PresentAtAllLocations is true.
ItemData	String	Structured data for a CatalogItem, set for CatalogObjects of type ITEM. This field is populated only if the Catalog type is ITEM.
CategoryData	String	Structured data for a CatalogCategory, set for CatalogObjects of type CATEGORY. This field is populated only if the Catalog type is CATEGORY.
ItemVariationData	String	Structured data for a CatalogItemVariation, set for CatalogObjects of type ITEM_VARIATION. This field is populated only if the Catalog type is ITEM_VARIATION.
TaxData	String	Structured data for a CatalogTax, set for CatalogObjects of type TAX. This field is populated only if the Catalog type is TAX.
DiscountData	String	Structured data for a CatalogDiscount, set for CatalogObjects of type DISCOUNT. This field is populated only if the Catalog type is DISCOUNT.
ModifierListData	String	Structured data for a CatalogModifierList, set for CatalogObjects of type MODIFIER_LIST. This field is populated only if the Catalog type is MODIFIER_LIST.
ModifierData	String	Structured data for a CatalogModifier, set for CatalogObjects of type MODIFIER. This field is populated only if the Catalog type is MODIFIER.
TimePeriodData	String	Structured data for a CatalogTimePeriod, set for CatalogObjects of type TIME_PERIOD. This field is populated only if the Catalog type is TIME_PERIOD.
ProductSetData	String	Structured data for a CatalogProductSet, set for CatalogObjects of type PRODUCT_SET. This field is populated only if the Catalog type is PRODUCT_SET.
PricingRuleData	String	Structured data for a CatalogPricingRule, set for CatalogObjects of type PRICING_RULE. This field is populated only if the Catalog type is PRICING_RULE.
ImageData	String	Structured data for a CatalogImage, set for CatalogObjects of type IMAGE. This field is populated only if the Catalog type is IMAGE.
MeasurementUnitData	String	Structured data for a CatalogMeasurementUnit, set for CatalogObjects of type MEASUREMENT_UNIT. This field is populated only if the Catalog type is MEASUREMENT_UNIT.
SubscriptionPlanData	String	Structured data for a CatalogSubscriptionPlan, set for CatalogObjects of type SUBSCRIPTION_PLAN. This field is populated only if the Catalog type is SUBSCRIPTION_PLAN.
ItemOptionData	String	Structured data for a CatalogItemOption, set for CatalogObjects of type ITEM_OPTION. This field is populated only if the Catalog type is ITEM_OPTION.
ItemOptionValueData	String	Structured data for a CatalogItemOptionValue, set for CatalogObjects of type ITEM_OPTION_VAL. This field is populated only if the Catalog type is ITEM_OPTION_VAL.
CustomAttributeDefinitionData	String	Structured data for a CatalogCustomAttributeDefinition, set for CatalogObjects of type CUSTOM_ATTRIBUTE_DEFINITION. This field is populated only if the Catalog type is CUSTOM_ATTRIBUTE_DEFINITION.
SubscriptionPlanVariationData	String	Structured data for a CatalogSubscriptionPlanVariation, set for CatalogObjects of type SUBSCRIPTION_PLAN_VARIATION. This field is populated only if the Catalog type is SUBSCRIPTION_PLAN_VARIATION.

LocationBookingProfiles

Lists location booking profiles of a seller.

Table Specific Information

Select

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

Retrieve all the LocationBookingProfiles of a seller attached to your Square account.

SELECT * from LocationBookingProfiles

Retrieve the LocationBookingProfile for a particular location.

SELECT * from LocationBookingProfiles where LocationId = '92BYHNBR6W77E'

Columns


Name	Type	Description
LocationId [KEY]	String	The ID of the location.
BookingSiteUrl	String	Url for the online booking site for this location.
OnlineBookingEnabled	Boolean	Indicates whether the location is enabled for online booking.

Merchants

Query the available merchants in Square.

Table Specific Information

Select

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

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.

OrderDiscounts

The list of all discounts associated with the order.

Table Specific Information

Select

The Cloud uses the Square API to process search criteria that refer to the OrderId and LocationId, while other filters are processed client side within the Cloud.

Retrieve all the OrderDiscounts found in every order of your Square account.

SELECT * FROM OrderDiscounts

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

 SELECT * FROM OrderDiscounts WHERE OrderId = 'TzratjkPk9rhOuLYvSXeznmVvIx5PVlZpg72GfPQGBxckDeeWNBN8yqnf11qTrg3W3AelXC1kB'

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

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

Columns


Name	Type	Description
Id	String	A unique ID that identifies the discount only within this order
LocationId	String	The Id of the location.
AppliedAmount	Integer	The amount of discount actually applied to the line item
AppliedCurrency	String	The type of currency, in ISO 4217 format
AmountMoneyAmount	Integer	The total declared monetary amount of the discount amount_money is not set for percentage-based discounts
AmountMoneyCurrency	String	The type of currency, in ISO 4217 format
Name	String	The discount's name
Percentage	String	The percentage of the discount
Scope	String	Indicates the level at which the discount applies The allowed values are OTHER_DISCOUNT_SCOPE, LINE_ITEM, ORDER.
Type	String	The type of the discount The allowed values are UNKNOWN_DISCOUNT, FIXED_PERCENTAGE, FIXED_AMOUNT, VARIABLE_PERCENTAGE, VARIABLE_AMOUNT.
CatalogObjectId	String	The catalog object ID
CatalogVersion	Int64	The version of the catalog object that this discount references

Pseudo-Columns

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


Name	Type	Description
OrderId	String	The order's unique ID.

OrderEntries

A list of OrderEntries that fit the query conditions.

Table Specific Information

Select

The Cloud uses the Square API to process list of OrderEntries that fit the query conditions;.

Retrieve all the OrderEntries found in your Square account.

SELECT * FROM OrderEntries

Columns


Name	Type	Description
LocationId	String	The Id of the location.
CreatedAt	Datetime	Created timestamp.
LineItems	String	Order Line Items.
OrderId	String	The Id of the Order.
Source	String	The origination details of the order.
UpdatedAt	Datetime	The time when the location was updated, in RFC 3339 format
Version	Integer	The version number, which is incremented each time an update is committed to the order.

OrderItems

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

Table Specific Information

Select

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

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

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

Table Specific Information

Select

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

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
CreatedAt	Datetime	The time when the location was created in RFC 3339 format
CustomerId	String	The ID of the customer associated with the order
Discounts	String	The list of all discounts associated with the order
LineItems	String	The line items included in the order
NetDueAmount	Integer	The amount of money in the smallest denomination of the currency indicated by currency
NetDueCurrency	String	The type of currency in ISO 4217 format
NetDiscountAmount	Integer	The amount of money in the smallest denomination of the currency indicated by currency
NetDiscountCurrency	String	The type of currency in ISO 4217 format
NetServiceChargeAmount	Integer	The amount of money in the smallest denomination of the currency indicated by currency
NetServiceChargeCurrency	String	The type of currency in ISO 4217 format
NetTaxAmount	Integer	The amount of money in the smallest denomination of the currency indicated by currency
NetTaxCurrency	String	The type of currency in ISO 4217 format
NetTipAmount	Integer	The amount of money in the smallest denomination of the currency indicated by currency
NetTipCurrency	String	The type of currency in ISO 4217 format
NetTotalAmount	Integer	The amount of money in the smallest denomination of the currency indicated by currency
NetTotalCurrency	String	The type of currency in ISO 4217 format
PricingAutoApplyDiscounts	Boolean	The option to determine whether pricing rule-based discounts are automatically applied to an order
SourceName	String	The name used to identify the place physical or digital that an order originates
State	String	The current state of the order
Taxes	String	The list of all taxes associated with the order
Tenders	String	The tenders that were used to pay for the order
TotalDiscountAmount	Integer	The amount of money, in the smallest denomination of the currency indicated by currency
TotalDiscountCurrency	String	The type of currency in ISO 4217 format
TotalAmount	Integer	The amount of money, in the smallest denomination of the currency indicated by currency
TotalCurrency	String	The type of currency in ISO 4217 format
ServiceChargeAmount	Integer	The amount of money, in the smallest denomination of the currency indicated by currency
ServiceChargeCurrency	String	The type of currency in ISO 4217 format
TaxAmount	Integer	The total amount of tax money to collect for the order
TaxCurrency	String	The type of currency, in ISO 4217 format
TipAmount	Integer	The total amount of tip money to collect for the order
TipCurrency	String	The type of currency, in ISO 4217 format
UpdatedAt	Datetime	The time when the location was updated, in RFC 3339 format
Version	Int64	The version number, which is incremented each time an update is committed to the order

Pseudo-Columns

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


Name	Type	Description
FulfillmentState	String	A list of fulfillment states to filter for. The list returns orders if any of its fulfillments match any of the fulfillment states listed in this field.
FulfillmentType	String	A list of fulfillment types to filter for. The list returns orders if any of its fulfillments match any of the fulfillment types listed in this field.

OrderTaxes

The list of all taxes associated with the order.

Table Specific Information

Select

The Cloud uses the Square API to process search criteria that refer to the OrderId and LocationId column, while other filters are processed client side within the Cloud.

Retrieve all the OrderTaxes found in every order of your Square account.

SELECT * FROM OrderTaxes

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

 SELECT * FROM OrderTaxes WHERE OrderId = 'TzratjkPk9rhOuLYvSXeznmVvIx5PVlZpg72GfPQGBxckDeeWNBN8yqnf11qTrg3W3AelXC1kB'

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

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

Columns


Name	Type	Description
Id	String	A unique ID that identifies the tax only within this order
LocationId	String	The Id of the location.
AppliedAmount	Integer	The amount of money applied by the tax in the order
AppliedCurrency	String	The type of currency, in ISO 4217 format
Name	String	The tax's name
Percentage	String	The percentage of the tax
Scope	String	Indicates the level at which the discount applies The allowed values are OTHER_DISCOUNT_SCOPE, LINE_ITEM, ORDER.
Type	String	Indicates the calculation method used to apply the tax The allowed values are UNKNOWN_DISCOUNT, FIXED_PERCENTAGE, FIXED_AMOUNT, VARIABLE_PERCENTAGE, VARIABLE_AMOUNT.
CatalogObjectId	String	The catalog object ID
CatalogVersion	Int64	The version of the catalog object that this tax references.

Pseudo-Columns

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


Name	Type	Description
OrderId	String	The order's unique ID.

PayoutEntries

Retrieves a list of all payout entries for a specific payout.

Columns


Name	Type	Description
PayoutId	String	The ID of the payout to retrieve the information for.
Id [KEY]	String	A unique ID for the payout entry.
Type	String	The type of activity associated with this payout entry.
FeeAmountMoneyAmount	Integer	The amount of money, in the smallest denomination of the currency indicated by currency.
FeeAmountMoneyCurrencyCode	String	The type of currency, in ISO 4217 format. For example, the currency code for US dollars is USD.
GrossAmountMoneyAmount	Integer	The amount of money, in the smallest denomination of the currency indicated by currency.
GrossAmountMoneyCurrencyCode	String	The type of currency, in ISO 4217 format. For example, the currency code for US dollars is USD.
NetAmountMoneyAmount	Integer	The amount of money, in the smallest denomination of the currency indicated by currency.
NetAmountMoneyCurrencyCode	String	The type of currency, in ISO 4217 format. For example, the currency code for US dollars is USD.
TypeChargeDetailsPaymentId	String	The ID of the payment associated with this activity.
TypeRefundDetailsPaymentId	String	The ID of the payment associated with this activity.
TypeRefundDetailsRefundId	String	The ID of the refund associated with this activity.
EffectiveAt	Datetime	The timestamp of when the payout entry affected the balance, in RFC 3339 format.
TypeAppFeeRevenueDetailsPaymentId	String	The ID of the payment associated with this activity.
TypeAppFeeRevenueDetailsLocationId	String	The ID of the location of the merchant associated with the payment activity.
TypeAppFeeRefundDetailsPaymentId	String	Details of a refund for an app fee on a payment.
TypeAppFeeRefundDetailsLocationId	String	The ID of the location of the merchant associated with the payment refund activity.
TypeAppFeeRefundDetailsRefundId	String	The ID of the refund associated with this activity.
TypeAutomaticSavingsDetailsPaymentId	String	The ID of the payment associated with this activity.
TypeAutomaticSavingsDetailsPayoutId	String	The ID of the payout associated with this activity.
TypeAutomaticSavingsReversedDetailsPaymentId	String	The ID of the payment associated with this activity.
TypeAutomaticSavingsReversedDetailsPayoutId	String	The ID of the payout associated with this activity.
TypeDepositFeeDetailsPayoutId	String	The ID of the payout that triggered this deposit fee activity.
TypeDisputeDetailsPaymentId	String	The ID of the payment associated with this activity.
TypeDisputeDetailsDisputeId	String	The ID of the dispute associated with this activity.
TypeFeeDetailsPaymentId	String	The ID of the payment associated with this activity This will only be populated when a principal LedgerEntryToken is also populated.
TypeFreeProcessingDetailsPaymentId	String	The ID of the payment associated with this activity.
TypeHoldAdjustmentDetailsPaymentId	String	The ID of the payment associated with this activity.
TypeOpenDisputeDetailsPaymentId	String	The ID of the payment associated with this activity.
TypeOpenDisputeDetailsDisputeId	String	The ID of the dispute associated with this activity.
TypeOtherDetailsPaymentId	String	The ID of the payment associated with this activity.
TypeOtherAdjustmentDetailsPaymentId	String	The ID of the payment associated with this activity.
TypeReleaseAdjustmentDetailsPaymentId	String	The ID of the payment associated with this activity.
TypeReleaseHoldDetailsPaymentId	String	The ID of the payment associated with this activity.
TypeReleaseReleaseDetailsPaymentId	String	The ID of the payment associated with this activity.
TypeSquareCapitalPaymentDetailsPaymentId	String	The ID of the payment associated with this activity.
TypeSquareCapitalReversedPaymentDetailsPaymentId	String	The ID of the payment associated with this activity.
TypeTaxOnFeeDetailsPaymentId	String	The ID of the payment associated with this activity.
TypeTaxOnFeeDetailsTaxRateDescription	String	The description of the tax rate being applied. For example:
TypeThirdPartyFeeDetailsPaymentId	String	The ID of the payment associated with this activity.
TypeThirdPartyFeeRefundDetailsPaymentId	String	The ID of the payment associated with this activity.
TypeThirdPartyFeeRefundDetailsRefundId	String	The public refund id associated with this activity.

Payouts

Retrieves a list of all payouts for the default location.

Columns


Name	Type	Description
Id [KEY]	String	A unique ID for the payout.
Status	String	The status for the payout.
LocationId	String	The ID of the location associated with the payout.
CreatedAt	Datetime	The timestamp of when the payout was created and submitted for deposit to the seller's banking destination, in RFC 3339 format.
UpdatedAt	Datetime	The timestamp of when the payout was last updated, in RFC 3339 format.
AmountMoneyAmount	String	The amount of money, in the smallest denomination of the currency indicated by currency.
AmountMoneyCurrencyCode	String	The type of currency, in ISO 4217 format. For example, the currency code for US dollars is USD.
DestinationId	String	Square issued unique ID (also known as the instrument ID) associated with this destination.
DestinationType	String	Type of the destination such as a bank account or debit card.
Version	Int64	The version number, which is incremented each time an update is made to this payout record. The version number helps developers receive event notifications or feeds out of order.
Type	String	Indicates the payout type.
PayoutFeeAmount	String	The money amount of the payout fee.
PayoutFeeCurrencyCode	String	The type of currency, in ISO 4217 format. For example, the currency code for US dollars is USD.
PayoutFeeEffectiveAt	Datetime	The timestamp of when the fee takes effect, in RFC 3339 format.
PayoutFeeType	String	The timestamp of when the fee takes effect, in RFC 3339 format.
ArrivalDate	Date	The calendar date, in ISO 8601 format (YYYY-MM-DD), when the payout is due to arrive in the seller’s banking destination.
EndToEndId	String	A unique ID for each Payout object that might also appear on the seller’s bank statement.

Sites

Lists the Square Online sites that belong to a seller.

Table Specific Information

Select

The Cloud will execute all filters to this view client-side, in memory.

Retrieve all the sites in your Square account.

SELECT * FROM Sites

Columns


Name	Type	Description
Id [KEY]	String	The Square-assigned ID of the site.
SiteTitle	String	The title of the site.
Domain	String	The domain of the site (without the protocol).
IsPublished	Boolean	Indicates whether the site is published.
CreatedAt	Datetime	The timestamp of when the site was created, in RFC 3339 format.
UpdatedAt	Datetime	The timestamp of when the site was last updated, in RFC 3339 format.

SubscriptionEvents

Lists all events for a specific subscription.

Table Specific Information

Select

The Cloud will execute all filters to this view client-side, in memory.

Retrieve the list of all subscription events for a subscription id. The Subscription Id is required to access the view.

SELECT * from SubscriptionEvents where Id = 'fd9d6200-bb12-43c5-9973-070bfc6f5e05'

Columns


Name	Type	Description
Id [KEY]	String	The ID of the subscription event.
SubscriptionEventType	String	Type of the subscription event.
PlanVariationId	String	The ID of the subscription plan variation associated with the subscription.
EffectiveDate	Datetime	The YYYY-MM-DD-formatted date when the subscription event occurred.
InfoDetail	String	A human-readable explanation for the subscription event.
InfoCode	String	An info code indicating the subscription event that occurred.
PhasesUID	String	The id of subscription phase.
PhasesOrdinal	Int64	The index of phase in total subscription plan.
PhasesOrderTemplateId	String	The id of order to be used in billing.
PhasesPlanPhaseUID	String	The uid from the plan's phase in catalog.

TeamMemberBookingProfiles

Lists booking profiles for team members.

Table Specific Information

Select

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

Retrieve all the booking profiles for team members.

SELECT * from TeamMemberBookingProfiles

Retrieve a particular team member's booking profile.

SELECT * from TeamMemberBookingProfiles where teammemberid = '_77Nq6SzK0cH2YRX-q9a'

Columns


Name	Type	Description
TeamMemberId [KEY]	String	The ID of the TeamMember object for the team member associated with the booking profile.
Description	String	The description of the team member.
DisplayName	String	The display name of the team member.
IsBookable	Boolean	Indicates whether the team member can be booked through the Bookings API or the seller's online booking channel or site (true) or not (false).
ProfileImageUrl	String	The URL of the team member's image for the bookings profile.

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with Square.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Square, along with an indication of whether the procedure succeeded or failed.

CData Cloud - Square Stored Procedures


Name	Description
AddItemImage	Uploads an image file to be represented by a CatalogImage object linked to an existing CatalogObject instance.
CancelInvoice	Cancels an invoice.
CancelPayment	Cancels (voids) a payment.
CancelPaymentByIdempotencyKey	Cancels (voids) a payment identified by the idempotency key that is specified in the request.
CancelSubscription	Schedules a CANCEL action to cancel an active subscription.
CaptureTransaction	Captures a transaction that was created with the Charge stored procedure with a DelayCapture value of true.
Charge	Charges a card represented by a card nonce or a customer's card on file.
CompletePayment	Completes (captures) a payment.
CreateCatalogImage	Uploads an image file to be represented by a CatalogImage object linked to an existing CatalogObject instance.
CreateInvoiceAttachment	Uploads a file and attaches it to an invoice.
Createorder	Creates an Order that can then be referenced as OrderId in a request to the Charge endpoint.
DeleteInvoiceAttachment	Removes an attachment from an invoice and permanently deletes the file.
PublishInvoice	Publishes the specified draft invoice.
VoidTransaction	Cancels a transaction that was created with the Charge stored procedure with a DelayCapture value of true.

AddItemImage

Uploads an image file to be represented by a CatalogImage object linked to an existing CatalogObject instance.

Table Specific Information

Catalog Item Variations

You cannot attach an image to a new item without item variations. To create itemVariations, you must insert data in a temporary table called 'CatalogItemVariations#TEMP'.

Example: Create a catalog item variation

INSERT INTO CatalogItemVariations#TEMP (Id, Name, PriceMoneyAmount, PriceMoneyCurrency, PricingType) VALUES ('#456', 'Image Test Variation', '250000', 'USD', 'FIXED_PRICING')

Execute

After creating at least one item variation, you can execute the stored procedure.

EXECUTE AddItemImage ObjectId = '#123', ImageId = 'MMMY47ZSOGZ27RHPPDCTVSK2', ItemDataName = 'CreateItem', ItemDataProductType = 'APPOINTMENTS_SERVICE', ItemDataVariations = 'CatalogItemVariations#TEMP'

Input


Name	Type	Required	Description
ObjectId	String	True	Unique ID of the CatalogObject to attach to this CatalogImage. Leave this field empty to create unattached images
AbsentAtLocationIds	String	False	A comma separated list of locations where the object is not present, even if present_at_all_locations is true. This can include locations that are deactivated.
CatalogV1Ids	String	False	The Connect v1 IDs for this object at each location where it is present, where they differ from the object's Connect V2 ID. The field will only be present for objects that have been created or modified by legacy APIs.
ImageId	String	True	Identifies the CatalogImage attached to this CatalogObject.
ItemDataAbbreviation	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.
ItemDataAvailableElectronically	Boolean	False	If true, the item can be added to electronically fulfilled orders from the merchant's online store.
ItemDataAvailableForPickUp	Boolean	False	If true, the item can be added to pickup orders from the merchant's online store.
ItemDataAvailableOnline	Boolean	False	If true, the item can be added to shipping orders from the merchant's online store.
ItemDataCategoryId	String	False	The ID of the item's category, if any.
ItemDataDescription	String	False	The item's description.
ItemDataLabelColor	String	False	The color of the item's display label in the Square Point of Sale app. This must be a valid hex color code.
ItemDataModifierListInfo	String	False	A set of CatalogItemModifierListInfo objects representing the modifier lists that apply to this item, along with the overrides and min and max limits that are specific to this item
ItemDataName	String	False	The item's name.
ItemDataProductType	String	False	The product type of the item. May not be changed once an item has been created. Only items of product type REGULAR or APPOINTMENTS_SERVICE may be created by this API;
ItemDataSkipModifierScreen	Boolean	False	If false, the Square Point of Sale app will present the CatalogItem's details screen immediately, allowing the merchant to choose CatalogModifiers before adding the item to the cart. This is the default behavior. 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.
ItemDataTaxIds	String	False	A set of IDs indicating the taxes enabled for this item. When updating an item, any taxes listed here will be added to the item.
ItemDataVariations	String	False	A list of CatalogItemVariation objects for this item. An item must have at least one variation.
PresentAtAllLocations	Boolean	False	If true, this object is present at all locations (including future locations), except where specified in the absent_at_location_ids field. If false, this object is not present at any locations (including future locations), except where specified in the present_at_location_ids field. If not specified, defaults to true.
PresentAtAllLocationIds	String	False	A comma separated list of locations where the object is present, even if present_at_all_locations is false. This can include locations that are deactivated.
ObjectVersion	Integer	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.

Result Set Columns


Name	Type	Description
Success	Boolean	Whether or not the image was attached to the item.
ImageId	String	Id of the Image.
ObjectId	String	Id of the Catalog Object to which the image is attached.

CancelInvoice

Cancels an invoice.

Stored Procedure Specific Information

Execute

To execute this stored procedure, you need to provide the Id of the invoice and its current version number to cancel.

EXECUTE CancelInvoice InvoiceId = 'inv:0-ChAALv-Dv-66y_I0TT0hCN2UEL0M', InvoiceVersion = 8

Input


Name	Type	Required	Description
InvoiceId	String	True	The ID of the invoice to cancel.
InvoiceVersion	String	True	The version of the invoice to cancel.

CancelPayment

Cancels (voids) a payment.

Stored Procedure Specific Information

Execute

You need to provide the PaymentId to execute the stored procedure.

EXECUTE CancelPayment PaymentId = 'fd9d6200-bb12-43c5-9973-070bfc6f5e05'

Input


Name	Type	Required	Description
PaymentId	String	False	The unique ID identifying the payment to be cancel.

Result Set Columns


Name	Type	Description
Success	Boolean	Whether the operation is successful or not.

CancelPaymentByIdempotencyKey

Cancels (voids) a payment identified by the idempotency key that is specified in the request.

Stored Procedure Specific Information

Execute

EXEC CancelPaymentByIdempotencyKey

Input


Name	Type	Required	Description
IdempotencyKey	String	False	The idempotency key identifying the payment to be canceled.

Result Set Columns


Name	Type	Description
Success	Boolean	Whether the operation is successful or not

CancelSubscription

Schedules a CANCEL action to cancel an active subscription.

Stored Procedure Specific Information

Execute

You need to provide the subscription id of an ACTIVE subscription to execute the stored procedure.

EXECUTE CancelSubscription Id = 'fd9d6200-bb12-43c5-9973-070bfc6f5e05'

Input


Name	Type	Required	Description
Id	String	False	The ID of the subscription to cancel.

Result Set Columns


Name	Type	Description
Success	Boolean	Whether the cancellation of the ACTIVE subscription was successful or not.
Status	String	The current status of the subscription.

CaptureTransaction

Captures a transaction that was created with the Charge stored procedure with a DelayCapture value of true.

Input


Name	Type	Required	Description
TransactionId	String	True	The transaction's unique ID, issued by Square payments servers.

Result Set Columns


Name	Type	Description
Success	Boolean	Whether the transaction was captured.

Charge

Charges a card represented by a card nonce or a customer's card on file.

Stored Procedure Specific Information

Execute

You must include in your query either of the following:

A value for the CardNonce parameter (to charge a card nonce generated with the SqPaymentForm).
Values for the CustomerCardId and CustomerId parameters (to charge a customer's card on file).

Note: If you provide the OrderId, the AmountMoney value must exactly match the TotalMoneyAmount value of the order you have created.

EXECUTE Charge OrderId = 'XKKB7LD30TpfNyW3e843ziklKh4vWEvweQyL5l4ESJLH3N2XXNBN8yqnf11qTrg3W3AelXC1kB',
  AmountMoney = 55555,
  AmountMoneyCurrency = 'USD',
  CardNonce = 'fake-card-nonce-ok',
  ReferenceId = 'some optional reference id',
  Note = 'some optional note',
  ShippingAddressLine1 = '123 Main St',
  ShippingAddressLocality = 'San Francisco',
  ShippingAddressAdministrativeDistrictLevel1 = 'CA',
  ShippingAddressPostalCode = '94114',
  ShippingAddressCountry= 'US',
  BillingAddressLine1= '500 Electric Ave',
  BillingAddressLine2 = 'Suite 600',
  BillingAddressAdministrativeDistrictLevel1 = 'NY',
  BillingAddressLocality = 'New York',
  BillingAddressPostalCode = '10003',
  BillingAddressCountry = 'US'

Input


Name	Type	Required	Description
IdempotencyKey	String	False	A value you specify that uniquely identifies this transaction among transactions you've created.
AmountMoney	String	True	The amount of money to charge.
AmountMoneyCurrency	String	True	The value of currency must match the currency associated with the business that is charging the card.
CardNonce	String	False	A nonce generated from the SqPaymentForm that represents the card to charge.
CustomerCardId	String	False	The ID of the customer card on file to charge.
DelayCapture	Boolean	False	If true, the request will only perform an Auth on the provided card. You can then later perform either a Capture or a Void.
ReferenceId	String	False	An optional ID you can associate with the transaction for your own purposes.
Note	String	False	An optional note to associate with the transaction.
CustomerId	String	False	The ID of the customer to associate this transaction with.
BuyerEmailAddress	String	False	The buyer's email address, if available. This value is optional, but this transaction is ineligible for chargeback protection if it is not provided.
OrderId	String	False	The ID of the order to associate with this transaction.
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.
ShippingAddressLine1	String	False	The first line of the address.
ShippingAddressLine2	String	False	The second line of the address.
ShippingAddressLine3	String	False	The third line of the address.
ShippingAddressLocality	String	False	The city or town of the address.
ShippingAddressSubLocality	String	False	A civil region within the address's locality.
ShippingAddressSubLocality2	String	False	A civil region within the address's sublocality.
ShippingAddressSubLocality3	String	False	A civil region within the address's sublocality_2.
ShippingAddressAdministrativeDistrictLevel1	String	False	A civil entity within the address's country. In the US, this is the state.
ShippingAddressAdministrativeDistrictLevel2	String	False	A civil entity within the address's administrative_district_level_1. In the US, this is the county.
ShippingAddressAdministrativeDistrictLevel3	String	False	A civil entity within the address's administrative_district_level_2.
ShippingAddressPostalCode	String	False	The address's postal code.
ShippingAddressCountry	String	False	The address's country, in ISO 3166-1-alpha-2 format.
ShippingAddressFirstName	String	False	Optional first name when it's representing recipient.
ShippingAddressLastName	String	False	Optional last name when it's representing recipient.
ShippingAddressOrganization	String	False	Optional organization name when it's representing recipient.

Result Set Columns


Name	Type	Description
Success	Boolean	Whether the transaction was successful.
TransactionId	String	The transaction's unique ID, issued by Square payments servers.

CompletePayment

Completes (captures) a payment.

Stored Procedure Specific Information

Execute

You need to provide the PaymentId to execute the stored procedure.

EXECUTE CompletePayment PaymentId = 'fd9d6200-bb12-43c5-9973-070bfc6f5e05'

Input


Name	Type	Required	Description
PaymentId	String	False	The unique ID identifying the payment to be completed.

Result Set Columns


Name	Type	Description
Success	Boolean	Whether the operation is successful or not.

CreateCatalogImage

Uploads an image file to be represented by a CatalogImage object linked to an existing CatalogObject instance.

Table Specific Information

If you want to create an image without attaching to any Catalog Object

EXECUTE CreateCatalogImage ImageFile = 'C:\\users\\image.png', ImageDataCaption = 'Test Image'

You can upload and attach image to a catalog object by specifying the objectid.

EXECUTE CreateCatalogImage ImageFile = 'C:\\users\\image.png', ImageDataCaption = 'Test Image', ObjectId = 'KGV3QARAJSYCIX4VUJZX64ZX'

In order to specify the value for ImageCatalogV1Ids, you need to create a well defined JSON structure

 
EXECUTE CreateCatalogImage ImageFile = 'C:\\users\\image.png', ImageDataCaption = 'Test Image', ImageCatalogV1Ids = '[{"catalog_v1_id":"KGV3QARAJSYCIX4VUJZX64ZX","location_id":"29BYHNBR6W77E"}]'

Input


Name	Type	Required	Description
ImageFile	String	False	An image file in JPEG, PJPEG, PNG, or GIF format.
ObjectId	String	False	Unique ID of the CatalogObject to attach to this CatalogImage. Leave this field empty to create unattached images
ImageAbsentAtLocationIds	String	False	A comma separated list of locations where the object is not present, even if present_at_all_locations is true. This can include locations that are deactivated.
ImageCatalogV1Ids	String	False	The Connect v1 IDs for this object at each location where it is present, where they differ from the object's Connect V2 ID. The field will only be present for objects that have been created or modified by legacy APIs.
ImageDataCaption	String	True	A caption that describes what is shown in the image.
ImageDataName	String	False	The internal name to identify this image in calls to the Square API.
ImageDataUrl	String	False	The URL of this image, generated by Square after an image is uploaded using the CreateCatalogImage endpoint.
PresentAtAllLocations	Boolean	False	If true, this object is present at all locations (including future locations), except where specified in the absent_at_location_ids field. If false, this object is not present at any locations (including future locations), except where specified in the present_at_location_ids field. If not specified, defaults to true.
PresentAtAllLocationIds	String	False	A comma separated list of locations where the object is present, even if present_at_all_locations is false. This can include locations that are deactivated.
ObjectVersion	Integer	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.
FileName	String	False	The file name including extension when using Content.

Result Set Columns


Name	Type	Description
Success	Boolean	Whether or not the image was attached to the item.
ImageId	String	Id of the Image.
ImageUrl	String	The url of the uploaded image.

CreateInvoiceAttachment

Uploads a file and attaches it to an invoice.

Stored Procedure Specific Information

Execute

To execute this stored procedure, you need to provide the InvoiceId for which the attachment will be created and the file path of the attachment.

EXECUTE CreateInvoiceAttachment InvoiceId = 'inv:0-ChAALv-Dv-66y_I0TT0hCN2UEL0M', File = 'D:\\Pictures\\Screenshots\\Screenshot123.png', Description = 'Test Description'

Input


Name	Type	Required	Description
InvoiceId	String	True	The ID of the invoice to attach the file to.
File	String	True	A file of following content types is allowed: image/gif, image/jpeg, application/pdf, image/png, image/tiff, image/bmp.
Description	String	False	The description of the attachment to display on the invoice.

Createorder

Creates an Order that can then be referenced as OrderId in a request to the Charge endpoint.

Table Specific Information

AutoCharge

If you want to use the AutoCharge feature, AutoCharge must be set to "True" and you must also include in your query either of the following:

A value for the CardNonce parameter (to charge a card nonce generated with the SqPaymentForm).
Values for the CustomerCardId and CustomerId parameters (to charge a customer's card on file).

Order Items

You cannot create an order without order items. To create orderItems, you must insert data in a temporary table called 'OrderItem#TEMP'.

Example: Create three order items

Insert INTO OrderItem#TEMP (Name, Quantity, BasePriceMoneyAmount, BasePriceMoneyCurrency) VALUES ('New York Strip Steak', '1', 1599, 'USD')
Insert INTO OrderItem#TEMP (Name, Quantity, BasePriceMoneyAmount, BasePriceMoneyCurrency) VALUES ('New York Strip Steak-Special', '1', 2599, 'USD')
Insert INTO OrderItem#TEMP (quantity, CatalogObjectId, Modifiers, Discounts) VALUES ('2', 'BEMYCSMIJL46OCDV4KYIKXIB', '[\n" +
        "        {\n" +
        "          \"catalog_object_id\": \"CHQX7Y4KY6N5KINJKZCFURPZ\"\n" +
        "        }\n" +
        "      ]', '[\n" +
        "        {\n" +
        "          \"name\": \"Sale - $1.00 off\",\n" +
        "          \"amount_money\": {\n" +
        "            \"amount\": 100,\n" +
        "            \"currency\": \"USD\"\n" +
        "          }\n" +
        "        }\n" +
        "      ]')

The columns available for this temporary table are the following:

Name
Quantity
BasePriceMoneyAmount
BasePriceMoneyCurrency
VariationName
CatalogObjectId
Modifiers
Taxes
Discounts

The last three columns are aggregates. You need to create the JSON structure to provide the values to insert. For more information about the specific JSON structure, visit the following link: https://docs.connect.squareup.com/api/connect/v2#type-createorderrequestlineitem

Execute

After creating at least one order item, you can execute the stored procedure.

If you want to charge this order, you must set AutoCharge to 'true'.

Note: For adding more than one values to "Taxes" and "Discounts", you can use the OrderTaxes#TEMP and OrderDiscounts#TEMP tables or create the JSON structure to provide the values to insert. Please refer the columns available for OrderTaxes and OrderDiscounts from Orders View

INSERT INTO OrderTaxes#TEMP (TaxName, TaxPercentage) VALUES ('State Sales Tax', '9')
INSERT INTO OrderTaxes#TEMP (TaxName, TaxPercentage) VALUES ('Central Sales Tax', '9')
INSERT INTO OrderDiscounts#TEMP (DiscountName, DiscountPercentage) VALUES ('Labor Day Sale', '5')
INSERT INTO OrderDiscounts#TEMP (DiscountName, DiscountPercentage) VALUES ('New Year Sale', '10')
EXECUTE CreateOrder  AutoCharge = true, CardNonce = 'fake-card-nonce-ok', ReferenceId = 'my-order-001', OrderLineItems = 'OrderItem#TEMP', OrderTaxes = 'OrderTaxes#TEMP', OrderDiscounts = 'OrderDiscounts#TEMP'

EXECUTE CreateOrder  AutoCharge = true, CardNonce = 'fake-card-nonce-ok', ReferenceId = 'my-order-001', OrderLineItems = 'OrderItem#TEMP', OrderTaxes = '[{"OrderTaxName":"State Sales Tax","OrderTaxPercentage": 9}]', OrderDiscounts = '[{"OrderDiscountName":"Labor Day Sale","OrderDiscountPercentage":5}]'

Input


Name	Type	Required	Description
AutoCharge	Boolean	False	Charge the order automatically
CardNonce	String	False	A nonce generated from the SqPaymentForm that represents the card to charge.
CustomerCardId	String	False	The ID of the customer card on file to charge.
CustomerId	String	False	The ID of the customer to associate this transaction with.
IdempotencyKey	String	False	A value you specify that uniquely identifies this order among orders you've created.
ReferenceId	String	False	An optional ID you can associate with the transaction for your own purposes.
OrderLineItems	String	False	The aggregate for the order line items.
OrderTaxAmountMoneyAmount	Integer	False	Only used for ad hoc taxes. The monetary amount of the tax. This column input will not be accepted if OrderTaxes column is added.
OrderTaxAmountMoneyCurrency	String	False	Only used for ad hoc taxes. The currency of the tax monetary amount. This column input will not be accepted if OrderTaxes column is added.
OrderTaxAppliedMoneyAmount	Integer	False	Only used for ad hoc taxes. The applied amount by the tax. This column input will not be accepted if OrderTaxes column is added.
OrderTaxAppliedMoneyCurrency	String	False	Only used for ad hoc taxes. The currency of the tax applied amount. This column input will not be accepted if OrderTaxes column is added.
OrderTaxCatalogObjectId	String	False	Only used for catalog taxes. The catalog object ID of an existing CatalogTax. This column input will not be accepted if OrderTaxes column is added.
OrderTaxName	String	False	Only used for ad hoc taxes. The tax's name. Do not provide a value for this field if you set catalogobjectid. This column input will not be accepted if OrderTaxes column is added.
OrderTaxPercentage	String	False	Only used for ad hoc taxes. The percentage of the tax, as a string representation of a decimal number. This column input will not be accepted if OrderTaxes column is added.
OrderTaxScope	String	False	Only used for ad hoc taxes. Indicates the level at which the tax applies. Possible values are OTHER_TAX_SCOPE, LINE_ITEM, ORDER. This column input will not be accepted if OrderTaxes column is added.
OrderTaxType	String	False	Only used for ad hoc taxes. The type of the tax. This column input will not be accepted if OrderTaxes column is added.
OrderTaxUID	String	False	Only used for ad hoc taxes. Unique ID that identifies the tax only within this order. This column input will not be accepted if OrderTaxes column is added.
OrderTaxes	String	False	The aggregate for the order taxes.
OrderDiscountAmountMoneyAmount	Integer	False	Only used for ad hoc discounts. The monetary amount of the discount. This column input will not be accepted if OrderDiscounts column is added.
OrderDiscountAmountMoneyCurrency	String	False	Only used for ad hoc discounts. The currency of the discount monetary amount. This column input will not be accepted if OrderDiscounts column is added.
OrderDiscountAppliedMoneyAmount	Integer	False	Only used for ad hoc discounts. The applied amount of the discount. This column input will not be accepted if OrderDiscounts column is added.
OrderDiscountAppliedMoneyCurrency	String	False	Only used for ad hoc discounts. The currency of the discount applied amount. This column input will not be accepted if OrderDiscounts column is added.
OrderDiscountCatalogObjectId	String	False	Only used for catalog discounts. The catalog object ID from exsiting CatalogDiscount. This column input will not be accepted if OrderDiscounts column is added.
OrderDiscountName	String	False	Only used for ad hoc discounts. The discount's name. This column input will not be accepted if OrderDiscounts column is added.
OrderDiscountPercentage	String	False	Only used for ad hoc discounts. The percentage of the discount, as a string representation of a decimal number. This column input will not be accepted if OrderDiscounts column is added.
OrderDiscountScope	String	False	Only used for ad hoc discounts. Indicates the level at which the discount applies. Possible values are OTHER_DISCOUNT_SCOPE, LINE_ITEM, ORDER. This column input will not be accepted if OrderDiscounts column is added.
OrderDiscountType	String	False	Only used for ad hoc discounts. The type of the discount. This column input will not be accepted if OrderDiscounts column is added.
OrderDiscountUID	String	False	Only used for ad hoc discounts. Unique ID that identifies the discount only within this order. This column input will not be accepted if OrderDiscounts column is added.
OrderDiscounts	String	False	The aggregate for the order discounts.

Result Set Columns


Name	Type	Description
Success	Boolean	Whether the transaction was successful.
OrderId	String	The transaction's unique ID, issued by Square payments servers.
Charged	Boolean	Whether the order is charged or not.
TransactionId	String	The transaction ID created after charging the order.

DeleteInvoiceAttachment

Removes an attachment from an invoice and permanently deletes the file.

Stored Procedure Specific Information

Execute

You must provide the Attachment Id of the attachment to delete along with its corresponding Invoice Id.

EXECUTE DeleteInvoiceAttachment InvoiceId = 'inv:0-ChC4p4-kE0gkhzWD2-NPhXiuEL0M' , AttachmentId = 'inva:0-ChAhhI2nQl9f_k2_vf6gR_Kq'

Input


Name	Type	Required	Description
InvoiceId	String	True	The ID of the invoice to delete the attachment from.
AttachmentId	String	True	The ID of the attachment to delete.

Result Set Columns


Name	Type	Description
Success	Boolean	Whether or not the attachment is removed from the invoice and deleted permanently.

PublishInvoice

Publishes the specified draft invoice.

Stored Procedure Specific Information

Execute

To execute this stored procedure, you need to provide the InvoiceId and its corresponding version number to publish. This version number must match the current version of the invoice; otherwise, the request is rejected.

EXEC PublishInvoice InvoiceId = 'inv:0-ChAALv-Dv-66y_I0TT0hCN2UEL0M', InvoiceVersion = 7

Input


Name	Type	Required	Description
InvoiceId	String	True	The ID of the invoice to publish.
InvoiceVersion	Int32	True	The version of the invoice to publish. This must match the current version of the invoice; otherwise, the request is rejected.

VoidTransaction

Cancels a transaction that was created with the Charge stored procedure with a DelayCapture value of true.

Input


Name	Type	Required	Description
TransactionId	String	True	The transaction's unique ID, issued by Square payments servers.

Result Set Columns


Name	Type	Description
Success	Boolean	Whether the transaction was canceled.

System Tables

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for Square:

sys_catalogs: Lists the available databases.
sys_schemas: Lists the available schemas.
sys_tables: Lists the available tables and views.
sys_tablecolumns: Describes the columns of the available tables and views.
sys_procedures: Describes the available stored procedures.
sys_procedureparameters: Describes stored procedure parameters.
sys_keycolumns: Describes the primary and foreign keys.
sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

sys_connection_props: Returns information on the available connection properties.
sys_sqlinfo: Describes the SELECT queries that the Cloud can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries:

sys_identity: Returns information about batch operations or single updates.

sys_catalogs

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns


Name	Type	Description
CatalogName	String	The database name.

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas

Columns


Name	Type	Description
CatalogName	String	The database name.
SchemaName	String	The schema name.

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables

Columns


Name	Type	Description
CatalogName	String	The database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view.
TableType	String	The table type (table or view).
Description	String	A description of the table or view.
IsUpdateable	Boolean	Whether the table can be updated.

sys_tablecolumns

Describes the columns of the available tables and views.

The following query returns the columns and data types for the Payments table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Payments'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view containing the column.
ColumnName	String	The column name.
DataTypeName	String	The data type name.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The storage size of the column.
DisplaySize	Int32	The designated column's normal maximum width in characters.
NumericPrecision	Int32	The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The column scale or number of digits to the right of the decimal point.
IsNullable	Boolean	Whether the column can contain null.
Description	String	A brief description of the column.
Ordinal	Int32	The sequence number of the column.
IsAutoIncrement	String	Whether the column value is assigned in fixed increments.
IsGeneratedColumn	String	Whether the column is generated.
IsHidden	Boolean	Whether the column is hidden.
IsArray	Boolean	Whether the column is an array.
IsReadOnly	Boolean	Whether the column is read-only.
IsKey	Boolean	Indicates whether a field returned from sys_tablecolumns is the primary key of the table.

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures

Columns


Name	Type	Description
CatalogName	String	The database containing the stored procedure.
SchemaName	String	The schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure.
Description	String	A description of the stored procedure.
ProcedureType	String	The type of the procedure, such as PROCEDURE or FUNCTION.

sys_procedureparameters

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the RefreshOAuthAccessToken stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='RefreshOAuthAccessToken' AND Direction=1 OR Direction=2

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the stored procedure.
SchemaName	String	The name of the schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure containing the parameter.
ColumnName	String	The name of the stored procedure parameter.
Direction	Int32	An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataTypeName	String	The name of the data type.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericPrecision	Int32	The maximum precision for numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The number of digits to the right of the decimal point in numeric data.
IsNullable	Boolean	Whether the parameter can contain null.
IsRequired	Boolean	Whether the parameter is required for execution of the procedure.
IsArray	Boolean	Whether the parameter is an array.
Description	String	The description of the parameter.
Ordinal	Int32	The index of the parameter.

sys_keycolumns

Describes the primary and foreign keys.

The following query retrieves the primary key for the Payments table:

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Payments'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
IsKey	Boolean	Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey	Boolean	Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.

sys_foreignkeys

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.
ForeignKeyType	String	Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

sys_primarykeys

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

         SELECT * FROM sys_primarykeys

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
KeySeq	String	The sequence number of the primary key.
KeyName	String	The name of the primary key.

sys_indexes

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

          SELECT * FROM sys_indexes WHERE IsPrimary='false'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the index.
SchemaName	String	The name of the schema containing the index.
TableName	String	The name of the table containing the index.
IndexName	String	The index name.
ColumnName	String	The name of the column associated with the index.
IsUnique	Boolean	True if the index is unique. False otherwise.
IsPrimary	Boolean	True if the index is a primary key. False otherwise.
Type	Int16	An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder	String	The sort order: A for ascending or D for descending.
OrdinalPosition	Int16	The sequence number of the column in the index.

sys_connection_props

Returns information on the available connection properties and those set in the connection string.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns


Name	Type	Description
Name	String	The name of the connection property.
ShortDescription	String	A brief description.
Type	String	The data type of the connection property.
Default	String	The default value if one is not explicitly set.
Values	String	A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value	String	The value you set or a preconfigured default.
Required	Boolean	Whether the property is required to connect.
Category	String	The category of the connection property.
IsSessionProperty	String	Whether the property is a session property, used to save information about the current connection.
Sensitivity	String	The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName	String	A camel-cased truncated form of the connection property name.
Ordinal	Int32	The index of the parameter.
CatOrdinal	Int32	The index of the parameter category.
Hierarchy	String	Shows dependent properties associated that need to be set alongside this one.
Visible	Boolean	Informs whether the property is visible in the connection UI.
ETC	String	Various miscellaneous information about the property.

sys_sqlinfo

Describes the SELECT query processing that the Cloud can offload to the data source.

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.


Name	Description	Possible Values
AGGREGATE_FUNCTIONS	Supported aggregation functions.	AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT	Whether COUNT function is supported.	YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR	The opening character used to escape an identifier.	[
IDENTIFIER_QUOTE_CLOSE_CHAR	The closing character used to escape an identifier.	]
SUPPORTED_OPERATORS	A list of supported SQL operators.	=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY	Whether GROUP BY is supported, and, if so, the degree of support.	NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIES	The supported varieties of outer joins supported.	NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS	Whether outer joins are supported.	YES, NO
SUBQUERIES	Whether subqueries are supported, and, if so, the degree of support.	NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONS	Supported string functions.	LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS	Supported numeric functions.	ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS	Supported date/time functions.	NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES	Indicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNS	A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERN	String value indicating what string is valid for an identifier.
SUPPORT_TRANSACTION	Indicates if the provider supports transactions such as commit and rollback.	YES, NO
DIALECT	Indicates the SQL dialect to use.
KEY_PROPERTIES	Indicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMAS	Indicates if multiple schemas may exist for the provider.	YES, NO
SUPPORTS_MULTIPLE_CATALOGS	Indicates if multiple catalogs may exist for the provider.	YES, NO
DATASYNCVERSION	The CData Data Sync version needed to access this driver.	Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY	The CData Data Sync category of this driver.	Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL	Whether enhanced SQL functionality beyond what is offered by the API is supported.	TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS	Whether batch operations are supported.	YES, NO
SQL_CAP	All supported SQL capabilities for this driver.	SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS	A string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERY	Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side.	YES, NO
PSEUDO_COLUMNS	A string array indicating the available pseudo columns.
MERGE_ALWAYS	If the value is true, The Merge Mode is forcibly executed in Data Sync.	TRUE, FALSE
REPLICATION_MIN_DATE_QUERY	A select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTION	Allows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATE	Allows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERY	A select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTION	Allows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE	A list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTID	Indicates whether the CheckCache statement should be done against the parent key column.	TRUE, FALSE
CREATE_SCHEMA_PROCEDURES	Indicates stored procedures that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns


Name	Type	Description
NAME	String	A component of SQL syntax, or a capability that can be processed on the server.
VALUE	String	Detail on the supported SQL or SQL syntax.

sys_identity

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

         SELECT * FROM sys_identity

Columns


Name	Type	Description
Id	String	The database-generated Id returned from a data modification operation.
Batch	String	An identifier for the batch. 1 for a single operation.
Operation	String	The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message	String	SUCCESS or an error message if the update in the batch failed.

sys_information

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns


Name	Type	Description
Product	String	The name of the product.
Version	String	The version number of the product.
Datasource	String	The name of the datasource the product connects to.
NodeId	String	The unique identifier of the machine where the product is installed.
HelpURL	String	The URL to the product's help documentation.
License	String	The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.)
Location	String	The file path location where the product's library is stored.
Environment	String	The version of the environment or rumtine the product is currently running under.
DataSyncVersion	String	The tier of CData Sync required to use this connector.
DataSyncCategory	String	The category of CData Sync functionality (e.g., Source, Destination).

Connection String Options

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

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

Authentication

Property	Description
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

Property	Description
OAuthClientId	Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecret	Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

SSL

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

Logging

Property	Description
Verbosity	Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Schema

Property	Description
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Schema	Specify the Square server version to connect with.

Miscellaneous

Property	Description
MaxRows	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
PageSize	The number of results to return per page of data retrieved from Square.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.

Authentication

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

Property	Description
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.

LocationId

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

Data Type

string

Default Value

""

Remarks

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.

UseSandbox

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

Data Type

bool

Default Value

false

Remarks

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

OAuth

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

Property	Description
OAuthClientId	Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecret	Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

OAuthClientId

Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.

Data Type

string

Default Value

""

Remarks

OAuthClientId is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

OAuthClientSecret

Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

Data Type

string

Default Value

""

Remarks

OAuthClientSecret is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

SSL

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

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

SSLServerCert

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

Data Type

string

Default Value

""

Remarks

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

This property can take the following forms:


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

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

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

Logging

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

Property	Description
Verbosity	Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Verbosity

Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Data Type

string

Default Value

"1"

Remarks

This property defines the level of detail the Cloud includes in the log file. Higher verbosity levels increase the detail of the logged information, but may also result in larger log files and slower performance due to the additional data being captured.

The default verbosity level is 1, which is recommended for regular operation. Higher verbosity levels are primarily intended for debugging purposes. For more information on each level, refer to Logging.

When combined with the LogModules property, Verbosity can refine logging to specific categories of information.

Schema

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

Property	Description
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Schema	Specify the Square server version to connect with.

BrowsableSchemas

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

Data Type

string

Default Value

""

Remarks

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

Schema

Specify the Square server version to connect with.

Possible Values

v1, v2

Data Type

string

Default Value

"v2"

Remarks

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

Miscellaneous

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

Property	Description
MaxRows	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
PageSize	The number of results to return per page of data retrieved from Square.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.

MaxRows

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

Data Type

int

Default Value

-1

Remarks

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

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

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

PageSize

The number of results to return per page of data retrieved from Square.

Data Type

string

Default Value

"500"

Remarks

Note that the PageSize must be between 1 and 1000. For order-related endpoints, it is recommended to set the PageSize between 1 and 300. If the PageSize is not specified within this range and there are more than 1,000 records, the API may throw a timeout exception.

PseudoColumns

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

Data Type

string

Default Value

""

Remarks

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

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

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

Timeout

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

Data Type

int

Default Value

60

Remarks

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

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

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

Cloud

Square - CData Cloud

Overview

Key Features

Getting Started

Connecting to Square

Accessing Data from CData Cloud Services

Establishing a Connection

Connecting to Square

Personal Access Token

Square Sandbox

OAuth

Post-Authentication Options

SSL Configuration

Customizing the SSL Configuration

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

Other Proxies

Data Model

Using Query Processing

Querying Several Business Locations

Square v1 Data Model

Stored Procedures

CData Cloud - Square Stored Procedures

ApplyFeeToItem

Input

Result Set Columns

RemoveFeeFromItem

Input

Result Set Columns

Square v2 Data Model

Tables

CData Cloud - Square Tables

Cards

Table Specific Information

Select

Insert

Delete

Columns

CatalogCategories

Table Specific Information

Select

Insert

Update

Delete

Columns

CatalogDiscounts

Table Specific Information

Select

Insert

Update

Delete

Columns

CatalogImages

Table Specific Information

Select

Insert

Update

Delete

Columns

CatalogItems

Table Specific Information

Select

Insert

Update

Delete

Columns

CatalogItemVariations

Table Specific Information

Select

Insert

Update

Delete

Columns

CatalogModifierLists

Table Specific Information

Select

Insert

Update