Develop Integrations with Web Services | APIs

I want to be able to save multiple PackageContents for an SOShipment in a single API call, but I’m getting odd results. I have the following Body for my PUT REST API request{ "Packages": [ { "PackageContents": [ { "ShipmentSplitLineNbr": { "value": 11 }, "Canister": { "value": 8 }, "Position": { "value": "Bottom" } }, { "ShipmentSplitLineNbr": { "value": 17 }, "Canister": { "value": 8 }, "Position": { "value": "Bottom" } }, { "ShipmentSplitLineNbr": { "value": 19 },

My task: Update two custom fields in the operation record named JBStartDate and JBEndDateThe Process: programmatically put the production order on hold, update the operations, release the production order from hold.Accomplished: put the production order on hold and release the production order from holdError encountered: updating the operation record (specifically the custom fields JBStartDate and JBEndDate)JSON: {"OrderType" :  {"value": "RO" },"ProductionNbr" : {"value" : "MFG000007-000" }, "Operations" : [{"id" : "c24f0a14-d742-f011-8429-129114ee79ef", "JBStartDate" : { "value" : "2025-10-16T13:24:51Z"}, "JBEndDate" : { "value" : "2025-10-22T11:26:39Z"} },{"id" : "c64f0a14-d742-f011-8429-129114ee79ef", "JBStartDate" : { "value" : "2025-10-22T11:26:40Z"}, "JBEndDate" : { "value" : "2025-10-23T11:57:16Z"} },{"id" : "ca4f0a14-d742-f011-8429-129114ee79ef", "JBStartDate" : { "value" : "2025-10-23T11:57:17Z"}, "JBEndDate" : { "value" : "2025-10-29T07:14:05Z"} }]}Error Message returned (th

Hi I am trying to update the purchase order line details via API call below using the GUID:Request Type: PUTURL: https://{URL}/entity/Integration/23.200.001/PurchaseOrder/5ad3671b-217f-f011-ac46-0a3ddcc27c8dThe above GUID used in the request URL is the purchase order related one. Body:{    "id": "5ad3671b-217f-f011-ac46-0a3ddcc27c8d",    "Type": {        "value": "RO"    },    "OrderNbr": {        "value": "SPC005897"    },    "Details": [        {            "id": "d109d928-217f-f011-ac46-029be7b75a6f",            "VesselName": {                "value": "TEST"            },            "DepartureDate": {                "value": "2024-01-15T00:00:00Z"            },            "ETA": {                "value": "2024-02-20T00:00:00Z"            },            "FirstFreeDay": {                "value": "2024-02-22T00:00:00Z"            },            "LastFreeDay": {                "value": "2024-02-25T00:00:00Z"            },            "ContainerNumber": {                "value": "CONTAINER1

Hi Team,We have a requirement to create Issues(IN302000) via API calls and insert line details along with a custom field, but without mapping the custom field in the Web Service Endpoint. Currently, when we use a PUT request, the Issue is created with the line details, but the custom field is not being inserted. Could you please review this and suggest the best possible approach to achieve it.For your reference, we’ve attached the package and the Postman request.http://localhost/NAWEndpoints25.101.0153/(W(7))/entity/Default/24.200.001/InventoryIssue?$expand=Details{    "Details": [        {            "InventoryID": {                "value": "AACOMPUT01"            },            "WarehouseID": {                "value": "WHOLESALE"            },            "Location": {                "value": "R1S1"            },            "Qty": {                "value": 1.000000            },            "UOM": {                "value": "EA"            },           "custom": {                "Transac

Hey everyone! New to acumatica REST API. Getting this error when trying to simply login using the HTTPClient in MS visual studio:StatusCode: 415, ReasonPhrase: 'Unsupported Media Type', Version: 1.1, Content: System.Net.Http.StreamContentGrateful for any assist on this.Thanks!

Im trying to get all expense receipt  using  GET https://{BASE URL}/entity/Default/22.200.001/ExpenseReceipt but nothing is returned on postman. Can any help ? what am I missing here?If i replace ExpenseReceipt with Vendor, I get a list of all vendors. 

I have created a new local installation of Acumatica as a test bed and created a user with the hope of using OData access to pull the data from Acumatica. The user that I created was assigned the role of API user and the Tenant name is Company.I can log in as the admin user interactively but when I try to use Postman to simply get a list of OData exposed generic inquiries (I exposed one so there should be something on the list) I simply get the 401 Unauthorized response. The url I am trying to access is: http://localhost/ACUERP/t/Company/api/odata/gi/Please give me some direction on this.Thanks in advance!

Hi,What is last Acumatica supported version?Second moment, which I need to clarify, how to find out which endpoint version corresponds to Acumatica version ? Does any endpoint version can be imported for any Acumatica version or there are some rules and logic, which must be followed for correct work ?

Hi folks,I want to create a pivot from Generic enquiry where I want to do the below image have FY and YTD values. I have already created the GI but the YTD values and sometimes even the FY values are not correct. I am not sure what my formula can improve the result intended on the Pivot table is as follows:My formula for FY2022 is as below (Using AU financial year July to June):=Round(IIF(( [ARTran.TranDate] > Cdate('2021-06-30')) and ([ARTran.TranDate] < Cdate('2022-07-01')),[ARTran.CuryExtPrice],0),2)Formula for YTD is as below:=Round(IIF(( [ARTran.TranDate] > Cdate('2021-06-30')) and ([ARTran.TranDate] < Dateadd(Today(),'y',-4)),[ARTran.CuryExtPrice],0),2)I have attached my GI as well:Pivot table is as below: Any help or tips would be appreciated.

I’m trying to get some data using the Acumatica REST API, and while it works for some entities (StockItem, TaxCategory, Contact, Account) just fine, others (SalesOrder, SalesInvoice, or Customer) return 200 status with a json empty set returned ala []. Note: I CAN see data for SalesOrder, Customers, etc, using my normal login in the standard UI.Does this sound like a permission issue on the APIUSER user account that is calling the REST API?Thanks for your time, Paul

Hi there,I am currently trying to resolve a API call to enter a activity on a customer. I have tried referring a few articles online. One of them was as below.https://www.postman.com/flight-geoscientist-57391170/celigo-pakcage/request/wgijcfd/create-an-activity-that-is-linked-to-a-customerMy postman call is as below:https://{URL}/entity/Default/24.200.001/Activity/{    "Summary": {"value": "Automated Test 2"},    "Type": {"value": "N"},    "RelatedEntityNoteID": {"value": "a474872e-1378-f011-ac49-0a202afc9b19"},    "RelatedEntityType": {"value": "PX.Objects.AR.Customer"},    "ActivityDetails":{"value": "Automated Test 2"},    "RefNoteID":{"value": "CUST000001, BA Industries"}}My error is: 406 not acceptable. My I please get some tips in this regards.

Can someone know how to update acumatica order's delivery status, timestamp, signature image (URL or attachment) and optional delivery notes/photos using restapi?Thanks in Advance 

Basically, I’m looking to build something similar to the Tenant select combo box on the standard Acumatica login screen.Is there an API call that will return the tenant list of an Acumatica instance?

What is the proper format for a DateTime parameter when using  OData against a GI that has parameters.A simple sample would be getting a list of customers modified since a certain date / time, assuming parameter name is ModDate. ParametersCondition to apply parameterODataDateText_WithParameters(ModDate=2025-06-01) == 500 - Specified cast is not valid.ODataDateText_WithParameters(ModDate='2025-06-01') == 404ODataDateText_WithParameters(ModDate=2025-06-01T00:00:00Z) == 400 (problem with : )I’ve tried other formatting techniques such as URL encoding the values, encoding the entire parameter string, even asked AI, but that just sent me in circles trying the same things over and over, getting the same results.The only hack I’ve found is to have the parameter derive it’s type from a text field (such as Account Name), and then pass in the value as a string : Mapping to a string schema fieldODataDateText_WithParameters(ModDate='2025-06-01') == works when parameter is mapped to a string field i

Hello. Is it possible to create the Active directory user via API or Import scenario. The import doesn't create the user, even though it completes the import. Failing on the API side as well - I can create the native user but not API

hey everyone hope all good  I’ve a PO with “OPEN” Status, i want to create purchase receipt  I’ve added new action to the endpoint   I’ve added new field “OrderNbr” so i can add that to by request to find the PO   This is my endpoint request  https://company/entity/vendorpolineitems/22.200.001/purchasereceipt/AddPOOrder Http body request  {    "entity": {},    "parameters": {                 "OrderNbr": {            "value": "PPO-05298"        }       } }Error Message  "message":"An error has occurred.","exceptionMessage":"Operation failed","exceptionType":"Thanks

I am trying to update a custom field in a Sales Order line using the REST API, but I’m encountering the following error:API URL:http://localhost/AcumaticaDA/entity/DefaultExt/24.200.010/SalesOrder?$expand=Details&$select=OrderType,OrderNbr,Details/InventoryID,Details/LineNbr Method: PUTJSON Payload:{  "OrderType": { "value": "SO" },  "OrderNbr": { "value": "000183" },  "Details": [    {      "LineNbr": { "value": "1" },      "MetaData": { "value": "Updated via CBAPI" }    }  ]}Error Returned:{   "message": "An error has occurred.",   "exceptionMessage": "The given key was not present in the dictionary.",   "exceptionType": "System.Collections.Generic.KeyNotFoundException" } Has anyone encountered this issue before? Is there something wrong with the structure of the payload or the custom field name?Any help is appreciated!

Post data migration process, I was trying to sync credit cards from Authorize.net to our Acumatica 2024 R2 version, but the process ends with error:“E00001: An error occurred during processing. Please try again. The profile in the received response is empty. Please try to send a request later.”I would appreciate any suggestions might help to overcome this issue. Thanks

I have made a project attribute: DOCLINKS which I use to store a string (url) for documents to attach to Project Quotes.I want to update this field via the api.As far as I know, Acumatica does not have a DEFAULT end point for Project Quotes so I cannot extend the default end point.I tried to create a new web service endpoint to pull at least the quote number from the Quote Summary but am struggling to add the project attribute field to the response. I can pull the data via querying a custom GI but I need to also update and edit that field which you cannot do via the api.I tried following this But to no avail.

I following the instructions listed here:https://www.acumatica.com/blog/contract-based-apis-in-generic-inquiries/ However, my Generic Inquiry is really large so I’d like to apply a filter.  However, since I created a Result set using the instructions above, I get an error when I want to filter on a Generic Inquiry value:    "exceptionMessage": "The parent value for a property access of a property 'InventoryID' is not a single value. Property access can only be applied to a single value.", I’m able to filter in the UI on the Generic Inquiry page when I click VIEW INQUIRY so it seems like I shouldn’t have followed the instructions above when creating my Web Service Endpoint. Question: are there a separate set of instructions to follow when using $filter with Generic Inquiry and REST? Here’s the URL I’m using:https://sandbox.acumatica.com/entity/INStockItem/22.200.001/POReceiptPackages?$expand=Result&$filter=Result/InventoryID eq '331-0470'

Currently using 2023 R2 and will soon be updating to 2025 and I’d like to know if I can continue using endpoint version 22.200.001 or if an update will be needed. Where can I find the list of supported web service endpoint versions? Thank you!

Hi everyone,I’ve been trying to retrieve data via OData using a Generic Inquiry (GI) with a parameter, but I’m running into some issues.In my GI, I’ve defined a parameter named PPeriod and when I use it in the Acumatica web UI (for example, entering "092025" for 09-2025), everything works fine — I get the expected result with EndDate as 2025-02-02, along with the correct data for document FCV002141.  GI parameter GI result enddate with 09-2025 and FCV002141However, when I call the same GI via OData in Postman using the same parameter, I receive a 200 OK response but it completely ignores the parameter and returns bad data :  Postman Odata result , dont take in account the parameter If I try with REST API, it work, but i need the odata .. Here’s what I’ve confirmed so far: The parameter is correctly defined in the metadata as: <Function Name="AR_Documents_PeriodSensitive"> <Parameter Name="PPeriod" Type="Edm.String" /> <ReturnType Type="Collection(GenericInquiry.AR_Docume

Have made one Custom Endpoint under GI which is having User, Roles Entities added and we are able to fetch custom endpoint data using Odata in VMware Postman but want to publish this endpoint for all end-users with valid Acumatica credentials and same endpoint if can be configured in Java CodePOC DescriptionWe are working on a Hyper Scaler project POC and need to build an Acumatica Connector which should extract data from Cdata (serving as the data source) and synchronize it into some Data store. Additionally, it should retrieve detailed Access Control Lists (ACLs) from Cdata and perform ACL synchronization alongside the data sync to ensure least-privilege access for logged in use

I am creating a PO receipt through the REST API, and for lines that are sent to a different warehouse or location than the default, the quantities are doubled.  The client has separate virtual warehouses set up for damaged goods, if if received products are received to the damaged warehouse, the resulting quantity shown in the UI is always double the quantity that I sent in the HTTP body.  Anyone have any ideas what is causing this, and how to avoid it?Jim 

Hi allPerhaps a case of running before I’m walking here and quite probably missed some step in the docs/examples. So what I’ve done is develop a customization which I intend to build an extension library from. In this customization I created a report (This report is kind of like a Purchase Order).  Now what I want to do is to via a rest service call where I pass in a record id, download this report as a pdf.In the customization I think I’ve got the method sorted to generate the pdf document, but I can’t figure out how to wire up a service endpoint to trigger this method and return the pdf.  Are there any examples around I should be looking at?  Or advise on how to do this?