INTEGRATION DEVELOPMENT GUIDE DEVELOPER GUIDE Acumatica ERP 2020 R2 cpm:page- sequence | Contents | 2 Contents Copyright............................................................................................................................... 6 Integration Development Guide.............................................................................................7 Limiting Connections of Integrated Applications................................................................... 8 License Restrictions for API Users..................................................................................8 Limitation of API Connections for Integrated Applications................................................12 To Limit the Number of API Connections of Integrated Applications.................................. 13 To Limit API Connections of a Particular Application....................................................... 14 Authorizing Client Applications to Work with Acumatica ERP.............................................. 16 Authorization Code Flow............................................................................................. 16 Implicit Flow............................................................................................................. 23 Resource Owner Password Credentials Flow.................................................................. 27 Comparison of the Flows............................................................................................ 32 To Register a Client Application................................................................................... 33 To Revoke the Access of a Connected Application.......................................................... 35 Configuring the Contract-Based REST and SOAP API...........................................................37 Contract-Based Web Services API................................................................................37 Endpoints and Contracts.............................................................................................38 API Entities, Fields, and Actions.................................................................................. 39 Custom Fields........................................................................................................... 42 Custom Endpoints and Endpoint Extensions.................................................................. 44 Naming Rules for Endpoints........................................................................................44 Comparison of Contract Versions................................................................................. 45 Comparison of System Endpoints................................................................................ 46 Changes to the Entities, Fields, and Actions of the Default/18.200.001 Endpoint as Compared to the Default/17.200.001 Endpoint.........................................................................47 Changes to the Entities, Fields, and Actions of the Default/20.200.001 Endpoint as Compared to the Default/18.200.001 Endpoint.........................................................................52 To Create a Custom Endpoint......................................................................................60 To Extend an Existing Endpoint................................................................................... 63 To Validate an Endpoint..............................................................................................65 Working with the Contract-Based REST API........................................................................ 67 Representation of a Record in JSON Format..................................................................68 Sign-In to the Service................................................................................................71 Sign-Out from the Service..........................................................................................75 Change of the Business Date or Current Branch............................................................ 77 Creation of a Record..................................................................................................79 Update of a Record....................................................................................................83 Retrieval of a Record by Key Fields..............................................................................88 Retrieval of a Record by ID........................................................................................ 91 Retrieval of Records by Conditions...............................................................................94 Retrieval of Data from an Inquiry Form........................................................................98 Retrieval of Records with Attributes........................................................................... 101 | Contents | 3 Parameters for Retrieving Records............................................................................. 104 Removal of a Record................................................................................................ 107 Execution of an Action..............................................................................................111 Attachment of a File to a Record............................................................................... 117 Retrieval of a File Attached to a Record......................................................................120 Retrieval of the Schema of Custom Fields................................................................... 125 Retrieval of the Acumatica ERP Version and the List of Endpoints................................... 127 Multi-Language Fields...............................................................................................129 Working with the Contract-Based SOAP API..................................................................... 132 Multi-Language Fields...............................................................................................132 To Configure the Client Application.............................................................................134 Working with the Screen-Based SOAP API........................................................................ 138 Screen-Based Web Services API................................................................................ 138 API Objects Related to Acumatica ERP Forms.............................................................. 139 Screen-Based API Wrapper....................................................................................... 141 To Generate the WSDL File of the Web Services.......................................................... 144 To Import the WSDL File Into the Development Environment.........................................145 To Use the Screen-Based API Wrapper....................................................................... 148 Working with Commands of the Screen-Based SOAP API.................................................. 149 Commands for Retrieving the Values of Elements........................................................ 149 Selection of a Group of Records for Export................................................................. 151 Commands for Setting the Values of Elements............................................................ 152 Commands for Clicking Buttons on a Form..................................................................153 Commands for Adding Detail Lines.............................................................................153 Commands for Pop-Up Dialog Boxes and Pop-Up Forms................................................154 Commands for Pop-Up Panels....................................................................................157 Commands for Record Searching: Filter Service Command............................................159 Commands for Record Searching: Key Command.........................................................161 Commands for Record Searching: Custom Field...........................................................162 Commands That Require a Commit............................................................................ 163 Commands for Working with Attachments...................................................................164 Commands for Working with Multi-Language Fields...................................................... 165 Configuring Push Notifications.......................................................................................... 167 Push Notifications.................................................................................................... 167 Recommendations for the Data Queries......................................................................169 Push Notification Destinations................................................................................... 169 Push Notification Format...........................................................................................170 To Configure Push Notifications..................................................................................171 To Process Failed Notifications................................................................................... 174 Defining Push Notifications............................................................................................... 176 To Create a Built-In Definition................................................................................... 176 To Connect to the SignalR