Square Query Data Model

Connection String Options

  1. Auto Cache
  2. Cache Connection
  3. Cache Driver
  4. Cache Location
  5. Cache Metadata
  6. Cache Query Result
  7. Callback URL
  8. Connect On Open
  9. Firewall Password
  10. Firewall Port
  11. Firewall Server
  12. Firewall Type
  13. Firewall User
  14. Initiate OAuth
  15. Location
  16. Location Id
  17. Logfile
  18. Max Log File Size
  19. OAuth Access Token
  20. OAuth Client Id
  21. OAuth Client Secret
  22. OAuth Refresh Token
  23. OAuth Settings Location
  24. Offline
  25. Other
  26. Pool Idle Timeout
  27. Pool Max Size
  28. Pool Wait Time
  29. Proxy Auth Scheme
  30. Proxy Auto Detect
  31. Proxy Password
  32. Proxy Port
  33. Proxy Server
  34. Proxy SSL Type
  35. Proxy User
  36. Pseudo Columns
  37. Readonly
  38. RTK
  39. SSL Server Cert
  40. Support Enhanced SQL
  41. Tables
  42. Timeout
  43. Use Connection Pooling
  44. Verbosity
  45. Views

Auto Cache

Data Type

bool

Default Value

false

Remarks

When AutoCache is set, the driver automatically maintains a cache of your table's data in the database of your choice. With CacheQueryResult set, the driver updates the cache when you execute a SELECT query and returns the live results from the Square data.

 

Explicitly Caching SELECT Results

 

CacheQueryResult is a way to query Square in real time while maintaining a cache for offline use. Set CacheQueryResult to update the cache whenever you execute a SELECT statement. When you execute a SELECT statement with AutoCache and CacheQueryResult set, the driver executes the query to the remote data and caches the results; rows that already exist are overwritten. That is, SELECT statements are used to create and refresh the cache, not to query it. Data manipulation commands are executed to the remote data as well.

To query the cached data, set the Offline property. If you need to query the cached data in an online connection, you can append #CACHE to the table name. For example:

