Develop Integrations with Web Services | APIs

I know there are a lot of endpoints, but is there a way to get a single swagger file for Acumatica’s REST API, or must I get one per endpoint? 

Hi,The aim of this case is to figure out how to save a field in the endpoint so that, when I import the customization project, this new field will be available for use. I need to add OrderNbr for PurchaseReceipt.After I added the field to the endpoint, I pressed Validate Entity. Then, in the customization project, I selected my package and pressed Reload from Database.After that, I selected Publish with Cleanup and exported my customization package.During testing, I imported my customization project, but the OrderNbr field was not available in the endpoint.Acumatica 2026R1. I tried without reloading from the database and publishing with cleanup, but result remains the same

Hi,We are running into an issue with Acumatica DeviceHub and wanted to check whether anyone has seen this before.We are receiving the following error in the DeviceHub log during label printing:Error calling AuthLogin“The number of concurrent API logins specified for your user account on the Users (SM201010) form has been reached.”Here is what we found so far:The DeviceHub user in Users (SM201010) has Max. Number of Concurrent Logins = 3 In License Monitoring Console (SM604000), our license shows: Maximum Number of Web Services API Users = 20 Maximum Number of Concurrent Web Services API Requests = 3 We changed Maximum Number of Concurrent Web Services API Requests from 3 to 5 and tested again, but the error still remained In System Monitor → Active Users, we can see multiple active DeviceHub sessions, including API sessions DeviceHub appears to repeatedly try to log out and log back in, but continues failing with the same AuthLogin error Because of this, printing fails when DeviceHub

I have an integration (roughly 4 years old) that I used the Acumatica.RESTClient to get started a while back. While not this exact version, it was an older version available at the time: https://github.com/Acumatica/AcumaticaRESTAPIClientForCSharpAll of a sudden recently an issue popped up in the live tenant when using this tool to submit to the web services just creating a very basic Journal Transaction. The payload includes the Module (GL), LedgerID (ACTUAL), Description, TransactionDate, Hold (false), and finally Details (details include Account, Subaccount, DebitAmount, and CreditAmount).When sending to the transaction using the Acumatica.RESTClient code, it will fail in the live tenant. I get this response from the web services:  An error has occurred. : Operation failed : { "message": "An error has occurred.", "exceptionMessage": "The system failed to commit the BatchModule row.", "exceptionType": "PX.Data.PXException", "stackTrace": " at PX.Api.SyImportProcessor.SyStep.Com

Hello,We would like to know what are the options (and costs involved, if any) to have access to a Sandbox Accumatica instance where we can develop and test integrations via web API calls. It would be like a NFR licenses companies use to offer to development partners.We don't plan to sell any specific Acumatica plugins or applications but only to provide consulting services for companies already using Acumatica and demanding integrations with other platforms.Also, we don't want to be reseller or a company that implements Acumatica so I think ISV level partnership isn't necessary.Thank you,Fernando.

Until two weeks ago my integration was working. But for the last two weeks (since March 7th, 2026) I can't make it succeed no more.For context:I'm also downloading many other tables. Sometimes we get 5xx but with retries is enough. For many other integrations (other clients) things are working fine.The problem:As I need to download all the Journals, I'm applying this strategy:I define a date range to $filter: 30 days. Within that range, I paginate with $top=1000 + $skip to fetch all the journals in the period. Then I choose the previous period and repeat (moving backwards until there are no previous journals).I could retrieve a couple of pages, then I started getting timeouts from my side after waiting 10 minutes for a request to finish. Even retrying 5 times. No success. Example request:HTTP Request: GET my.acumatica.com/entity/Default/24.200.001/JournalTransaction?%24filter=LastModifiedDateTime+ge+datetimeoffset%272026-02-15T15%3A46%3A19.303Z%27+and+LastModifiedDateTime+lt+datetimeof

Hello Team, I am getting error while order creation sending with payment details via api.Request- Description:While creating a Sales Order with payment via API, the system throws an error during AR Payment creation. The payment is being passed in the payload, including Cash Account and Payment Method, but the system is not recognizing the Cash Account and fails validation.Error Message:Inserting 'AR Payment' record raised at least one error. Please review the errors.CashAccountID: 'Cash Account' cannot be empty.Steps to Reproduce: Create a Sales Order via API. Include Payment details in the request (PaymentMethod = CASH, CashAccount = 10250). Submit the request.    

