Develop Integrations with Web Services | APIs

Is there any glossary of complete customer object fields? I’m using SOAP API and some of the fields aren’t coming with the getSchema object and I have to find them by searching through Acumatica question/answers but I don’t know where they are listed properly?? So far I found:LastModifiedDateTimeCreatedDateTimeNow looking for Branch and Company IDs but don’t know the exact field names.. any help?

Hello, Our push notifications are part of our customization project, and we publish our customization project to all three of our tenants to keep them in sync. When we do this, the push notification URL is set to the same value for all three tenants, whereas we need each tenant to use its own specific push notification URL. Is it possible for the push notification URL to be dynamic? We’d like each tenant to use different  push notification URL depending on the CompanyId of the tenant.Thank you, Dave

Hello, We are integrating with the Acumatica SAAS product via the REST API by means of lambda functions. This is working fine in general. However, we find that after a period of inactivity, the response to an API request takes much longer than usual. The lambda function is configured with an execution time of 15 seconds, and it often stops executing before the response is received. An Acumatica support rep once mentioned that this could be due to "cache expiration", but we can't find any documentation about this. Is it possible to configure the cache expiration time, or something similar that would help us solve this problem?Thank you,Dave

Hi Is it any possible way to logout the instance based on the branch using REST API?

Dear Experts,We are facing a peculiar issue that I wanted your input with.  We have a few non-stock items with a price-sheet in Acumatica. We also built an external integration via REST APIs to create an invoice in Acumatica from an external system. The pricing is different in Acumatica’s price sheet vs External System for one particular Invoice Item, say PRODUCT_X. Since we don’t want Acumatica to calculate it’s own list price when the price comes from External System, we tried to set the UnitPrice, ListPrice, ExtPrice and Amount fields through the API. Acumatica accepts all of them except for ListPrice. It always sets the ListPrice to be the price that Acumatica calculates through the Sales Price Sheet. Do you know if this a known behavior? I am still able to edit the List Price from the UI, but it’s just that I am not able to set it via API. Thanks again for your valuable input, as always!

Hello, In the Request Profiler, I can identify the requests made by our API user because the username is displayed. There are often other requests where the username field is blank, and I’m not sure what that means. What does a blank username field mean?Thanks, Dave

Hi, when we create our Sales Order using the API, we encountered this issue Response 422  Unprocessable EntityWe rarely encountered this issue, and we don’t know why it happens. In our request body, we are sure that we have the Status field.  For additional record, I have used the same request body a moment ago and the Sales Order is created but after trying now, the error shows up.Any help would be helpful. Thanks a lot  

Hi Everyone ,We have  below requirement , can anyone suggest best possible way to achieve it please?Added a new field in Payment and Application header level   Should display the above custom field value in Bank Deposit Document level grid Thanks in advance.

I have extended a Web service End Point to include the results using instructions from https://www.acumatica.com/blog/contract-based-apis-in-generic-inquiries/. and Am using a GI as a data source with Celigo (integrator.io).  The problem I’m running into is it breaks down the GI into pages and with my  $Skip formula to chunk the data into pages. I think its because all the data is in the Detail item “Result” and it sees everything as 1 big record.  I think this because to read the results correctly I had to point the resource path to “Result”   I’m at a loss here on how to fix the issue but I’m not an expert so maybe someone here has dealt with this and can help! Thanks in advance, Greg

I created a custom Import Scenario that uses the Employee screen. It essentially calls a custom Action I created. The action performs no redirection; it merely creates a new PREmployee record.The configuration is below: When I try to run this in an “Import by Scenario”, I receive an error: Error: x items have not been processed successfully. View name: Employee. No errors appear next to the individual items. Furthermore, the action performs as expected; the PREmployee record is created.Why might this error be appearing and how might I troubleshoot?

We have encountered an issue with the Project API in 2021R1.The validation is on the size of the "Account Email" field in the Project API Model (presumably the email address of the Customer related to the Project). There seems to be some new validation on the length of the field.Does anyone know the size limit for the field?

We are carrying out an integration to export sales records from Acumatica Sales Order Screen into external system via third-party API, what is the best way to carry out this integration?What is the best way to send Acumatica sales data to this external API and also sales data must be sent hourly. Currently thinking of using Contract-based REST API method in Acumatica. Please let me know the right solution to go ahead with this requirement or any documents present. 

