Establishing a Connection

Create a connection to Wave Financial by navigating to the Connections page in the Sync App application and selecting the corresponding icon in the Add Connections panel. 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.

Required properties are listed under the Settings tab. The Advanced tab lists connection properties that are not typically required.

Connecting to Wave Financial

You can connect to Sync App by specifying the APIToken You can obtain an API Token using the following steps:

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

OAuth

Alternatively, you can establish a connection Using OAuth Authentication.

Advanced Features

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

User Defined Views

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

SSL Configuration

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

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

See Query Processing for more information.

Logging

See Logging for an overview of configuration settings that can be used to refine CData logging. For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.

SSL Configuration

Customizing the SSL Configuration

By default, the Sync App attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.

In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.

Other Proxies

Set the following properties:

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

Data Model

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

Views are composed of columns and pseudo columns. Views are similar to tables in the way that data is represented; however, views do not support updates. Entities that are represented as views are typically read-only entities. Often, a stored procedure is available to update the data if such functionality is applicable to the data source.

Queries can be executed against a view as if it were a normal table, and the data that comes back is similar in that regard.

Dynamic views, such as queries exposed as views, and views for looking up specific combinations of project_team work items are supported.

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.

Accounts

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.

AccountSubtypes

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.

AccountTypes

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.

Businesses

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.
IsClassicAccounting	Bool			Does business use classic accounting system.
IsClassicInvoicing	Bool			Does business use classic invoicing system.
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.

Countries

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.

Currencies

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

Customers

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.

InvoiceItems

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

InvoiceItemTaxes

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.

Invoices

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.

ProductDefaultSalesTaxes

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.

ProductDefaultSalesTaxRates

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%).

Products

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.

Provinces

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.
Slug	String			Informal name for identification.
Name	String			Plain-language representation.

SalesTaxes

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.

SalesTaxRates

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%).

Vendors

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.

Connection String Options

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

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

Authentication

Property	Description
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	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.

SSL

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

Firewall

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

Proxy

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Logging

Property	Description
LogModules	Core modules to be included in the log file.

Schema

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Miscellaneous

Property	Description
MaxRows	Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
Other	These hidden properties are used only in specific use cases.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

Authentication

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.

AuthScheme

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.

APIToken

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

Remarks

You can obtain an API Token using the following steps:

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

OAuth

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

Property	Description
OAuthClientId	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.

OAuthClientId

The client Id assigned when you register your application with an OAuth authorization server.

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

OAuthClientSecret

The client secret assigned when you register your application with an OAuth authorization server.

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

SSL

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

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

SSLServerCert

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.

Firewall

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

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

FirewallType

The protocol used by a proxy-based firewall.

Remarks

This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that 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.


Type	Default Port	Description
TUNNEL	80	When this is set, the Sync App opens a connection to Wave Financial and traffic flows back and forth through the proxy.
SOCKS4	1080	When this is set, the Sync App 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 Sync App 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.

FirewallServer

The name or IP address of a proxy-based firewall.

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 Sync App uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.

FirewallPort

The TCP port for a proxy-based firewall.

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.

FirewallUser

The user name to use to authenticate with a proxy-based firewall.

Remarks

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

FirewallPassword

A password used to authenticate to a proxy-based firewall.

Remarks

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

Proxy

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

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

ProxyAutoDetect

This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

Remarks

This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

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

ProxyServer

The hostname or IP address of a proxy to route HTTP traffic through.

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The Sync App 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 Sync App uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.

ProxyPort

The TCP port the ProxyServer proxy is running on.

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.

ProxyAuthScheme

The authentication type to use to authenticate to the ProxyServer proxy.

Remarks

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

Note that the Sync App 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 Sync App performs HTTP BASIC authentication.
DIGEST: The Sync App performs HTTP DIGEST authentication.
NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
PROPRIETARY: The Sync App 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.

ProxyUser

A user name to be used to authenticate to the ProxyServer proxy.

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 user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:

user@domain
domain\user

ProxyPassword

A password to be used to authenticate to the ProxyServer proxy.

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 Sync App uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.

ProxySSLType

The SSL type to use when connecting to the ProxyServer proxy.

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 Sync App 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.

ProxyExceptions

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

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, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

Logging

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

Property	Description
LogModules	Core modules to be included in the log file.

LogModules

Core modules to be included in the log file.

Remarks

Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.

See the Logging page for an overview.

Schema

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

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Location

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Remarks

The path to a directory which contains the schema files for the Sync App (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) 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" with %APPDATA% being set to the user's configuration directory:

BrowsableSchemas

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Remarks

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

Tables

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Remarks

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

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

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 that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Views

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

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 that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Miscellaneous

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

Property	Description
MaxRows	Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
Other	These hidden properties are used only in specific use cases.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

MaxRows

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

Remarks

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

Other

These hidden properties are used only in specific use cases.

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

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.

PseudoColumns

This property indicates whether or not to include pseudo columns as columns to the table.

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; for example, "*=*".

Timeout

The value in seconds until the timeout error is thrown, canceling the operation.

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

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

UserDefinedViews

A filepath pointing to the JSON configuration file containing your custom views.

Remarks

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Sync App automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the Sync App.

This User Defined View configuration file is formatted as follows:

Each root element defines the name of a view.
Each root element contains a child element, called query, which contains the custom 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)"
	}
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

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