ODBC Driver for FreshBooks

Connection String Options - FreshBooks ODBC Driver



FreshBooks ODBC Connection String Options

The following table lists the connection string options for FreshBooks.

Option Description

Version

Used to specify the required FreshBooks version. The available values are:

  • New
  • Classic

The default value - New.

FreshBooks New:

Option Description

Company Name

The company name used when creating a FreshBooks account.

Access Token

Access token is used to securely connect ODBC Driver for FreshBooks to your account. For information on obtaining an access token, see Requesting Access Token. To save your authentication token in the DSN settings, select the Save Token checkbox.

FreshBooks Classic:

Option Description

Server

The URL of the FreshBooks server to connect to.

Authentication Token

API/authentication token is used to securely connect ODBC Driver for FreshBooks to your account. For information on obtaining an authentication token, see Obtaining API Key. To save your authentication token in the DSN settings, select the Save Token checkbox.

Proxy Settings

Option Description

Proxy Server

The proxy hostname or IP address.

Proxy Port

The proxy port.

Proxy User

The proxy username.

Proxy Password

The proxy password.

Advanced Settings

Option Description

AllowNullStringsInMetadata

Some parameters don't accept null values when retrieving metadata. If a third-party tool passes a null value to such a parameter, the driver returns an error. By default, these options are enabled for compatibility with such third-party tools.

EmptyStringsAsNullInMetadata

Connection Timeout

The time (in seconds) to wait for a connection to open before terminating an attempt. The default value is 60.

ODBC Behavior Sets the behavior corresponding to the ODBC specification version expected by a third-party tool. The behavior of the ODBC driver can be changed by calling the SQLSetEnvAttr function to set the SQL_ATTR_ODBC_VERSION environment attribute. Some third-party tools expect the driver to exhibit ODBC 2.x behavior, but forget to call SQLSetEnvAttr with the needed version, or pass an incorrect value. In this case, the behavior can be explicitly set in the connection string.
0
The default value. ODBC behavior is determined by a third-party tool.
2
ODBC 2.x behavior is explicitly set.
3
ODBC 3.x behavior is explicitly set.

QueryTimeout

The time to wait for a query execution result before terminating and generating an error.

RegionalDateTimeSettings

Enables the use of local regional settings when converting dates and times to strings.

RegionalNumberSettings

Enables the use of local regional settings when converting numbers to strings.

ReturnForeignKeys

Use the option to specify whether the driver must return foreign keys. Retrieving metadata about foreign key constraints is a time-consuming operation; many third-party tools request foreign key metadata even whey they do not actually need this information. Note that enabling the option may degrade performance of data access operations. The default value is False.

String Types Sets the string value types returned by the driver as Default, ANSI, or Unicode.
Default
The driver defines the string types.
Ansi
All string types are returned as SQL_CHAR, SQL_VARCHAR, and SQL_LONGVARCHAR.
Unicode
All string types are returned as SQL_WCHAR, SQL_WVARCHAR, and SQL_WLONGVARCHAR.
Note: Set the option to Ansi or Unicode if your third-party tool supports only ANSI or Unicode strings.

UTC Dates

Specifies whether all the datetime values retrieved from the data source are returned as UTC values or converted to local time and whether the date values specified on the application side (e.g., in SQL statements) are considered UTC or local. The default value is false.

Sample FreshBooks Classic ODBC Connection String

DRIVER={Devart ODBC Driver for FreshBooks};Version=Classic;Server=https://mycompany-billing.freshbooks.com/api/2.1/xml-in;Authentication Token=vs1b0ca04c5848d74w0d37q764509ee5d80ee5d80

Sample FreshBooks New ODBC Connection String

DRIVER={Devart ODBC Driver for FreshBooks};Version=New;Company Name=Your_company_name;Access Token=d3b765fgdf907f067q764509ee5d80h987v5848s1b0ca04cdid92376847g74w0

© 2015-2022 Devart. All Rights Reserved. Request Support ODBC Forum Provide Feedback