Adding a Connection to Wave Financial

To add a connection to Wave Financial:

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

For required properties, see the Settings tab.

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

Connecting to Wave Financial

Wave Financial provides two means of connecting to data: by specifying the API Token, or by using OAuth credentials.

API Token

To obtain the Wave Financial API Token:

1. Log into your Wave Financial account.
2. In the left pane, navigate to Manage Applications.
3. Select the application that you would like to create a token for. You may need to create an application first.
4. To generate the API Token, click Create token.

OAuth

Wave Financial 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 Wave Financial 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 creating 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 Wave Financial, see Connection.

The Sync App refreshes the access token automatically when it expires.

Automatic refresh of the OAuth access token

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

1. 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 Sync App to save the OAuth values, which persist across connections.
2. 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.

1. To manually refresh the OAuthAccessToken after the ExpiresIn period (returned by GetOAuthAccessToken) has elapsed, call the RefreshOAuthAccessToken stored procedure.
2. Set the following connection properties:
   • OAuthClientId = the Client Id in your application settings.
   • OAuthClientSecret = the Client Secret in your application settings.

3. Call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken.
4. 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.

This section details a selection of advanced features of the Wave Financial Sync App.

User Defined Views

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

SSL Configuration

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

Firewall and Proxy

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

Query Processing

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

For further information, see Query Processing.

Logging

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

Customizing the SSL Configuration

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

To specify another certificate, see the SSLServerCert connection property.

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

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

Other Proxies

Set the following properties:

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

Overview

The CData Sync App models Wave Financial objects as relational tables and views.

A Wave Financial object has relationships to other objects; in the tables, these relationships are expressed through foreign keys. The following sections show the available API objects and provide more information on executing SQL to Wave Financial APIs.

Schemas for most database objects are defined in simple, text-based configuration files.

Views

Views describes the available views. Views are statically defined to model Accounts, Customers, Products, and more.

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.

Wave Financial Connector for CData Sync Views

Name	Description
Accounts	Chart of Accounts for the business.
AccountSubtypes	List subtypes of accounts.
AccountTypes	List types of accounts.
Businesses	List businesses.
Countries	List countries.
Currencies	List currencies.
Customers	List of customers for the business.
InvoiceItems	The line items (product, unit and price) that make up the invoiced sale.
InvoiceItemTaxes	List of taxes applied to an invoice item.
Invoices	List of invoices for the business.
ProductDefaultSalesTaxes	Default sales taxes to apply on product.
ProductDefaultSalesTaxRates	Tax rates with their effective dates of application.
Products	List of products (and services) for the business.
Provinces	List of principal subdivisions.
SalesTaxes	List of sales taxes for the business.
SalesTaxRates	Tax rates with their effective dates of application
Vendors	List of vendors for the business.

Chart of Accounts for the business.

Table Specific Information

The Sync App uses the Wave Financial API to process some of the filters. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. For example, the following queries are processed server side.

SELECT

SELECT * FROM Accounts WHERE Id = 'QWNjb3VudDo4MDEyMDg4OD3MWUwYWYtZDZiZS00OGI3LWE1ZTAtNmYyNzU4N2IwNGNi'
SELECT * FROM Accounts WHERE BusinessId = 'QnVzaW5lc3M6MDU3MWUwYWYtZDZiZS00OGI3LWE1ZTAtNmYyNzU4N2IwNGNi'
SELECT * FROM Accounts WHERE Name = 'Accounting Fees'
SELECT * FROM Accounts WHERE TypeValue = 'EXPENSE'
SELECT * FROM Accounts WHERE SubtypeValue = 'CASH_AND_BANK'
SELECT * FROM Accounts WHERE IsArchived = true
SELECT * FROM Accounts WHERE TypeValue IN ('EXPENSE', 'LIABILITY')
SELECT * FROM Accounts WHERE SubtypeValue IN ('COST_OF_GOODS_SOLD', 'EXPENSE')

Columns

