How to use SQLAlchemy ORM to access Sage Intacct Data in Python

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

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

Getting Started

---

Connecting to Sage Intacct Data

Connecting to Sage Intacct 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.

To connect using the Login method, the following connection properties are required: User, Password, CompanyId, SenderId and SenderPassword.

User, Password, and CompanyId are the credentials for the account you wish to connect to.

SenderId and SenderPassword are the Web Services credentials assigned to you by Sage Intacct.

Follow the procedure below to install SQLAlchemy and start accessing Sage Intacct 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 Sage Intacct Data in Python

You can now connect with a connection string. Use the create_engine function to create an Engine for working with Sage Intacct 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("sageintacct:///?User=myusername&CompanyId=TestCompany&Password=mypassword&SenderId=Test&SenderPassword=abcde123")

Declare a Mapping Class for Sage Intacct 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 Customer 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 Customer(base):
	__tablename__ = "Customer"
	Name = Column(String,primary_key=True)
	TotalDue = Column(String)
	...

Query Sage Intacct 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("sageintacct:///?User=myusername&CompanyId=TestCompany&Password=mypassword&SenderId=Test&SenderPassword=abcde123")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Customer).filter_by(CustomerId="12345"):
	print("Name: ", instance.Name)
	print("TotalDue: ", instance.TotalDue)
	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

Customer_table = Customer.metadata.tables["Customer"]
for instance in session.execute(Customer_table.select().where(Customer_table.c.CustomerId == "12345")):
	print("Name: ", instance.Name)
	print("TotalDue: ", instance.TotalDue)
	print("---------")

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

Insert Sage Intacct Data

To insert Sage Intacct 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 Sage Intacct.

new_rec = Customer(Name="placeholder", CustomerId="12345")
session.add(new_rec)
session.commit()

Update Sage Intacct Data

To update Sage Intacct 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 Sage Intacct.

updated_rec = session.query(Customer).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.CustomerId = "12345"
session.commit()

Delete Sage Intacct Data

To delete Sage Intacct 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(Customer).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 CData Python Connector for Sage Intacct to start building Python apps and scripts with connectivity to Sage Intacct data. Reach out to our Support Team if you have any questions.