I’m looking for instructions or an example on how to set the “Apply Retainage” checkbox on an AR Invoice via an API.  It’s very easy to do in the UI and works exactly how we’d like.  We’ve enabled the Retainage features, and extended the Invoice endpoint to include RetainageApply and RetainagePct fields; however, they’re not not being triggered when sent as “:true” etc. through the API.  Checking other sources online has lead to solutions that didn’t actually work, or were related to AP bills. Any help would be appreciated! 

Has anyone done an integration between the WMS solution Deposco & Acumatica?

Hello,I am trying to create order with payment details, but I am getting error “Inserting 'AR Payment' record raised at least one error. Please review the errors.\nCashAccountID: 'Cash Account' cannot be empty” even I am sending payment method to my payload. In my acumatica, I have two branches- BLASTLINE and STANIOS. For blasline, I didnt get any error when I am passing payment details. But when I am changing the branch with Stanios, it start giving me above error. Please help me in that. order creation payload- Thank you RegardsNamrata

Hello. I’m trying to create a REST call to update a Sales Order record, and at the same time (if possible) to create a Change Order related to it.In my instance, the Change Orders are here, under this tab inside the Sales Order:  The reason why I need to create this record, along with my update to the Sales Order, is that my instance currently has a validation which requires to create a Change Order every time that the Sales Order is updated. For example, In the UI I see this prompt: Without this record, the changes made to the SO aren’t saved to the database.  ​​​Thanks, any advice would be greatly appreciated.

Hello everyone, I wanted to share a small but important detail about REST API behavior differences between Classic UI and Modern UI. I think the general expectation is that UI changes do not/should not affect API behavior. But it’s not completely true. The REST API behavior does depend on the UI of the mapped screen. The order of containers in which REST API processes the request is bound to the order these containers are defined in aspx.E.g. if you have the following mapping structure the order of writing Details and TaxDetails depends on which of these containers is defined first in the aspx of the screen.{"DocType": {"value":"Invoice"}, "RefNbr": {"value":"012345"}"Details": [...]"TaxDetails": [...]}When a user switches UI to the modern one, we do not have aspx anymore. But now, the order will be taken from the typescript definition of the screen. The same rule applies - the first container defined in the typescript will be processed first by the API.  That may cause an issue. If th

I am curious if anyone else is using claude code to help with integrations with Acumatica. Specifically Skills and Agents that assist in building with the REST API. 

Hello. I’m using the Acumatica API to update one field inside the Sales Order entity.This field is ‘Terms’, a relationship field in which users can select a Credit Terms record, to set it as parent.I was using my Default web service endpoint, version 23.200.001. I made a Query to a Sales Order to see if the ‘Terms’ field was returned, but it wasn’t returned.So, I created a new Web Service Endpoint, extending the Default one. Then I went to the Sales Order entity and added a new entry for the Terms field, like in this picture:  Currently we have these Terms records available:Now when I use my custom endpoint ‘SalesOrderTerms’, and execute a GET to query one Sales Order, the Terms are returned. All fine until here.But, when I try to execute a PUT call to update the Terms field, the field is not updated. This is my call:Method: PUTURL: https://<host-name>/entity/SalesOrderTerms/23.200.001/SalesOrder?$filter=OrderNbr%20eq%20'013381'Payload:{    "Terms": {        "value": "NET20"    

Hello, I am new to Acumatica and I am facing this same issue when integrating with service using the web service endpoints, for the Inventory Adjustment.So, a service that should call this api end point only has the inventory id and how much qty with a reason code, and no other data.So when looking at how Acumatica does the process of inventory Adjustments, I was confused with the ReceiptNbr.When testing the service on my local instance using Postman:this request works but I don’t know how can I find this value when sending the put request.How will my api call determine which ReceiptNbr to use for a specific InventoryID, cause if I don’t put this I get an error:error I am getting when not putting the receiptNbr in my put end-point  So, I would love if someone already faced this issue and can tell me what solution they implemented.Or is there something I am missing so I don’t have to put ReceiptNbr in the request, and how Acumatica can figure it out?

Hi Everyone, I’m trying to add the Bank Deposit (CA305000) to a custom endpoint, however I’m struggling with getting the payment details to populate.I have no issue with adding the Header or the charges, but I’ve tried a bunch of different ways of adding the payments without any success.Below is how I have the endpoint at the moment however I have tried it with the AddPaymentDetail not being nested within AddPayment as well as trying to add the payments directly through Payments.When I submit a request the record will create however the payment detail will be emptyThe closest I can got to having it look like it is trying to add the payments is if I omit the DocModule property of $.AddPayment.Payments[*] then I receive the following error.Any help here would be greatly appreciated.

