Acumatica REST API

HI All,

With Acumatica 6 release you can find (and actually use) new type of API – Rest API.

Acumatica 6 API

Acumatica Rest API is based on Contract based API, so here you have some important points:

  • You need to use existing or custom endpoint be able to send API calls
  • Field and container is available for REST API only if it is defined in contract. But you may extend existing contracts.
  • With REST API you have the same set of commands that you have with Contract Based API.
  • Acumatica uses Json format for transfer data between client and server
  • You still have to maintain session and authentication cookies.

URL: http://<InstanceName>/entity/<EndpointName>/<EndpointVersion>/<Entity>
Example: http://acumatica.com/entity/Default/6.00.001/StockItem

Ok, lest try to do some examples. Here I will show you how to call Acumatica REST commands from Browser. By using this approach you can easily test functionality and just feel, how does it work.

To do so, we need a special tool. I will use PostMan extension for Google Chrome browser.

postman api builder

As we need to maintain session and cookies between calls, we also need to install Postman Interceptor extension.

postman api builder

Login
Now we actually can login. To do so, we need to send our credentials for the specific url:
URL: http://acumatica.com/entity/auth/login
JSON:

{
    "name" : "admin",
    "password" : "123",
    "company" :  ""
}

Response should be 204 No Content.

Geting
Ok, authentication is done, lets try to select data.

URL: http://acumatica.com/entity/Default/6.00.001/StockItem

Filtering
If we want some filtering or conditions, we just can use “OData” like filters – $filter=ItemStatus eq ‘Active’

URL: http://acumatica.com/entity/Default/6.00.001/StockItem?$filter=ItemStatus eq ‘Active’&$top=9

Additional parameters that you can use together with URL when you retrieve records from Acumatica ERP:

  • $filter: To specify filtering conditions on the records to be returned
  • $skip: To specify the number of records to be skipped from the list of returned records
  • $top: To specify the number of records to be returned in the list
  • $expand: To specify the linked and detail entities to be expanded
  • $custom: To specify the fields that are not defined in the contract to be returned

Getting Single Record
If you know key, you can easily get details about single record – just add key field to the url string:

URL: http://acusea.acumatica.com/future/entity/Default/6.00.001/StockItem/AACOMPUT01

Puting
You also can create new entity using REST API, in this case you need to use PUT method and send item details using JSON format. Name of the fields and containers you can get from Contract definition.

URL: http://acusea.acumatica.com/future/entity/Default/6.00.001/StockItem
JSON:

{
    "InventoryID" : {value : "Kettler" } ,
    "Description" : {value : "New Cool Kettler" },
    "ItemClass" : {value : "ELECCOMP" }
}

Documentation
Good news that the documentation on the REST API is included right within standard Acumatica Help. There you can find multiple examples and good code snippets that you can use from your favorite language/platform/code.

Have a nice integration!

Average rating:

