Automate ChargeOver Integration Tasks from PowerShell

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Are you in search of a quick and easy way to access ChargeOver data from PowerShell? This article demonstrates how to utilize the ChargeOver Cmdlets for tasks like connecting to ChargeOver 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 ChargeOver.

ADO.NET Provider

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

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

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

ChargeOver API Profile Settings

Log into ChargeOver, navigate to Settings > Developer > REST API, enable the API, and copy your Public Key (APIKey) and Private Key (APISecret).

  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 ChargeOver:

     
    $conn= New-Object System.Data.CData.API.APIConnection("Profile=C:\profiles\Chargeover.apip;ProfileSettings='APIKey=your_public_key;APISecret=your_private_key;Domain=your_subdomain';")
    $conn.Open()
    
  3. Instantiate the APIDataAdapter, execute an SQL query, and output the results:

    $sql="SELECT Id, Email from AdminWorkers"
    
    $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 $_.email
    }
      

Ready to get started?

Connect to live data from ChargeOver with the API Driver

Connect to ChargeOver