Develop Integrations with Web Services | APIs

I use the Default/Shipment endpoint to save shipment information to Acumatica via REST API. If the order cannot be shipped in full (or other common errors), I get a failure to save the shipment record and the only message returned by Acumatica will say “Order SO X cannot be shipped in full. Check Trace for more details.”How can I check trace for more details? I have tried: Request Profiler I can see the returned Exception here if I turn on logging, but the exception is too late to tell me where the problem is.  System Monitor Logging in as the API user and looking at the Trace page there Guzzle request to /Scripts/Trace/index.html This just returns the HTML for a deferred script unless I want to get into browser emulation just to get a usable error message Shipments can be 80+ lines, so trying to replicate the problem by hand in Acumatica is not working well. 

At the recent Acumatica Summit 2026 I heard something along the lines that OData data pulls do not consume transactions or do not count against the api calls...something like this so correct my terminology if I am wrong.With this in mind, our developer team is creating a custom mobile app to do more advanced scanning than the WMS system can handle. As we have been doing this, I am setting up endpoints and testing through Postman that every call the app might make it covered. Some of these calls are just GET requests to a GI that I have set up on the endpoint (some of the GIs have parameters as well). Is it best practice to instead of putting the GIs on an endpoint, to just ‘expose to OData’ and do an OData call? This would presumably cut down on our api calls if my above thoughts are correct. Or are the differences negligible? We are trying to ‘standardize’ how this app accesses Acumatica so currently just putting everything onto one endpoint with different entities. Should we change a

I am trying to pin an Activity to a Lead via REST API. There isn’t an action for togglePinActivity on the DEFAULT Lead endpoint out-of-the-box, so I added one: I found a lead in the sales demo data that had multiple activities associated (Darren Walker):I got into the DAC Schema browser and found the Note ID for the 3rd activity here (Summary: Follow up on pricing) and used that and the lead’s id (9833) to create an API request.I POSTed to http://localhost/25R2SalesDemo/entity/ActivityPin/25.200.001/Lead/togglePinActivity{ "entity": { "LeadID":{"value":9833} }, "parameters": { "id":"4d1a3b2c-d87f-e411-beca-00b56d0561c2", "NoteID":{"value":"4d1a3b2c-d87f-e411-beca-00b56d0561c2"} }}I tried the activity note two ways (id and NoteID). I get a 204, which is a successful response. I check the UI, and it did pin an activity, but always the first one, regardless of the ID parameter I send:Posting again removes the pin on the first activity. How can I tell the API which activi