Name	Type	References	SupportedOperators	Description
Id [KEY]	String			Unique identifier for the account.
BusinessId	String	Businesses.id		The unique identifier for the business.
Name	String			Name of the account.
Description	String			User defined description for the account.
DisplayId	String			User defined id for the account.
CurrencyCode	String	Currencies.Code		Currency code.
TypeValue	String			Account type value.
SubtypeValue	String			Account subtype value.
NormalBalanceType	String			Credit or Debit.
IsArchived	Bool			Indicates whether the account is hidden from view by default.
Sequence	Int			Numerically increasing version, each representing a revision of account data. As soon as something modifies an account, its sequence is incremented.
Balance	Decimal			The balance of the account as of the current date.
BalanceInBusinessCurrency	Decimal			The balance of the account as of the current date in the business currency.

List subtypes of accounts.

Columns

Name	Type	References	SupportedOperators	Description
Value [KEY]	String			Account subtype value.
Name	String			Account subtype name.
AccountTypeName	String			Account type name for the subtype.
Archivable	Bool			Indicates if accounts of this subtype can be archived.
SystemCreated	Bool			Indicates if accounts of this subtype is system created accounts.

List types of accounts.

SELECT

SELECT * FROM AccountTypes

Columns

Name	Type	References	SupportedOperators	Description
Value [KEY]	String			Account type value.
Name	String			Account type name.
NormalBalanceType	String			Normal balance type of the account type.

List businesses.

Table Specific Information

The Sync App uses the Wave Financial API to process some of the filters. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. For example, the following queries are processed server side.

SELECT

SELECT name FROM Businesses WHERE Id = 'QnVzaW5lc3M6MDU3MWUwYWYtGI3LWE1ZTAtNmYyNzU4N2IwNGNi'

Columns

Name	Type	References	SupportedOperators	Description
Id [KEY]	String			The unique identifier for the business.
Name	String			The name of the business.
IsPersonal	Bool			Is the business a personal one with limited functionality compared to regular businesses.
OrganizationalType	String			The organization type of the business.
TypeName	String			The description of the business type in human-friendly form.
TypeValue	String			The enum value of the business type.
SubtypeName	String			The description of the business subtype in human-friendly form.
SubtypeValue	String			The enum value of the business subtype.
CurrencyCode	String	Currencies.Code		Currency code.
Timezone	String			The timezone of the business.
AddressLine1	String			Address line 1 (Street address/PO Box/Company name).
AddressLine2	String			Address line 2 (Apartment/Suite/Unit/Building).
AddressCity	String			City/District/Suburb/Town/Village.
AddressProvinceCode	String	Provinces.Code		[ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) identifier.
AddressCountryCode	String	Countries.Code		Country code.
AddressPostalCode	String			Zip/Postal Code.
Phone	String			The phone number of the business.
Fax	String			The fax number of the business.
Mobile	String			The mobile/cell number of the business.
TollFree	String			The toll free number of the business.
Website	String			The website of the business.
IsArchived	Bool			Is the business hidden from view by default.
CreatedAt	Datetime			When the business was created.
ModifiedAt	Datetime			When the business was last modified.

List countries.

Table Specific Information

The Sync App uses the Wave Financial API to process some of the filters. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. For example, the following queries are processed server side.

SELECT

SELECT * FROM Countries WHERE Code = 'US'

Columns

Name	Type	References	SupportedOperators	Description
Code [KEY]	String			Country code.
Name	String			Plain-language representation.
CurrencyCode	String	Currencies.Code		Currency code.
NameWithArticle	String			Name of the country with the appropriate article.

List currencies.

Table Specific Information

The Sync App uses the Wave Financial API to process some of the filters. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. For example, the following queries are processed server side.

SELECT

SELECT * FROM Currencies WHERE Code = 'USD'

Columns

Name	Type	References	SupportedOperators	Description
Code [KEY]	String			Currency code.
Symbol	String			Symbol used to denote that a number is a monetary value.
Name	String			Plain-language representation.
Plural	String			Plural version of currency name.
Exponent	Int			Expresses the relationship between a major currency unit and its minor currency unit. The number of digits found to the right of the decimal place to represent the fractional part of this currency (assumes a base of 10).

List of customers for the business.

Table Specific Information

The Sync App uses the Wave Financial API to process some of the filters. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. For example, the following queries are processed server side.

SELECT

