I330: DataManipulationRESTAPI
Version: 2025R1
Category: Integration
How to Use This Course
External systems can use Acumatica ERP integration interfaces to access the business functionality and data of
Acumatica ERP. You can use the following integration interfaces:
- The Open Data (OData) protocol
- The contract-based REST API
- The screen-based SOAP API
This course shows how you can submit data to Acumatica ERP and process data in it with the contract-based REST
API. (The data submission and data processing with the screen-based SOAP APIs is outside of the scope of this
course. The OData interface cannot be used for this type of integration.)
Information about data retrieval through the OData and contract-based REST API is available in the I300 Data Retrieval with OData, I310 Data Retrieval with REST API Basics, and I320 Advanced Data Retrieval with REST API training courses.
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 process of developing a client application that uses the contract-based REST API. The course gives you ideas about how to create REST API requests to develop your own applications by using the contract-based REST API. Aer you complete all the lessons of the course, you will be familiar with the advanced techniques of data submission and data processing through the Acumatica ERP contract-based REST API.
What the Course Prerequisites Are
To complete this course, you should be familiar with the financial and distribution functionality of Acumatica ERP,
the basic principles of the system, and the principles of data retrieval with the Acumatica ERP contract-based
REST API. We recommend that you complete the I310 Data Retrieval with REST API Basics and I320 Advanced Data
Retrieval with REST API training courses before you go through this course.
What Is in a Part
All parts of the course are 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.
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 contract-
based REST API. Each lesson consists of a brief description of the web integration scenario and a sample HTTP
request that can be used for the implementation of this scenario.
Where the Source Code Is
You can find the Postman collection with the requests illustrated in this course in the
IntegrationDevelopment\I330 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
How to Use This Course | 5
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.
Which License You Should Use
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 and MyStoreIntegration Application | 6
Company Story and MyStoreIntegration Application
In this course, you will simulate the integration of Acumatica ERP with the online store of a small retail company, MyStore. This company is a single business entity that has no branches or subsidiaries. MyStore uses Acumatica ERP for customer management, sales order processing, and payment collection. MyStore has been acting upon plans to extend its business and start selling goods online. To do this, MyStore has been investigating the options available in Acumatica ERP for integration with eCommerce applications. In the first stage of the implementation, which is covered in the I320 Advanced Data Retrieval with REST API training course, MyStore has developed the MyStoreIntegration application. During this stage, the retrieval of information about stock items, sales orders, and payments from Acumatica ERP was implemented. In the second stage of the implementation, which this course covers, MyStoreIntegration will be expanded to submit information about customers, sales orders, and payments from the online store to Acumatica ERP. For the implementation of the MyStoreIntegration application, the MyStore company can use the contract-based REST API. The OData interface can be used only for the implementation of the data retrieval part of the MyStoreIntegration application; data submission should be performed by other integration interfaces because data submission is not possible through OData. The examples of this course show the REST API requests that can be used in the implementation of the MyStoreIntegration application. The following diagram shows how the MyStoreIntegration integration application fits in the integration of the MyStore online store with Acumatica ERP.
Figure: Integration of the MyStore online store and Acumatica ERP
Integration Requirements
Two types of users work with the online store application of the MyStore company: the customers who purchase goods, and the administrators who manage the online store. In the second stage of implementation, the MyStoreIntegration application should implement integration with Acumatica ERP to support the following usage scenarios in the online store:
- A registered customer should be able to do the following:
- Purchase goods
- Update the purchase before it is shipped
- Have the goods shipped
- An administrator should be able to do the following:
- Add new stock items to the catalog of the online store Company Story and MyStoreIntegration Application | 7
- Add notes and attachments to stock items In this course, you will not implement the online store application itself; instead, you create the REST API requests for the integration part between the online store and Acumatica ERP, which provides the support for these scenarios in the online store application. Initial Configuration | 8
Initial Configuration
You need to perform the prerequisite actions before you start to complete the course. Do the following:
- 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 I310 Data Retrieval with REST API Basics or I320 Advanced Data Retrieval with REST API training course, you can use the instance that you have deployed for this course. For information on how to deploy the instance for the training course, see Deploying an Acumatica ERP Instance for the Training Course.
- Make sure that the following conditions are met:
- The Postman application should be installed on your computer. To download and install Postman, follow the instructions on https://www.postman.com/downloads/.
- A Postman collection should be configured to use the OAuth 2.0 authorization, or the requests for signing in to and signing out from Acumatica ERP should be included in the collection. You can use the Postman collection that you have created in the I320 Advanced Data Retrieval with REST API training course. For details about how to configure OAuth 2.0 authorization, see Part 1 of the I320 Advanced Data Retrieval with REST API training course. For details about the sign-in and sign-out methods, see Sign-In to the Service and Sign-Out from the Service in the documentation.
- Make sure that you have HTTP access to the Acumatica ERP instance from the computer where you work with the course.
- If you use OAuth 2.0 authorization, configure HTTPS on the Acumatica ERP website by completing Configuring a Website for HTTPS. If you have configured HTTPS on the Acumatica ERP website for the I320 Advanced Data Retrieval with REST API training course and you are using the same site for the current course, you do not need to configure HTTPS again. If you do not use OAuth 2.0 authorization, you can call API methods via HTTP.
Deploying an Acumatica ERP Instance for the Training Course
Instead of deploying a new instance, you can use the Acumatica ERP instance that you have deployed
for the I310 Data Retrieval with REST API Basics or I320 Advanced Data Retrieval with REST API training
course.
You deploy an Acumatica ERP instance and configure it as follows:
- 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 Initial Configuration | 9
- 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.
- 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.
- 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.
Configuring a Website for HTTPS
In the examples of this guide, you will use the secure connection between the API client application and Acumatica ERP. A secure connection between the client application and the Acumatica ERP website with a Secure Socket Layer (SSL) certificate is required for the authorization of the client application through OAuth 2.0. Therefore, you have to set up the Acumatica ERP website for HTTPS, as described in this topic.
Configuring a Website for HTTPS
As the Microso IIS documentation states, the general steps for configuring SSL for a site include the following:
- You obtain the needed certificate. (For the purposes of completing the course, you can create a self-signed server certificate.)
- You create an SSL binding on a site.
- You test the website by making a request to the site.
- Optional: You configure the SSL options.
To complete the examples of this guide, you should create a self-signed certificate and configure SSL binding as follows: - Create a self-signed certificate by doing the following:
a. In the Control Panel, open Administrative Tools > Internet Information Services (IIS) Manager.
b. In the Features View, double-click Server Certificates, as shown in the following screenshot.
Initial Configuration | 10
Figure: IIS Manager: The Server Certificates icon
c. Click the Create Self-Signed Certificate link in the Actions pane (see the following screenshot).
Figure: IIS Manager: The Create Self-Signed Certificate link
d. Enter a name for the new certificate and click OK. - Do the following to create an SSL binding:
a. Select a site in the tree view and click the Bindings link in the Actions pane (see the following
screenshot).
Initial Configuration | 11
Figure: IIS Manager: Bindings link
b. In the Site Bindings dialog box, click Add to add your new SSL binding to the site. c. In the Type drop-down list, select https. d. Select the self-signed certificate you created and click OK to close the dialog box. - In the Actions pane, under Browse Website, click the link associated with the binding you just created
(Browse *:443 (https)), as the following screenshot shows.
Figure: Opening the HTTPS website
The browser will display an error page because the self-signed certificate was issued by your computer rather than by a trusted certificate authority. - Click the link to proceed with this website and disregard the error. The HTTPS website opens. Part 1: Creation of Records | 12