Learn more
 

Natively Connect to Xero WorkflowMax Data in PHP

Ready to get started?

Download a free trial:

Download Now

Learn more:

Xero WorkflowMax ODBC Driver

The Xero WorkflowMax ODBC Driver is a powerful tool that allows you to connect with live data from Xero WorkflowMax, directly from any applications that support ODBC connectivity.

Access Xero WorkflowMax data like you would a database - read, write, and update Xero WorkflowMax Clients, Jobs, Leads, Quotes, etc. through a standard ODBC Driver interface.

In this article

Related articles


The CData ODBC driver for Xero WorkflowMax enables you to create PHP applications with connectivity to Xero WorkflowMax data. Leverage the native support for ODBC in PHP.

Drop the CData ODBC Driver for Xero WorkflowMax into your LAMP or WAMP stack to build Xero WorkflowMax-connected Web applications. This article shows how to use PHP's ODBC built-in functions to connect to Xero WorkflowMax data, execute queries, and output the results.

Configure a DSN

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

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.

Establish a Connection

Open the connection to Xero WorkflowMax by calling the odbc_connect or odbc_pconnect methods. To close connections, use odbc_close or odbc_close_all.

$conn = odbc_connect("CData ODBC XeroWorkflowMax Source","user","password");

Connections opened with odbc_connect are closed when the script ends. Connections opened with the odbc_pconnect method are still open after the script ends. This enables other scripts to share that connection when they connect with the same credentials. By sharing connections among your scripts, you can save system resources, and queries execute faster.

$conn = odbc_pconnect("CData ODBC XeroWorkflowMax Source","user","password"); ... odbc_close($conn); //persistent connection must be closed explicitly

Create Prepared Statements

Create prepared statements and parameterized queries with the odbc_prepare function.

$query = odbc_prepare($conn, "SELECT * FROM Clients WHERE Name = ?");

Execute Queries

Execute prepared statements with odbc_execute.

$conn = odbc_connect("CData ODBC XeroWorkflowMax Source","user","password"); $query = odbc_prepare($conn, "SELECT * FROM Clients WHERE Name = ?"); $success = odbc_execute($query, array('Cynthia'));

Execute nonparameterized queries with odbc_exec.

$conn = odbc_connect("CData ODBC XeroWorkflowMax Source","user","password"); $query = odbc_exec($conn, "SELECT Id, Name FROM Clients WHERE Name = 'Cynthia'");

Process Results

Access a row in the result set as an array with the odbc_fetch_array function.

$conn = odbc_connect("CData ODBC Xero WorkflowMax data Source","user","password"); $query = odbc_exec($conn, "SELECT Id, Name FROM Clients WHERE Name = 'Cynthia'"); while($row = odbc_fetch_array($query)){ echo $row["Id"] . "\n"; }

Display the result set in an HTML table with the odbc_result_all function.

$conn = odbc_connect("CData ODBC Xero WorkflowMax data Source","user","password"); $query = odbc_prepare($conn, "SELECT * FROM Clients WHERE Name = ?"); $success = odbc_execute($query, array('Cynthia')); if($success) odbc_result_all($query);

More Example Queries

You will find complete information on the driver's supported SQL in the help documentation. The code examples above are Xero WorkflowMax-specific adaptations of the PHP community documentation for all ODBC functions.