Develop Integrations with Web Services | APIs

I am creating a Payment/Prepayment through the Acumatica Contract-Based REST API and applying it to a Sales Order using the OrdersToApply detail.The same API payload structure works for several Sales Orders, but it fails for some specific orders with the following error:An error occurred during processing of the field Order Nbr.:The order cannot be applied, the specified combination of the order type and order number cannot be found in the system.Sample request structure:{ "CashAccount": { "value": "XXXXX" }, "CurrencyID": { "value": "USD" }, "CustomerID": { "value": "CXXXXXXXXXXX" }, "Description": { "value": "Shopify Payment XXXXX" }, "Hold": { "value": false }, "OrdersToApply": [ { "AppliedToOrder": { "value": 69.08 }, "OrderNbr": { "value": "ES88832" }, "OrderType": { "value": "ES" } } ], "PaymentAmount": { "value": 69.08 }, "PaymentMethod": { "value": "SHOPPAY" }, "PaymentRef": { "val

I'm trying to download JournalTransaction data. I'm following the documentation to Retrieve the List of Records in Batches, using the $top and $skip parameters. I've tried different values for those.But I can see that as the $skip parameter grows each request take increasingly longer to finish.Finally, after ~1 hour of processing, it fails with a ReadTimeout. Even if I retry, after 60 secs or more, it keeps failing with ReadTimeout. It is not a session expiration issue: I tried with logout/login.Besides it is not consistent. For example with a $size of 500 it typically fails on $skip=115500. But sometimes I get up to the next page ($skip=116000) until it fails.And I can't get over that.Any ideas?

Hi, I would like to clarify a limitation I encountered when working with the Paycheck entity (Screen ID: PR302000 - Paychecks and Adjustments) via Web Services. While reviewing the entity, I noticed the following warning on certain fields:"Do not include fields of this object in a request that retrieves a list of entities. To retrieve those fields, request entities one by one by specifying key fields."From my understanding, this means that some fields (such as detail-level fields like Taxes or similar sub-objects) cannot be retrieved using a standard list request and instead require querying each record individually using its key fields. I would like to ask:Is there any supported way to retrieve these fields in a single list request (e.g., via $expand, endpoint configuration, or other approaches)? Are there any recommended alternatives to avoid multiple per-record API calls, especially for large datasets? Would using a Generic Inquiry (GI) or custom endpoint be the only viable workarou

I'm building an integration that creates Sales Orders and Drop-Ship Purchase Orders via the Acumatica REST API (endpoint version 24.200.001 / a custom endpoint based on it). Once the SO and PO are created, the integration then links the PO and SO line via the API. Everything works correctly when the PO vendor matches the item's default vendor in Acumatica, but fails when using a non-default vendor.What works: After creating the SO and Drop-Ship PO, I release the SO from Hold, then send: PUT /SalesOrder?$expand=Details,Details/PurchasingDetails{ "OrderType": { "value": "SO" }, "OrderNbr": { "value": "SO-000123" }, "Details": [{ "id": "<soLineId>", "PurchasingDetails": [{ "POOrderType": { "value": "Drop-Ship" }, "POOrderNbr": { "value": "PO-000456" }, "POOrderLineNbr": { "value": 1 }, "Selected": { "value": true } }] }]}When the PO vendor is the item's default vendor, SOLineSplit records are auto-created by Acumatica when the PO is sav

Hello, I am trying to extend my endpoint to include the AttributeValue0 data fiend in the MatrixInventoryItem data class. I am doing this to try to pull the default column attribute value for the matrix item. However, Acumatica says that the endpoint is not mapped correctly. How would I correct this, or alternatively, is there a workaround for this? Thanks!

Hi,We are trying to filter a field in an Acumatica dashboard through the URL, but we do not see any possibility of achieving this. Could you please confirm if there is a way to accomplish this? Example: We have a custom dashboard called Production Status with a parameter Work Center. Through the URL, we would like to filter the dashboard to show only WC100. Is there a supported method to apply such parameter-based filtering via URL? Thanks

    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?

Best approach for integration — Web Service Endpoints (Generic Inquiry) vs OData?Hi all,I'd like some advice on the best way to build an integration with Acumatica. What's the recommended approach — going through standard Web Service Endpoints (via Generic Inquiry or standart endpoint) or using OData?What I need to retrieve:Account balances as of a given date Transactions (including base currency) for a specific period Currency exchange rates for a specific periodWhat I've tried so far:I created several Generic Inquiries and exposed them through a Web Service Endpoint.When I tested it by pulling transactions(via standart JournalTransaction)  for a single month (to get the line details I had to pass $expand), execution time was around 14–60 seconds. Our demo instance originally had 16 GB of RAM; after bumping it up to 64 GB, performance improved to around 5–15 seconds — but that's still pretty slow for demo ~155 transaction per month.2019-01 [2019-01-01 -> 2019-02-01]: 359 transactio

Hi everyone,I'm new to Acumatica and currently working on integrating Certificate of Analysis (COA) data. However, I'm having trouble finding any custom endpoints or relevant screens that store or manage this data.I've searched through the default APIs and screens, but nothing related to COA has come up. I wanted to check if anyone here has worked with COA data in Acumatica before.Does Acumatica have a built-in module or screen where COA data is typically stored?Any guidance or best practices for handling COA data in Acumatica would be greatly appreciated.Thanks in advance for your help!

Is there an existing integration with either Ceridian or Payworks, both for Canadian PR processing. 

I have created Generic Inquiry AccountBalances.Created date parameter Dateadded conditionenabled odata i see that url in $metadata. Without param that odata endpoint works fine. Found documentation that explained how to set paramhttps://help-2025r1.acumatica.com/(W(14))/Wiki/ShowWiki.aspx?pageid=7990b4d9-1f40-4654-9494-7b2f6abfd023 But when I trying to fetch data via postman/Acumatica/odata/SomeCompany/AccountBalances_WithParameters(Date=2025-01-01)?$format=jsonor /Acumatica/odata/SomeCompany/AccountBalances_WithParameters(Date=@p1)?$format=json&p1=2025-01-01 it returns 404 How I can correctly pass that Date param ?

This is more of a discussion topic than a question… I’m considering a customization that uses the REST API internally to access data stored in Acumatica.  I know that this isn’t the recommended API. I should be using the Platform API, but there is a good chance that what is being developped will eventualy move outside of Acumatica as a standalone application that talks to Acumatica.What are your thoughts on this?

Hello, I created a custom quoting software in Python for the machine shop I work for.  It auto generates a routing with set-up time, run units, and run time. As well as what material to use based on user inputs. previously we have just ran this software then just copied it over into Acumatica, so Acumatica gives a unit price.   I am trying to get this info to be pushed to Acumatica via the rest API.  I have successfully been able to put/patch the info from my software to Acumatica.  The one tricky thing I have been having problems with is Acumatica calculating everything incorrectly.  Resulting in me editing the times and reverting it back to get Acumatica to give me the correct costs. For Example:image (8) shows the data fresh from my calculator in Acumatica.  You can see it is not calculating fixed labor costs at all.  2: the variable labor cost is off..   some operations have no run time but still show a variable labor cost.  The material cost is also off.  when I go into estimate o

I am currently working with an Acumatica demo instance and planning to integrate with it via the API (Web service endpoints). Could you please provide information on the following:1. API rate limit — what is the maximum number of API calls permitted per minute?2. Concurrent calls — how many parallel API calls can be made by the same user at the same time?3. Transaction limit — is there a monthly cap on the number of transactions that can be created in the demo instance?Thank you in advance for your assistance.

Hi All,I want to release invoice on screen Process Invoice and Memo via REST API. I add screen and actions to the endpoint.The problem is if I send POST request to {{baseUrl}}/ProcessSalesInvoices/ProcessAll. The endpoint asks Entity in the body. That means I only can process one invoice per request. If I send PUT request to {{baseUrl}}/ProcessSalesInvoices with body:{    "DocDetails": [        {            "RefNbr": {                "value": "INV100031"            },            "Selected": {                "value": true            }        },        {            "RefNbr": {                "value": "INV100033"            },            "Selected": {                "value": true            }        }    ],    "ScreenAction": {        "value": "Release"    },    "Action":{        "value":"Process"    }}.   Nothing happened.  The reason I don’t use {{baseUrl}}/SalesInvoice/ReleaseSalesInvoice is I need to wait the invoice to release one by one.   

Hi All,I want to change the Freight Price and Amount on SO303000. I tried few different way but can’t make it. My most current request.I send PUT request to endpoint SalesInvoicewith body:{  "ReferenceNbr": { "value": "INVSP212099" },  "Type": { "value": "Invoice" },  "FreightDetails": [            {   "OrderNbr":{                    "value":"SP219039"                },                "OrderType":{                    "value":"SP"                },                "ShipmentNbr": {                    "value": "SHP297504"                },                "ShipmentType": {                    "value": "Shipment"                },                "FreightAmount": {                    "value": 0                }            }        ]}This will add a new line not update the current data. Do anyone have been done this before? Thank you.

nevermind… 

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!