52 Replies to “Acumatica REST API”

  1. Hi Andrew,

    You can use it like this:
    http://[Base endpoint URL]/[Top-level entity]/[Action name]

    You use the POST HTTP method and pass the record to which the action should be applied and the parameters of the action in the request body in JSON format as follows:
    {
    "entity" : [record in JSON format],
    "parameters" : [parameters in JSON format]
    }

  2. Hi Dkardell,
    You should pass filters with query URL. And yes, you should have spaces there, but in the end spaces should be encoded as accordingly to standard URL encoding rules

  3. Hi Sergey,

    I'm trying to work with the REST APIs using PHP cURL code.

    I'm testing by doing to calls in Postman: Login, Create a Customer. It works fine.

    Then I generate the PHP cURL code and run the code in PHP, but I get an error on the second call: {"message":"You are not logged in."}

    I'm thinking that Postman automatically passes the session information between calls.

    So, I added Postman Interceptor and now I get back cookie information like this: https://imgur.com/a/zejPA

    But, when I generate the PHP cURL code, it still doesn't generate the cookie information:
    "http://localhost/Acumatica/entity/auth/login&quot;,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_POSTFIELDS => "{rn "name": "admin",rn "password": "mypassword",rn "company": "Company"rn}",
    CURLOPT_HTTPHEADER => array(
    "cache-control: no-cache",
    "content-type: application/json",
    "postman-token: 3af0af99-e514-ab2e-4f69-7481a1b9c6ce"
    ),
    ));

    $response = curl_exec($curl);
    $err = curl_error($curl);

    curl_close($curl);

    if ($err) {
    echo "cURL Error #:" . $err;
    } else {
    echo $response;
    }

    Do you know how to get the PHP cURL code that will pass the cookie information between API calls?

  4. Hi Sergey,
    I am trying to use the action Prepare Invoice for a sales order with the instructions from your post dating 26th January.
    I can't get it to work, do you think it is possible to do it for this action ?

    Thanks,

  5. Hi Sergey,

    Nevermind on this. I was able to get it to work.
    I needed to add the PrepareInvoice action in web service endpoint SalesOrder.

  6. Can we create record with custom field in rest api:
    {
    "OrderType": {value: "IN"},
    "CustomerID" : {value : "1ARA" } ,
    "Details" :[
    {
    "InventoryIDz": {value: "1BRO01"},
    "InventoryID" : {value: "6DOC"}
    }]
    }

  7. Hi Indranil,

    Try using no filters to find out the date field name for the specific object(endpoint) you are looking for. For example, the StockItem endpoint gives information about the items that are on stock. It has a field 'LastModified' that accepts date values as filters. Here is how the filter can be applied.
    https:///StockItem?$filter=ItemStatus eq 'Active' and LastModified gt datetimeoffset'2017-10-01'
    This URI would fetch all stock items that are in a status of 'Active' and modified after 01-OCT-2017.

    Good luck.

  8. I did think the best way to fetch a product price would be to use the endpoint for products(NonStockItem or StockItem I think) and then use the response JSON to extract the relevant information (in this case the price as you want it) from it.
    As for the multiple addresses, I think these multiple addresses would need to be added as a JSON array onto the corresponding linked entity. I have not tried it myself though.

    Cheers

  9. NonStockItem or StockItem are not the best place for price, as price may be different per customer/class/item/promotion and so on.
    There is an example in our Acumatica I210 training guide (Contract-Based Web Serivices) that uses small csutomization fro that. Please check Lesson 3.4: Retrieving the Price of an Item
    You can do the same with REST, but use PUT method

  10. Hi, how do I select a value from a selector based on some condition? I'm creating an Inventory Adjustment transaction and I need to select a ReceiptNbr to associate with the adjustment transaction. I need to select the oldest receipt with a non zero qty. on hand from the selector. How do I perform this? Can you provide an example? Thank you.
    -Raj

  11. Hi Rajasekaran,
    I do not think you can do this in one request. I suggest you get oldest receipt from receipts screen or generic inquiries and than create a adjustment with second request.

  12. Hello,

    I created a Production Order using the REST api in Postman. Now I need to release this production order.

    I am POSTing to http://localhost/Development/entity/MANUFACTURING/17.200.001/ProductionOrder/ReleaseProductionOrder
    {
    "entity":{"ProductionNbr": {"value": "0000249"}},
    "parameters": null
    }

    response:

    {
    "message": "The request is invalid.",
    "modelState": {
    "parameters": [
    "Error reading JObject from JsonReader. Current JsonReader item is not an object: Null. Path 'parameters', line 3, position 22."
    ]
    }
    }

    Any idea on why I am getting this message ?

    Thanks,

    Mauricio Camara

  13. Hi Maurício,
    I see that you miss the second key of Production Order – OrderType. When you pass entity you need to pass all keys to find it.
    Also make sure that your action is defined in the contract.

  14. Thanks for the response Sergey …

    I tried passing the OrderType as well. I tried using ProductionNbr as well as the DB field name ProdOrdID. The Action is defined in the web services endpoint ProductionOrder > Actions > ReleaseProductionOrder.

    Passing the number and type my response was:
    {
    "message": "The request is invalid.",
    "modelState": {
    "parameters": [
    "Error reading JObject from JsonReader. Current JsonReader item is not an object: Null. Path 'parameters', line 3, position 22."
    ]
    }
    }

    Thanks a lot,

    Mauricio

  15. Hi Maurício,
    I'm really sorry for long reply. Could you please create a case with Acumatica team? It looks that we need to investigate your problem. Thank you!

  16. Hey Tourvi,

    You should be able to get the list of available endpoints and its fields on the menu "System" >> "Integration" >> "Web Service Endpoints".

    Goodluck!

  17. Hi Nick,
    You can use allocations popup on SO to put LotSerialNbr there:
    new SalesOrderDetail()
    {
    InventoryID = new StringValue() { Value = "AAMACHINE1" },
    Allocations = new SalesOrderDetailAllocation[]
    {
    new SalesOrderDetailAllocation()
    {
    Allocated = new BooleanValue() { Value = true },
    LotSerNbr = new StringValue() { Value = "123" },
    },
    },

    Or you can create shipment from shipment screen and link it with sales order. In second case you need to have 2 calls.

  18. Hi Sergey,

    I was referring to how use the rest api. I am using postman and I have been unable to submit a value to the detail array.

    I was thinking it would look something like this:

    {
    ShipmentNbr: { value: "Shipment #" },
    ShipmentDate: { value: "4/26/2018"},
    Detail: [
    {
    Inventory: { value: "Some Item ID"},
    ShippedQty: { value: "9" }
    }
    ]

    }

    This does not seem to work.

    Thanks in advance

  19. Nick,
    One of the issues you have is "Inventory" -it should be "InventoryID"
    But if that does not help, please connect me by skype and we can discuss it there. I'll need an error message.

  20. HI Sergey,

    The InventoryID does not work either.

    I am trying to update the shipping lines (Lot Serial Numbers) via a put method, but it seems that the api method only attempts to add new line. is there some kind of identifier (like the @@ in import scenarios) so I can uniquely identify a specific shipping line.

    What would be the best way to message you, so I can give you my skype info?

    Thanks for all the help.

  21. Nick, sorry for later reply.
    You can retrieve data by using record ID. Read about it here http://help.acumatica.com/Main?ScreenId=ShowWiki&pageid=bc9531b0-717b-4b2d-8899-ff7ca805ade1
    Or you also can retrive and update record by keys
    http://help.acumatica.com/Main?ScreenId=ShowWiki&pageid=52c97a83-1fa1-40e9-8219-52a89a91f2da
    Id can be obtained from "ID" field when you retrieve records.

    To contact me please message me in linkedin or thought google hangouts. For security reasons I do not want to publish my skype on blog.

  22. Hi Sergey,

    When sending a request fetch details for a specific StockItem is it possible for the response to include information on the ItemSalesCategory records a item is associated with?

    I reviewed the StockItem schema, but was unable to locate a reference to the associated ItemSalesCategory fields.

    I did find a method to retrieve the information by making a second request using a filter on ItemSalesCategory, but it would help reduce the number of calls required to integrate each StockItem if there was a method to include these details with the existing information for a StockItem.

  23. Hey Sergey,

    I am trying to find if there is a problem with the REST API endpoints starting with 6.00.001. This has been happening for the past couple of days. The usual SalesOrder endpoint I have been using in the past is now rendering a “Object reference not set to an instance of an object”. Any clues why this is happening?

    Thanks
    Lakki

    1. Hi Lakki, as far as I know there are many customers who are using REST API 6.00.
      And NullReferenceException may be a reason of many things including Sales Order itself.
      Could you please provide a bit more details? – Stack Trace, code?

  24. I create an endpoint for SM200530 and try to upload attachment file through rest API. Please note that DAC of this screen does not have CD column. Therefore the uri of api as below.
    (PUT) http://localhost:5481/entity/Security/17.200.001/EncryptionCertificate/e8e1d3c5-f9fd-49d9-9afc-b209d4f9522d/files/test.txt
    (BODY) binary -> attached test.txt file

    Error from postman
    {
    “message”: “An error has occurred.”,
    “exceptionMessage”: “No entity satisfies the condition.”,
    “exceptionType”: “PX.Api.ContractBased.NoEntitySatisfiesTheConditionException”,
    “stackTrace”: ” at PX.Api.ContractBased.EntityService.PutFiles(ISystemContract systemContract, String version, String name, EntityImpl entity, File[] files, CbOperationContext operationContext)\r\n at PX.Api.ContractBased.SystemContracts.V2.SoapFacade.PX.Api.ContractBased.IRestGate.PutFile(EntityImpl entityImpl, String filename, HttpContent body)\r\n at PX.Api.ContractBased.SystemContracts.V2.RestController.PutFile(String objectName, String ids)\r\n at lambda_method(Closure , Object , Object[] )\r\n at System.Web.Http.Controllers.ReflectedHttpActionDescriptor.ActionExecutor.c__DisplayClass10.b__9(Object instance, Object[] methodParameters)\r\n at System.Web.Http.Controllers.ReflectedHttpActionDescriptor.ExecuteAsync(HttpControllerContext controllerContext, IDictionary`2 arguments, CancellationToken cancellationToken)\r\n— End of stack trace from previous location where exception was thrown —\r\n at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()\r\n at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)\r\n at System.Web.Http.Controllers.ApiControllerActionInvoker.d__0.MoveNext()\r\n— End of stack trace from previous location where exception was thrown —\r\n at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()\r\n at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)\r\n at System.Web.Http.Filters.ActionFilterAttribute.d__5.MoveNext()\r\n— End of stack trace from previous location where exception was thrown —\r\n at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()\r\n at System.Web.Http.Filters.ActionFilterAttribute.d__5.MoveNext()\r\n— End of stack trace from previous location where exception was thrown —\r\n at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()\r\n at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)\r\n at System.Web.Http.Filters.ActionFilterAttribute.d__0.MoveNext()\r\n— End of stack trace from previous location where exception was thrown —\r\n at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()\r\n at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)\r\n at System.Web.Http.Controllers.ActionFilterResult.d__2.MoveNext()\r\n— End of stack trace from previous location where exception was thrown —\r\n at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()\r\n at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)\r\n at System.Web.Http.Filters.AuthorizationFilterAttribute.d__2.MoveNext()\r\n— End of stack trace from previous location where exception was thrown —\r\n at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()\r\n at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)\r\n at System.Web.Http.Controllers.ExceptionFilterResult.d__0.MoveNext()\r\n— End of stack trace from previous location where exception was thrown —\r\n at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()\r\n at System.Web.Http.Controllers.ExceptionFilterResult.d__0.MoveNext()\r\n— End of stack trace from previous location where exception was thrown —\r\n at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()\r\n at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)\r\n at System.Web.Http.Dispatcher.HttpControllerDispatcher.d__1.MoveNext()”
    }

  25. Hi Sergey,

    I have created a new REST API endpoint. Now, I want to deploy it to 200 sites of my clients. How can I achieve that?
    There was a post from Acumatica stackoverflow said that the API migration can be done through customization package. However, in my situation it is very troublesome to manually apply customization for 200 sites.

    Best Regards,
    Khiem.

    1. Hi Vo,
      Unfortunately I can’t answer this from top of my head and need to debug code first. I’ll try to do this as soon as I have some time. But it may be faster if you create a supprot case, so our services team can check your code faster.

  26. H Sergey,

    I try to get list of tenants per site.
    [GET] http://localhost:5481/entity/Security/17.200.001/Tenants (SM203530)
    It gives me error. Please assist.
    “exceptionMessage”: “Optimization cannot be performed.The following fields cause the error:\r\nTenantName: View Companies has BQL delegate\r\nTenantID: View Companies has BQL delegate\r\nCurrent: View Companies has BQL delegate\r\nLoginName: View Companies has BQL delegate\r\nStatus: View Companies has BQL delegate\r\n”,
    “exceptionType”: “PX.Api.ContractBased.OptimizedExport.CannotOptimizeException”

    however, if I try to put in CompanyID, it returns expected data.
    [GET] http://localhost:5481/entity/Security/17.200.001/Tenants/3

  27. Hi, How can I update the items on a sales order record through REST API, such as the quantity, discount? do I need to supply a specific row number? If i’m trying to update its creating a new line but that’s not i need, it should be update based on inventory id. please help me out.

      1. Hi Sergey Marenich
        Thanks Its working fine, can we check specific item is there or not in the Sales order using filter operation, because its not easy to fetch the item id in the salesorder to update it.
        i tried with /SalesOrder?$expand=Details&$filter=ExternalRef eq ‘3422978000000217039’&$filter=Array.Details.InventoryID eq ‘DEMOITEM4’

    1. Hi Munesware,
      Checking item by InventoryId is not always correct as you may have multiple lines with the same inventory item in the SO.
      Better use IDs, or select items with filtering by Inventory and than get IDs

Leave a Reply

Please rate*

Your email address will not be published. Required fields are marked *