Ready to get started?

Learn more about the Xero PowerShell Cmdlets or download a free trial:

Download Now

Pipe Xero Data to CSV in PowerShell

Use standard PowerShell cmdlets to access Xero tables.

The CData Cmdlets Module for Xero is a standard PowerShell module offering straightforward integration with Xero. Below, you will find examples of using our Xero Cmdlets with native PowerShell cmdlets.

Creating a Connection to Your Xero Data

To connect, set the Schema connection property in addition to any authentication values. Xero offers authentication for private applications, public applications, and partner applications. You will need to set the XeroAppAuthentication property to PUBLIC, PRIVATE, or PARTNER, depending on the type of application configured. To connect from a private application, you will additionally need to set the OAuthAccessToken, OAuthClientId, OAuthClientSecret, CertificateStoreType, CertificateStore, and CertificateStorePassword.

To connect from a public or partner application, you can use the embedded OAuthClientId, OAuthClientSecret, and CallbackURL, or you can register an app to obtain your own OAuth values.

See the "Getting Started" chapter of the help documentation for a guide to authenticating to Xero.

$conn = Connect-Xero 

Selecting Data

Follow the steps below to retrieve data from the Items table and pipe the result into to a CSV file:

Select-Xero -Connection $conn -Table Items | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myItemsData.csv -NoTypeInformation

You will notice that we piped the results from Select-Xero 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" in the result set, and we do not necessarily want that information in our CSV file.

The Connection, Table, and Columns are appended to the results in order to facilitate piping results from one of the CData Cmdlets directly into another one.

Deleting Data

The following line deletes any records that match the criteria:

Select-Xero -Connection $conn -Table Items -Where "Name = Golf balls - white single" | Remove-Xero

Inserting and Updating Data

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

Import-Csv -Path C:\MyItemsUpdates.csv | %{
  $record = Select-Xero -Connection $Xero -Table Items -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-Xero -Connection $xero -Table Items -Columns ("Name","QuantityOnHand") -Values ($_.Name, $_.QuantityOnHand) -Where ("Id = `'"+$_.Id+"`'")
  }else{
    Add-Xero -Connection $xero -Table Items -Columns ("Name","QuantityOnHand") -Values ($_.Name, $_.QuantityOnHand)
  }
}

As always, our goal is to simplify the way you connect to data. With cmdlets users can install a data module, set the connection properties, and start building. Download Cmdlets and start working with your data in PowerShell today!