Working with Xero WorkflowMax Data in LINQPad

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Xero WorkflowMax ADO.NET Provider

Rapidly create and deploy powerful .NET applications that integrate with Xero WorkflowMax.



Execute LINQ queries to Xero WorkflowMax data in LINQPad.

The CData ADO.NET Provider for Xero WorkflowMax enables you to use standard ADO.NET interfaces like LINQ and the Entity Framework to work with Xero WorkflowMax data. This article shows how to connect from LINQPad and execute LINQ queries.

Create the Data Model

After downloading and installing the provider and LINQPad, create a new class library project in Visual Studio.

See the help documentation for a guide to setting up an EF 6 project to use the provider.

  1. Right-click your project and click Add -> New Item -> ADO.NET Entity Data Model. In the resulting dialog, select Code First from database. Click New Connection and specify the connection string options in the resulting wizard.

    To connect to the WorkflowMax API, obtain an APIKey and AccountKey from Xero. This can only be done by contacting Xero support (https://www.workflowmax.com/contact-us).

    After obtaining an API Key and Account Key, set the values in the APIKey and AccountKey connection properties. Once these are set, you are ready to connect.

    Below is a typical connection string:

    APIKey=myApiKey;AccountKey=myAccountKey;
  2. Select the desired tables and views and click Finish to create the data model.

  3. Build the project. The generated files can be used to create the Xero WorkflowMax connection in LINQPad.

Connect to Xero WorkflowMax Data in LINQPad

After you have obtained the required connection properties and created the data model assembly, follow the steps below to start using the data model in LINQPad.

  1. Open LINQPad and click Add Connection.

  2. Select the "Use a typed data context from your own assembly" option.

  3. Select Entity Framework DbContext.

  4. Click Browse next to the Path to Custom Assembly box and browse to your project folder. Browse to the .dll or .exe under the bin folder.

  5. Select the name of the DbContext.
  6. If you saved your connection string in App.Config, specify the path to the App.config.

You can now query Xero WorkflowMax data through LINQPad. For examples of the supported LINQ queries, see the "LINQ and Entity Framework" chapter in the help documentation.