Natively Connect to Acumatica Data in PHP

Drop the CData ODBC Driver for Acumatica into your LAMP or WAMP stack to build Acumatica-connected Web applications. This article shows how to use PHP's ODBC built-in functions to connect to Acumatica 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.

Set the following connection properties to connect to Acumatica:

• User: Set this to your username.
• Password: Set this to your password.
• Company: Set this to your company.
• Url: Set this to your Acumatica URL, in the format http://{Acumatica ERP instance URL}/entity/{Endpoint name}/{Endpoint version}/.
  For example: https://acumatica.com/entity/Default/17.200.001/

See the Getting Started guide in the CData driver documentation for more information.

Establish a Connection

Open the connection to Acumatica by calling the or methods. To close connections, use or .

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

Connections opened with are closed when the script ends. Connections opened with the 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 Acumatica Source","user","password");
...
odbc_close($conn); //persistent connection must be closed explicitly

Create Prepared Statements

Create prepared statements and parameterized queries with the function.

$query = odbc_prepare($conn, "SELECT * FROM Events WHERE Id = ?");

Execute Queries

Execute prepared statements with .

$conn = odbc_connect("CData ODBC Acumatica Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Events WHERE Id = ?");
$success = odbc_execute($query, array('1'));
 

Execute nonparameterized queries with .

$conn = odbc_connect("CData ODBC Acumatica Source","user","password");
$query = odbc_exec($conn, "SELECT Id, location_displayname FROM Events");
 

Process Results

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

$conn = odbc_connect("CData ODBC Acumatica data Source","user","password");
$query = odbc_exec($conn, "SELECT Id, location_displayname FROM Events");
while($row = odbc_fetch_array($query)){
 echo $row["Id"] . "\n";
}

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

$conn = odbc_connect("CData ODBC Acumatica data Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Events WHERE Id = ?");
$success = odbc_execute($query, array('1'));
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 Acumatica-specific adaptations of the PHP community documentation for all ODBC functions.