Skip to main content

Develop Integrations with Web Services | APIs

Technical discussions focused on Web Services and APIs for developers

  • 804 Topics
  • 3,191 Replies
804 Topics
N
Freshman II
nickacfieldFreshman II
asked in Develop Integrations with Web Services | APIs
GET PurchaseReceipt Can i filter api response by any containing Details/POOrderNbr = ' certain value'

Hi, How can i GET PurchaseReceipt - List of Lines that are for a certain PO number?I cannot seem to filter by expanded objects. Otherwise to get all Receipt Lines against a certain PO I will need to dig out all receip[ts for a supplier and loop through all returned lines to get my filtered list. here is my API call returning a 500 - "The parent value for a property access of a property 'POOrderNbr' is not a single value. Property access can only be applied to a single value.", /entity/Default/22.200.001/PurchaseReceipt/?$expand=Details&$filter=VendorID eq 'V000000001' and Details/POOrderNbr eq '000018' or is there a way to query ReceiptLines seperately?

777
N
Freshman II
G
Freshman I
geoffatsourceFreshman I
asked in Develop Integrations with Web Services | APIs
Reopen a Purchase Order via the default API?

Is there a way to reopen a purchase order that was set to “completed” via the API? I have some tests that are cancelling line items and some of the POs are being closed automatically and I can’t delete them when I run my cleanup script.

4910
G
Freshman I
G
Jr Varsity III
grillevanJr Varsity III
asked in Develop Integrations with Web Services | APIs
Acumatica - Avalara Integration; Is it set up to pass Latitude/Longitude to calculate Sales Tax

Good day, Avalara has the ability to calculate sales tax by entering the Latitude/Longitude manually. My question is does the Acumatica - Avalara integration set up to pass this information from the Project Address tab. Some of our projects have a state/city/ postal code but not actually address just a location on a pipeline. I have seen any documents or announcements. Thank you

272
G
Jr Varsity III
jinin
Pro I
jininPro I
asked in Develop Integrations with Web Services | APIs
Unable to make Customer Contact as primary except for the First record through API call

Hello Everyone, I am trying to make a customer contact as primary through API call. But it is working for the first entered contact. Unable to set another contact. Could you please review and share your feedback?

3038
abrunner78
Jr Varsity III
B
Freshman I
BEXJensFreshman I
asked in Develop Integrations with Web Services | APIs
Get ID of ERP system from push notification

Hi folks, i’m looking for an possibility to identify the system that sent a push-notification. The notification body looks like that: { "Inserted": [ { .... } ], "Deleted": [], "Query": "<my_query>", "CompanyId": "<my_company>", "Id": "8d6d670d-86e0-477f-a8cc-343b578ba3dd", "TimeStamp": 638775642732888022, "AdditionalInfo": { "PXPerformanceInfoStartTime": "03/14/2025 15:51:12" }} However, if i receive push notifications from different systems (different domains) i can’t figure out which system sent the notification. I only have the company id but I don’t think that the companyid is unique. Does anyone know how to solve this problem? Thanks in advance.

162
B
Freshman I
H
Semi-Pro II
HarrySemi-Pro II
asked in Develop Integrations with Web Services | APIs
Login Syntax for OData

Hello community, I have been trying to use a GET method to login to my Acumatica instance using Postman, but it displays 404 error or sometimes 401 unauthorized error. i have created a user account and have given the account as Admin & Access to OData roles. I have been using the following syntax in the postman: https://site URL/AcumaticaERP/OData Is this the correct syntax that I have been using? If yes then why I am facing the issue? Thanks in advance.

71315
R
Freshman II
M
Varsity I
matthewgerdanVarsity I
asked in Develop Integrations with Web Services | APIs
REST API: Sequence of field defaulting causing errors

Hi Everyone, MYOB customer updating from 23R1 to 24R1. Having an issue where the Payment endpoint in the API is returning an error that the cash account cannot be found. This error is also experienced in the UI and is due to the Branch that is defaulted from the customer record being a different branch than the cash account (fair enough). The request body has the correct value for the branch so that if all values of the API request were entered in the correct order, then the payment would be valid. Is there a way to control the sequence that values in API requests are entered so that defaulting happens in the correct order?

383
M
Varsity I
P
Jr Varsity II
PBSAJr Varsity II
asked in Develop Integrations with Web Services | APIs
Production Order Details API Scheduling (Time Zone Problem)

​TLDR; How can I avoid time zone issues with Plan dates on Production Order Details when they are created via API? Due to the long JSON blocks, this question split over the first few comments as well. Configuration: My Site Preferences ‘Login Time Zone’ is blank My logged in UI user is also set to a blank Time Zone My API user’s Time Zone is blank I am using infinite scheduling with a Finish On Constraint The Work Calendar is M-F 11 hour days in UTC-08:00 Request: I log in via Postman to the API user for my local Acumatica instance. Then I PUT a Production Order (entity/MANUFACTURING/23.200.001/ProductionOrder?$filter=ProductionNbr eq 'DATETEST'): { "OrderType": { "value": "RG" }, "ProductionNbr": { "value": "DATETEST" }, "InventoryID": { "value": "018954" }, "OrderDescription": { "value": "test product" }, "Warehouse": { "value": "PBNW" }, "Location": { "value": "*MFG" }, "OrderDate": { "value": "2025-01-03T00:00:00-08:00" }, "QtytoProduce": { "value": 31 }, "UOM": { "value": "EA" },

839
Chris Hackett
Community Manager
S
Freshman I
sclassingFreshman I
asked in Develop Integrations with Web Services | APIs
$select after API action returns empty body

We have defined an action on SOShipment and exposed it via the REST API. When we call the action for the API we define a query string param $select=ShipmentNbr. The action succeeds, but the the return body is empty. We expected to see an SOShipment, with the ShipmentNbr specified. How can we fix this? Here are the details On SOShipmentEntryExt, we define an action named AddShipmentNbr. public PXAction<SOShipment> AddShipmentNbr; [PXUIField(DisplayName = "Add ShipmentNbr", MapEnableRights = PXCacheRights.Select, MapViewRights = PXCacheRights.Select)] [PXButton()] public virtual IEnumerable addShipmentNbr(PXAdapter adapter) { ... } We exposed this action as an Action on the Shipment REST API, naming it LockShipmentMutex. We construct a call in Postman POST {{PackingEndpointURL}}/Shipment/LockShipmentMutex?$select=ShipmentNbr BODY { "entity": { "id": "6B4E9A21-78F6-EA11-96A4-000D3A610F1B" }} The action succeeds, but we receive an empty body in the response. We expected to receive a SOShip

233
Dmitrii Naumov
Acumatica Moderator
B
Semi-Pro I
bpgravesSemi-Pro I
asked in Develop Integrations with Web Services | APIs
REST API: retrieving CustomerPaymentDetail from CustomerPaymentMethod

When I use the following, I am able to get everything except the Details (CustomerPaymentDetail): entity/Default/22.200.001/CustomerPaymentMethod/?$filter=CustomerID+eq+'C10987654321'+and+PaymentMethod+eq+'CC Visa'+and+ProcCenterID+eq+'procID'+and+CustomerProfileID+eq+'12345678901' The Details are in the Web service endpoint. Is there a specific URL parameter I need to pass to see it?

151
Dmitrii Naumov
Acumatica Moderator
amitr70
Semi-Pro I
amitr70Semi-Pro I
asked in Develop Integrations with Web Services | APIs
Exposing Inventory Summary Available to Ship field to StockItem endpoint

Hi , I wanted to extend my stock item end point to include Available to Ship value of Inventory Summary screen. To do so, I Create a custom view and tried to populate the field from DAC level only. So that when called from API it will resolve the BQL and fire the data to the API. I want this field for API only so I dont have any screen level events attached to this DAC field. Below is my code public class TSInventoryItemNIExtension : PXCacheExtension<PX.Objects.IN.InventoryItem> { public static bool IsActive() => true; #region UsrAvailToShip [PXDBDecimal] [PXSelector(typeof( Search<TSViewGetAvailToShip.qtyHardAvail, Where<TSViewGetAvailToShip.inventoryID, Equal<Current<InventoryItem.inventoryID>>>>))] [PXUIField(DisplayName = "Avail To Ship")] public virtual decimal? UsrAvailToShip { get; set; } public abstract class usrAvailToShip : PX.Data.BQL.BqlDecimal.Field<usrAvailToShip> { } #endregion } In the above DAC TSViewGetAvailToShip is a Sql view that return a list all StockItems with Q

416
Chris Hackett
Community Manager
S
Varsity III
safetynetwebVarsity III
asked in Develop Integrations with Web Services | APIs
creating payment for custom sales order cause error

We are using end point to create payment for our sales order, the default Sales Order Type is “SO”, when creating payment record it works and get added correctly. We added a new Sales Order type “CL” with a separate sequence. But when sending the payment to it it returns this 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 Although in the request the order NBr is correct and OrderTYpe, here is the payload of the payment creation request: $data = [ "Type" => ["value" => "Payment"], "CustomerID" => ["value" => "CUST001"], "CashAccount" => ["value" => "MAIN"], "PaymentMethod" => ["value" => "CHECK"], "PaymentAmount" => ["value" => 100], "OrdersToApply" => [ [ "Type" => ["value" => "CL"], "OrderNbr" => ["value" => "CL00000001"], "AppliedToOrder" => ["value" => 100] ] ]]; When doing the same call for sales orders of the type “SO” and orderNbr with the s

544
S
Varsity III
S
Freshman I
swassoufFreshman I
asked in Develop Integrations with Web Services | APIs
Release payment failing

I am trying to release a payment using rest api I Created invoice by calling put request and was successful and get the reference Nbr I called release payment object Payment soPaymentToBeReleased = new Payment { Type = new StringValue { Value = type }, ReferenceNbr = new StringValue { Value = paymentRefNo } }; created release object var releasePayment = new Models.AcumaticaModels.Actions.ReleasePayment(soPaymentToBeReleased); then I called post request var token = await acumaticaTokenHelper.GetAccessToken(); using var httpClientPost = new HttpClient(); var requestMessage = new HttpRequestMessage(HttpMethod.Post, "https://acctqa.nabp.pharmacy/entity/NABPR2/24.200.001/Payment/ReleasePayment"); requestMessage.Headers.Add("Accept", "application/json");requestMessage.Headers.Add("Authorization", $"Bearer {token.AccessToken}");requestMessage.Headers.Add("PX-CbApiBranch", branch); requestMessage.Content = new StringContent(JsonConvert.SerializeObject(soPaymentToBeReleased ), null, "applicatio

231
Dmitrii Naumov
Acumatica Moderator
B
Semi-Pro I
bpgravesSemi-Pro I
asked in Develop Integrations with Web Services | APIs
REST API: setting custom values using JSON

I can GET custom values using the REST API but when I trying setting, they remain NULL. Question: what JSON structure do I use to set custom values? Here’s an example when I use GET: "custom": { "Document": { "UsrDeviceIPaddress": { "type": "CustomStringField", "value": “100.99.777.55” } } } However, when I use this same structure during a PUT to create a SalesOrder, the value is always null.

699
B
Semi-Pro I
P
Freshman II
PSchirf61Freshman II
asked in Develop Integrations with Web Services | APIs
REST API returning empty set for some object types

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

519
P
Freshman II
R
Freshman I
richard77Freshman I
asked in Develop Integrations with Web Services | APIs
API SOLine Details - Endpoint

When you Alt+Ctrl in the SO301000 screen for SOLine details. It gives you the element properties. How do you use this information to add it to an endpoint? Specifically if it is from a customization and not standard Acumatica.

331
D
Captain II
D
Freshman II
dominicfedcoFreshman II
asked in Develop Integrations with Web Services | APIs
Querying GI over web service API always fails with connection reset

I have two Generic Inquires exposed to OData. I can use the API to query one of them without issue, but the other one always fails. In particular, it returns a partial fragment of the results and then the HTTP connection drops with our HTTP library (curl) reporting this error: “HTTP/2 stream 0 was not closed cleanly: CANCEL (err 8)” If I force HTTP 1.1 instead, the behavior is the same, but the error says “Connection reset by peer”. Any troubleshooting suggestions would be appreciated, thank you!

110
D
Freshman II
K
Freshman I
KyranWFreshman I
asked in Develop Integrations with Web Services | APIs
Acumatica Push Notification Issue: Triggering API multiple times on single addition to GI

Good day Acumatica Community, I have a GI linked to a Push Notification in Acumatica and on addition of a row to the GI my push notification is triggered to send the JSON information to an external API. The issue I am facing is that this specific push notification is resulting in more than one API call per row addition which is unusual as I have similar push notification setup for a different API and the information in the GI’s is nearly identical. I have tested the API via PostMan and the issue is not recreated so my assumption is that it is something on the Acumatica side, possibly queue overflow or timeout? Any assistance is greatly appreciated. Many Thanks

417
jinin
Pro I
Q
Freshman II
QuicklyTestFreshman II
asked in Develop Integrations with Web Services | APIs
Ability to ignore or turn of retainage when creating new bill

Hello, When pushing a bill via the API. Is there an option to override a default vendor retainage? I m pushing a Debt Adjustment via the api and because the vendor has a default retainage it’ s auto being applied. Is there a flag I can set during the PUT to /bill to set retainage to zero? Thanks

201
V
Acumatica Moderator
M
Freshman I
mattollieFreshman I
asked in Develop Integrations with Web Services | APIs
Updating an existing employee

Hi, I was wondering if there was a way to update only specific data against an employee using the RestAPI. I noticed that there is a PUT method on the Employee endpoint. The issue I have found is that if I do not pass all data in the PUT request, it clears the data out of Acumatica. Ideally I would like it to only update the data I send in the PUT request and leave the rest alone. Is this possible or am I doing something wrong?

373
M
Freshman I
abrunner78
Jr Varsity III
abrunner78Jr Varsity III
asked in Develop Integrations with Web Services | APIs
New Line to an Inquiry Form via API

My company has just deployed Acumatica to our Mexico branch. We noticed the exchange rate pulled from Open Exchange doesn’t match the MX governments (DOF). To resolve this we are going to use Zapier and some Python to pull the exchange rate from the DOF’s website and apply it in Acumatica(Currency Rate (CM301000)). I have worked through adding Currency Rate and it’s details screen to an endpoint. With the following bit of code can get the list of currencies and their exchange rates. Code: cury = { 'ToCurrency':{'value': 'USD'}, 'EffectiveDate':{'value': '2025-02-28T00:00:00'} } endpoint = 'https://tormach.acumatica.com/entity/Magento/22.200.001/CurrencyRate?$expand=Details'req = session.put(endpoint, json=cury)print(json.dumps(req.json(), indent=2)) Output: "id": "cc39eca5-673b-444e-a080-8e548c6d80fa", "rowNumber": 1, "note": null, "Details": [ { "id": "e2782637-564c-4cbd-8efd-bfcabea7fdc8", "rowNumber": 1, "note": { "value": "" }, "CurrencyEffectiveDate": { "value": "2025-02-28T00:00:

192
abrunner78
Jr Varsity III
T
Freshman I
trishantpFreshman I
asked in Develop Integrations with Web Services | APIs
Issue Retrieving or Creating Approval Mapping Details via Custom Endpoint

Hello, I’ve created a custom endpoint in Acumatica, but I’m encountering issues when trying to retrieve or manage the approval mapping details, specifically the approval steps and associated rules. Despite setting up the custom endpoint, I am unable to retrieve the step and rule details. When I perform a GET request to the Approval Maps (EP205015) screen, I receive the following response: { "id": "3bdd9e49-3ae5-ef11-8220-a0481c0a4b38", "rowNumber": 2, "note": { "value": "" }, "ApprovalMap": { "value": 3 }, "Conditions": [], "EntityType": { "value": "Purchase Orders" }, "MapEntityType": { "value": "PX.Objects.PO.POOrder" }, "MapId": { "value": 3 }, "MapName": { "value": "Purchase order" }, "Name": { "value": "Purchase order" }, "Steps": [], "custom": {}, "_links": { "self": "/AcumaticaT100/entity/TEST/24.200.001/ApprovalRouting/3bdd9e49-3ae5-ef11-8220-a0481c0a4b38", "files:put": "/AcumaticaT100/entity/TEST/24.200.001/files/PX.Objects.EP.EPApprovalMapMaint/AssigmentMap/3bdd9e49-3ae5-ef11

613
T
Freshman I
M
Freshman I
mattollieFreshman I
asked in Develop Integrations with Web Services | APIs
Best method to use for generating an Access Token

Hey guys, Hopefully I can get some help on the topic. Currently we use Authorization Code to generate an Access Token. We help the client setup a new Connected Application In the Flow, we choose Authorization Code We setup a new Shared Secret and we set the Redirect URI to be our server from our application we store the Clients URL, ClientID and Shared Secret and use them as follows We then load the following URL on the client side https://*CLIENT_URL/identity/connect/authorize?response_type=code&client_id=CLIENT_ID&redirect_uri=REDIRECT_URI&scope=api offline_access&state=CLIENT_CODE This redirects the client to the website asking them to authorize. Once done, the client is redirected to our server and the server will store the following access_token expires_in refresh_token When the access token has expires, we then use the stored refresh_token to generate access_token like this Method: POST https://*CLIENT_URL/identity/connect/token Post Data client_id: CLIENT_ID client_secret: CLIEN

52113
M
Freshman I
H
HAN
asked in Develop Integrations with Web Services | APIs
How to fetch the invoices related to a specified sales order via REST API

I’m trying to create credit memos via REST API and to do that I need the invoice related to a certain refunded sales order so that I can apply the credit memo on it, I looked the docs but I can only see how to retrieve all invoices, I also looked up the interface and apparently there’s no mention on the sales order anyway on the invoice page, if anyone has had a similar issue please advise !!

421
Dmitrii Naumov
Acumatica Moderator
S
Freshman I
swassoufFreshman I
asked in Develop Integrations with Web Services | APIs
Resource owner password flow

Hello, I am using a restful api to get invoice as described by the documentation using Resource owner password flow. after generated a token I made a call to api to get invoice Url + "Invoice?filter=ReferenceNbr eq 'XXXXXX'&$filter=ReferenceNbr eq 'XXXXXX'" after 2 successful attempt to get invoice when I try to get invoice for the third time I get error API Login Limit I tried to logout after each request, but the logout request getting 204 no matter what I passed in the authorization. so not sure if logout is working with me. using var client = new HttpClient();var request = new HttpRequestMessage(HttpMethod.Post, configuration["SignoutUrl"]);request.Headers.Add("Accept", "*/*");string authInfo = configuration["UserName"] + ":" + configuration["Password"];authInfo = Convert.ToBase64String(Encoding.Default.GetBytes(authInfo));request.Headers.Add("Authorization", "Basic " + authInfo); var response = await client.SendAsync(request);response.EnsureSuccessStatusCode(); how to get unlimite

657
S
Freshman I

Go to

Discussion Forums
Financials
Distribution
Manufacturing
Construction
CRM
Field Service
Retail
Payroll
Professional Services
Low Code | No Code Customizations or Integrations
Develop Customizations
Develop Integrations with Web Services | APIs
Other Developer Topics
ISV Solutions
Configuration and Installation
Reports and Generic Inquires
Import and Export Scenarios
System Health and Performance
Community site discussions
Community Introductions
Everything Else
Technology Partners and Customers
News & Announcements

Tags

Most helpful members this week

Badge winners

Show all badges
Terms & ConditionsCookie settings

Cookie policy

We use cookies to enhance and personalize your experience. If you accept you agree to our full cookie policy. Learn more about our cookies.

 
Cookie settings
About Acumatica ERP system
Acumatica Cloud ERP provides the best business management solution for transforming your company to thrive in the new digital economy. Built on a future-proof platform with open architecture for rapid integrations, scalability, and ease of use, Acumatica delivers unparalleled value to small and midmarket organizations. Connected Business. Delivered.
© 2008 — 2024  Acumatica, Inc. All rights reserved