Use SQLAlchemy ORMs to Access Sage Cloud Accounting Data in Python

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Sage Cloud Accounting Python Connector

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



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

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

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

Connecting to Sage Cloud Accounting Data

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

You can connect to Sage Business Cloud Accounting using the embedded OAuth connectivity. When you connect, the OAuth endpoint opens in your browser. Log in and grant permissions to complete the OAuth process. See the OAuth section in the online Help documentation for more information on other OAuth authentication flows.

Follow the procedure below to install SQLAlchemy and start accessing Sage Cloud Accounting through Python objects.

Install Required Modules

Use the pip utility to install the SQLAlchemy toolkit:

pip install sqlalchemy

Be sure to import the module with the following:

import sqlalchemy

Model Sage Cloud Accounting Data in Python

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

engine = create_engine("sagebcaccounting:///?InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

Declare a Mapping Class for Sage Cloud Accounting 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 SalesInvoices 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 SalesInvoices(base):
	__tablename__ = "SalesInvoices"
	contact_name = Column(String,primary_key=True)
	total_amount = Column(String)
	...

Query Sage Cloud Accounting 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("sagebcaccounting:///?InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(SalesInvoices).filter_by(sent="TRUE"):
	print("contact_name: ", instance.contact_name)
	print("total_amount: ", instance.total_amount)
	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

SalesInvoices_table = SalesInvoices.metadata.tables["SalesInvoices"]
for instance in session.execute(SalesInvoices_table.select().where(SalesInvoices_table.c.sent == "TRUE")):
	print("contact_name: ", instance.contact_name)
	print("total_amount: ", instance.total_amount)
	print("---------")

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

Insert Sage Cloud Accounting Data

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

new_rec = SalesInvoices(contact_name="placeholder", sent="TRUE")
session.add(new_rec)
session.commit()

Update Sage Cloud Accounting Data

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

updated_rec = session.query(SalesInvoices).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.sent = "TRUE"
session.commit()

Delete Sage Cloud Accounting Data

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