Hello, I’m currently trying to add a bill where the post period differs from the bill date. But it seems the system keeps taking the default post period based on date in case when my user profile don’t have a default branch.When a default branch is assigned to the user profile, it appears to work correctly only for bills associated with that same branch.For example, if the bill is in the BRANCH1 branch and the user's default branch is also BRANCH1, the Post Period is correctly populated based on the financial period of that branch.However, when processing bills that belong to other branches such as BRANCH2 or BRANCH3 the Post Period instead defaults based on the document date rather than following the logic of the branch-specific period.The endpoint we've tried:/entity/Default/22.200.001/Bill/entity/Default/24.200.001/BillRequest Method: @PUTRequest Body: { ... "Date": { "value": "2025-02-11T05:00:00.000+0000" }, "BranchID": { "value": "BRANCH1" }, "Post

I’m trying to create a simple AP Bill via the Rest API, but am running into an issue where it appears Acumatica is validating the Subaccount field and producing an error even though I have valid accounts in the account and subaccount.  Below in the UI screenshot when I enter line 1, the account and sub default from the vendor record.  In line 2 I have manually entered the account and subaccount from the payload that are valid.  In line 3 shows as I first update the account, the subaccount is showing an error just like the API payload response.  I can’t use PATCH because this is the initial PUT to create the bill.  I have also tried creating a non-stock item with no expense account or sub to see if that helps, but it does not.Right now, the only solution I can see is to delete the account and subaccount from the vendor so it doesn’t default into the line.  One thought is to turn off the commit on the Account field in a customization, but that doesn’t feel right.Are there any other solut

Hi, I’m using the REST API to retrieve data from our Acumatica instance. So far, things worked fine, but now I have the issue that the Invoice endpoint does not return invoices with a status of “Balanced”.For example:Invoice VR00000520 has status OpenInvoice VR00000521 has status Balanced When I do the following GET request../entity/Default/24.200.001/Invoice?$filter=ReferenceNbr eq 'VR00000520'..I get a proper response with the invoice data. However, when I do the following GET request../entity/Default/24.200.001/Invoice?$filter=ReferenceNbr eq 'VR00000521'..I get an empty response. I tried to query the Invoices endpoint only by status. This works for the Open status, such as:/entity/Default/24.200.001/Invoice?$filter=Status eq 'Open'..but it does not work for the Balanced status (the response is empty), such as:/entity/Default/24.200.001/Invoice?$filter=Status eq 'Balanced' What do I need to do to access also the invoices with status “Balanced”? Thank youMathias

Hi,Does anyone use the Progression Live software with Acumatica? Our Service Manager mentioned that an API was developed and is working well on both sides to import and export data with Acumatica. I’d like to confirm if this information is accurate.Also, how is the performance of the integration in terms of speed and reliability?How stable is it over time—have you experienced any issues or downtime?Have there been any bugs, and if so, how were they handled?Finally, how do the APIs react to Acumatica upgrades—do they require adjustments or have they remained compatible?

Hi, I’m using Device Hub and this is for MYOB Acumatica. The device hub gives me following logs. Unable to re-enter the password in the device hub as well producing the similar kind of error.  I would appreciate help with this. Thank you,Dulanjana

I have a development instance of Acumatica 2025R2 setup and am testing sending requests to the OData DAC endpoints. Specifically I am targeting the PX_Objects_CS_Segment endpoint and have noticed an issue when including the Length field in the $select parameter. When testing in Postman, these requests return the expected data:{{EndpointURLDAC}}/t/SalesDemo/api/odata/dac/PX_Objects_CS_Segment {{EndpointURLDAC}}/t/SalesDemo/api/odata/dac/PX_Objects_CS_Segment?$top=5 {{EndpointURLDAC}}/t/SalesDemo/api/odata/dac/PX_Objects_CS_Segment?$select=SegmentID,DimensionID,Descr,EditMask,FillCharacter,tstamp,LastModifiedDateTimeThese requests result in ECONNRESET errors:{{EndpointURLDAC}}/t/SalesDemo/api/odata/dac/PX_Objects_CS_Segment?$select=SegmentID,DimensionID,Descr,EditMask,FillCharacter,tstamp,LastModifiedDateTime,Length {{EndpointURLDAC}}/t/SalesDemo/api/odata/dac/PX_Objects_CS_Segment?$select=LengthIs there something special about the Length field that the DAC endpoint is having an issue wi

Hi Community, Is there a way to have an API Role for a designated API User that is basically an API Admin and not a UI Admin? -RJ

Hi all, I have my reverse and apply API working per this threadReverseInvoiceAndApplyToMemo via API | Community Issue is that when you try to Reverse an Invoice it defaults to the Fin Period it was created. Since that Period is closed it needs to be changed to the current Period.  I have tried adding "PostPeriod":{            "value": "122025"        }  or "FinPeriodID":{            "value": "122025"        }  to the payload but still Errors out    "PostPeriod": {        "value": "072025",        "error": "Error: The 07-2025 financial period is closed in the ABC company."    } Is this possible with the API?  How do I find the right field to pass? I can change the period in the UI and it works. Thank you all

 I will return this purchease receipt

Hello Team,I am not able to access GI data in JSON format in 25R2 by odata using postman by using following URL format, it was working in 24R2{Acumatica instance}/OData/{Tenant}/{GI title}?$format=jsonPlease help me

I am working with a dev team and they are connecting a website to Acumatica.  We are trying to get to the Related Items data on a Stock Items.I created a new endpoint named RelatedItems.  I have created other endpoints this way and they have worked, but the dev team is reporting this one is not working.  What is different about this one? Testing this in Postman generates an error.   I also had the dev team try the web service on the screenI created a new endpoint named RelatedItems.  I have created other endpoints this way and they have worked, but the dev team is reporting this one is not working.  What is different about this one?Web Service for RelatedItems  Fields that are available for RelatedItems The web service attached to the Related Items screen also generates an error when called.This is from the Web Services Link on the Acumatica Related Items screen 

client want to show live stream in custom screen

Good afternoon, I’m looking to see if anyone has had any experience with setting up an integration with Alteryx, and if there were any unexpected hurdles or tips needed to make them work. We’re currently looking at just establishing a generic ODBC connection to capture data, which should be pretty straight forward.

Could I get some details on how and who to contact for EDI development for our customer. They have specific Vendors that require EDI, and we need to set it up for them. Thank you in advance! - Johanna

The Sales Order screen has an option to “Recalculate Prices”, which displays a dialog box containing several options including “Set Current Unit Prices”. I’d like to invoke this functionality using the REST API. I’ve discovered the /SalesOrder/AutoRecalculateDiscounts API action, which seems to be the correct endpoint. However, I’m not sure how to pass a parameter indicating that ‘current unit prices’ should be set.A payload like this does not cause the unit prices to be updated: POST /entity/Default/22.200.001/SalesOrder/AutoRecalculateDiscounts HTTP/1.1{    "entity" :    {        "OrderType" : {"value" : "SO"},        "OrderNbr" : {"value" : "002215"}    },    "parameters": { }}(EDIT: I’ll note that “DisableAutomaticDiscountCalculation” is set to false for the SO in question.)What’s the correct parameter to supply this endpoint for unit prices to be updated? The swagger.json file doesn’t appear to contain any information about parameters for this action. Any assistance is appreciated

Hi. Currently, I’m having some issues by expanding the following item of the endpoint (in order to retrieve the Email of a Contact related to a Project’s Address): The Tab, DAC, View and wanted field to retrieve in the endpoint (Project - PM301000)The wanted field to retrieve in endpoint, mappedThe error I got by trying to retrieve the field I would like to add, that the the View (Billing Contact) does not have any ContactID field to map, and also fails the endpoint even if I add it manually (and Validate the entity, which is valid, yet the error persists)The currently available fields in Billing_Contact viewDo any of you have some ideas of how to solve this topic?

We are using the “entity/Manufacturing/23.200.001/MoveEntry/ReleaseMoveEntry” REST API Endpoint to release the move entry at the end of the process.  We get a 202 Accepted response even when the release was unsuccessful.  A couple of reasons for the release being unsuccessful is duplicate serial numbers being received and backflush not being setup properly in the BOM.  In both of these scenarios, we still receive the 202 Accepted response with no body.  How can we “trap” these errors so we can report them to users to make the corrections?  Is there a different API call to use?  Any thoughts would be appreciated.Thank you in advance.

As far as I know, Acumatica only allows you to PUT one entity at a time. Is there any way to do a bulk upload of entites (eg. Stock Items, Journal Transactions etc)?If it’s not possible to do it within Acumatica, can it be done with a custom API or a wrapper and what would that look like?

Hello,We are using the Acumatica native BigCommerce connector, and we’ve noticed that several sales orders created directly in Acumatica have been pushed to our BigCommerce portal, creating corresponding sales records there.We want to stop this, meaning that no sales orders created in Acumatica should be exported to BigCommerce. BigCommerce should only receive orders that originate from the website.Is the sync direction the cause of this issue, since it is currently set to bidirectional?If so, why are only some Acumatica-created sales orders being exported to BigCommerce, and not all of them? We have screenshots of the import and export mappings available for review. 

Inserting 'AR Invoice/Memo' record raised at least one error. Please review the errors. Error: 'Exchange Rate' cannot be empty.

Some of our items are defaulted to ‘Mark for Production’ and ‘Made to Order’.  When I manually create a sales order and add an item to it, the check box for “Mark for Production” is checked.  But when I create the order via the API, it does not mark the line item for production by default.  How can I set this correctly for each line item when creating a sales order with the API?

I am having trouble updating and adding allocations on a shipment detail.  For simple cases, everything is working fine.  I am building an integration to a warehouse system, so I am trying to update the shipment with details from the warehouse system about shipped quantities and packages.I have a detail line that is a kit, so it already has the 3 components connected to it for allocations.  If everything shipped in 1 package, then I can update those 3 allocations with the quantity shipped for each, no problem.  However, when a line like that is shipped in multiple packages, I need to expand the allocation entries to have 1 for each combination of SKU and package, with the quantity shipped in that specific package.When I attempt this, the response I get back has more allocation entries in it than what I sent in.  If originally there was 3 allocation entries, and I try to update those 3 and add 5 more (total of 8), I get back a response with 11 allocation entries and an error that “the q