Is there any documentation on how to connect these endpoints in API push?

Wondering if anyone has tried the following before:Step 1) Web service call (REST) to create a Drop Ship Purchase OrderStep. 2) Web service call (REST) to create Sales Order, including Drop Ship PO information at the SO Line level in the PUT request. Has anyone tried to update the PO information on the SO Line via REST API call? Below are my two API calls – first for creating the PO, second for creating the SO.  I am trying to populate the “POOrderNbr” on the Detail record directly (which is essentially what it looks like the PO Link functionality does).  Assuming that the PO Link has some extra logic baked in that allows this field to be written to as needed. Purchase Order API call: {   "Details":[      {         "InventoryId":{            "value":"ITS-002687"         },         "LineNbr":{            "value":1         },         "OrderNbr":{            "value":"400080001"         },         "OrderQty":{            "value":1.0         },         "UOM":{            "value":"EA"       

Hi i am looking for help with creating a receipt for a transfer order via API.I created a 2 step transfer as seen in the image. Now i need to create a Receipt for this order using the API. I have tried to follow this post without any success. https://help-2021r1.acumatica.com/(W(10))/Help?ScreenId=ShowWiki&pageid=24c68cc6-6985-4421-86c9-e29156f3c150This is a sample of what i have tried.Endpoint : https://<baseurl>/entity/Default/18.200.001/PurchaseReceipt{    "Type": {        "value": "Transfer Receipt"    },    "Warehouse": {        "value": "DP@RAM"    },    "Details": [        {            "TransferOrderType": {                "value": "TR"            },            "TransferOrderNbr": {                "value": "INRDP000002"            },            "TransferOrderLineNbr": {                "value": "1"            },            "TransferShipmentNbr": {                "value": "INRDP000002"            },            "ReceiptQty": {                "value": "1"            },    

Hi Experts,II’m trying to test Acumatica’s OAuth Authorization flow using Postman. I already created a Client in the Connected Applications screen, and set the flow to Authorization Code. Also I got the access token after I called the authorize api.I can call the OData service successfully as below.But when I call the web service to get sales orders with the access token, I always get a message “You are not logged in.” Here is the screenshot.Do we still need to call LogIn api again when we call the web service with access token?Thanks in advance!

I’m looking for some general direction.  I need to create 3 or 4 forms to be embedded on our public website where users can submit and it goes directly into Acumatica (possibly kicking off a workflow).  The form might also contain the fields to upload specific documents.  Any suggestions?

Good day.I am trying to create new leads via an API call.I have the following settings configured inside postman:URL: https://localhost/MyStoreInstance/entity/Default/20.200.001/LeadHTTP method: PUTParameters:$expand: Contact,Address$select: Contact/FirstName,Contact/LastName,Address/CountryHeaders:Accept: application/jsonContent-Type: application/jsonBody:{"Contact":[{"FirstName":{"value":"NewTest"},"LastName":{"value":"NewTest"}}],"Address":{"CountryID":{"value":"ZA"}}}This is just a basic PUT method to make sure that it is working. I will later add it with correct and more values.Any help would be greatly appreciatedI am receiving the following internal server error:{"message": "An error has occurred.","exceptionMessage": "The given key was not present in the dictionary.","exceptionType": "System.Collections.Generic.KeyNotFoundException","stackTrace": " at System.ThrowHelper.ThrowKeyNotFoundException()\r\n at System.Collections.Generic.Dictionary`2.get_Item(TKey key)\r\n at Microsof

Hello,I created a bill in Acumatica 2020/R1 and am trying to retrieve it via the Contract-Based REST API. I’ve tried with and without parameters like this:GET https://acumatica-dev.psfc.coop/entity/Default/18.200.001//Bill?$select=Date,Amount,ReferenceNbr,Vendor,VendorRef,Details/Description,Details/UnitCost,Details/Qty,Details/Amount,Details/Account&$expand=Detailsand this:GET https://acumatica-dev.psfc.coop/entity/Default/18.200.001//BillI get back a 200 response and empty array [] in the body.Can anyone please help me with this?

Hello,Maybe related to a problem I posted earlier about not being able retrieve a bill created in the Acumatica 2020/R1 gui:I tried to create a bill with the Contract-Based REST API, based on an http request in the integration guide:PUT https://acumatica-dev.psfc.coop/entity/Default/18.200.001/Bill?$select=ReferenceNbr,Details/POOrderNbr,Details/POOrderNbr,Details/InventoryID,Details/Qty&$expand=Detailsbody:{    "Vendor": {        "value": "V100958"    },    "VendorRef": {        "value": "123"    },    "Description": {        "value": "Bill for particular lines of a purchase order"    },    "Details": [        {            "POOrderType":            {                "value": "Normal"            },            "POOrderNbr":            {                "value": "000001"            },            "POLine":            {                "value": 1            },            "Qty":            {                "value": 5            }        }    ]}I get a 500 response and this body (edited):{ 

Hello, We’re publishing Acumatica push notifications to a Kafka topic as part of our system integration. It would help us greatly to identify push notifications that result from user actions in the Acumatica UI as opposed to actions that are performed via the API. One way to do this, I thought, would be to identify the user performing the actions, since actions performed via the API are always carried out under the same user account. Is it possible to include the name or ID of the user associated with an action in our push notifications?Thank you, Dave

Good morning, We are integrating with Acumatica via its API, and have run into a situation w/regard to postal code. In the Acumatica UI, I can create a business account without entering a postal code. It doesn’t matter which country I specify in the address fields. Via the Acumatica API, I can create a business account without entering a postal code if I specify the country as France. But if I set the country to US and don’t enter a postal code, the response is a 422 error code specifying a problem with postal code. So it seems the postal code is required by Acumatica API if country = US, but there’s no similar requirement in Acumatica UI. Can any one please shed some light on this? I don’t know where requirements like this might be configured or if there’s a way we can work around this. Thank you, Dave

Hi,Interested in knowing how I can use Acumatica API to upload data from C#. I’m looking for any step-by-step document which can explain me from the scratch like how to configure API, how to check it is ready to use or not and then how to use it. I tried to add API’s wsdl in VS project as a service reference but it gave me an error: There was an error downloading 'https://mycompany.acumatica.com/entity/Default/18.200.001/_vti_bin/ListData.svc/$metadata'.The underlying connection was closed: An unexpected error occurred on a send.Unable to read data from the transport connection: An existing connection was forcibly closed by the remote host.An existing connection was forcibly closed by the remote hostMetadata contains a reference that cannot be resolved: 'https://mycompanyt.acumatica.com/entity/Default/18.200.001'.An error occurred while making the HTTP request to https://mycompany.acumatica.com/entity/Default/18.200.001. This could be due to the fact that the server certificate is not

I have a DAC MySOInfo defined as Child of SOOrder and another DAC MySODetail as Child of MySOInfo.If a SOOrder is deleted in Screen SO301000, I would expect that the linked MySOInfo entries are deleted and MySODetail entries, too. In fact the first Children MySOInfo are deleted but the Children’s Children MySODetail are not deleted.The DAC’s are defined like this: [Serializable] [PXCacheName("MySOInfo")] public class MySOInfo : IBqlTable { #region RecordID [PXDBIdentity(IsKey = true)] public virtual int? RecordId { get; set; } public abstract class recordId : PX.Data.BQL.BqlInt.Field<recordId> { } #endregion #region OrderNbr [PXParent(typeof(SelectFrom<SOOrder>.Where<SOOrder.orderNbr.IsEqual<orderNbr> .And<SOOrder.orderType.IsEqual<orderType>>>))] [PXDBString(15, IsUnicode = true, InputMask = "")] [PXUIField(DisplayName = "Order Nbr")

For a newly created Sales Order I want to add positiv or negativ discounds, on document and line level.Discounts by percentage work find. On document level I create a new SOOrderDiscountDetail, set Type = ‘B’, IsManual = true and DiscountPct. On line level I just set SOLine.DiscPct.But I have problems to set discounts by amount. If I set SOOrderDiscountDetail.DiscountAmt or SOLine.DiscAmt, it is set back to 0,0.The lines and discount details are created any persisted like this.SOOrderEntry.Transactions.Insert(new SOLine{...});SOOrderEntry.DiscountDetails.Insert(new SOOrderDiscountDetail{...});SOOrdeEntry.Actions.PressSave(); What is the correct way to set a discount amount on document and line level code?