Learn more
 

Ready to get started?

Download a free trial of the Xero WorkflowMax Data Provider to get started:

 Download Now

Learn more:

Xero WorkflowMax Icon Xero WorkflowMax ADO.NET Provider

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

In this article

Related articles

LINQ to Xero WorkflowMax Data


LINQ offers versatile querying capabilities within the .NET Framework (v3.0+), offering a straightforward method for programmatic data access through CData ADO.NET Data Providers. In this article, we demonstrate the use of LINQ to retrieve information from the Xero WorkflowMax Data Provider.

This article illustrates using LINQ to access tables within the Xero WorkflowMax via the CData ADO.NET Data Provider for Xero WorkflowMax. To achieve this, we will use LINQ to Entity Framework, which facilitates the generation of connections and can be seamlessly employed with any CData ADO.NET Data Providers to access data through LINQ.

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

  1. In a new project in Visual Studio, right-click on the project and choose to add a new item. Add an ADO.NET Entity Data Model.
  2. Choose EF Designer from Database and click Next.
  3. Add a new Data Connection, and change your data source type to "CData Xero WorkflowMax Data Source".

  4. Enter your data source connection information.

    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;
  5. If saving your entity connection to App.Config, set an entity name. In this example we are setting XeroWorkflowMaxEntities as our entity connection in App.Config.
  6. Enter a model name and select any tables or views you would like to include in the model.

Using the entity you created, you can now perform select , update, delete, and insert commands. For example:

XeroWorkflowMaxEntities context = new XeroWorkflowMaxEntities(); var clientsQuery = from clients in context.Clients select clients; foreach (var result in clientsQuery) { Console.WriteLine("{0} {1} ", result.Id, result.Id); }

See "LINQ and Entity Framework" chapter in the help documentation for example queries of the supported LINQ.