Cmdlets for FreshBooks

Build 20.0.7587

Establishing a Connection

With the CData Cmdlets users can install a data module, set the connection properties, and start scripting. This section provides examples of using our FreshBooks Cmdlets with native PowerShell cmdlets, like the CSV import and export cmdlets.

Installing and Connecting

If you have PSGet, installing the cmdlets can be accomplished from the PowerShell Gallery with the following command. You can also obtain a setup from the CData site.

Install-Module FreshBooksCmdlets

The following line is then added to your profile, loading the cmdlets on the next session:

Import-Module FreshBooksCmdlets;

You can then use the Connect-FreshBooks cmdlet to create a connection object that can be passed to other cmdlets:

$conn = Connect-$psname; -CompanyName 'MyCompany' -Token 'MyToken'

Authenticating to FreshBooks

FreshBooks uses the OAuth authentication standard. To authenticate using OAuth, you will need to create an app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties. See Using OAuth Authentication for an authentication guide.

Retrieving Data

The Select-FreshBooks cmdlet provides a native PowerShell interface for retrieving data:

$results = Select-FreshBooks -Connection $conn -Table "Clients" -Columns @("Email, Username") -Where "Email=''"
The Invoke-FreshBooks cmdlet provides an SQL interface. This cmdlet can be used to execute an SQL query via the Query parameter.

Piping Cmdlet Output

The cmdlets return row objects to the pipeline one row at a time. The following line exports results to a CSV file:

Select-FreshBooks -Connection $conn -Table Clients -Where "Email = ''" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myClientsData.csv -NoTypeInformation

You will notice that we piped the results from Select-FreshBooks into a Select-Object cmdlet and excluded some properties before piping them into an Export-CSV cmdlet. We do this because the CData Cmdlets append Connection, Table, and Columns information onto each row object in the result set, and we do not necessarily want that information in our CSV file.

However, this makes it easy to pipe the output of one cmdlet to another. The following is an example of converting a result set to JSON:

PS C:\> $conn  = Connect-$psname; -CompanyName 'MyCompany' -Token 'MyToken'
PS C:\> $row = Select-FreshBooks -Connection $conn -Table "Clients" -Columns (Email, Username) -Where "Email = ''" | select -first 1
PS C:\> $row | ConvertTo-Json
  "Connection":  {

  "Table":  "Clients",
  "Columns":  [

  "Email":  "MyEmail",
  "Username":  "MyUsername"

Deleting Data

The following line deletes any records that match the criteria:

Select-FreshBooks -Connection $conn -Table Clients -Where "Email = ''" | Remove-FreshBooks

Updating Data

The cmdlets make data transformation easy as well as data cleansing. The following example loads data from a CSV file into FreshBooks, checking first whether a record already exists and needs to be updated instead of inserted.

Import-Csv -Path C:\MyClientsUpdates.csv | %{
  $record = Select-FreshBooks -Connection $conn -Table Clients -Where ("Id = `'"+$_.Id+"`'")
    Update-FreshBooks -Connection $conn -Table Clients -Columns @("Email","Username") -Values @($_.Email, $_.Username) -Where "Id  = `'$_.Id`'"
    Add-FreshBooks -Connection $conn -Table Clients -Columns @("Email","Username") -Values @($_.Email, $_.Username)

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