Hi,Building an integration with Shopify for a client. I am using custom fields to store the order ID keys and there is a PXCheckUnique in place on this field to prevent duplication. #region UsrMAXXShopifyOrderID [PXDBString(30)] [PXCheckUnique( Where = typeof(Where<SOOrderExt.usrMAXXShopifyOrderID, Equal<Current<SOOrderExt.usrMAXXShopifyOrderID>>>))] [PXUIField(DisplayName = "Shopify Order ID", Enabled = false)] public string UsrMAXXShopifyOrderID { get; set; } public abstract class usrMAXXShopifyOrderID : PX.Data.BQL.BqlString.Field<usrMAXXShopifyOrderID> { } #endregionThis validation works as expected in the UIHowever, if an identical request is made then in the response all Usr fields that are on the SOOrder object are null and the order is created without any of these fields created. (There is a Usr field on the SOLine that is still populated)I have done integrations for other clients

Hi all,I’m currently trying to receive the owner data of a shipment using the REST API.The response of GET /entity/Default/24.200.001/Shipment/<ShipmentNbr> contains the contact ID:... "OverrideFreightPrice": { "value": false }, "Owner": { "value": "56" }, "PackageCount": { "value": 4 }...However, I can’t request more information about the contact.The owner of a shipment is an employee. But the REST endpoint /entity/Default/24.200.001/Employee does not contain the ContactID.Is there any other endpoint that can be used?Thanks in advance!

Has anyone built out a Toast Integration in the marketplace?

Does anyone have an equation that can turn a negative to a positive amount in integrations. Our client integrates several thousand transactions and a handful (maybe a hundred) sometimes have a negative amount in the Debit and Credit field. This is happening because of how they are entered in the originating system. I have tried a few equations but keep getting errors. =IIf( [Debit Amount]>0, [Debit Amount], [Debit Amount]*-1)Cannot perform the ‘*’ Operation on System.String and System.Int32.  I have tried double and decimal formats and still get this error. =ABS([Credit Amount])An error has occurred while the Abs(Identifier(Debit Amount)) function was being executed: ‘Type mismatch in the argument 1 of the Abs() function: Expected on of the Integer types.’ I have tried the Int32, double, and string types.  I use this in excel. Not sure if the function actually works in Acumatica but thought I’d give it a try. 

I have an Inventory with underscore eg. TEST_1 with the same description.If i make a request with ?$filter=InventoryId eq ‘TEST_1’ it cannot find it but it can find it with  ?$filter=Description eq ‘TEST_1’. I CAN also find with  ?$filter=InventoryId eq ‘TEST_1’ it but when I query a GI with Odata, but not with Rest API.This is the case for all items with underscore, any ideas? My segmented keys for items are question marks and not underscores.

According to Shopify Support Team, Shopify's API access tokens for merchants using the client credentials grant will expire every 24 hours starting January 2026.And Legacy custom app connections still rely on static API access tokens and secret keys without a refresh flow.Since the Acumatica public app uses OAuth for authentication, the token refresh mechanism would typically be part of the OAuth flow, however, the available Acumatica documentation and Shopify release notes do not detail any Shopify-specific token refresh implementation on the connector side.Please confirm whether the Acumatica connector handles the 24-hour token refresh automatically or if manual intervention is required. 

Having issues trying to Import the Acumatica Endpoint as a Postman collection.It was working in previous but now it appears to start making the collection, then it disappears and shows Import Failed.I’m thinking it is to do with the size of the collection as I can create a small custom Endpoint and it imports using the JSON/Swagger/URL data, but trying to use the full Default endpoint fails. Any other ideas or workarounds to try?

When creating a new record - is it possible to exclude certain fields from the response?

I’m working on a utility that can bulk test the configuration mapping software we’ve written, which converts a design from our design tool to an Acumatica configuration. Right now the only way I’ve been able to test is by adding a line item to a sales order with the proper SKU, and then reviewing the generated configuration on that line item once our software runs. This becomes very time consuming when I’m testing in bulk, and it would be much simpler if I could pull down only the blank configuration template by SKU and revision number, and let our software fill that out. I saw that there is a “Test Configuration” tool when editing a configuration from the Configuration Maintenence screen, but I don’t see an API endpoint that can give me that data. Any help to point me in the right direction would be greatly appreciated.