SELECT * FROM Customers WHERE Id = 'QnVzaW5lc3M6NjE2MtYzVlMS00YzkyLTg0Y2EtNzA0ZDM4MTcyNTdlO0N1c3RvbWVyOjMyNzkyMTY1'
SELECT * FROM Customers WHERE BusinessId = 'QnVYtYzVlMS00YzkyLTg0Y2EtNzA0ZDM4MTcyNTdl'
SELECT * FROM Customers WHERE ModifiedAt > '2019-10-30 07:14:55.0' AND ModifiedAt < '2019-10-30 07:18:03.0'

Columns

Name	Type	References	SupportedOperators	Description
Id [KEY]	String			Unique identifier for the customer.
BusinessId	String	Businesses.id		The unique identifier for the business.
Name	String			Name or business name of the customer.
FirstName	String			First name of the principal contact.
LastName	String			Last name of the principal contact.
Email	String			Email of the principal contact.
AddressAddressLine1	String			Address line 1 (Street address/PO Box/Company name).
AddressAddressLine2	String			Address line 2 (Apartment/Suite/Unit/Building).
AddressCity	String			City/District/Suburb/Town/Village.
AddressProvinceCode	String	Provinces.Code		[ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) identifier.
AddressCountryCode	String	Countries.Code		Country code.
AddressPostalCode	String			Zip/Postal Code.
DisplayId	String			User defined id for the customer. Commonly referred to as Account Number.
Mobile	String			Mobile telephone number of the principal contact.
Phone	String			Telephone number of the customer.
Fax	String			Fax number of the customer.
TollFree	String			Toll-free number of the customer.
Website	String			Website address of the customer.
InternalNotes	String			Internal notes about the customer.
CurrencyCode	String	Currencies.Code		Currency code.
ShippingName	String			Name or business name of the customer.
ShippingAddressLine1	String			Address line 1 (Street address/PO Box/Company name).
ShippingAddressLine2	String			Address line 2 (Apartment/Suite/Unit/Building).
ShippingAddressCity	String			City/District/Suburb/Town/Village.
ShippingAddressProvinceCode	String	Provinces.Code		[ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) identifier.
ShippingAddressCountryCode	String	Countries.Code		Country code.
ShippingAddressPostalCode	String			Zip/Postal Code.
ShippingPhone	String			Telephone number of the customer.
ShippingInstructions	String			Delivery instructions for handling.
CreatedAt	Datetime			When the customer was created.
ModifiedAt	Datetime			When the customer was last modified.
IsArchived	Bool			Whether or not the customer is archived.

The line items (product, unit and price) that make up the invoiced sale.

Table Specific Information

The Sync App uses the Wave Financial API to process some of the filters. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. For example, the following queries are processed server side.

SELECT

SELECT * FROM InvoiceItems WHERE InvoiceId = 'QnVzaW5lc3M6MTY4NTYtYzVlMS00YzkyLTg0Y2EtNzA0ZDM4MTcyNTdl'

Columns

Name	Type	References	SupportedOperators	Description
ProductId [KEY]	String	Products.Id		Unique identifier for the associated product.
InvoiceId [KEY]	String	Invoices.Id		Unique identifier for the invoice.
Quantity	Decimal			Number of units.
UnitPrice	Decimal			Price per unit.
SubtotalValue	Decimal			Amount represented as a combination of the major and minor currency unit (uses a decimal separator).
SubtotalCurrencyCode	String	Currencies.Code		Currency code.
TotalValue	Decimal			Amount represented as a combination of the major and minor currency unit (uses a decimal separator).
TotalCurrencyCode	String	Currencies.Code		Currency code.
AccountId	String			Unique identifier for the account.

List of taxes applied to an invoice item.

SELECT

SELECT * FROM InvoiceItemTaxes

Columns

Name	Type	References	SupportedOperators	Description
SalesTaxId [KEY]	String			The unique identifier for the sales tax.
ProductId [KEY]	String	Products.Id		Associated product Id.
AmountValue	Decimal			Amount represented as a combination of the major and minor currency unit (uses a decimal separator).
AmountCurrencyCode	String	Currencies.Code		Currency code.

List of invoices for the business.

Table Specific Information

