Skip to main content

Develop Integrations with Web Services | APIs

Technical discussions focused on Web Services and APIs for developers

  • 844 Topics
  • 3,367 Replies
844 Topics
bigred1022
Jr Varsity II
bigred1022Jr Varsity II
asked in Develop Integrations with Web Services | APIs
Update UDF on a Sales Order via Power Automate

Hello,I am beginning to get into Power Automate and see there is a Connector available for the Acumatica API.  Are we able to update a UDF on a Sales Order using a Flow?  Our need is we have a spreadsheet with tracking information and we also have a UDF for the tracking number.  Hoping there is a way to automatically add the information from the spreadsheet instead of manual import scenarios.  Thanks-

00
bigred1022
Jr Varsity II
Litox
Freshman I
LitoxFreshman I
asked in Develop Integrations with Web Services | APIs
How can I get the first (eldest) record of an entity?

Using the REST API I need to know which is the first record (chronologically) of JournalTransaction. That is, the one with the eldest CreatedDateTime.How can I get that? What's the default ordering of that collection? Can I do something like sort + top=1?

51
Litox
Freshman I
K
Freshman I
kkrausFreshman I
asked in Develop Integrations with Web Services | APIs
How to Extend Endpoints to an older version?

We’re trying to connect Acumatica to Power Automate, however, the program requires version 17.200.001. I’ve been trying to extend the default endpoint to 17.200.001, however, whenever I do, I get the error: “Versions of the contract for a system endpoint cannot be created. Create a custom endpoint and give its contract another name.” However, if I try to name the extension something else, it just doesn’t create anything. Is there a way to access Power Automate this way? 

535
Yuriy Zaletskyy
Jr Varsity I
Litox
Freshman I
LitoxFreshman I
asked in Develop Integrations with Web Services | APIs
Read Timeout fetching data even when using $skip and $top parameters

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?

162
Litox
Freshman I
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 invoiceUrl + "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 errorAPI Login LimitI 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 unlimited c

749
S
Freshman I
C
Freshman I
curthubbardFreshman I
asked in Develop Integrations with Web Services | APIs
AccountSummaryInquiry Subaccount

Hello, We have a client that’s having issues with Subaccount in the AccountSummaryInquiry, no matter what we try the field is always blank.Is there a query string we need to send so Subaccount is populated? They’re using the Default schema so I don’t think they’ve done anything custom with it. 

264
Chris Hackett
Community Manager
adriangavino45
Freshman I
adriangavino45Freshman I
asked in Develop Integrations with Web Services | APIs
Help needed with CreateAPBill action via API from Purchase Receipt