SELECT * FROM [Payments#CACHE]

 

 

Setting the Caching Database

 

When AutoCache is set, the driver caches to a simple, file-based cache. You can configure its location or cache to a different database with the following properties:

 

 

See Also

 

 

  • CacheQueryResult: Insert or update each row returned into the corresponding table in the cache.
  • Caching: Best Practices: This section provides more examples of using AutoCache with Offline, as well as information on determining a caching strategy.

    When this property is set, the driver builds a temporary, in-memory dataset that caches the results of the queries you execute. Result sets for subsequent queries are extracted from this dataset, if possible.

    This property is useful in BI, analytics, and other tools that generate queries for you. In these tools, explicit cache queries with the #CACHE syntax may not be an option.

  • CacheMetadata: This property reduces the amount of metadata that crosses the network by persisting table schemas retrieved from the Square metadata. Metadata then needs to be retrieved only once instead of every connection.
  • CACHE Statements: You can use the CACHE statement to persist any SELECT query, as well as manage the cache; for example, refreshing schemas.

 

 

 

Cache Connection

Data Type

string

Default Value

""

Remarks

The cache database is determined based on the CacheDriver and CacheConnection properties. Both properies are required to use the cache database. Examples of common cache database settings can be found below. For more information on setting the caching database's driver, refer to CacheDriver.

The connection string specified in the CacheConnection property is passed directly to the underlying CacheDriver. Consult the documentation for the specific JDBC driver for more information on the available properties. Make sure to include the JDBC driver in your application's classpath.

 

Derby and Java DB

 

The driver simplifies caching to Derby, only requiring you to set the CacheLocation property to make a basic connection.

Alternatively, you can configure the connection to Derby manually using CacheProvider and CacheConnection. Below is the Derby JDBC URL syntax:

jdbc:derby:[subsubprotocol:][databaseName][;attribute=value[;attribute=value] ... ]
For example, to cache to an in-memory database, use the following:
jdbc:derby:memory

 

 

SQLite

 

To cache to SQLite, you can use the SQLite JDBC driver. Below is the syntax of the JDBC URL:

jdbc:sqlite:dataSource
  • Data Source: The path to an SQLite database file. Or, use a value of :memory to cache in memory.

 

 

MySQL

 

The installation includes the CData JDBC Driver for MySQL. Below is an example JDBC URL:

jdbc:mysql:User=root;Password=root;Server=localhost;Port=3306;Database=cache
Below are typical connection properties:

 

 

  • Server: The IP address or domain name of the server you want to connect to.
  • Port: The port that the server is running on.
  • User: The username provided for authentication to the database.
  • Password: The password provided for authentication to the database.
  • Database: The name of the database.
SQL Server

 

The JDBC URL for the Microsoft JDBC Driver for SQL Server has the following syntax:

jdbc:sqlserver://[serverName[\instance][:port]][;database=databaseName][;property=value[;property=value] ... ]
For example:
jdbc:sqlserver://localhost\sqlexpress:1433;integratedSecurity=true
Below are typical SQL Server connection properties:
  • Server: The name or network address of the computer running SQL Server. To connect to a named instance instead of the default instance, this property can be used to specify the host name and the instance, separated by a backslash.
  • Port: The port SQL Server is running on.
  • Database: The name of the SQL Server database.
  • Integrated Security: Set this option to true to use the current Windows account for authentication. Set this option to false if you are setting the User and Password in the connection.

    To use integrated security, you will also need to add sqljdbc_auth.dll to a folder on the Windows system path. This file is located in the auth subfolder of the Microsoft JDBC Driver for SQL Server installation. The bitness of the assembly must match the bitness of your JVM.

  • User: The username provided for authentication with SQL Server. Only needed if you are not using integrated security.
  • Password: The password provided for authentication with SQL Server. Only needed if you are not using integrated security.
Oracle

 

Below is the conventional JDBC URL syntax for the Oracle JDBC Thin driver:

jdbc:oracle:thin:[userId/password]@[//]host[[:port][:sid]]
For example:
jdbc:oracle:thin:scott/tiger@myhost:1521:orcl
Below are typical connection properties:
  • Data Source: The connect descriptor that identifies the Oracle database. This can be a TNS connect descriptor, an Oracle Net Services name that resolves to a connect descriptor, or, after version 11g, an Easy Connect naming (the host name of the Oracle server with an optional port and service name).

  • Password: The password provided for authentication with the Oracle database.
  • User Id: The user Id provided for authentication with the Oracle database.
PostgreSQL

 

Below is the JDBC URL syntax for the official PostgreSQL JDBC driver:

jdbc:postgresql:[//[host[:port]]/]database[[?option=value][[&option=value][&option=value] ... ]]
For example, the following connection string connects to a database on the default host (localhost) and port (5432):
jdbc:postgresql:postgres
Below are typical connection properties:
  • Host: The address of the server hosting the PostgreSQL database.
  • Port: The port used to connect to the server hosting the PostgreSQL database.
  • Database: The name of the database.
  • Username: The user Id provided for authentication with the PostgreSQL database. You can specify this in the JDBC URL with the "user" parameter.
  • Password: The password provided for authentication with the PostgreSQL database.

 

 

Cache Driver

Data Type

string

Default Value

""

Remarks

You can cache to any database for which you have a JDBC driver, including CData JDBC drivers.

The cache database is determined based on the CacheDriver and CacheConnection properties. The CacheDriver is the name of the JDBC driver class that you would like to use to cache data.

Note that you must also add the CacheDriver JAR to the classpath.

The following examples show how to cache to several major databases. Refer to CacheConnection for more information on the JDBC URL syntax and typical connection properties.

Derby and Java DB

 

 

The driver simplifies Derby configuration. Java DB is the Oracle distribution of Derby. The JAR is shipped in the JDK. You can find the JAR, derby.jar, in the db subfolder of the JDK installation. In most caching scenarios, you need to specify only the following, after adding derby.jar to the classpath.

jdbc:square:CacheLocation='c:/Temp/cachedir';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyApplicationId;OAuthClientSecret=MyApplicationSecret;CallbackURL=http://localhost:33333;LocationId=MyDefaultLocation
To customize the Derby JDBC URL, use CacheDriver and CacheConnection. For example, to cache to an in-memory database, use a JDBC URL like the following:
jdbc:square:CacheDriver=org.apache.derby.jdbc.EmbeddedDriver;CacheConnection='jdbc:derby:memory';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyApplicationId;OAuthClientSecret=MyApplicationSecret;CallbackURL=http://localhost:33333;LocationId=MyDefaultLocation
SQLite

 

Below is a JDBC URL for the SQLite JDBC driver:

jdbc:square:CacheDriver=org.sqlite.JDBC;CacheConnection='jdbc:sqlite:C:/Temp/sqlite.db';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyApplicationId;OAuthClientSecret=MyApplicationSecret;CallbackURL=http://localhost:33333;LocationId=MyDefaultLocation
MySQL

 

Below is a JDBC URL for the included CData JDBC Driver for MySQL:

jdbc:square:Cache Driver=cdata.jdbc.mysql.MySQLDriver;Cache Connection='jdbc:mysql:Server=localhost;Port=3306;Database=cache;User=root;Password=123456';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyApplicationId;OAuthClientSecret=MyApplicationSecret;CallbackURL=http://localhost:33333;LocationId=MyDefaultLocation
The CData JDBC Driver for MySQL is located in the lib subfolder of the CData JDBC Driver for Square 2017 installation directory.
SQL Server

 

The following JDBC URL uses the Microsoft JDBC Driver for SQL Server:

jdbc:square:Cache Driver=com.microsoft.sqlserver.jdbc.SQLServerDriver;Cache Connection='jdbc:sqlserver://localhost\sqlexpress:7437;user=sa;password=123456;databaseName=Cache';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyApplicationId;OAuthClientSecret=MyApplicationSecret;CallbackURL=http://localhost:33333;LocationId=MyDefaultLocation
Oracle

 

Below is a JDBC URL for the Oracle Thin Client:

jdbc:square:Cache Driver=oracle.jdbc.driver.OracleDriver;CacheConnection='jdbc:oracle:thin:scott/tiger@localhost:1521:orcldb';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyApplicationId;OAuthClientSecret=MyApplicationSecret;CallbackURL=http://localhost:33333;LocationId=MyDefaultLocation
PostgreSQL

 

The following JDBC URL uses the official PostgreSQL JDBC driver:

jdbc:square:CacheDriver=org.postgresql.Driver;CacheConnection='jdbc:postgresql://localhost:5433/postgres?user=postgres&password=admin';InitiateOAuth=GETANDREFRESH;OAuthClientId=MyApplicationId;OAuthClientSecret=MyApplicationSecret;CallbackURL=http://localhost:33333;LocationId=MyDefaultLocation

 

 

Cache Location

Data Type

string

Default Value

""

Remarks

The CacheLocation is a simple, file-based cache. The driver uses Java DB, Oracle's distribution of the Derby database. To cache to Java DB, you will need to add the Java DB JAR to the classpath. The JAR, derby.jar, is shipped in the JDK and located in the db subfolder of the JDK installation.

CacheLocation defaults to the directory specified by the Location setting.

See Also

 

 

  • AutoCache: Set this to implicitly create and maintain a cache for later offline use.
  • CacheMetadata: Set this to persist the Square catalog in CacheLocation.

 

 

Cache Metadata

Data Type

bool

Default Value

false

Remarks

As you execute queries with this property set, table metadata in the Square catalog are cached to the file store specified by CacheLocation if set or the user's home directory otherwise. A table's metadata will be retrieved only once, when the table is queried for the first time.

When to Use CacheMetadata

 

The driver automatically persists metadata in memory for up to two hours when you first discover the metadata for a table or view and therefore, CacheMetadata is generally not required. CacheMetadata becomes useful when metadata operations are expensive such as when you are working with large amounts of metadata or when you have many short-lived connections.

When Not to Use CacheMetadata

 

 

  • When you are working with volatile metadata: Metadata for a table is only retrieved the first time the connection to the table is made. To pick up new, changed, or deleted columns, you would need to delete and rebuild the metadata cache. Therefore, it is best to rely on the in-memory caching for cases where metdata will change often.
  • When you are caching to a database: CacheMetadata can only be used with CacheLocation. If you are caching to another database with the CacheDriver and CacheConnection properties, use AutoCache to cache implicitly. Or, use CACHE Statements to cache explicitly.

 

 

Cache Query Result

Data Type

bool

Default Value

false

Remarks

When CacheQueryResult and AutoCache are set, the rows returned from a SELECT query are cached in the cache database. The driver handles caching in a streaming fashion with each row being processed into the cache database from the original result set as you read the row from the returned ResultSet object. This ensures that the live data is not queried twice. Note that any rows you do not read from the returned ResultSet will not be updated in the cache.

 

Callback URL

Data Type

string

Default Value

"http://localhost:33333"

Remarks

This value is the URL that Square redirects to during the authentication process.

 

Connect On Open

Data Type

bool

Default Value

false

Remarks

When set to 'true', a connection will be made to Square when the connection is opened. This property enables the 'Test Connection' feature available in various database tools.

This feature acts as a NOOP command as it is used to verify a connection can be made to Square and nothing from this initial connection is maintained.

Setting this property to 'false' may provide performance improvements (depending upon the number of times a connection is opened).

 

Firewall Password

Data Type

string

Default Value

""

Remarks

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.

 

Firewall Port

Data Type

string

Default Value

""

Remarks

This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.

 

Firewall Server

Data Type

string

Default Value

""

Remarks

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.

Note that the driver uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.

 

Firewall Type

Data Type

string

Default Value

"NONE"

Remarks

This property specifies the protocol that the driver will use to tunnel traffic through the FirewallServer proxy. Note that by default the driver connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

 

   
Type Default Port Description
TUNNEL 80 When this is set, the driver opens a connection to Square and traffic flows back and forth through the proxy.
SOCKS4 1080 When this is set, the driver sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted.
SOCKS5 1080 When this is set, the driver sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

 

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

 

 

Firewall User

Data Type

string

Default Value

""

Remarks

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication type specified in FirewallType.

 

Initiate OAuth

Data Type

string

Default Value

"OFF"

Remarks

The following options are available:

  1. OFF: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.
  2. GETANDREFRESH: Indicates that the entire OAuth Flow will be handled by the driver. If no token currently exists, it will be obtained by prompting the user via the browser. If a token exists, it will be refreshed when applicable.
  3. REFRESH: Indicates that the driver will only handle refreshing the OAuthAccessToken. The user will never be prompted by the driver to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.

 

 

Location

Data Type

string

Default Value

""

Remarks

The path to a directory which contains the schema files for the driver (.rsd files for tables and views, .rsb files for stored procedures). The Location property is only needed if you would like to customize definitions (e.g., change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.

The schema files used in your application must be deployed with other assemblies. You must also ensure that Location points to the folder that contains the schema files. The folder location can be a relative path from the location of the executable.

 

Location Id

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.

 

Logfile

Data Type

string

Default Value

""

Remarks

For more control over what is written to the log file, take a look at Verbosity.

 

Max Log File Size

Data Type

string

Default Value

""

Remarks

A string specifying the maximum size in bytes for a log file (ex: 10MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end. There is no limit by default. Values lower than 100kB will use 100kB as the value instead.

 

OAuth Access Token

Data Type

string

Default Value

""

Remarks

The OAuthAccessToken property is used to connect using OAuth. The OAuthAccessToken is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.

The access token is used in place of your username and password. The access token protects your credentials by keeping them on the server.

 

OAuth Client Id

Data Type

string

Default Value

""

Remarks

OAuth requires you to register your application. As part of the registration, you will receive a client Id, sometimes also called a consumer key, and a client secret. You must specify both the OAuthClientId and OAuthClientSecret to connect to an OAuth server.

 

OAuth Client Secret

Data Type

string

Default Value

""

Remarks

OAuth requires you to register your application. As part of the registration you will receive a client Id and a client secret, sometimes also called a consumer secret. You must specify both the OAuthClientId and OAuthClientSecret to connect to an OAuth server.

 

OAuth Refresh Token

Data Type

string

Default Value

""

Remarks

The OAuthRefreshToken property is used to refresh the OAuthAccessToken when using OAuth authentication.

 

OAuth Settings Location

Data Type

string

Default Value

"%APPDATA%\\CData\\Square Data Provider\\OAuthSettings.txt"

Remarks

When InitiateOAuth is set to GETANDREFRESH or REFRESH, the driver saves OAuth values to a settings file to avoid requiring the user to manually enter OAuth connection properties. The default OAuthSettingsLocation is a settings file located in the %AppData%\CData folder.

 

Offline

Data Type

bool

Default Value

false

Remarks

When Offline is set to TRUE, all queries execute against the cache as opposed to the live data source. In this mode, certain queries like INSERT, UPDATE, DELETE, and CACHE are not allowed.

 

Other

Data Type

string

Default Value

""

Remarks

The Other property is a semicolon-separated list of name-value pairs used in connection parameters specific to a data source.

Caching Configuration

 

   
CachePartial=True Caches only a subset of columns, which you can specify in your query.
QueryPassthrough=True Passes the specified query to the cache database instead of using the SQL parser of the driver.

 

Integration and Formatting

 

   
ConvertDateTimeToGMT Whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filename Records the underlying socket data transfer to the specified file.
ClientCulture This property can be used to specify the format of data (e.g., currency values) that is accepted by the client application. This property can be used when the client application does not support the machine's culture settings. For example, Microsoft Access requires 'en-US'.
Culture This setting can be used to specify culture settings that determine how the driver interprets certain data types that are passed into the driver. For example, setting Culture='de-DE' will output German formats even on an American machine.

 

 

Pool Idle Timeout

Data Type

string

Default Value

""

Remarks

The allowed idle time from when the connection is free to when the connection is released and returned to the pool. The default is 60 seconds.

 

Pool Max Size

Data Type

string

Default Value

"100"

Remarks

The maximum connections in the pool. The default is 100. To disable this property, set the property value to 0 or less.

 

Pool Wait Time

Data Type

string

Default Value

""

Remarks

The max seconds to wait for a connection to become available. If a new connection request is waiting for an available connection and exceeds this time, an error is thrown. By default, new requests wait forever for an available connection.

 

Proxy Auth Scheme

Data Type

string

Default Value

"BASIC"

Remarks

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.

Note that the driver will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

The authentication type can be one of the following:

  • BASIC: The driver performs HTTP BASIC authentication.
  • DIGEST: The driver performs HTTP DIGEST authentication.
  • NEGOTIATE: The driver retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
  • PROPRIETARY: The driver does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

 

 

Proxy Auto Detect

Data Type

bool

Default Value

true

Remarks

By default, the driver uses the system HTTP proxy. Set this to false if you want to connect to another proxy.

To connect to an HTTP proxy, see ProxyServer.

For other proxies, such as SOCKS or tunneling, see FirewallType.

 

Proxy Password

Data Type

string

Default Value

""

Remarks

This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.

If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.

If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.

For SOCKS 5 authentication or tunneling, see FirewallType.

By default, the driver uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.

 

Proxy Port

Data Type

string

Default Value

"80"

Remarks

The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.

 

Proxy Server

Data Type

string

Default Value

""

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The driver can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.

If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.

By default, the driver uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.

 

Proxy SSL Type

Data Type

string

Default Value

"AUTO"

Remarks

This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:

 

   
AUTO Default setting. If the URL is an HTTPS URL, the driver will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option.
ALWAYS The connection is always SSL enabled.
NEVER The connection is not SSL enabled.
TUNNEL The connection is through a tunneling proxy: The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

 

 

Proxy User

Data Type

string

Default Value

""

Remarks

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

You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the username of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a username in one of the following formats:

user@domain
domain\user

 

 

Pseudo Columns

Data Type

string

Default Value

""

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; i.e., "*=*".

 

Readonly

Data Type

bool

Default Value

false

Remarks

If this property is set to true, the driver will allow only SELECT queries. INSERT, UPDATE, DELETE, and stored procedure queries will cause an error to be thrown.

 

RTK

Data Type

string

Default Value

""

Remarks

The RTK property may be used to license a build. Please see the included licensing file to see how to set this property. The runtime key is only available if you purchased an OEM license.

 

SSL Server Cert

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 will be rejected.

This property can take the 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 will be accepted. Use '*' to signify to accept all certificates (not recommended for security concerns).

 

Support Enhanced SQL

Data Type

bool

Default Value

true

Remarks

When SupportEnhancedSQL is set to true, the driver offloads as much of the SELECT statement processing as possible to Square and then processes the rest of the query in memory. In this way the driver can execute unsupported predicates, joins, and aggregation.

When SupportEnhancedSQL is set to false, the driver limits SQL execution to what is supported by the Square API.

Execution of Predicates

 

The driver determines which of the clauses are supported by the data source and then pushes them to the source to get the smallest superset of rows that would satisfy the query. It then filters the rest of the rows locally. The filter operation is streamed, which enables the driver to filter effectively for even very large datasets.

Execution of Joins

 

The driver uses various techniques to join in memory. The driver trades off memory utilization against the requirement of reading the same table more than once.

Execution of Aggregates

 

The driver retrieves all rows necessary to process the aggregation in memory.

 

Tables

Data Type

string

Default Value

""

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the driver.

 

Timeout

Data Type

string

Default Value

"60"

Remarks

If the Timeout property is set to 0, operations do not time out: They run until they complete successfully or encounter an error condition.

If Timeout expires and the operation is not yet complete, the driver throws an exception.

 

Use Connection Pooling

Data Type

string

Default Value

"false"

Remarks

Enables connection pooling. The default is false. See Connection Pooling for information on using connection pools.

 

Verbosity

Data Type

string

Default Value

"1"

Remarks

The verbosity level determines the amount of detail that the driver reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are described below:

 

   
1 Setting Verbosity to 1 will log the query, the number of rows returned by it, the start of execution and the time taken, and any errors.
2 Setting Verbosity to 2 will log everything included in Verbosity 1, cache queries, and HTTP headers.
3 Setting Verbosity to 3 will additionally log the body of the HTTP requests.
4 Setting Verbosity to 4 will additionally log transport-level communication with the data source. This includes SSL negotiation.
5 Setting Verbosity to 5 will additionally log communication with the data source and additional details that may be helpful in troubleshooting problems. This includes interface commands.

The Verbosity should not be set to greater than 1 for normal operation. Substantial amounts of data can be logged at higher verbosities, which can delay execution times.

 

Views

Data Type

string

Default Value

""

Remarks

Listing the Views from some databases can be expensive. Providing a list of Views in the connection string improves the performance of the driver.




 

Tables

  1. Categories
  2. Cells
  3. Discounts
  4. Fees
  5. Items
  6. ItemVariations
  7. ModifierLists
  8. ModifierOptions
  9. Pages
  10. Refunds

Categories

Create, update, delete, and query available categories in Square.

 

Table Specific Information
Select

 

Select all Categories

SELECT * from Categories
Insert

 

To create a category, you will need to specify at least a Name.

INSERT INTO Categories (Name) VALUES ('My category')
Update

 

Categories may be modified by providing the Id of the category and issuing an UPDATE statement

UPDATE Categories SET Name = 'Cat Updated' WHERE Id='123456'
Delete

 

Categories may be deleted by providing the Id of the category and issuing a DELETE statement.

DELETE FROM Categories WHERE Id='123456'
Columns

 

 

 

   
Name Type ReadOnly Description
Id [KEY] String True

The Id of the category.

LocationId String False

The Id of the location.

Name String False

The internal name of the category.

 

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
Rows@Next String

This is used to page through multiple pages of results and should not be set manually.

 

 

 

Cells

Query, update and delete Cells of a favorite page in Square Register.

 

Table Specific Information

 

 

Select

 

Select cells of a page. A page Id is required.

SELECT * FROM Cells where PageId='abc123'
Insert

 

Insert a cell in the given page. PageId, Row , Column , ObjectType and either ObjectId or PlaceholderType are required.Note: Inserting to an already existing cell in the given row, column and PageId will overwrite the cell data.

INSERT into Cells (PageId, Row, Column, ObjectType, PlaceholderType) VALUES('123abc', 0, 0, 'PLACEHOLDER', 'ALL_ITEMS') 
Update

 

Update Pages and set cells.

UPDATE Cells SET Row=1, Column=1, ObjectType='DISCOUNT' WHERE PageID = 'aaa123'
Delete

 

Delete cells of a page

DELETE FROM Cells WHERE PageID='abc123' AND Row=1 AND Column=1
Columns

 

 

 

   
Name Type ReadOnly Description
PageId [KEY] String False

The unique identifier of the page the cell is included on.

LocationId String True

The Id of the location.

Row [KEY] Integer False

The row of the cell.

Column [KEY] Integer False

The column of the cell. Always an integer between 0 and 4, inclusive.

ObjectType String False

The type of entity represented in the cell (ITEM, DISCOUNT, CATEGORY, or PLACEHOLDER).

ObjectId String False

The unique identifier of the entity represented in the cell. Not present for cells with an object_type of PLACEHOLDER.

PlaceholderType String False

For a cell with an ObjectType of PLACEHOLDER, this value indicates the special behavior of the cell.

 

 

 

Discounts

Create, update, delete, and query Discounts for a merchant.

 

Table Specific Information
Select

 

Retrieve all Discounts:

SELECT * FROM Discounts
Insert

 

Name and Rate are required to insert a new discount:

INSERT INTO Discounts (PINRequired, DiscountType, Name, Rate) VALUES (false,'FIXED','Early Bird 700','0.2')
Update

 

Update an existing discount by specifying the discount Id and issuing an UPDATE statement

UPDATE Discounts SET pinrequired = false, discounttype = 'FIXED', name =' Early Bird 150', rate ='0.25' WHERE Id= '123445'"
Delete

 

Discounts can be deleted by specifying a discount Id and issuing a DELETE statement.

DELETE FROM Discounts WHERE Id='123456'
Columns

 

 

 

   
Name Type ReadOnly Description
Id [KEY] String True

The Id of the discount.

Name String False

The internal name of the discount.

LocationId String True

The Id of the location.

PINRequired Boolean False

Indicates whether a mobile staff member needs to enter their PIN to apply the discount to a payment.

DiscountType String False

Indicates whether the discount is a FIXED value or entered at the time of sale.

Rate String False

The rate of the discount.

MoneyAmount Integer True

The amount of the discount.

MoneyCurrencyCode String True

The currency code of the money amount.

Color String True

The color of the display label for the discount in Square Register, if not the default color. The default color is 9da2a6.

 

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
Rows@Next String

This is used to page through multiple pages of results and should not be set manually.

 

 

 

Fees

Create, update, delete, and query the Fees or taxes for a merchant.

 

Table Specific Information
Select

 

Select all Fees:

SELECT * FROM Fees
Insert

 

Name and Rate are required to insert.

INSERT INTO Fees (Name, Rate) VALUES ('Sales tax 6.25%','0.0625')
Update

 

Update an existing fee by specifying the fee Id and issuing an UPDATE statement

UPDATE Fees SET name = 'Sales tax 122', rate = '0.021' WHERE ID= '123'
Delete

 

Fees can be deleted by specifying a fee Id and issuing a DELETE statement.

DELETE FROM Fees WHERE Id='123'
Columns

 

 

 

   
Name Type ReadOnly Description
Id [KEY] String True

The Id of the fee.

Name String False

The internal name of the fee.

LocationId String True

The Id of the location.

Rate String False

The rate of the fee.

Type String True

The type of the fee.

CalculationPhase String True

Whether the fee is calculated based on the subtotal or total for a payment.

AdjustmentType String True

The type of adjustment the fee applies to a payment.

AppliesToCustomAmounts Boolean True

If true, the fee applies to custom amounts entered into Square Register that are not associated with a particular item.

Enabled Boolean True

If true, the fee is applied to all appropriate items. If false, the fee is not applied at all.

InclusionType String True

Whether the fee is ADDITIVE or INCLUSIVE.

 

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
Rows@Next String

This is used to page through multiple pages of results and should not be set manually.

 

 

 

Items

Create, update, delete, and query the available Items.

 

Table Specific Information
Select

 

Select all Items

SELECT * FROM Items
Insert

 

To insert an Item, you must specify at least a VariationsAggregate.

INSERT INTO Items (Name, Description, Visibility, VariationsAggregate) VALUES ('Jeep Rentals NEW', 'Our Daily Jeep Rates', 'Private', '[{\"name\": \"2 door\", \"pricing_type\": \"FIXED_PRICING\", \"price_money\": {\"currency_code\": \"USD\", \"amount\": 19900}, \"sku\": \"123\"}]')
Update

 

Update an existing item by specifying the item Id and issuing an UPDATE statement

UPDATE Items SET Name = 'Jeep Rentals Updated', Description = 'Updated Rates', Visibility = Private WHERE ID = '12345'
Delete

 

Fees can be deleted by specifying a fee Id and issuing a DELETE statement.

DELETE FROM Items WHERE Id='12345'
Columns

 

 

 

   
Name Type ReadOnly Description
Id [KEY] String True

The Id of the item.

LocationId String False

The Id of the location.

Name String False

The internal name of the item.

Description String False

The internal description of the item.

Visibility String False

The visibility of the item.

Type String True

The type of the item.

AvailableOnline Boolean True

The availability online of the item.

AvailableForPickup Boolean True

The availability for pick up of the item.

Color String True

The color of the item.

ImageUrl String True

The URL of the image uploaded for the item.

Abbreviation String True

The abbreviation of the name of the item.

CategoryId String True

The Id of the category the item belongs to, if any.

CategoryName String True

The name of the category the item belongs to, if any.

FeesAggregate String True

The fees that apply to the item, if any.

VariationsAggregate String False

The variations of the item.

ModifierListsAggregate String True

The modifier lists that apply to the item, 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
Rows@Next String

This is used to page through multiple pages of results and should not be set manually.

 

 

 

ItemVariations

Create, update, delete and query Item Variations of an existing item.

 

Table Specific Information
Select

 

To select from the ItemVariations table, you must provide an ItemId.

SELECT * FROM ItemVariations WHERE ItemId='abc123'
Insert

 

To insert into ItemVariations, specify at least the ItemId, Name, Amount, and CurrencyCode columns.

INSERT INTO ItemVariations (Name, CurrencyCode, Amount, TrackInventory, InventoryAlertType, InventoryAlertThreshold, UserData, ItemId)
VALUES ('Big','USD', 200, true, 'LOW_QUANTITY', 10, 'SEASONAL=TRUE', 'abc123')
Update

 

To update ItemVariations, you must specify both Id and ItemId.

UPDATE ItemVariations SET Name ='Small 55' WHERE Id='123abc' AND ItemId='abc123'
Delete

 

To delete from ItemVariations, you must specify both Id and ItemId.

DELETE FROM ItemVariations WHERE Id='123abc' AND ItemId='abc123'
Columns

 

 

 

   
Name Type ReadOnly Description
Id [KEY] String True

The unique Id of the variations for the item.

LocationId String False

The Id of the location.

Name String False

The name of the item variation.

ItemId String True

The Id of the item associated with the variation.

Ordinal Integer True

Indicates the list position of the variation when displayed in Square Register and the merchant dashboard.

PricingType String True

Indicates whether the price for the item variation price is fixed or determined at the time of the sale.

Amount Integer False

The amount of money for the price of the item variation, if any.

CurrencyCode String False

The type of currency for the price of the item variation, if any.

SKU String True

The SKU of the item variation, if any.

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 metadata associated with the variation. This cannot exceed 255 characters.

 

 

 

ModifierLists

Create, update, delete, and query the Modifier Lists of a merchant.

 

Table Specific Information
Select

 

Select all Modifier Lists:

SELECT * FROM ModifierLists
Insert

 

To insert into ModifierLists, you must specify at least the ModifierOptionsAggregate column:

INSERT INTO ModifierLists (Name, SelectionType, ModifierOptionsAggregate) VALUES ('Type', 'MULTIPLE', '[{\"name\": \"4 door\", \"price_money\": {\"currency_code\": \"USD\", \"amount\": 23900}}]')
Update

 

Update an existing list by specifying the list Id and issuing an UPDATE statement

UPDATE ModifierLists SET Name = 'Type Updated', selectiontype = 'MULTIPLE' WHERE ID = '1234'
Delete

 

A Modifier List can be deleted by specifying a list Id and issuing a DELETE statement.

DELETE FROM ModifierLists WHERE Id='1234'
Columns

 

 

 

   
Name Type ReadOnly Description
ID [KEY] String True

The unique identifier of the modifier list.

Name String False

The internal name of the modifier.

LocationId String False

The Id of the location.

SelectionType String False

The selection type of the modifier.

ModifierOptionsAggregate String False

The options included in the modifier list.

 

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
Rows@Next String

This is used to page through multiple pages of results and should not be set manually.

 

 

 

ModifierOptions

Create, update, delete, and query all of the Modifier Options for a merchant.

 

Table Specific Information
Select

 

ModifierListId must be specified to select from the ModifierOptions table.

SELECT * FROM ModifierOptions WHERE ModifierListId='abc123'
Insert

 

To insert into ModifierOptions, specify at least Name, Amount, CurrencyCode, and ModifierListId.

INSERT INTO ModifierOptions (Name, Amount, CurrencyCode, ModifierListId) VALUES ('LDW', 2000, 'USD', 'abc123')
Update

 

To update a ModifierOption, you must specify the Id and ModifierListId.

UPDATE ModifierOptions SET Name = 'LDW Updated' WHERE Id = 'aaa123' AND ModifierListId='123abc'
Delete

 

To delete from ModifierOptions, you must specify the Id and ModifierListId.

DELETE FROM ModifierOptions WHERE Id='123abc' AND ModifierListId='123123'
Columns

 

 

 

   
Name Type ReadOnly Description
Id [KEY] String True

The unique identifier for the modifier option.

LocationId String False

The Id of the location.

Name String False

The name of the modifier option.

Amount Integer False

The amount of money for the price of the modifier option.

CurrencyCode String False

The type of currency involved for the price of the modifier option.

OnByDefault Boolean True

If true, the modifier option is the default option in a modifier list for which the SelectionType is SINGLE.

Ordinal Integer True

Indicates the list position of a modifier option when displayed in Square Register and the merchant dashboard.

ModifierListId String True

The Id of the modifier list the option belongs to.

 

 

 

Pages

Create, update, delete, and query all of the Favorites Pages in Square Register for a Merchant.

 

Table Specific Information
Select

 

Retrieve all pages:

SELECT * FROM Pages
Insert

 

To create a new Page, specify at least Name and PageIndex:

INSERT INTO Pages (Name, PageIndex) VALUES ('Lunch Items 2', 2)
Update

 

To modify a Page, specify both the PageIndex and Id:

UPDATE Pages SET Name = 'Lunch Items 3', PageIndex=4 WHERE Id ='aaa123'
Delete

 

To remove a Page, specify the primary key:

DELETE from Pages WHERE Id='123abc'
Columns

 

 

 

   
Name Type ReadOnly Description
Id [KEY] String True

The unique identifier of the page.

LocationId String False

The Id of the location.

Name String False

The internal name of the page.

PageIndex Integer False

The position of the page in the list of pages for the merchant. Must be an integer between 0 and 4, inclusive.

CellsAggregate String True

The cells included on the page.

 

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
Rows@Next String

This is used to page through multiple pages of results and should not be set manually.

 

 

 

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

 

The Square API supports the SELECT operation and searching for Refunds related to a Transaction Tender:

SELECT * FROM Refunds WHERE TenderId ='123123'
Insert

 

To insert a Refund, specify the TenderId, Type, Reason, RefundedMoneyCurrencyCode, and RefundedMoneyAmount.

INSERT INTO Refunds (TenderId, Type,Reason, RefundedMoneyCurrencyCode, RefundedMoneyAmount)
            VALUES ('123123123', 'PARTIAL', 'Returned Goods', 'USD', -200)
Columns

 

 

 

   
Name Type ReadOnly Description
TenderId [KEY] String False

The Square-issued Id of the transaction tender the refund is applied to.

LocationId String True

The Id of the location.

MerchantId String False

The Square-issued Id of the merchant associated with the refund.

Type String False

The type of refund (FULL or PARTIAL).

CreatedAt Datetime True

The time when the merchant initiated the refund for Square to process.

ProcessedAt Datetime True

The time when Square processed the refund on behalf of the merchant.

Reason String False

The merchant-specified reason for the refund.

RefundedMoneyAmount Integer False

The amount of money refunded. This amount is always negative.

RefundedMoneyCurrencyCode String False

The currency code of the amount of money refunded.

RequestIdempotenceKey String False

An optional key to ensure idempotence if you issue the same PARTIAL refund request more than once.

 

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
Rows@Next String

This is used to page through multiple pages of results and should not be set manually.

 

 




 

Views

  1. BankAccounts
  2. Customers
  3. Employees
  4. Inventory
  5. Locations
  6. PaymentItemizations
  7. Payments
  8. Settlements
  9. Transactions
  10. TransactionTenders

BankAccounts

Query the Bank Accounts of the merchant.

 

Table Specific Information
Select

 

Retrieve all Bank Accounts:

SELECT * FROM BankAccounts
Columns

 

 

 

   
Name Type Description
Id [KEY] String The Square-issued Id of the bank account.
LocationId String The Id of the location.
MerchantId String The Square-issued Id of the merchant associated with the bank account.
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.
RoutingNumber String The routing number of the bank account.
AccountNumberSuffix String The last few digits of the bank account number.
CurrencyCode String The code of the currency associated with the bank account.

 

 

 

Customers

Query the available customers in Square.

 

Table Specific Information
Select

 

Retrieve all customers:

SELECT * FROM Customers
Columns

 

 

 

   
Name Type Description
Id [KEY] String The Id of the customer.
GivenName String The customer's given (i.e., first) name.
FamilyName String The customer's family (i.e., last) name.
Nickname String The customer's nickname.
Email String The customer's email address.
CompanyName String The name of the customer's company.
PhoneNumber String The customer's phone number.
Address String The customer's physical address.
CreatedAt String The time when the customer was created.
UpdatedAt String The time when the customer was last updated.
ReferenceId String A second ID you can set to associate the customer with an entity in another system.
Note String A note to associate with the customer.
CardsAggregate String The non-confidential details of the customer's cards on file.

 

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
Rows@Next String This is used to page through multiple pages of results and should not be set manually.

 

 

 

Employees

Query the available Employees in Square.

 

Table Specific Information
Select

 

Retrieve all Employees:

SELECT * FROM Employees
Columns

 

 

 

   
Name Type Description
Id [KEY] String The Id of the employee.
FirstName String The first name of the employee.
LastName String The last name of the employee.
Email String The email address of the employee.
Status String Whether the employee is ACTIVE or INACTIVE.
CreatedAt String The time when the employee entity was created.
UpdatedAt String The time when the employee entity was last updated.
ExternalId String An Id the merchant can set to associate the employee with an entity in another system.
RoleIdsAggregate String The Ids of the roles associated with the employee. Currently, you can specify only one role or zero roles per employee.
AuthorizedLocationIdsAggregate String The Ids of the locations the employee is allowed to clock in at.

 

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
Rows@Next String This is used to page through multiple pages of results and should not be set manually.

 

 

 

Inventory

Query Inventory information for all of the inventory-enabled item variations for a merchant.

 

Table Specific Information
Select

 

Retrieve all item variations in the inventory:

SELECT * FROM Inventory
Columns

 

 

 

   
Name Type Description
VariationId [KEY] String The variation Id that the entry corresponds to.
LocationId String The Id of the location.
QuantityOnHand Integer The quantity of the item.

 

 

 

Locations

Query Location information for a Merchant.

 

Table Specific Information
Select

 

Retrieve all Locations:

SELECT * FROM Locations
Columns

 

 

 

   
Name Type Description
Id [KEY] String The Id of the location.
Name String The name associated with the merchant account.
Email String The email address associated with the merchant account.
CountryCode String The country associated with the merchant account.
LanguageCode String The language associated with the merchant account.
CurrencyCode String The currency associated with the merchant account.
BusinessName String The name of the business of the merchant.
BusinessAddressAddressLine1 String Line 1 of the address of the business of the merchant.
BusinessAddressAddressLine2 String Line 2 of the address of the business of the merchant.
BusinessAddressLocality String The city or other locality of the business of the merchant.
BusinessAddressAdministrativeDistrictLevel1 String The district level of the address of the business of the merchant.
BusinessAddressPostalCode String The postal code of the business of the merchant.
BusinessPhoneCallingCode String The calling code of the phone number of the business of the merchant.
BusinessPhoneNumber String The phone number of the business of the merchant.
BusinessType String The type of business operated by the merchant.
ShippingAddressAddressLine1 String Line 1 of the shipping address of the merchant.
ShippingAddressLocality String The city or other locality of the shipping address of the merchant.
ShippingAddressAdministrativeDistrictLevel1 String The administrative district level of the shipping address of the merchant.
ShippingAddressPostalCode String The postal code of the shipping address of the merchant.
AccountType String Indicates whether the Square account of the merchant is a LOCATION or BUSINESS type.
AccountCapabilities String Capabilities that are enabled for the Square account for the merchant.
LocationDetailsNicknameAggregate String Additional information for a single-location account.
MarketURL String The URL of the online store of the merchant.

 

 

 

PaymentItemizations

Query the items of a payment.

 

Table Specific Information
Select

 

Retrieve all items of all Payments. The Square API returns Payment items that are not older than one year from now.

SELECT * FROM PaymentItemizations

 

Retrieve all the Items purchased in the Payment by providing a PaymentId:

SELECT * FROM PaymentItemizations WHERE PaymentId='abc123'  
Columns

 

 

 

   
Name Type Description
ItemId [KEY] String The Id of the item.
PaymentId [KEY] String The Id of the payment.
LocationId String The Id of the location.
Name String The name of the item.
Quantity String The quantity of the item purchased. This can be a decimal value.
TotalMoneyAmount Integer The total cost of the item, including all taxes and discounts.
TotalMoneyCurrency String The currency of the total cost of the item.
Notes String Notes entered by the merchant about the item at the time of payment, if any.
ItemVariationName String The name of the item variation purchased, if any.
ItemVariationId String The unique Id of the item variation purchased, if any.
SingleQuantityMoneyAmount Integer The cost of a single unit of this item.
SingleQuantityMoneyCurrency String The currency of a single unit of this item.
GrossSalesMoneyAmount Integer The total cost of the itemization and its modifiers, not including taxes or discounts.
GrossSalesMoneyCurrency String The currency of the itemization and its modifiers.
DiscountMoneyAmount Integer The total of all discounts applied to the itemization. This value is always negative or zero.
DiscountMoneyCurrency String The currency of the discount.
NetSalesMoneyAmount Integer The sum of GrossSalesMoney and DiscountMoney.
NetSalesMoneyCurrency String The currency of the net sales.
TaxesAggregate String The taxes applied to the purchase, in the JSON foramt.
ModifierOptioniD String The Id of the applied modifier option, if available. Modifier options applied in older versions of Square Register might not have an Id.
ModifierOptionName String The name of the modifier option.

 

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
Rows@Next String This is used to page through multiple pages of results and should not be set manually.

 

 

 

Payments

Query the available Payments in Square.

 

Table Specific Information
Select

 

Retrieve all Payments:

SELECT * FROM Payments

 

You can filter by the creation date of a Payment:

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

 

You can also filter by date, sort, and limit results. Note that you cannot query with a date older than one year from the current date or dates that are in the future.

SELECT * FROM Payments WHERE CreatedAt>'2016-12-25T00:00:00Z' ORDER BY CreatedAt DESC LIMIT 2
Columns

 

 

 

   
Name Type Description
Id [KEY] String The Id of the payment.
LocationId String The Id of the location.
MerchantId String The Id of the merchant.
CreatedAt Datetime The internal datetime of the payment.
CreatorId String The Id of the creator.
DeviceId String The Id of the device from where the payment was done.
DeviceName String The name of the device from where the payment was done.
PaymentURL String The URL of the detail page of the payment in the merchant dashboard.
ReceiptURL String The URL of the receipt for the payment.
InclusiveTaxMoneyCurrencyCode String The currency code of the sum of all inclusive taxes associated with the payment.
InclusiveTaxMoneyAmount Integer The sum of all inclusive taxes associated with the payment.
AdditiveTaxMoneyCurrencyCode String The currency code of the sum of all additive taxes associated with the payment.
AdditiveTaxMoneyAmount Integer The sum of all additive taxes associated with the payment.
TaxMoneyCurrencyCode String The currency code of the total of all taxes applied to the payment.
TaxMoneyAmount Integer The total of all taxes applied to the payment.
TipMoneyCurrencyCode String The currency code of the total of all tips applied to the payment.
TipMoneyAmount Integer The total of all tips applied to the payment.
DiscountMoneyCurrencyCode String The currency code of the total of all discounts applied to the payment.
DiscountMoneyAmount Integer The total of all discounts applied to the payment.
TotalCollectedMoneyCurrencyCode String The currency code of the total amount of money collected from the buyer for the payment.
TotalCollectedMoneyAmount Integer The total amount of money collected from the buyer for the payment.
ProcessingFeemoneyCurrencyCode String The currency code of the total of all processing fees collected by Square for the payment.
ProcessingFeeMoneyAmount Integer The total of all processing fees collected by Square for the payment.
NetTotalMoneyCurrencyCode String The currency code of the amount to be deposited into the bank account for the payment.
NetTotalMoneyAmount Integer The amount to be deposited into the bank account for the payment.
NetSalesMoneyCurrencyCode String The currency code of the total of the net sales from the payment.
NetSalesMoneyAmount Integer The total of the net sales from the payment.
GrossSalesMoneyCurrencyCode String The currency code of the total of the gross sales from the payment.
GrossSalesMoneyAmount Integer The total of the gross sales from the payment.
RefundedMoneyCurrencyCode String The currency code of the total of all refunds applied to the payment.
RefundedMoneyAmount Integer The total of all refunds applied to the payment.
InclusiveTaxAggregate String The sum of all inclusive taxes associated with the payment.
AdditiveTaxAggregate String The sum of all additive taxes associated with the payment.
TenderAggregate String The forms of tender provided by the buyer for the payment.
RefundsAggregate String All of the refunds applied to the payment.
ItemizationsAggregate String The items purchased in the 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
Rows@Next String This is used to page through multiple pages of results and should not be set manually.

 

 

 

Settlements

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

 

Table Specific Information
Select

 

Retrieve all Settlements:

SELECT * FROM Settlements
Columns

 

 

 

   
Name Type Description
Id [KEY] String The Id of the settlement.
LocationId String The Id of the location.
Status String The status of the settlement.
BankAccountId String The Id of the bank account.
InitiatedAt Datetime The date and time a settlement was initiated.
Amount String The amount of money involved in the settlement.
CurrencyCode String The currency code of the money involved in the settlement.
EntriesAggregate String The entries included in this settlement.

 

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
Rows@Next String This is used to page through multiple pages of results and should not be set manually.

 

 

 

Transactions

Query transactions processed with Square.

 

Table Specific Information
Select

 

Select all Transactions:

SELECT * FROM Transactions
Columns

 

 

 

   
Name Type Description
TransactionId [KEY] String The Id of the transaction.
TenderId [KEY] String The Id of the tender.
LocationId String The Id of the location.
CreatedAt Datetime The time when the transaction was created.
Product String The Square product that processed the transaction.
ClientId String If the transaction was created in the Square Register app, this value is the ID generated for the transaction by Square Register.
TenderCustomerId String If the tender represents a customer's card on file, this is the ID of the associated customer.
TenderMoneyAmount Integer The amount of the tender.
TenderMoneyAmountCurrency String The type of currency.
TenderCreatedAt Datetime The time when the transaction was created.
TenderNote String An optional note associated with the tender at the time of payment.
TenderType String The customer's nickname.

 

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
Rows@Next String This is used to page through multiple pages of results and should not be set manually.

 

 

 

TransactionTenders

Query transaction tenders processed with Square.

 

Table Specific Information
Select

 

Retrieve all transaction tenders:

SELECT * FROM TransactionTenders
Columns

 

 

 

   
Name Type Description
Id [KEY] String The Id of the transaction.
CustomerId String If the tender represents a customer's card on file, this is the ID of the associated customer.
MoneyAmount Integer The amount of the tender.
MoneyAmountCurrency String The type of currency.
LocationId String The Id of the location.
TransactionId String The ID of the tender's associated transaction.
CreatedAt Datetime The time when the transaction was created.
Note String An optional note associated with the tender at the time of payment.
Type String The customer's nickname.

 

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
Rows@Next String This is used to page through multiple pages of results and should not be set manually.