The Sync App uses the Wave Financial API to process some of the filters. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. For example, the following queries are processed server side.

SELECT

SELECT * FROM Invoices WHERE BusinessId = 'QnVzaW5lc3M6NjE2MTYtYzVlMS00YzkyLTg0Y2EtNzA0ZDM4MTcyNTdl'
SELECT * FROM Invoices WHERE CustomerID = 'QnVzaW5lc3M6NjE2MTY4NzVlMS00YzkyLTg0Y2EtNzA0ZDM4MTcyNTdlO0N1c3RvbWVyOjMyNzkyMTEz'
SELECT * FROM Invoices WHERE ModifiedAt < '2020-02-26 18:02:06.171'
SELECT * FROM Invoices WHERE InvoiceDate >= '2020-07-03'
SELECT * FROM Invoices WHERE Status = 'SENT'
SELECT * FROM Invoices WHERE CurrencyCode = 'USD'

Columns

Name	Type	References	SupportedOperators	Description
Id [KEY]	String			Unique identifier for the invoice.
BusinessId	String	Businesses.id		The unique identifier for the business.
CreatedAt	Datetime			When the invoice was created.
ModifiedAt	Datetime			When the invoice was last modified.
PdfUrl	String			URL to access PDF representation of the invoice.
ViewUrl	String			URL to view the invoice online as seen by a customer.
CustomerId	String	Customers.id		Unique identifier for the customer.
CustomerName	String			The customer's name.
Status	String			Status of the Invoice. The allowed values are DRAFT, OVERDUE, PAID, PARTIAL, SAVED, SENT, UNPAID, VIEWED.
Title	String			Invoice title at the top of the document.
Subhead	String			Invoice subheading text.
InvoiceNumber	String			Unique number assigned to the invoice.
PoNumber	String			Purchase order or sales order number for the invoice.
InvoiceDate	Date			Date when invoice is issued.
DueDate	Date			Date when payment is due.
AmountDueValue	Decimal			Amount represented as a combination of the major and minor currency unit (uses a decimal separator).
AmountDueCurrencyCode	String	Currencies.Code		Currency code.
AmountPaidValue	Decimal			Amount represented as a combination of the major and minor currency unit (uses a decimal separator).
AmountPaidCurrencyCode	String	Currencies.Code		Currency code.
TaxTotalValue	Decimal			Amount represented as a combination of the major and minor currency unit (uses a decimal separator).
TaxTotalCurrencyCode	String	Currencies.Code		Currency code.
TotalValue	Decimal			Amount represented as a combination of the major and minor currency unit (uses a decimal separator).
TotalCurrencyCode	String	Currencies.Code		Currency code.
CurrencyCode	String	Currencies.Code		Currency code.
ExchangeRate	Decimal			Exchange rate to business's currency from the invoice's currency. Used to value the invoice income within Wave's accounting transactions.
Memo	String			Invoice memo (notes) text.
Footer	String			Invoice footer text.
DisableCreditCardPayments	Bool			Within a business that is enabled to accept credit card payments, indicates if this individual invoice has been marked to not be payable by card.
DisableBankPayments	Bool			Within a business that is enabled to accept bank payments, indicates if this individual invoice has been marked to not be payable by bank payment.
ItemTitle	String			The label for the 'Item' column in the line items listing.
UnitTitle	String			The label for the 'Unit' column in the listing of line items on the invoice.
PriceTitle	String			The label for the 'Price' column in the listing of line items on the invoice.
AmountTitle	String			The label for the 'Amount' (= unit x price) column in the listing of line items on the invoice.
HideName	Bool			Indicates whether item's product name in item column is hidden in the line items listing.
HideDescription	Bool			Indicates whether item's description in item column is hidden in the line items listing.
HideUnit	Bool			Indicates whether item's unit is hidden in the line items listing.
HidePrice	Bool			Indicates whether item's price is hidden in the line items listing.
HideAmount	Bool			Indicates whether item's amount is hidden in the line items listing.
LastSentAt	Datetime			When the invoice was last sent.
LastSentVia	String			How the invoice was last sent.
LastViewedAt	Datetime			When the invoice was last viewed by the customer.
DisableAmexPayments	Bool			Within a business that is enabled to accept credit card payments, indicates if this individual invoice has been marked to not be payable by American Express.

