I310: DataRetrievalRESTAPIBasics

Version: 2025R1
Category: Integration

How to Use This Course

External systems can use Acumatica ERP integration services to access the business functionality and data of
Acumatica ERP. This course introduces one of these integration services, which is the contract-based REST API.
This course is intended for developers who need to create applications that interact with Acumatica ERP.
The course is based on a set of examples of web integration scenarios that demonstrate the processes of
developing a client application that uses the Acumatica ERP contract-based REST API. These examples may give
you ideas about how to construct your own requests by using the REST API. The course demonstrates the main
elements of the REST API and its use in typical tasks that integrate Acumatica ERP with third-party applications.
This course contains the same integration scenarios that are used in I300 Data Retrieval with OData, which
introduces Acumatica ERP OData endpoints.
Aer you complete all the lessons of the course, you will be familiar with the basic techniques of data retrieval
through the Acumatica ERP contract-based REST API.

What the Course Prerequisites Are

To complete this course, you should be familiar with the basic principles of Acumatica ERP.

What Is in a Part

The first part of the course explains how to sign in to Acumatica ERP through the contract-based REST API.
The second part of the course is dedicated to the implementation of particular web integration scenarios that you
may need to implement in a third-party application that integrates an external system with Acumatica ERP.
The third part of the course shows how to implement real-time monitoring of data in Acumatica ERP by using push
notifications.
The fourth part of the course describes how to include in a customization project the items that you have created in
Acumatica ERP for integration with an external system.
Each part of the course consists of lessons you should complete.

What Is in a Lesson

Each lesson is dedicated to a particular web integration scenario that you can implement by using the REST API
or push notifications. A lesson usually includes at least one activity that you have to complete to learn how to
implement the described web integration scenario.

Where the Source Code Is

You can find the Postman collection with the requests illustrated in this course in the
IntegrationDevelopment\I310 folder of the Help-and-Training-Examples repository in Acumatica GitHub.

What the Documentation Resources Are

The complete Acumatica ERP and Acumatica Framework documentation is available at https://help.acumatica.com/
and is included in the Acumatica ERP instance. While viewing any form used in the course, you can click the Open
Help button in the top pane of the Acumatica ERP screen to bring up a form-specific Help menu; you can use the
links on this menu to quickly access form-related information and activities and to open a reference topic with
detailed descriptions of the form elements.

How to Use This Course | 6

For the educational purposes of this course, you use Acumatica ERP under the trial license, which does not require activation and provides all available features. For the production use of the Acumatica ERP functionality, an administrator has to activate the license the organization has purchased. Each particular feature may be subject to additional licensing; please consult the Acumatica ERP licensing policy for details. Company Story | 7

Company Story

In this course, you will implement the REST API requests for the integration of Acumatica ERP with a business intelligence (BI) application that is used by a small retail company, MyStore. This company is a single business entity that has no branches or subsidiaries. MyStore uses Acumatica ERP primarily for customer management and inventory management. MyStore plans to extend its business, and it needs analytic data about its customers and the goods in the store. It needs to investigate the options available in Acumatica ERP for integration with BI applications. The integration application that MyStore is developing should retrieve information about customers and stock items from Acumatica ERP. For the integration of a BI application with Acumatica ERP, the MyStore company can use the contract-based REST API. The following diagram shows the integration scheme of the MyStore BI application with Acumatica ERP.

Figure: Integration of the MyStore BI application and Acumatica ERP

Integration Requirements

The BI application of the MyStore company will be used by the company’s marketing managers and warehouse managers to analyze existing customers and review the item availability in warehouses. This course examines the following usage scenarios in the BI application:

Retrieval of the list of customers with contact and address details of each customer
Retrieval of the information about the availability of stock items in warehouses In this course, you will not implement the BI application itself; instead, you will implement the integration part between the BI application and Acumatica ERP. This part provides the support for these usage scenarios in the BI application. (The implementation of the BI application is outside of the scope of this course.) Initial Configuration | 8

Initial Configuration

You need to perform the prerequisite actions before you start to complete the course.

Make sure that the environment that you are going to use conforms to the System Requirements for the Acumatica ERP Installation.
Make sure that the Web Server (IIS) features that are listed in Configuration of IIS Web Server Features are turned on.
Deploy an instance of Acumatica ERP 2025 R1 with the name MyStoreInstance and a tenant that contains the T100 data. If you have completed the I300 Data Retrieval with OData training course, you can use the instance that you have deployed for this course. You deploy an Acumatica ERP instance and configure it as follows: a. Open the Acumatica ERP Configuration wizard and deploy a new application instance as follows: a. On the Database Configuration page of the Acumatica ERP Configuration wizard, type the name of the database: MyStoreInstance. b. On the Tenant Setup page, set up one tenant with the T100 data inserted by specifying the following settings:

Tenant Name: MyStore
New: Selected
Insert Data: T100
Parent Tenant ID: 1
Visible: Selected The system creates a new Acumatica ERP instance, adds a new tenant, and loads the selected data. b. Sign in to the new tenant by using the following credentials:
Username: admin
Password: setup Change the password when the system prompts you to do so. c. Click the username in the top right corner of the Acumatica ERP screen and click My Profile. On the General Info tab of the User Profile (SM203010) form, which opens, select MYSTORE in the Default Branch box; then click Save on the form toolbar. In subsequent sign-ins to this account, you will be signed in to this branch.

Make sure the Postman application is installed on your computer. To download and install Postman, follow the instructions on https://www.postman.com/downloads/.
Make sure that you have HTTP access to the Acumatica ERP instance from the computer where you work with the course. Part 1: Getting Started with the REST API | 9