Develop Integrations with Web Services | APIs

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! 

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:

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. 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 exe

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 empty

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 identi

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 t

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?

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. 

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.

    Hello， happy 2026.  I noticed that Acumatica officially released AI Studio with their 2025 R2 version, but it's not a true AI agent yet—it can't create detailed order information. I'm wondering if anyone has used AI agents (like Manus and similar ones) to operate Acumatica. How was the experience? Could you share your feedback?

In Acumatica, on screen AR302000, I have a Closed payment that I want to change to Voided Payment using the APIs. In the UI, the process is simple: we click VOID, then REMOVE HOLD, and the document becomes voided.The VOID button triggers the action /24.200.001/Payment/VoidCheck, and the REMOVE HOLD button triggers /24.200.001/Payment/ReleaseFromHold.I called these two APIs sequentially. The first one returned 204, but the second one failed because the payment is not placed on hold after running VoidCheck, meaning Acumatica does not allow ReleaseFromHold.Here is the payload I’m sending for the first API call:json{ "entity": { "ReferenceNbr": { "value": "000025" } }}

I am using REST API to insert a record. Normally, when you manually insert the record from the UI screen, we have custom logic to throw a warning by using e.Cache.RaiseExceptionHandling and PXSetPropertyException and PXErrorLevel.Warning. This allows the user to insert the record with no issues and then later on when they click a “Validate” button in the workflow of that screen our logic will decide what to do.The problem is that when inserting this same record using REST API we do not see that warning reflected back in the JSON response. It seems that the only way to see the error reflected back is to actually have an error be thrown rather than just a warning.It would be pretty simple to just save this warning to a field and then add that field to our endpoint.BUT I would like to know if there are any better ways to do this? 

In our application we are creating Purchase Order Receipts and they had been working fine, but we had not used this function for 6 months or so  and are using it again. We are getting this errorGuzzleHttp\Exception\ClientException: Client error: `PUT https://prestigesalonproducts.acumatica.com/entity/ORDIO/20.200.001/PurchaseReceipt` resulted in a `422 Unprocessable Entity` response: {"id":"15468762-cac9-ee11-65424-12a215648465216","rowNumber":1,"note":null,"error":"'POAccrualAcctID' cannot be empty.; Here is our codereturn [            'note' => $receipt->comment,            'VendorID' => ['value' => $po->vendor_id],            'PostPeriod' => ['value' => now()->format('mY')],            'Details' => collect($receipt->products)->map(function ($product, $key) use ($po) {                return [                    'InventoryID' => ['value' => $product-&

If I have a script that is polling an API from an external system and then transforming the data and writing to Acumatica - what is the best free way to host that script so it can run on a schedule?So far it runs in my VM in the background but I want to know if there are any better or fully free options.

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 e

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

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

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.A