Automate FreeAgent Integration Tasks from PowerShell

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Are you in search of a quick and easy way to access FreeAgent data from PowerShell? This article demonstrates how to utilize the FreeAgent Cmdlets for tasks like connecting to FreeAgent data, automating operations, downloading data, and more.

The CData API Driver for ADO.NET is a standard ADO.NET Provider that make it easy to accomplish data cleansing, normalization, backup, and other integration tasks by enabling real-time access to FreeAgent.

ADO.NET Provider

The ADO.NET Provider provides a SQL interface for FreeAgent; this tutorial shows how to use the Provider to retrieve FreeAgent data.

Once you have acquired the necessary connection properties, accessing FreeAgent data in PowerShell can be enabled in three steps.

Start by setting the Profile connection property to the location of the FreeAgent Profile on disk (e.g. C:\profiles\FreeAgent.apip). Next, set the ProfileSettings connection property to the connection string for FreeAgent (see below).

FreeAgent API Profile Settings

Register an OAuth application via the FreeAgent Developer Dashboard to obtain your Client ID and Client Secret.

  1. Load the provider's assembly:

    [Reflection.Assembly]::LoadFile("C:\Program Files\CData\CData API Driver for ADO.NET\lib\System.Data.CData.API.dll")
        
  2. Connect to FreeAgent:

     
    $conn= New-Object System.Data.CData.API.APIConnection("Profile=C:\profiles\FreeAgent.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;")
    $conn.Open()
    
  3. Instantiate the APIDataAdapter, execute an SQL query, and output the results:

    $sql="SELECT Id, Url from BankAccounts"
    
    $da= New-Object System.Data.CData.API.APIDataAdapter($sql, $conn)
    $dt= New-Object System.Data.DataTable
    $da.Fill($dt)
    
    $dt.Rows | foreach {
    	Write-Host $_.id $_.url
    }
      

Ready to get started?

Connect to live data from FreeAgent with the API Driver

Connect to FreeAgent