Default sales taxes to apply on product.

Table Specific Information

The Sync App uses the Wave Financial API to process some of the filters. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. For example, the following queries are processed server side.

SELECT

SELECT * FROM ProductDefaultSalesTaxes WHERE ProductId = 'QnVzaW5lc3M6NjE2MTYtYzVlMS00YzkyLTg0Y'
SELECT * FROM ProductDefaultSalesTaxes WHERE BusinessId = 'QnVzaW5lc3M6NjE2MTY4NzVlMSyOjMyNzkyMTEz'

Columns

Name	Type	References	SupportedOperators	Description
Id [KEY]	String			The unique identifier for the sales tax.
ProductId [KEY]	String	Products.Id		Unique identifier for the product.
BusinessId	String	Businesses.Id		The unique identifier for the business.
Name	String			Name of the tax.
Abbreviation	String			A short form or code representing the sales tax.
Description	String			User defined description for the sales tax.
TaxNumber	String			The tax's issued identification number from a taxing authority.
ShowTaxNumberOnInvoices	Bool			Display tax number beside the tax name on an invoice.
Rate	Decimal			Tax rate effective on 'for' date, or current date if no parameter, as a decimal (e.g. 0.15 represents 15%).
IsCompound	Bool			Is a compound tax, or stacked tax. This tax is calculated on top of the subtotal and other tax amounts.
IsRecoverable	Bool			Is a recoverable tax. It is recoverable if you can deduct the tax that you as a business paid from the tax that you have collected.
IsArchived	Bool			Is the sales tax hidden from view by default.
CreatedAt	Datetime			When the sales tax was created.
ModifiedAt	Datetime			When the sales tax was last modified.

Tax rates with their effective dates of application.

Table Specific Information

The Sync App uses the Wave Financial API to process some of the filters. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. For example, the following queries are processed server side.

SELECT

SELECT * FROM ProductDefaultSalesTaxRates WHERE ProductId = 'QnVzaW5lc3M6NjE2MTYtYzVlMS00YzkyLTg0Y'
SELECT * FROM ProductDefaultSalesTaxRates WHERE BusinessId = 'QnVzaW5lc3M6NjE2MTY4NzVlMSyOjMyNzkyMTEz'

Columns

Name	Type	References	SupportedOperators	Description
SalesTaxId [KEY]	String	ProductDefaultSalesTaxes.Id		The unique identifier for the sales tax.
ProductId [KEY]	String	Products.Id		Unique identifier for the product.
BusinessId	String	Businesses.Id		The unique identifier for the business.
Effective	Date			Date from which the sales tax rate applies.
Rate	Decimal			Tax rate applying from the effective date as a decimal (e.g. 0.15 represents 15%).

List of products (and services) for the business.

Table Specific Information

The Sync App uses the Wave Financial API to process some of the filters. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. For example, the following queries are processed server side.

SELECT

SELECT * FROM Products WHERE BusinessId = 'QnVzaW5lc3M6NjE2MTYtYzVlMS00YzkyLTg0Y2EtNzA0ZDM4MTcyNTdl'
SELECT * FROM Products WHERE Id = 'QzVlMS00YzkyLTg0Y2EtNzA0ZDM4MTcyNTdlO0N1c3RvbWVyOjMyNzkyMTEz'
SELECT * FROM Products WHERE IsSold = true
SELECT * FROM Products WHERE IsBought = true
SELECT * FROM Products WHERE IsArchived = true
SELECT * FROM Products WHERE ModifiedAt < '2020-07-03 08:28:56.0'

Columns

Name	Type	References	SupportedOperators	Description
Id [KEY]	String			Unique identifier for the product.
BusinessId	String	Businesses.id		The unique identifier for the business.
Name	String			Name of the product.
Description	String			Description of the product.
UnitPrice	Decimal			Price per unit in the major currency unit.
IsSold	Bool			Is product sold by the business. Allow this product or service to be added to Invoices.
IsBought	Bool			Is product bought by the business. Allow this product or service to be added to Bills.
IncomeAccountId	String	Accounts.Id		Unique identifier for the account.
ExpenseAccountId	String	Accounts.Id		Unique identifier for the account.
IsArchived	Bool			Is the product hidden from view by default.
CreatedAt	Datetime			When the product was created.
ModifiedAt	Datetime			When the product was last modified.

