Cmdlets for FreshBooks

Build 20.0.7587

Parameters (Connect-FreshBooks Cmdlet)

The following is the full list of the parameters of the cmdlet with short descriptions. Click the links for further details.

Parameter Required Description
AccountId    The Account Id to connect to. If a value is not specified, the first one returned will be used. 
AutoCache    Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider . 
CacheConnection    The connection string for the cache database. This property is always used in conjunction with CacheProvider . Setting both properties will override the value set for CacheLocation for caching data. 
CacheLocation    Specifies the path to the cache when caching to a file. 
CacheMetadata    This property determines whether or not to cache the table metadata to a file store. 
CacheProvider    The name of the provider to be used to cache data. 
CacheTolerance    The tolerance for stale data in the cache specified in seconds when using AutoCache . 
CallbackURL    The authorization URL for the OAuth service. 
CompanyName  True  The company name used to access FreshBooks. 
FirewallPassword    A password used to authenticate to a proxy-based firewall. 
FirewallPort    The TCP port for a proxy-based firewall. 
FirewallServer    The name or IP address of a proxy-based firewall. 
FirewallType    The protocol used by a proxy-based firewall. 
FirewallUser    The user name to use to authenticate with a proxy-based firewall. 
InitiateOAuth    Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. 
Location    A path to the directory that contains the schema files defining tables, views, and stored procedures. 
Logfile    A filepath which designates the name and location of the log file. 
LogModules    Core modules to be included in the log file. 
MaxLogFileCount    A string specifying the maximum file count of log files. When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted. 
MaxLogFileSize    A string specifying the maximum size in bytes for a log file (for example, 10 MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end. 
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. 
OAuthAccessToken    The access token for connecting using OAuth. 
OAuthAccessTokenSecret    The OAuth access token secret for connecting using OAuth. 
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. 
OAuthExpiresIn    The lifetime in seconds of the OAuth AccessToken. 
OAuthSettingsLocation    The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, this can be held in memory by specifying a value starting with memory://. 
OAuthTokenTimestamp    The Unix epoch timestamp in milliseconds when the current Access Token was created. 
OAuthVerifier    The verifier code returned from the OAuth authorization URL. 
Offline    Use offline mode to get the data from the cache instead of the live source. 
Other    These hidden properties are used only in specific use cases. 
ProxyAuthScheme    The authentication type to use to authenticate to the ProxyServer proxy. 
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. 
ProxyExceptions    A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . 
ProxyPassword    A password to be used to authenticate to the ProxyServer proxy. 
ProxyPort    The TCP port the ProxyServer proxy is running on. 
ProxyServer    The hostname or IP address of a proxy to route HTTP traffic through. 
ProxySSLType    The SSL type to use when connecting to the ProxyServer proxy. 
ProxyUser    A user name to be used to authenticate to the ProxyServer proxy. 
PseudoColumns    This property indicates whether or not to include pseudo columns as columns to the table. 
Readonly    You can use this property to enforce read-only access to FreshBooks from the provider. 
RTK    The runtime key used for licensing. 
Schema  True  The type of schema to use. 
SSLServerCert    The certificate to be accepted from the server when connecting using TLS/SSL. 
SupportEnhancedSQL    This property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing. 
Tables    This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. 
Timeout    The value in seconds until the timeout error is thrown, canceling the operation. 
Token  True  The Token sent to FreshBooks for authentication. 
Verbosity    The verbosity level that determines the amount of detail included in the log file. 
Views    Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. 

Copyright (c) 2020 CData Software, Inc. - All rights reserved.
Build 20.0.7587