With the CData Cmdlets users can install a data module, set the connection properties, and start scripting. This section provides examples of using our ZohoBooks 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 ZohoBooksCmdlets

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

Import-Module ZohoBooksCmdlets;

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

$conn = -InitiateoAuth "GETANDREFRESH" -OrganizationId "YourOrganizationId" -AccountsServer "YourAccountServerURL"

Authenticating to Zoho Books

Zoho Books 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-ZohoBooks cmdlet provides a native PowerShell interface for retrieving data:

$results = Select-ZohoBooks -Connection $conn -Table "INVOICES" -Columns @("InvoiceId, InvoiceNumber") -Where "CustomerName='NewTech Industries'"

The Invoke-ZohoBooks 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-ZohoBooks -Connection $conn -Table INVOICES -Where "CustomerName = 'NewTech Industries'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myINVOICESData.csv -NoTypeInformation

You will notice that we piped the results from Select-ZohoBooks 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  = -InitiateoAuth "GETANDREFRESH" -OrganizationId "YourOrganizationId" -AccountsServer "YourAccountServerURL"
PS C:\> $row = Select-ZohoBooks -Connection $conn -Table "INVOICES" -Columns (InvoiceId, InvoiceNumber) -Where "CustomerName = 'NewTech Industries'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "INVOICES",
  "Columns":  [

  ],
  "InvoiceId":  "MyInvoiceId",
  "InvoiceNumber":  "MyInvoiceNumber"
}