ODBC Driver for FreshBooks

Connection String Options - FreshBooks ODBC Driver



The following table describes the options that you can include in the connection string for FreshBooks:

Option Description

Version

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

  • Classic
  • New

The default value - Classic.

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. See the Obtaining API Key section.

If you want to save Authentication Token in DSN Settings, select the Save Token checkbox

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. See the Requesting Access Token section.

If you want to save Access Token in DSN Settings, select the Save Token checkbox

Proxy connection options:

Option Description

Proxy Host

If you are using Proxy for connection to your network, specify the Proxy server address in this option. To learn your Proxy server address, open Control Panel->Internet Options->Connections->LAN settings.

Proxy Port

Specify the Proxy port here. You can learn Proxy Port in the same way as described above for the host.

Proxy User

If Proxy User authorization is used, specify Proxy user name (ID) in this option.

Proxy Password

If Proxy User authorization is used, specify Proxy user password in this option.

Advanced Settings

Option Description

Allow NULL strings

To retrieve metadata, not all parameters according to MSDN can accept a null value. If NULL, the driver should return an error. But some 3rd-party tools pass NULL to the parameters. These options should be enabled for compatibility with such tools.

Empty strings as NULL

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 will be returned as SQL_CHAR, SQL_VARCHAR and SLQ_LONGVARCHAR.
  • Unicode - all string types will be returned as SQL_WCHAR, SQL_WVARCHAR and SLQ_WLONGVARCHAR.

The option value should be changed if any third-party tool supports only Ansi string types or Unicode ones.

RegionalNumberSettings

Enables using local regional settings when converting numbers to string.

RegionalDateTimeSettings

Enables using local regional settings when converting dates and times to string.

ConnectionTimeout

The time to wait while trying to establish a connection before terminating the attempt and generating an error.

QueryTimeout

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

FreshBooks ODBC Connection String classic version sample

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

FreshBooks ODBC Connection String new version sample

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

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