Use SQLAlchemy ORMs to Access Acumatica Data in Python

Ready to get started?

Download a free trial:

Download Now

Learn more:

Acumatica Python Connector

Python Connector Libraries for Acumatica Data Connectivity. Integrate Acumatica with popular Python tools like Pandas, SQLAlchemy, Dash & petl.

The CData Python Connector for Acumatica enables you to create Python applications and scripts that use SQLAlchemy Object-Relational Mappings of Acumatica data.

The rich ecosystem of Python modules lets you get to work quickly and integrate your systems effectively. With the CData Python Connector for Acumatica and the SQLAlchemy toolkit, you can build Acumatica-connected Python applications and scripts. This article shows how to use SQLAlchemy to connect to Acumatica data to query, update, delete, and insert Acumatica data.

With built-in optimized data processing, the CData Python Connector offers unmatched performance for interacting with live Acumatica data in Python. When you issue complex SQL queries from Acumatica, the CData Connector pushes supported SQL operations, like filters and aggregations, directly to Acumatica and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations).

Connecting to Acumatica Data

Connecting to Acumatica data looks just like connecting to any relational data source. Create a connection string using the required connection properties. For this article, you will pass the connection string as a parameter to the create_engine function.

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:

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

Follow the procedure below to install SQLAlchemy and start accessing Acumatica through Python objects.

Install Required Modules

Use the pip utility to install the SQLAlchemy toolkit and SQLAlchemy ORM package:

pip install sqlalchemy pip install sqlalchemy.orm

Be sure to import the appropriate modules:

from sqlalchemy import create_engine, String, Column from sqlalchemy.ext.declarative import declarative_base from sqlalchemy.orm import sessionmaker

Model Acumatica Data in Python

You can now connect with a connection string. Use the create_engine function to create an Engine for working with Acumatica data.

NOTE: Users should URL encode the any connection string properties that include special characters. For more information, refer to the SQL Alchemy documentation.

engine = create_engine("acumatica:///?Url =")

Declare a Mapping Class for Acumatica Data

After establishing the connection, declare a mapping class for the table you wish to model in the ORM (in this article, we will model the Events table). Use the sqlalchemy.ext.declarative.declarative_base function and create a new class with some or all of the fields (columns) defined.

base = declarative_base() class Events(base): __tablename__ = "Events" Id = Column(String,primary_key=True) location_displayname = Column(String) ...

Query Acumatica Data

With the mapping class prepared, you can use a session object to query the data source. After binding the Engine to the session, provide the mapping class to the session query method.

Using the query Method

engine = create_engine("acumatica:///?Url =") factory = sessionmaker(bind=engine) session = factory() for instance in session.query(Events).filter_by(Id="1"): print("Id: ", instance.Id) print("location_displayname: ", instance.location_displayname) print("---------")

Alternatively, you can use the execute method with the appropriate table object. The code below works with an active session.

Using the execute Method

Events_table = Events.metadata.tables["Events"] for instance in session.execute( == "1")): print("Id: ", instance.Id) print("location_displayname: ", instance.location_displayname) print("---------")

For examples of more complex querying, including JOINs, aggregations, limits, and more, refer to the Help documentation for the extension.

Insert Acumatica Data

To insert Acumatica data, define an instance of the mapped class and add it to the active session. Call the commit function on the session to push all added instances to Acumatica.

new_rec = Events(Id="placeholder", Id="1") session.add(new_rec) session.commit()

Update Acumatica Data

To update Acumatica data, fetch the desired record(s) with a filter query. Then, modify the values of the fields and call the commit function on the session to push the modified record to Acumatica.

updated_rec = session.query(Events).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first() updated_rec.Id = "1" session.commit()

Delete Acumatica Data

To delete Acumatica data, fetch the desired record(s) with a filter query. Then delete the record with the active session and call the commit function on the session to perform the delete operation on the provided records (rows).

deleted_rec = session.query(Events).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first() session.delete(deleted_rec) session.commit()

Free Trial & More Information

Download a free, 30-day trial of the Acumatica Python Connector to start building Python apps and scripts with connectivity to Acumatica data. Reach out to our Support Team if you have any questions.