•  Refresh
  • Tools
  •  
  • Expand All
  • Collapse All
  • Locales
  • Get File Link
  • Report Typo
  • Print
  • Export

Configuring the REST API

Acumatica ERP provides web services for integration with external systems. Through the web services of Acumatica ERP, external systems can get data records from Acumatica ERP, process these records, and save new or updated records to Acumatica ERP.

To access these web services, you can use the contract-based representational state transfer (REST) API and the screen-based SOAP API. In this chapter, you will find the main concepts that are related to the contract-based REST API.

Back to TopIn This Chapter

  • Contract-Based REST API
    • The contract-based REST API operates with business logic objects that do not depend on Acumatica ERP forms or their properties and methods. (In this context, contract-based means based on the object model that the REST API provides.) Each REST API contract is fixed and does not change based on system customization, localization, or any other changes made to Acumatica ERP.
  • Endpoints and Contracts
    • You access the contract-based REST API through endpoints that are configured on the Web Service Endpoints (SM207060) form.
  • API Entities, Fields, and Actions
    • The contract of an endpoint defines the following elements of the contract-based REST API: entities, fields, and actions.
  • Custom Fields
    • You can work with the values of the custom fields that are not included in the entity definition.
  • Custom Endpoints and Endpoint Extensions
    • If the API provided by the system endpoint of Acumatica ERP is not sufficient for the requirements of your application, you can create a custom endpoint from scratch or by extending an existing endpoint.
  • Naming Rules for Endpoints
    • When you create a custom endpoint on the Web Service Endpoints (SM207060) form (either from scratch or by extending a system endpoint), for the names of the entities, fields, actions, and action parameters of the endpoint, and the endpoint name and version, you should make sure to adhere to the following rules:
  • Contract Version
    • Acumatica ERP 2026 R1 supports one version of system contract, which is Contract Version 4. In this topic, you can learn the main characteristics of this contract version.
  • Comparison of System Endpoints
    • Acumatica ERP 2026 R1 provides multiple system endpoints, which have Contract Version 4. In this topic, you can learn about the differences between these endpoints.
  • OpenAPI 3.0
    • Acumatica ERP provides you with the contract-based REST APIs of web service endpoints and with the contract-based REST API of an Acumatica ERP instance. The methods of a REST API are provided in a swagger.json file, which is an OpenAPI 3.0 file. For more information about the OpenAPI specification, see https://www.openapis.org. You can use the swagger.json files to review the APIs of the instance and endpoints and build the client applications for Acumatica ERP based on these files.
  • Representation of a Record in JSON Format
    • By using the contract-based REST API, you obtain existing records from Acumatica ERP, create new records, update, and delete them. You work with the records in Acumatica ERP by using the entities that are defined in the contract of the endpoint that you use to access the service. You pass records to and receive them from the contract-based REST API in JavaScript object notation (JSON) format. JSON is a text format for transmitting data objects that consist of key-value pairs.
  • To Create a Custom Endpoint
    • You use the Web Service Endpoints (SM207060) form to create a custom endpoint.
  • To Extend an Existing Endpoint
    • You use the Web Service Endpoints (SM207060) form to create an endpoint as an extension of an existing endpoint.
  • To Validate an Endpoint
    • You use the Web Service Endpoints (SM207060) form to validate an endpoint, an entity, or an action. During this validation, the system makes sure the following criteria are met for the elements of the endpoint, entity, or action:
  • To Import a REST Schema to a Visual Studio Solution
    • You can create a Visual Studio project and use the REST schema contained in the Acumatica ERPswagger.json files for interaction with Acumatica ERP. (For details about the swagger.json files, see OpenAPI 3.0.) You import the REST schema to a Visual Studio solution in two stages:#You generate Visual Studio packages from the REST schema.#You include the generated Visual Studio packages in your Visual Studio solution.
  • Web Service Endpoints: Endpoint in a Customization Project
    • If you need to transfer the configuration of a web service endpoint, which is defined on the Web Service Endpoints (SM207060) form, to another Acumatica ERP instance, you need to include the respective endpoint in a customization project.
  • Web Service Endpoints: To Include an Endpoint in a Customization Project
    • This activity will walk you through the process of including an endpoint in a customization project.