List of principal subdivisions.

Table Specific Information

The Sync App uses the Wave Financial API to process some of the filters. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. For example, the following queries are processed server side.

SELECT

SELECT * FROM Provinces WHERE CountryCode = 'US'

Columns

Name	Type	References	SupportedOperators	Description
Code [KEY]	String			[ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) identifier.
CountryCode	String	Countries.Code		Country code.
Name	String			Plain-language representation.

List of sales taxes for the business.

Table Specific Information

The Sync App uses the Wave Financial API to process some of the filters. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. For example, the following queries are processed server side.

SELECT

SELECT * FROM SalesTaxes WHERE Id = 'QnVzaW5lc3M6NjE2MTYtYzVlMS00YzkyLTg0Y2EtNzA0ZDM4MTcyNTdl'
SELECT * FROM SalesTaxes WHERE BusinessId = 'QnVzaW5lc3M6NjE2MTY4NzVlMS00YzkyLTg0Y2EtNzA0ZDM4MTcyNTdlO0N1c3RvbWVyOjMyNzkyMTEz'
SELECT * FROM SalesTaxes WHERE ModifiedAt < '2020-02-26 18:02:06.171'
SELECT * FROM SalesTaxes WHERE IsArchived = true

Columns

Name	Type	References	SupportedOperators	Description
Id [KEY]	String			The unique identifier for the sales tax.
BusinessId	String	Businesses.id		The unique identifier for the business.
Name	String			Name of the tax.
Abbreviation	String			A short form or code representing the sales tax.
Description	String			User defined description for the sales tax.
TaxNumber	String			The tax's issued identification number from a taxing authority.
ShowTaxNumberOnInvoices	Bool			Display tax number beside the tax name on an invoice.
Rate	Decimal			Tax rate effective on 'for' date, or current date if no parameter, as a decimal (e.g. 0.15 represents 15%).
IsCompound	Bool			Is a compound tax, or stacked tax. This tax is calculated on top of the subtotal and other tax amounts.
IsRecoverable	Bool			Is a recoverable tax. It is recoverable if you can deduct the tax that you as a business paid from the tax that you have collected.
IsArchived	Bool			Is the sales tax hidden from view by default.
CreatedAt	Datetime			When the sales tax was created.
ModifiedAt	Datetime			When the sales tax was last modified.

Tax rates with their effective dates of application

Columns

Name	Type	References	SupportedOperators	Description
SalesTaxId [KEY]	String	SalesTaxes.Id		The unique identifier for the sales tax.
BusinessId	String	Businesses.Id		The unique identifier for the business.
Effective	Date			Date from which the sales tax rate applies.
Rate	Decimal			Tax rate applying from the effective date as a decimal (e.g. 0.15 represents 15%).

List of vendors for the business.

Table Specific Information

The Sync App uses the Wave Financial API to process some of the filters. The Sync App processes other filters client-side within the Sync App. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause inconsistent data. For example, the following queries are processed server side.

SELECT

SELECT * FROM Vendors WHERE Id = 'QnVzaW5lc3M6NjE2MTYtYzVlMS00YzkyLTg0Y2DM4MTcyNTdl'
SELECT * FROM Vendors WHERE ModifiedAt < '2020-02-26 18:02:06.171'

Columns

