CData Cloud offers access to Wave Financial across several standard services and protocols, in a cloud-hosted solution. Any application that can connect to a SQL Server database can connect to Wave Financial through CData Cloud.
CData Cloud allows you to standardize and configure connections to Wave Financial as though it were any other OData endpoint or standard SQL Server.
This page provides a guide to Establishing a Connection to Wave Financial in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.
Establishing a Connection shows how to authenticate to Wave Financial and configure any necessary connection properties to create a database in CData Cloud
Accessing data from Wave Financial through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.
Connect to Wave Financial by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.
The following subsections describe how to authenticate to Wave Financial from three common authentication flows:
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 Cloud refreshes the access token automatically when it expires.
Automatic refresh of the OAuth access token
To have the Cloud automatically refresh the OAuth access token, do the following:
Manual refresh of the OAuth Access Token
The only value needed to manually refresh the OAUth access token is the OAuth refresh token.
Store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.
By default, the Cloud attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.
To specify another certificate, see the SSLServerCert connection property.
To authenticate to an HTTP proxy, set the following:
Set the following properties:
The CData Cloud 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 describes the available views. Views are statically defined to model Accounts, Customers, Products, and more.
The Cloud models the data in Wave Financial as a list of tables in a relational database that can be queried using standard SQL statements.
| Name | Description |
| Invoices | List of invoices for the business. |
List of invoices for the business.
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'
The following columns can be used to create a new record:
BusinessId, CustomerId, Status, Title, Subhead, InvoiceNumber, PoNumber, InvoiceDate, DueDate, CurrencyCode, ExchangeRate, Memo, Footer, DisableCreditCardPayments, DisableBankPayments, ItemTitle, UnitTitle, PriceTitle, AmountTitle, HideName, HideDescription, HideUnit, HidePrice, HideAmount, DisableAmexPayments, RequireTermsOfServiceAgreement
The following pseudo-columns can be used to create a new record:
InvoiceItems (references InvoiceItems), FixedInvoiceDiscounts (references FixedInvoiceDiscounts), PercentageInvoiceDiscounts (references PercentageInvoiceDiscounts)
| Column Name | Type | Description |
| ProductId | String | Unique identifier for the associated product. |
| Description | String | Detailed description. |
| Quantity | Decimal | Number of units. |
| UnitPrice | Decimal | Price per unit. |
| InvoiceItemTaxes (references InvoiceItemTaxes) | String | The item's taxes. |
| Column Name | Type | Description |
| Name | String | A description of the discount. |
| Amount | Decimal | The amount of the discount. |
| Column Name | Type | Description |
| Name | String | A description of the discount. |
| Percentage | Decimal | The percentage of the discount. |
| Column Name | Type | Description |
| SalesTaxId | String | The unique identifier for the sales tax. |
| AmountValue | Decimal | Amount represented as a combination of the major and minor currency unit (uses a decimal separator). |
INSERT INTO InvoiceItemTaxes#TEMP (ParentId, RowId, SalesTaxId, AmountValue) VALUES (1, 1, 'QnVzaW5lc3M6ZGVlMjVhM2YtNjRjOS00ZmI0LWE5MmYtYTRiMTYyMTFhMjg1O1NhbGVzVGF4OjE5NTgzNDUzMjQ=',10);
INSERT INTO InvoiceItemTaxes#TEMP (ParentId, RowId, SalesTaxId, AmountValue) VALUES (1, 2, 'QnVzaW5lc3M6ZGVlMjVhM2YtNjRjOS00ZmI0LWE5MmYtYTRiMTYyMTFhMjg1O1NhbGVzVGF4OjE5NTgzNDUzNzU=',15);
INSERT INTO InvoiceItemTaxes#TEMP (ParentId, RowId, SalesTaxId, AmountValue) VALUES (2, 1, 'QnVzaW5lc3M6ZGVlMjVhM2YtNjRjOS00ZmI0LWE5MmYtYTRiMTYyMTFhMjg1O1NhbGVzVGF4OjE5NTgzNDUzMjQ=',12);
INSERT INTO InvoiceItemTaxes#TEMP (ParentId, RowId, SalesTaxId, AmountValue) VALUES (2, 2, 'QnVzaW5lc3M6ZGVlMjVhM2YtNjRjOS00ZmI0LWE5MmYtYTRiMTYyMTFhMjg1O1NhbGVzVGF4OjE5NTgzNDUzNzU=',14);
INSERT INTO InvoiceItems#TEMP (RowId, ProductId, Description, Quantity, UnitPrice, InvoiceItemTaxes) VALUES (1, 'QnVzaW5lc3M6ZGVlMjVhM2YtNjRjOS00ZmI0LWE5MmYtYTRiMTYyMTFhMjg1O1Byb2R1Y3Q6NjgxNjk2OTY=', 'Description', 50, 100, 'InvoiceItemTaxes#TEMP');
INSERT INTO InvoiceItems#TEMP (RowId, ProductId, Description, Quantity, UnitPrice, InvoiceItemTaxes) VALUES (2, 'QnVzaW5lc3M6ZGVlMjVhM2YtNjRjOS00ZmI0LWE5MmYtYTRiMTYyMTFhMjg1O1Byb2R1Y3Q6NjgxNjk2OTY=', 'Description', 75, 200, 'InvoiceItemTaxes#TEMP');
INSERT INTO PercentageInvoiceDiscounts#TEMP (RowId, Name, Percentage) VALUES (1, 'Discount', 10);
INSERT INTO Invoices (BusinessId, CustomerId, Status, CurrencyCode, Title, Subhead, InvoiceNumber, PoNumber, InvoiceDate, ExchangeRate, DueDate, InvoiceItems, PercentageInvoiceDiscounts, Memo, Footer, DisableAmexPayments, DisableBankPayments, ItemTitle, UnitTitle, PriceTitle, AmountTitle, HideName, HideDescription, HideUnit, HidePrice, HideAmount) VALUES ('QnVzaW5lc3M6ZGVlMjVhM2YtNjRjOS00ZmI0LWE5MmYtYTRiMTYyMTFhMjg1', 'QnVzaW5lc3M6ZGVlMjVhM2YtNjRjOS00ZmI0LWE5MmYtYTRiMTYyMTFhMjg1O0N1c3RvbWVyOjk0MjM2OTg1', 'SAVED', 'EUR', 'Invoice', 'Subhead', '24', '128', '2025-05-20', 10.42, '2025-05-26', 'InvoiceItems#TEMP', 'PercentageInvoiceDiscounts#TEMP', 'Memo', 'Footer', false, false, 'Items', 'Quantity', 'Price', 'Amount', false, false, false, false, false);
| Name | Type | ReadOnly | References | SupportedOperators | Description |
| Id [KEY] | String | False |
Unique identifier for the invoice. | ||
| BusinessId | String | False |
Businesses.id |
The unique identifier for the business. | |
| CreatedAt | Datetime | False |
When the invoice was created. | ||
| ModifiedAt | Datetime | False |
When the invoice was last modified. | ||
| PdfUrl | String | False |
URL to access PDF representation of the invoice. | ||
| ViewUrl | String | False |
URL to view the invoice online as seen by a customer. | ||
| CustomerId | String | False |
Customers.id |
Unique identifier for the customer. | |
| CustomerName | String | False |
The customer's name. | ||
| Status | String | False |
Status of the Invoice. The allowed values are DRAFT, OVERDUE, PAID, PARTIAL, SAVED, SENT, UNPAID, VIEWED. | ||
| Title | String | False |
Invoice title at the top of the document. | ||
| Subhead | String | False |
Invoice subheading text. | ||
| InvoiceNumber | String | False |
Unique number assigned to the invoice. | ||
| PoNumber | String | False |
Purchase order or sales order number for the invoice. | ||
| InvoiceDate | Date | False |
Date when invoice is issued. | ||
| DueDate | Date | False |
Date when payment is due. | ||
| AmountDueValue | Decimal | False |
Amount represented as a combination of the major and minor currency unit (uses a decimal separator). | ||
| AmountDueCurrencyCode | String | False |
Currencies.Code |
Currency code. | |
| AmountPaidValue | Decimal | False |
Amount represented as a combination of the major and minor currency unit (uses a decimal separator). | ||
| AmountPaidCurrencyCode | String | False |
Currencies.Code |
Currency code. | |
| TaxTotalValue | Decimal | False |
Amount represented as a combination of the major and minor currency unit (uses a decimal separator). | ||
| TaxTotalCurrencyCode | String | False |
Currencies.Code |
Currency code. | |
| TotalValue | Decimal | False |
Amount represented as a combination of the major and minor currency unit (uses a decimal separator). | ||
| TotalCurrencyCode | String | False |
Currencies.Code |
Currency code. | |
| CurrencyCode | String | False |
Currencies.Code |
Currency code. | |
| ExchangeRate | Decimal | False |
Exchange rate to business's currency from the invoice's currency. Used to value the invoice income within Wave's accounting transactions. | ||
| Memo | String | False |
Invoice memo (notes) text. | ||
| Footer | String | False |
Invoice footer text. | ||
| DisableCreditCardPayments | Bool | False |
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 | False |
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 | False |
The label for the 'Item' column in the line items listing. | ||
| UnitTitle | String | False |
The label for the 'Unit' column in the listing of line items on the invoice. | ||
| PriceTitle | String | False |
The label for the 'Price' column in the listing of line items on the invoice. | ||
| AmountTitle | String | False |
The label for the 'Amount' (= unit x price) column in the listing of line items on the invoice. | ||
| HideName | Bool | False |
Indicates whether item's product name in item column is hidden in the line items listing. | ||
| HideDescription | Bool | False |
Indicates whether item's description in item column is hidden in the line items listing. | ||
| HideUnit | Bool | False |
Indicates whether item's unit is hidden in the line items listing. | ||
| HidePrice | Bool | False |
Indicates whether item's price is hidden in the line items listing. | ||
| HideAmount | Bool | False |
Indicates whether item's amount is hidden in the line items listing. | ||
| LastSentAt | Datetime | False |
When the invoice was last sent. | ||
| LastSentVia | String | False |
How the invoice was last sent. | ||
| LastViewedAt | Datetime | False |
When the invoice was last viewed by the customer. | ||
| DisableAmexPayments | Bool | False |
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. | ||
| RequireTermsOfServiceAgreement | Bool | False |
Indicates whether the customer is required to accept the terms of service. This feature is available to Wave's online payments customers. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| InvoiceItems | String |
The line items (product, unit and price) that make up the invoiced sale. |
| FixedInvoiceDiscounts | String |
The fixed discounts applied to the invoice (currently limited to max 1). |
| PercentageInvoiceDiscounts | String |
The percentage discounts applied to the invoice (currently limited to max 1). |
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.
| 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. |
| FixedInvoiceDiscounts | List of fixed invoice discounts 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. |
| PercentageInvoiceDiscounts | List of percentage invoice discounts 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.
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')
| 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.
| 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 * FROM AccountTypes
| 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.
SELECT name FROM Businesses WHERE Id = 'QnVzaW5lc3M6MDU3MWUwYWYtGI3LWE1ZTAtNmYyNzU4N2IwNGNi'
| 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.
SELECT * FROM Countries WHERE Code = 'US'
| 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.
SELECT * FROM Currencies WHERE Code = 'USD'
| 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.
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'
| 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. | ||
| 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. |
List of fixed invoice discounts for the business.
SELECT * FROM FixedInvoiceDiscounts WHERE BusinessId = 'QnVzaW5lc3M6NjE2MTYtYzVlMS00YzkyLTg0Y2EtNzA0ZDM4MTcyNTdl' SELECT * FROM FixedInvoiceDiscounts WHERE InvoiceId = 'QnVzaW5lc3M6ZGVlMjVhM2YtNjRjOS00ZmI0LWE5MmYtYTRiMTYyMTFhMjg1O0ludm9pY2U6MjI2NDExMDcwODE5MzAxNDgwMQ=='
| Name | Type | References | SupportedOperators | Description |
| BusinessId | String |
Businesses.id | The unique identifier for the business. | |
| InvoiceId | String |
Invoices.Id | Unique identifier for the invoice. | |
| Name | String | A description of the discount. | ||
| CreatedAt | Datetime | When the invoice discount was created. | ||
| ModifiedAt | Datetime | When the invoice discount was last modified. | ||
| Amount | Decimal | The amount of the discount. |
The line items (product, unit and price) that make up the invoiced sale.
SELECT * FROM InvoiceItems WHERE InvoiceId = 'QnVzaW5lc3M6MTY4NTYtYzVlMS00YzkyLTg0Y2EtNzA0ZDM4MTcyNTdl'
| 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. | |
| Description | String | Detailed description. | ||
| 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. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| InvoiceItemTaxes | String | The item's taxes. |
List of taxes applied to an invoice item.
SELECT * FROM InvoiceItemTaxes
| 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 percentage invoice discounts for the business.
SELECT * FROM PercentageInvoiceDiscounts WHERE BusinessId = 'QnVzaW5lc3M6NjE2MTYtYzVlMS00YzkyLTg0Y2EtNzA0ZDM4MTcyNTdl' SELECT * FROM PercentageInvoiceDiscounts WHERE InvoiceId = 'QnVzaW5lc3M6ZGVlMjVhM2YtNjRjOS00ZmI0LWE5MmYtYTRiMTYyMTFhMjg1O0ludm9pY2U6MjI2NDExMDcwODE5MzAxNDgwMQ=='
| Name | Type | References | SupportedOperators | Description |
| BusinessId | String |
Businesses.id | The unique identifier for the business. | |
| InvoiceId | String |
Invoices.Id | Unique identifier for the invoice. | |
| Name | String | A description of the discount. | ||
| CreatedAt | Datetime | When the invoice discount was created. | ||
| ModifiedAt | Datetime | When the invoice discount was last modified. | ||
| Percentage | Decimal | The percentage of the discount. |
Default sales taxes to apply on product.
SELECT * FROM ProductDefaultSalesTaxes WHERE ProductId = 'QnVzaW5lc3M6NjE2MTYtYzVlMS00YzkyLTg0Y' SELECT * FROM ProductDefaultSalesTaxes WHERE BusinessId = 'QnVzaW5lc3M6NjE2MTY4NzVlMSyOjMyNzkyMTEz'
| 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.
SELECT * FROM ProductDefaultSalesTaxRates WHERE ProductId = 'QnVzaW5lc3M6NjE2MTYtYzVlMS00YzkyLTg0Y' SELECT * FROM ProductDefaultSalesTaxRates WHERE BusinessId = 'QnVzaW5lc3M6NjE2MTY4NzVlMSyOjMyNzkyMTEz'
| Name | Type | References | SupportedOperators | Description |
| SalesTaxId [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. | |
| 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.
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'
| 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.
SELECT * FROM Provinces WHERE CountryCode = 'US'
| 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.
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
| 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
| 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.
SELECT * FROM Vendors WHERE Id = 'QnVzaW5lc3M6NjE2MTYtYzVlMS00YzkyLTg0Y2DM4MTcyNTdl' SELECT * FROM Vendors WHERE ModifiedAt < '2020-02-26 18:02:06.171'
| 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. | ||
| 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. |
Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT operations with Wave Financial.
Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Wave Financial, along with an indication of whether the procedure succeeded or failed.
| Name | Description |
You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.
The following tables return database metadata for Wave Financial:
The following tables return information about how to connect to and query the data source:
The following table returns query statistics for data modification queries:
Lists the available databases.
The following query retrieves all databases determined by the connection string:
SELECT * FROM sys_catalogs
| Name | Type | Description |
| CatalogName | String | The database name. |
Lists the available schemas.
The following query retrieves all available schemas:
SELECT * FROM sys_schemas
| Name | Type | Description |
| CatalogName | String | The database name. |
| SchemaName | String | The schema name. |
Lists the available tables.
The following query retrieves the available tables and views:
SELECT * FROM sys_tables
| Name | Type | Description |
| CatalogName | String | The database containing the table or view. |
| SchemaName | String | The schema containing the table or view. |
| TableName | String | The name of the table or view. |
| TableType | String | The table type (table or view). |
| Description | String | A description of the table or view. |
| IsUpdateable | Boolean | Whether the table can be updated. |
Describes the columns of the available tables and views.
The following query returns the columns and data types for the Invoices table:
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Invoices'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the table or view. |
| SchemaName | String | The schema containing the table or view. |
| TableName | String | The name of the table or view containing the column. |
| ColumnName | String | The column name. |
| DataTypeName | String | The data type name. |
| DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
| Length | Int32 | The storage size of the column. |
| DisplaySize | Int32 | The designated column's normal maximum width in characters. |
| NumericPrecision | Int32 | The maximum number of digits in numeric data. The column length in characters for character and date-time data. |
| NumericScale | Int32 | The column scale or number of digits to the right of the decimal point. |
| IsNullable | Boolean | Whether the column can contain null. |
| Description | String | A brief description of the column. |
| Ordinal | Int32 | The sequence number of the column. |
| IsAutoIncrement | String | Whether the column value is assigned in fixed increments. |
| IsGeneratedColumn | String | Whether the column is generated. |
| IsHidden | Boolean | Whether the column is hidden. |
| IsArray | Boolean | Whether the column is an array. |
| IsReadOnly | Boolean | Whether the column is read-only. |
| IsKey | Boolean | Indicates whether a field returned from sys_tablecolumns is the primary key of the table. |
| ColumnType | String | The role or classification of the column in the schema. Possible values include SYSTEM, LINKEDCOLUMN, NAVIGATIONKEY, REFERENCECOLUMN, and NAVIGATIONPARENTCOLUMN. |
Lists the available stored procedures.
The following query retrieves the available stored procedures:
SELECT * FROM sys_procedures
| Name | Type | Description |
| CatalogName | String | The database containing the stored procedure. |
| SchemaName | String | The schema containing the stored procedure. |
| ProcedureName | String | The name of the stored procedure. |
| Description | String | A description of the stored procedure. |
| ProcedureType | String | The type of the procedure, such as PROCEDURE or FUNCTION. |
Describes stored procedure parameters.
The following query returns information about all of the input parameters for the SampleProcedure stored procedure:
SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SampleProcedure' AND Direction = 1 OR Direction = 2
To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True:
SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SampleProcedure' AND IncludeResultColumns='True'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the stored procedure. |
| SchemaName | String | The name of the schema containing the stored procedure. |
| ProcedureName | String | The name of the stored procedure containing the parameter. |
| ColumnName | String | The name of the stored procedure parameter. |
| Direction | Int32 | An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters. |
| DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
| DataTypeName | String | The name of the data type. |
| NumericPrecision | Int32 | The maximum precision for numeric data. The column length in characters for character and date-time data. |
| Length | Int32 | The number of characters allowed for character data. The number of digits allowed for numeric data. |
| NumericScale | Int32 | The number of digits to the right of the decimal point in numeric data. |
| IsNullable | Boolean | Whether the parameter can contain null. |
| IsRequired | Boolean | Whether the parameter is required for execution of the procedure. |
| IsArray | Boolean | Whether the parameter is an array. |
| Description | String | The description of the parameter. |
| Ordinal | Int32 | The index of the parameter. |
| Values | String | The values you can set in this parameter are limited to those shown in this column. Possible values are comma-separated. |
| SupportsStreams | Boolean | Whether the parameter represents a file that you can pass as either a file path or a stream. |
| IsPath | Boolean | Whether the parameter is a target path for a schema creation operation. |
| Default | String | The value used for this parameter when no value is specified. |
| SpecificName | String | A label that, when multiple stored procedures have the same name, uniquely identifies each identically-named stored procedure. If there's only one procedure with a given name, its name is simply reflected here. |
| IsCDataProvided | Boolean | Whether the procedure is added/implemented by CData, as opposed to being a native Wave Financial procedure. |
| Name | Type | Description |
| IncludeResultColumns | Boolean | Whether the output should include columns from the result set in addition to parameters. Defaults to False. |
Describes the primary and foreign keys.
The following query retrieves the primary key for the Invoices table:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Invoices'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the key. |
| SchemaName | String | The name of the schema containing the key. |
| TableName | String | The name of the table containing the key. |
| ColumnName | String | The name of the key column. |
| IsKey | Boolean | Whether the column is a primary key in the table referenced in the TableName field. |
| IsForeignKey | Boolean | Whether the column is a foreign key referenced in the TableName field. |
| PrimaryKeyName | String | The name of the primary key. |
| ForeignKeyName | String | The name of the foreign key. |
| ReferencedCatalogName | String | The database containing the primary key. |
| ReferencedSchemaName | String | The schema containing the primary key. |
| ReferencedTableName | String | The table containing the primary key. |
| ReferencedColumnName | String | The column name of the primary key. |
Describes the foreign keys.
The following query retrieves all foreign keys which refer to other tables:
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the key. |
| SchemaName | String | The name of the schema containing the key. |
| TableName | String | The name of the table containing the key. |
| ColumnName | String | The name of the key column. |
| PrimaryKeyName | String | The name of the primary key. |
| ForeignKeyName | String | The name of the foreign key. |
| ReferencedCatalogName | String | The database containing the primary key. |
| ReferencedSchemaName | String | The schema containing the primary key. |
| ReferencedTableName | String | The table containing the primary key. |
| ReferencedColumnName | String | The column name of the primary key. |
| ForeignKeyType | String | Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key. |
Describes the primary keys.
The following query retrieves the primary keys from all tables and views:
SELECT * FROM sys_primarykeys
| Name | Type | Description |
| CatalogName | String | The name of the database containing the key. |
| SchemaName | String | The name of the schema containing the key. |
| TableName | String | The name of the table containing the key. |
| ColumnName | String | The name of the key column. |
| KeySeq | String | The sequence number of the primary key. |
| KeyName | String | The name of the primary key. |
Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.
The following query retrieves all indexes that are not primary keys:
SELECT * FROM sys_indexes WHERE IsPrimary='false'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the index. |
| SchemaName | String | The name of the schema containing the index. |
| TableName | String | The name of the table containing the index. |
| IndexName | String | The index name. |
| ColumnName | String | The name of the column associated with the index. |
| IsUnique | Boolean | True if the index is unique. False otherwise. |
| IsPrimary | Boolean | True if the index is a primary key. False otherwise. |
| Type | Int16 | An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3). |
| SortOrder | String | The sort order: A for ascending or D for descending. |
| OrdinalPosition | Int16 | The sequence number of the column in the index. |
Returns information on the available connection properties and those set in the connection string.
The following query retrieves all connection properties that have been set in the connection string or set through a default value:
SELECT * FROM sys_connection_props WHERE Value <> ''
| Name | Type | Description |
| Name | String | The name of the connection property. |
| ShortDescription | String | A brief description. |
| Type | String | The data type of the connection property. |
| Default | String | The default value if one is not explicitly set. |
| Values | String | A comma-separated list of possible values. A validation error is thrown if another value is specified. |
| Value | String | The value you set or a preconfigured default. |
| Required | Boolean | Whether the property is required to connect. |
| Category | String | The category of the connection property. |
| IsSessionProperty | String | Whether the property is a session property, used to save information about the current connection. |
| Sensitivity | String | The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms. |
| PropertyName | String | A camel-cased truncated form of the connection property name. |
| Ordinal | Int32 | The index of the parameter. |
| CatOrdinal | Int32 | The index of the parameter category. |
| Hierarchy | String | Shows dependent properties associated that need to be set alongside this one. |
| Visible | Boolean | Informs whether the property is visible in the connection UI. |
| ETC | String | Various miscellaneous information about the property. |
Describes the SELECT query processing that the Cloud can offload to the data source.
See SQL Compliance for SQL syntax details.
Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.
| Name | Description | Possible Values |
| AGGREGATE_FUNCTIONS | Supported aggregation functions. | AVG, COUNT, MAX, MIN, SUM, DISTINCT |
| COUNT | Whether COUNT function is supported. | YES, NO |
| IDENTIFIER_QUOTE_OPEN_CHAR | The opening character used to escape an identifier. | [ |
| IDENTIFIER_QUOTE_CLOSE_CHAR | The closing character used to escape an identifier. | ] |
| SUPPORTED_OPERATORS | A list of supported SQL operators. | =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR |
| GROUP_BY | Whether GROUP BY is supported, and, if so, the degree of support. | NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE |
| OJ_CAPABILITIES | The supported varieties of outer joins supported. | NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS |
| OUTER_JOINS | Whether outer joins are supported. | YES, NO |
| SUBQUERIES | Whether subqueries are supported, and, if so, the degree of support. | NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED |
| STRING_FUNCTIONS | Supported string functions. | LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE |
| NUMERIC_FUNCTIONS | Supported numeric functions. | ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE |
| TIMEDATE_FUNCTIONS | Supported date/time functions. | NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT |
| REPLICATION_SKIP_TABLES | Indicates tables skipped during replication. | |
| REPLICATION_TIMECHECK_COLUMNS | A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication. | |
| IDENTIFIER_PATTERN | String value indicating what string is valid for an identifier. | |
| SUPPORT_TRANSACTION | Indicates if the provider supports transactions such as commit and rollback. | YES, NO |
| DIALECT | Indicates the SQL dialect to use. | |
| KEY_PROPERTIES | Indicates the properties which identify the uniform database. | |
| SUPPORTS_MULTIPLE_SCHEMAS | Indicates if multiple schemas may exist for the provider. | YES, NO |
| SUPPORTS_MULTIPLE_CATALOGS | Indicates if multiple catalogs may exist for the provider. | YES, NO |
| DATASYNCVERSION | The CData Data Sync version needed to access this driver. | Standard, Starter, Professional, Enterprise |
| DATASYNCCATEGORY | The CData Data Sync category of this driver. | Source, Destination, Cloud Destination |
| SUPPORTSENHANCEDSQL | Whether enhanced SQL functionality beyond what is offered by the API is supported. | TRUE, FALSE |
| SUPPORTS_BATCH_OPERATIONS | Whether batch operations are supported. | YES, NO |
| SQL_CAP | All supported SQL capabilities for this driver. | SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX |
| PREFERRED_CACHE_OPTIONS | A string value specifies the preferred cacheOptions. | |
| ENABLE_EF_ADVANCED_QUERY | Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side. | YES, NO |
| PSEUDO_COLUMNS | A string array indicating the available pseudo columns. | |
| MERGE_ALWAYS | If the value is true, The Merge Mode is forcibly executed in Data Sync. | TRUE, FALSE |
| REPLICATION_MIN_DATE_QUERY | A select query to return the replicate start datetime. | |
| REPLICATION_MIN_FUNCTION | Allows a provider to specify the formula name to use for executing a server side min. | |
| REPLICATION_START_DATE | Allows a provider to specify a replicate startdate. | |
| REPLICATION_MAX_DATE_QUERY | A select query to return the replicate end datetime. | |
| REPLICATION_MAX_FUNCTION | Allows a provider to specify the formula name to use for executing a server side max. | |
| IGNORE_INTERVALS_ON_INITIAL_REPLICATE | A list of tables which will skip dividing the replicate into chunks on the initial replicate. | |
| CHECKCACHE_USE_PARENTID | Indicates whether the CheckCache statement should be done against the parent key column. | TRUE, FALSE |
| CREATE_SCHEMA_PROCEDURES | Indicates stored procedures that can be used for generating schema files. |
The following query retrieves the operators that can be used in the WHERE clause:
SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.
| Name | Type | Description |
| NAME | String | A component of SQL syntax, or a capability that can be processed on the server. |
| VALUE | String | Detail on the supported SQL or SQL syntax. |
Returns information about attempted modifications.
The following query retrieves the Ids of the modified rows in a batch operation:
SELECT * FROM sys_identity
| Name | Type | Description |
| Id | String | The database-generated Id returned from a data modification operation. |
| Batch | String | An identifier for the batch. 1 for a single operation. |
| Operation | String | The result of the operation in the batch: INSERTED, UPDATED, or DELETED. |
| Message | String | SUCCESS or an error message if the update in the batch failed. |
Describes the available system information.
The following query retrieves all columns:
SELECT * FROM sys_information
| Name | Type | Description |
| Product | String | The name of the product. |
| Version | String | The version number of the product. |
| Datasource | String | The name of the datasource the product connects to. |
| NodeId | String | The unique identifier of the machine where the product is installed. |
| HelpURL | String | The URL to the product's help documentation. |
| License | String | The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.) |
| Location | String | The file path location where the product's library is stored. |
| Environment | String | The version of the environment or rumtine the product is currently running under. |
| DataSyncVersion | String | The tier of CData Sync required to use this connector. |
| DataSyncCategory | String | The category of CData Sync functionality (e.g., Source, Destination). |
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.
| 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. |
| Property | Description |
| OAuthClientId | Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
| OAuthClientSecret | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.). |
| Scope | Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created. |
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| Verbosity | Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5. |
| Property | Description |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Property | Description |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| ThrowsKeyNotFound | Specifies whether or not throws an exception if there is no rows updated. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
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.
string
"OAuth"
The API token obtained when you register a Wave Financial application.
string
""
You can obtain an API Token using the following steps:
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 (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
| OAuthClientSecret | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.). |
| Scope | Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created. |
Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
string
""
This property is required in two cases:
(When the driver provides embedded OAuth credentials, this value may already be provided by the Cloud and thus not require manual entry.)
OAuthClientId is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.
OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can usually find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.
While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.
For more information on how this property is used when configuring a connection, see Establishing a Connection.
Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
string
""
This property (sometimes called the application secret or consumer secret) is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.
The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication fails with either an invalid_client or an unauthorized_client error.
OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application.
Notes:
For more information on how this property is used when configuring a connection, see Establishing a Connection
Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created.
string
""
Scopes are set to define what kind of access the authenticating user will have; for example, read, read and write, restricted access to sensitive information. System administrators can use scopes to selectively enable access by functionality or security clearance.
When InitiateOAuth is set to GETANDREFRESH, you must use this property if you want to change which scopes are requested.
When InitiateOAuth is set to either REFRESH or OFF, you can change which scopes are requested using either this property or the Scope input.
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.
string
""
If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are 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 |
Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
| Property | Description |
| Verbosity | Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5. |
Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.
string
"1"
This property defines the level of detail the Cloud includes in the log file. Higher verbosity levels increase the detail of the logged information, but may also result in larger log files and slower performance due to the additional data being captured.
The default verbosity level is 1, which is recommended for regular operation. Higher verbosity levels are primarily intended for debugging purposes. For more information on each level, refer to Logging.
When combined with the LogModules property, Verbosity can refine logging to specific categories of information.
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
| Property | Description |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
string
""
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.
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 number of rows returned for queries that do not include either aggregation or GROUP BY. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| ThrowsKeyNotFound | Specifies whether or not throws an exception if there is no rows updated. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
int
-1
The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)
Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.
This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.
Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
string
""
This property allows you to define which pseudocolumns the Cloud exposes as table columns.
To specify individual pseudocolumns, use the following format:
Table1=Column1;Table1=Column2;Table2=Column3
To include all pseudocolumns for all tables use:
*=*
Specifies whether or not throws an exception if there is no rows updated.
bool
false
Specifies whether or not throws an exception if there is no rows updated.
Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
int
60
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.
Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.
Disabling the timeout allows 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.
Note: Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.
LZMA from 7Zip LZMA SDK
LZMA SDK is placed in the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
LZMA2 from XZ SDK
Version 1.9 and older are in the public domain.
Xamarin.Forms
Xamarin SDK
The MIT License (MIT)
Copyright (c) .NET Foundation Contributors
All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
NSIS 3.10
Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
1. DEFINITIONS
"Contribution" means:
a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:
i) changes to the Program, and
ii) additions to the Program;
where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.
"Contributor" means any person or entity that distributes the Program.
"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.
"Program" means the Contributions distributed in accordance with this Agreement.
"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.
2. GRANT OF RIGHTS
a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.
b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.
c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.
d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.
3. REQUIREMENTS
A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:
a) it complies with the terms and conditions of this Agreement; and
b) its license agreement:
i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;
ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;
iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and
iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.
When the Program is made available in source code form:
a) it must be made available under this Agreement; and
b) a copy of this Agreement must be included with each copy of the Program.
Contributors may not remove or alter any copyright notices contained within the Program.
Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.
4. COMMERCIAL DISTRIBUTION
Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.
For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.
5. NO WARRANTY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.
6. DISCLAIMER OF LIABILITY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
7. GENERAL
If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.
All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.
Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.
This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.