How-toSYSPRO e.net SolutionsIntegration / e.net business objects / REST

SYSPRO API Documentation: e.net Business Objects and REST

Question
syspro api documentation

Also searched as

  • syspro rest api
  • syspro e.net business objects
  • syspro web services api
  • syspro api authentication logon

Short answer

SYSPRO's integration layer is e.net Solutions: a set of business objects (queries, transactions and setup objects) that take and return XML, reachable through a COM or .NET interface or through web services hosted by the e.net components. The documentation ships with the product help and the schema (XSD) files for each business object; a typical call is Logon, then Query or Transaction Post, then Logoff.

Applies to: SYSPRO 7 and 8. The exact web-service and REST endpoints depend on release and how e.net Communications Load Balancer and web services are installed.

How to make your first SYSPRO API call

  1. 1Install and licence e.net Solutions on the application server and confirm the e.net Communications Load Balancer service is running.
  2. 2Create a dedicated SYSPRO operator for the integration with only the program access it needs, and use a strong password stored in a secrets store.
  3. 3Call the Logon business object with operator, company, company password and language. It returns a session identifier (a GUID) that every later call must pass.
  4. 4Call a Query business object (for example a stock or customer query) with the session ID and an XML parameter block. Start read-only.
  5. 5For writes, use the Transaction Post call for a transaction business object, with an XML parameters block and an XML data block that match the object's XSD.
  6. 6Always call Logoff when finished so you do not leak licence sessions. Handle errors by parsing the returned error XML, not by checking only the transport status.

Where the documentation is

The authoritative reference is the SYSPRO e.net help in the product, the SYSPRO developer and partner resources, and the schema files installed with SYSPRO. Each business object has an input and an output XSD and sample XML, so the schema files are often the fastest way to see exactly which fields a transaction expects.

Business object names are short codes that follow SYSPRO's program naming, for example a sales order transaction object. The existing page on creating a sales order through the SORTOI business object shows the shape of a real transaction call.

e.net versus REST

The long-standing pattern is XML in, XML out through the e.net interface. Newer releases add web service and REST-style access layered on the same business objects, which is convenient for cloud and JSON consumers. Because endpoints and availability depend on release and installation, confirm them in your release documentation rather than copying a URL from another site.

Whichever door you use, the same rules apply: one session per integration, validated XML against the XSD, and idempotent design. SYSPRO will not stop you posting a purchase order twice, so your integration must record what it has already sent.

<!-- Skeleton of a query call: values are placeholders -->
<Query>
  <Key>
    <StockCode>A100</StockCode>
  </Key>
</Query>

Security and operations

API access runs under a SYSPRO operator, so role and program access control what the integration can do. Use a separate operator per integration so audit trails and licence use are clear, and avoid sharing the interactive user of a person.

Plan for licence cost and concurrency. Each active session consumes a licence slot, and a loop that logs on per record is slow and wasteful. Log on once, process a batch, log off.

Try it here, free

SYSPRO Private AI Layer Blueprint Generator

Open full tool

Generate a shareable architecture plan for adding a private, on-prem AI assistant to SYSPRO: read replica, e.net business objects, retrieval index, local model serving, permissions and audit.

Common pitfalls

  • !Logging on for every record instead of reusing a session, exhausting licences and slowing the integration.
  • !Skipping Logoff after errors, leaving orphaned sessions.
  • !Trusting only HTTP or transport success; SYSPRO returns business errors inside the XML.
  • !Hardcoding an endpoint copied from a forum; endpoints differ by installation.
  • !Posting transactions without idempotency, creating duplicates on retry.

How an ERP-grounded AI assistant handles this

Netray adds a private AI layer to the SYSPRO you already run, including on-prem installs where the SQL Server and application server never leave your network. ERPray answers questions over live SYSPRO data with read-only SQL or e.net queries it shows you, under the operator's own SYSPRO security, so a planner or accountant can ask the question in plain language and see exactly which tables or business objects produced the answer. Any write-back, such as posting a transaction, goes through a human approval step. The model is open-weight and runs on your own GPUs, so company data is not sent to a public AI service.