Name	Type	References	SupportedOperators	Description
Id [KEY]	String			Unique identifier for the customer.
BusinessId	String	Businesses.id		The unique identifier for the business.
Name	String			Name or business name of the vendor.
AddressLine1	String			Address line 1 (Street address/PO Box/Company name).
AddressLine2	String			Address line 2 (Apartment/Suite/Unit/Building).
AddressCity	String			City/District/Suburb/Town/Village.
AddressProvinceCode	String	Provinces.Code		[ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) identifier.
AddressCountryCode	String	Countries.Code		Country code.
AddressPostalCode	String			Zip/Postal Code.
FirstName	String			The first name of the principal contact.
LastName	String			The last name of the principal contact.
DisplayId	String			User defined id for the vendor. Commonly referred to as Account Number.
Email	String			Email of the principal vendor.
Mobile	String			The mobile number of the vendor.
Phone	String			The phone number of the vendor.
Fax	String			Fax number of the vendor.
TollFree	String			Toll-free number of the vendor.
Website	String			Website address of the vendor.
InternalNotes	String			Internal notes about the vendor.
CurrencyCode	String	Currencies.Code		Currency code.
ShippingName	String			Name or business name of the customer.
ShippingAddressLine1	String			Address line 1 (Street address/PO Box/Company name).
ShippingAddressLine2	String			Address line 2 (Apartment/Suite/Unit/Building).
ShippingAddressCity	String			City/District/Suburb/Town/Village.
ShippingAddressProvinceCode	String	Provinces.Code		[ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) identifier.
ShippingAddressCountryCode	String	Countries.Code		Country code.
ShippingAddressPostalCode	String			Zip/Postal Code.
ShippingPhone	String			Telephone number of the customer.
ShippingInstructions	String			Delivery instructions for handling.
CreatedAt	Datetime			When the vendor was created.
ModifiedAt	Datetime			When the vendor was last modified.
IsArchived	Bool			Whether or not the vendor is archived.

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
AuthScheme	The type of authentication to use when connecting to Wave Financial.
APIToken	The API token obtained when you register a Wave Financial application.

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.

Firewall

---

Property	Description
FirewallType	Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServer	Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPort	Specifies the TCP port to be used for a proxy-based firewall.
FirewallUser	Identifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPassword	Specifies the password of the user account authenticating to a proxy-based firewall.

Proxy

---

Property	Description
ProxyAutoDetect	Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServer	The hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort	The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthScheme	Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUser	The username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	The password associated with the user specified in the ProxyUser connection property.
ProxySSLType	The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Logging

---

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

Schema

---

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

Miscellaneous

---

Property	Description
MaxRows	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Other	Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
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.
UserDefinedViews	Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

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

---

Property	Description
AuthScheme	The type of authentication to use when connecting to Wave Financial.
APIToken	The API token obtained when you register a Wave Financial application.

The type of authentication to use when connecting to Wave Financial.

Remarks

• Token: Set this to perform Wave Financial token authentication.
• OAuth: Set this to perform Wave Financial OAuth authentication.

The API token obtained when you register a Wave Financial application.

Remarks

You can obtain an API Token using the following steps:

1. Log in to your Wave Financial account and navigate to Manage Applications in the left pane.
2. Select the application that you would like to create a token for. You may need to create an application first.
3. Click the Create token button to generate an APIToken

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.

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.

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.

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.

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.

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.

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

Remarks

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

This property can take the following forms:

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

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

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

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

---

Property	Description
FirewallType	Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServer	Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPort	Specifies the TCP port to be used for a proxy-based firewall.
FirewallUser	Identifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPassword	Specifies the password of the user account authenticating to a proxy-based firewall.

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

Remarks

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

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

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

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

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

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

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

Remarks

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

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

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

Remarks

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

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

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

Remarks

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

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

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

Remarks

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

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

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

---

Property	Description
ProxyAutoDetect	Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServer	The hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort	The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthScheme	Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUser	The username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	The password associated with the user specified in the ProxyUser connection property.
ProxySSLType	The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

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

Remarks

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

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

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

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

Remarks

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

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

Remarks

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

For other proxy types, see FirewallType.

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

Remarks

The authentication type can be one of the following:

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

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

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

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

Remarks

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

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

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

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

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

Remarks

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

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

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

For SOCKS 5 authentication or tunneling, see FirewallType.

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

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

Remarks

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

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

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

Remarks

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

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

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

---

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

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

Remarks

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

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

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

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

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

---

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

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

Remarks

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

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

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

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

Remarks

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

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

Remarks

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

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

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

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

Remarks

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

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

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

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.
Other	Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
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.
UserDefinedViews	Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

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

Remarks

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

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

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

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

Remarks

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

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

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

DefaultColumnSize	Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT	Determines 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.

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

Remarks

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

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

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

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

Remarks

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

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

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

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

Remarks

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

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

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

Refer to User Defined Views for more information.