Hi everyone,I’m currently trying to create an AP Bill from a Purchase Receipt using an API (Postman), but I’m running into an error.Here are the details:Endpoint: POST {{BaseURL}}/entity/Default/23.200.001/PurchaseReceipt/CreateAPBill Request Body:{ "entity": { "id": "a256ce42-5b3b-f011-837f-0eddcec71d29" }} Response from Postman:{ "message": "An error has occurred.", "exceptionMessage": "Operation failed", "exceptionType": "PX.Data.PXInvalidOperationException", "stackTrace": " at PX.Api.ContractBased.EntityService.Invoke(ISystemContract systemContract, String version, String name, EntityImpl entity, ActionImpl action, CbOperationContext operationContext, Boolean throwOnError)\r\n at PX.Api.ContractBased.AspNetCore.CbEndpointFeatureServiceExtensions.Invoke(IEntityService entityService, ICbEndpointFeature feature, EntityImpl entity, ActionImpl action, CbOperationContext operationContext)\r\n at PX.Api.ContractBased.WebApi.Controllers.ActionController.InvokeA

434
adriangavino45
Freshman I
J
Freshman II
joegristFreshman II
asked in Develop Integrations with Web Services | APIs
How to handle a dialog when executing an action via the API?

The API I’m trying to use:Custom API, Entity representing the “Employee” screen (EP203000), an Action mapped to the “GenerateTimeCards” action.The Request I’m using:A “POST request using this JSON:{ "entity": { "EmployeeID": { "value": "A real employee ID" } }, "parameters": {}}The Error:HTTP 500, with the words “PX.Data.PXInvalidOperationException” in the stack trace.The Question:If I try to use this action from the UI, I am indeed presented with a dialog box.  I’d love to be able to figure out a way to tell the API to accept the dialog box with no changes, like I just clicked “OK” in the UI. I can’t seem to find any reference to this on the internet.  Does anybody know if this is even possible?  Thanks if you can help!

252
Dmitrii Naumov
Acumatica Moderator
M
Semi-Pro I
malinthawarnakulasooriya08Semi-Pro I
asked in Develop Integrations with Web Services | APIs
Is Logout Required After PUT Request When Exposing Generic Inquiry via REST API with OAuth2 (scope=api)?

As described in the blog post below, I’m exposing a Generic Inquiry (GI) to be retrieved by an external system via the REST API. We are using OAuth2 authentication with grant_type=password and scope=api.As shown in the blog post, I’m sending a PUT request to Acumatica with a {} in the request body.https://www.acumatica.com/blog/contract-based-apis-in-generic-inquiries/ Could you please clarify whether it is necessary to call a logout after performing the PUT request?     

322
M
Semi-Pro I
J
Jr Varsity III
JReppardJr Varsity III
asked in Develop Integrations with Web Services | APIs
Void Bank Rec Option

Hello - Does anyone have an idea why I cannot Void a bank rec. It is grayed out on all recs. I am an admin as well. We cleared a bank item that should have not been cleared vs another one. Therefore one remains open, but should have been cleared. I am assuming this is the solution to void the rec, then recreate them from the issue date. Thanks  

20
J
Jr Varsity III
JKurtz29
Varsity I
JKurtz29Varsity I
asked in Develop Integrations with Web Services | APIs
OData4 With Generic Inquiry and DataTime parameters

What is the proper format for a DateTime parameter when using  OData against a GI that has parameters.A simple sample would be getting a list of customers modified since a certain date / time, assuming parameter name is ModDate. ParametersCondition to apply parameterODataDateText_WithParameters(ModDate=2025-06-01) == 500 - Specified cast is not valid.ODataDateText_WithParameters(ModDate='2025-06-01') == 404ODataDateText_WithParameters(ModDate=2025-06-01T00:00:00Z) == 400 (problem with : )I’ve tried other formatting techniques such as URL encoding the values, encoding the entire parameter string, even asked AI, but that just sent me in circles trying the same things over and over, getting the same results.The only hack I’ve found is to have the parameter derive it’s type from a text field (such as Account Name), and then pass in the value as a string : Mapping to a string schema fieldODataDateText_WithParameters(ModDate='2025-06-01') == works when parameter is mapped to a string field i

418
JKurtz29
Varsity I
JKurtz29
Varsity I
JKurtz29Varsity I
asked in Develop Integrations with Web Services | APIs
URL format for ODataV4 With a GI with multiple parameters

I can get a GI with a single parameter to work with OData 4 using the following URL structure: https://[instance]/t/[tenant]/api/OData/MyGI_WithParameters(Param1='value1')However, when I try a GI that takes multiple parameters, I either get 403 or 404 errors.  Here is the Metadata for each parameter as reported by OData <Function Name="AI-CustomerGI">                <Parameter Name="CustomerIDGT" Type="Edm.String" />                <Parameter Name="DateGT" Type="Edm.DateTimeOffset" />                <Parameter Name="Employee" Type="Edm.String" />                <Parameter Name="FilterByClass" Type="Edm.Boolean" />                <Parameter Name="FilterByState" Type="Edm.Boolean" />                <Parameter Name="FilterBySalesperson" Type="Edm.Boolean" />                <ReturnType Type="Collection(GenericInquiry.AICustomerGI)" Nullable="false" />            </Function>CustomerIDGT is a starting customer numberDateGT is a starting d

151
JKurtz29
Varsity I
S
Freshman I
ssantillanFreshman I
asked in Develop Integrations with Web Services | APIs
Adobe Sign

Hi everyone,Has anyone successfully completed an adobe sign integration to Acumatica? I’m having issues finding the API from the clients Admin Adobe account.  Thanks in advance.

844
S
Freshman I
A
Freshman I
AllenVaughnFreshman I
asked in Develop Integrations with Web Services | APIs
Delete attribute value via REST API

I’m trying to delete a value from an attribute.  I’m trying by sending the attribute with the value needing to be deleted with the “delete” flag set to true.  I’m getting back no error message at all, with a status of OK, but the value is not being deleted.I can manually delete the value via the GUI, but the REST API will not delete it.The JSON object being sent to the AttributeDefinition endpoint:{"AttributeID":{"value":"DKWHLWIDTH"},"Values":[{"ValueID":{"value":"3-3/4"},"delete":true}]}Any suggestions?

515
A
Freshman I
B
Freshman I
BarryedbrookeFreshman I
asked in Develop Integrations with Web Services | APIs
OCR for automating the sales order raising process i.e. email PDF's

I work in a furniture business and looking at ways to reduce manual entry of Sales Orders. We have many small sized customers who do not have advance tech ability and often send their order either as a PDF attachment or in the body of an Email.  They are not too interested in EDI.  I’m looking for a system can read these PDF/emails as they are the same format each time and automatically import and create a SO.  Currently only found Artsyl but I’d like to review a few.Does anyone use a system like this already?  I am very interested in you experiences and suggestions.Thanks

1114
J
Varsity I
A
Jr Varsity III
AndrewMuzalovJr Varsity III
asked in Develop Integrations with Web Services | APIs
How to Include WorkGroup Field in TimeEntry API Endpoint for Employee Time Activities

Hello,I'm working with the Acumatica API to create time entries for the **Employee Time Activities** screen (EP307000) using the **TimeEntry** endpoint. The UI displays a **WorkGroup** field for each activity, but I cannot find this field in the API contract, even after attempting to extend the endpoint.There is only Items objact in the list, and there is no WorkGroupID in the list. I checked fields with selector - the same situation - field unavailableHere are the details:- Acumatica Version: 2025-1 - API Endpoint: `TimeEntry`- Issue: The `WorkGroupID` field is visible on the **Employee Time Activities** screen but is not available in the `TimeEntry` API payload. I checked the default and extended API contracts, but the field is missing.- What I Tried: - Extended the `TimeEntry` endpoint in Customization Projects to include additional fields, but `WorkGroup` is not listed.Questions: 1. Is the `WorkGroup` field available in the `TimeEntry` API, or is it handled differently (e.g., deriv

190
A
Jr Varsity III
B
Semi-Pro I
bpgravesSemi-Pro I
asked in Develop Integrations with Web Services | APIs
REST API: Sales Order cannot be created. Getting a Document number (NEW) error.

I’m getting the following error when I try to create a Sales Order:Document cannot be saved. Document number (<NEW>) equals to the New Number Symbol of a Numbering Sequence. Please change document number.This doesn’t make sense since I want the system to set the Sales Order Nbr so I need to use <NEW> for the Order Nbr.  Is this a configuration issue?

364
Chris Hackett
Community Manager
R
Pro III
raphrfPro III
asked in Develop Integrations with Web Services | APIs
API - Add BAccountID to the Employee Endpoint

Hi everyone, I’m just getting started with the Acumatica REST API and have successfully set up a GET request to the Employee endpoint, which returns a list of employees. However, I noticed that the BAccountID field, which is linked via DefContactID, is not included in the response. I’d like to know if it’s possible to add this BAccountID field to the Employee endpoint, and if so, what’s the correct way to do it—should I use the Customization Project Editor, or is it something that needs to be handled in code? Thanks in advance for your help!

463
Nilkanth Dipak
Semi-Pro III
L
Freshman II
LungileNjakazi37Freshman II
asked in Develop Integrations with Web Services | APIs
API to add segment value using rest api

HiI want to add a segment value using apiI added the screen, and I am able to pull exiting data. I now want to add a value on the segment value  

321
R
Jr Varsity I
B
Freshman II
BEXJensFreshman II
asked in Develop Integrations with Web Services | APIs
Connect to SignalR with Java Client

Hi all,My objective is to connect my java client with the SignalR Hub.I added a push-notification with Destination Type SignalR Hub as it is described here: Push Notifications: To Connect to the SignalR Hub.I use the following code snippet to connect my client with the SignalR Hub:String login = "<my_user>"; String tenant = "<my_tenant>"; String password = "<my_password>"; String basicAuthPlain = login + "@" + tenant + ":" + password; String encodedBasicAuth = Base64.getEncoder().encodeToString(basicAuthPlain.getBytes()); HubConnection hubConnection = HubConnectionBuilder.create("https://<my_x360_domain>/PushNotificationsHub") .withHeader("Authorization", "Basic " + encodedBasicAuth) .build(); hubConnection.start().blockingAwait(30, TimeUnit.SECONDS);... However, after executing start().blockingAwait() I receive the http status 401. Do I miss something? Can anyone tell me how I can sucessfully connect/authenticate the client? Thanks in advance

534
B
Freshman II
C
CSync
asked in Develop Integrations with Web Services | APIs
trouble updating and adding allocations to a shipment detail via REST

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

180
C
A
alancodeless
asked in Develop Integrations with Web Services | APIs
RefreshToken always expires after 24 hrs

For some reason our RefreshToken is always expiring after 24 hours. Regardless of what we set in Connected Applications settings. We are using Resource Owner Password Credentials and RefreshToken is set to Absolute expiration 30 days. Our Acumatica version is: 2024R1 and installed locally. Any help is much appreciated

270
A
iqraharrison
Captain II
iqraharrisonCaptain II
asked in Develop Integrations with Web Services | APIs
Has anyone integrated with lightspeed POS?

hi!we have a prospect who’s current POS system is lightspeed POS and they are looking to make the switch to acumatica.  I was wondering if anyone else has any clients who use lightspeed pos and was able to successfully integrate with acumatica. I would love to hear your experience and what challenges you faced.  

1534
jkoshar90
Jr Varsity II
A
Freshman I
alancodlessFreshman I
asked in Develop Integrations with Web Services | APIs
Acumatica API not updating multiple Contacts under Customer records

We are trying to create an integration with Acumatica API and we are encountering issues or weird behavior when updating multiple items in a parent record.For example when we try to update multiple contacts for a customer, it won't update the all contacts but only update the first one, but the weird thing is it picks up the values from the second item to update the first item, like the contact note field of second item will replace the contact note field of the first item, we are not sure if its bug or something.Anyone experience the same issues?Here is my sample Json payload for a Customer PutEntity endpoint, the note for ContactID: 100745 will replace the note for ContactID: 100743, but will not touch the second item.Seems like only first Contact gets updated.{ "id": "01a0c017-df7f-ea11-8175-b9d61cb73193", "Contacts": [ { "note": { "value": "Note for 100743" }, "ContactID": { "value": 100743 }, }, { "note": { "value": "Note f

403
Chris Hackett
Community Manager
rcreasy
Varsity I
rcreasyVarsity I
asked in Develop Integrations with Web Services | APIs
Push Notification to Google Space Webhook

Hi All,I am trying to set up a push notification to a Google Space webhook. I get an error that the format is incorrect - the error is generated from Google. Google does not like the format of the JSON that is sent.Does anyone know how to customize the JSON?

526
Chris Hackett
Community Manager

Badge winners

  • Customizations expert
    josiahl64has earned the badge Customizations expert
  • Acumatica expert
    Ankita Tayanahas earned the badge Acumatica expert
  • Distribution expert
    bwhite49has earned the badge Distribution expert
  • Acumatica expert
    DrewNisleyhas earned the badge Acumatica expert
  • Integrations and Web Services | APIs expert
    Samvel Petrosovhas earned the badge Integrations and Web Services | APIs expert
Show all badges
Terms & ConditionsCookie 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