Frequently asked questions

Does SYSPRO have a REST API?

SYSPRO exposes its business objects through e.net and, in newer releases, web service and REST-style access over the same objects. Availability and endpoints depend on your release and installation, so check the documentation for your version before designing against a URL.

What is an e.net business object?

It is a SYSPRO component that performs a query or transaction using XML input and output, for example creating a sales order or reading stock levels. Each has an XSD describing the XML, which you can use to validate requests.

How does authentication work?

You call a Logon object with an operator, company and passwords. SYSPRO returns a session GUID, which you pass on every later call, and you end the session with Logoff. Permissions are those of the SYSPRO operator you used.

Where do I find the field definitions?

In the e.net help and the XSD and sample XML files installed with SYSPRO. The schemas show required and optional fields for each business object, and are the quickest way to debug a rejected call.

Related

How-to

How to Create a SYSPRO Sales Order with the SORTOI Business Object

SORTOI is the SYSPRO e.net business object that enters sales orders from outside the SYSPRO client. You log on to get a session id, call the business object with a Parameter XML and a Document XML describing the order header and lines, then read the XML that comes back for warnings and the new sales order number. Always test in a non-production company first.

Advanced

SYSPRO SQL Query for Inventory On Hand by Warehouse

SYSPRO runs on SQL Server with one database per company, typically named like SysproCompanyA, and inventory is split between InvMaster for part-level data and InvWarehouse for quantities per warehouse. Join them on StockCode, filter, and read the quantity columns. Use a read-only login, never write to SYSPRO tables directly, and prefer e.net business objects for any change.

Error fix

SYSPRO Error 67259 and Client Runtime Errors: How to Triage

Numbered SYSPRO errors and client runtime errors are best solved by the message text and the context, not the number alone. We could not confirm an official meaning for 67259 and will not guess one; instead, capture the full message and the program that raised it, check whether it reproduces for other users and companies, review logs on the application server and database, and open a case with those facts.

CIO briefing

SYSPRO 7 to SYSPRO 8: What an IT Leader Should Plan Before Upgrading

A SYSPRO 7 to 8 upgrade is mostly a customisation, integration and report inventory exercise rather than a data migration problem. List everything that touches SYSPRO, test each item in a copy of production, plan the user interface change for operators, and agree rollback. Check with your SYSPRO partner and current support terms for your version before deciding the timing.

How-to

SYSPRO reporting API: e.net, SRS server-side reporting, Crystal Reports and SRS preview problems

SYSPRO gives you three reporting routes: the e.net Solutions business object API (XML in, XML out) for programmatic data, SYSPRO Reporting Services (SRS) for designed reports run on the server, and Crystal-based or SQL-based custom reports. If the SRS preview does not work, check the services, the runtime and bitness, the SQL permissions and the client and server versions in that order.

Error fix

Error validating SYSPRO online profile: what it means and how to fix it

A profile validation error means the SYSPRO client or service could not confirm the operator, company, licence or database connection it was handed at logon. Check the service and licence first, then the operator and company, then the database and disk, in that order. Storage errors are usually full disks, a locked SQL file or a tempdb problem rather than a SYSPRO bug.

AI for ERP

AI for SYSPRO, Grounded in Your Own Manufacturing Data

Add AI to SYSPRO without moving your manufacturing data to a public model. On-premise and private-cloud LLMs for SYSPRO in Australia, NA, and beyond.

AI for ERP

AI for SYSPRO Manufacturing Operations: From Work Centers to Answers

SYSPRO Manufacturing Operations generates data on work centers, routings, and WIP - see how private AI turns it into shop floor answers on-prem.

Stuck on SYSPRO e.net Solutions?

Talk to engineers who work inside SYSPRO e.net Solutions every week, and who build private AI that answers these questions from your own ERP data.

Keep exploring

Free tools

ERP fixes and how-tos

AI on your ERP

Integrations

Software