GUMU™ Sage 100 Web API – Direct Query Support Using API Method

By | March 6, 2026
0 Comment

Welcome back to our GUMU™ Sage 100 WebAPI blog series!

In our earlier blogs, we discussed how the GUMU™ Sage 100 WebAPI improves performance and flexibility compared to the legacy SData API. Today, we will look at another powerful capability introduced in the new API — Direct Query Execution using API methods.

This feature allows developers and integration platforms to execute queries directly against Sage 100 tables using a simple API request.

Query Support Through API Method
With the new GUMU™ Sage 100 WebAPI, users can execute queries directly through the API by passing a query statement inside the request payload.
For example, a simple API request can fetch customer records from Sage 100 using a query like:
SELECT * FROM AR_Customer
This means external systems can retrieve data directly from Sage 100 tables without the need to create multiple endpoints or custom routines.

Sample API Request
Below is an example request structure that demonstrates how a query can be executed through the API.

<?xml version="1.0" encoding="UTF-8"?>
<entry xmlns="http://www.w3.org/2005/Atom" xmlns:atom="http://www.w3.org/2005/Atom" xmlns:cf="http://www.microsoft.com/schemas/rss/core/2005" xmlns:http="http://schemas.sage.com/sdata/http/2008/1" xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/" xmlns:sdata="http://schemas.sage.com/sdata/2008/1" xmlns:sme="http://schemas.sage.com/sdata/sme/2007" xmlns:sync="http://schemas.sage.com/sdata/sync/2008/1" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <sdata:payload>
        <GT_Query xmlns="">
            <Query>SELECT * FROM AR_Customer</Query>
        </GT_Query>
    </sdata:payload>
</entry>

In this request:
GT_Query represents the query execution object.

  • The Query tag contains the SQL-like statement.
  • The Query tag contains the SQL-like statement.
  • The API processes the query and returns the requested records.

The GUMU™ Sage 100 WebAPI also provides a Swagger interface where you can easily test queries and explore API capabilities.

Key Advantages
Advanced Query Capabilities
The API allows developers to execute powerful SQL-like queries including filtering, sorting, and join operations across multiple tables.

For example, integrations can retrieve related information such as customer and order details in a single query, reducing the need for multiple API calls.

For more information on our integration solutions, please contact us at sage@greytrix.com. We will be glad to assist you.

Related Posts