Skip to main content

Develop Integrations with Web Services | APIs

Technical discussions focused on Web Services and APIs for developers

  • 808 Topics
  • 3,208 Replies
808 Topics
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

644
R
Freshman I
N
Jr Varsity III
nsmith51Jr Varsity III
asked in Develop Integrations with Web Services | APIs
Vendor Rest API - Insert/Update Payment Instructions

Hi Everyone, Can anyone help me provide the Json request to insert the Payment Instructions details in the Vendors → Default Payment Settings → Payment Instruction details?

498
N
Jr Varsity III
N
Freshman I
Namrata13Freshman I
asked in Develop Integrations with Web Services | APIs
How to fetch updated inventory from contract based rest api?

Hello, I am using contract based rest api. I was looking for the endpoint which can help me to fetch updated inventory changes nearly on real time based scenario, where I can pass updated date filter. So, can you please suggest which entity or endpoint would work better for this? And also looking for the endpoint where I can update stock quantity. Please look into the issue. Thank you

173
jinin
Pro I
S
Varsity I
stephenward03Varsity I
asked in Develop Integrations with Web Services | APIs
Importing parent/child/grandchild data via the API

Hello - I would like to import some forecasting data into custom DAC’s using the API. I’ve worked with parent/child data before and imported via the API but I’m finding this situation difficult because the forecasting data consists of 3 levels of data. I’m not sure how to configure the graph or the API to get this working. Here is a cut down version of the DAC’s, in the code I’ve included PXParent and PXDBDefault to link the DACs. DAC 1 - ForecastHeaderForecastNbr (key)Customer DAC 2 - ForecastLineForecastNbr (key)LineNbr (key)ProductCode DAC 3 - ForecastScheduleForecastNbr (key)LineNbr (key)ScheduleNbr (key)ForecastDateForecastQty With this type of DAC structure I would like to submit json in the following structure. { "ForecastNbr": {"value": 1}, "Customer": {"value": "Customer001"}, "ForecastLine": [ { "LineNbr": {"value": "1"}, "ProductCode": {"value": "Prod001"}, "ForecastSchedule": [ { "ScheduleNbr": {"value": "1"}, "ForecastDate": {"value": "20250501"}, "ForecastQty": {"value":

101
harutyungevorgyan
Jr Varsity I
D
Freshman I
DharmandarKumarFreshman I
asked in Develop Integrations with Web Services | APIs
How to get check and payment in doctype rest api endpoint

How to get Check and payment screen in Type dropdown value rest api endpoint .i want to get all doctype in check and payment which return doctype array.

434
R
Freshman I
K
Freshman I
kkrausFreshman I
asked in Develop Integrations with Web Services | APIs
Is it possible to have UPS Integrated Shipping give return labels for Ground regardless of the original orders ship via code?

For example if I were to create a shipment for UPS Express or Two Day Air, the return label would be UPS ground regardless? Is this something that is possible to do?

20
K
Freshman I
N
Freshman II
nickacfieldFreshman II
asked in Develop Integrations with Web Services | APIs
TaxCatagory specify for Overheads on Put Bill

Hi Team, When putting a bill/adjustment i am specifying my tax catagory, but its just defaulting to the default tax cat set on the tax zone id on the vendor. No matter what i do. if i set the vendor tax zone id’s default taxcat to nothing, i get no taxcat on the bill lines. Working with overheads for now, with no inv code on lines! (PO is fine because you select tax cat on the line items in the PO.) ive tried adding these to the header also; "IsTaxValid" => [ "value" => false], "TaxZoneID" => [ "value" => "MYWANTED ZONE ID"], confirmed my tax catagories exist in the tax zone used... and my detail lines as follows; "InventoryID" => ["value" => null] "LineType" => ["value" => "MiscCharge"] - was told to add this by GPT, no effect "UOM" => ["value" => "EA"], - UOM mandatory for tax apparently "TaxAmount" => ["value" => number_format((float) $InvoiceLine['TaxItemAmount'],5,".","")] - tried with or without this "TaxCatagory" => ["value" => “my Tax Cat”] ive also tried with or without TaxAmo

131
N
Freshman II
angelesosorno86
Freshman II
angelesosorno86Freshman II
asked in Develop Integrations with Web Services | APIs
Implementing webhook in 24R2

Hi everyone. I need to create a webhook, but I'm having trouble accessing AccesInfo.BranchID. I tried using PXContext.GetBranchID(), but it doesn't work. Does anyone know the best way to implement this?

1486
angelesosorno86
Freshman II
J
Freshman II
jessieparasFreshman II
asked in Develop Integrations with Web Services | APIs
Extend web service endpoint - Process Bank Transactions (CA306000)

Hi, I been trying to use the Process Bank Transactions (CA306000) screen via API to be used by 3rd party app, how can I make a correct call on the extended API endpoint for Process Bank Transactions? as I have tried, I cannot find any solution on how I can make it work. Web Service Endpoint Method: POST JSON body: { "CashAccount": { "value": "CA2000" } } Error: "The record was not processed because of an error during processing of the previous record" METHOD: GET Param: $filter=CashAccount eq 'CA2000' Error: "Optimization cannot be performed.The following fields cause the error:\r\nCashAccount: View TranFilter has BQL delegate\r\n"

494
J
Freshman II
C
Jr Varsity III
ckwiat46Jr Varsity III
asked in Develop Integrations with Web Services | APIs
http rest api and total count inclusion in response

I’m currently working with the Acumatica API and noticed that some REST services typically return a totalCount field or include the total count of records as part of the metadata in their responses. However, I couldn’t find any documentation or examples indicating that Acumatica supports this feature, in fact the opposite from the links i pasted below. Specifically, I’m looking for a way to retrieve the total number of records in a dataset (e.g., total orders or customers) alongside a paginated response. I don’t see a totalCount in the response body, nor have I found any mention of it in headers like X-Total-Count. My questions are: Does Acumatica support returning the total count of records in the API response? If not, is there a recommended approach or workaround to efficiently retrieve the total count of records? Should I rely on a separate API call to count the records? Are there any best practices for handling this in Acumatica? Any insights or suggestions would be greatly appreci

603
Dmitrii Naumov
Acumatica Moderator
jessicapruitt
Freshman II
jessicapruittFreshman II
asked in Develop Integrations with Web Services | APIs
How do we resolve Price List sync error?

Last Read Message: The NONMEMBER price list could not be exported because at least one item in it does not exist in the BigCommerce store. Synchronize all the items in the price list, and then process the price list again. We have 4 Price Lists, and all are reading the same error. Price Lists: PREMIER, NONMEMBER, PRACTICON, WHOLESALE We have no sync errors on the finished products. The only thing I can think of, is new products not yet ready to be installed in BigCommerce are on the Price Lists, so that may be stopping it. Is anyone familiar with this?

346
Chris Hackett
Community Manager
B
Jr Varsity II
bvoelschJr Varsity II
asked in Develop Integrations with Web Services | APIs
Voiding Prepayment via API returns 204 status code but does not void the prepayment

Making a POST request to the endpoint /entity/Default/22.200.001/Payment/VoidPayment with the body like "Entity": { "id": payment_id, "Hold": false, "Branch": “branch_name”, } returns a 204. We expect that this will actually void the prepayment, but the prepayment is still active. Is there any changes that should be made to this request to make it succeed or at least return an error

323
B
Jr Varsity II
M
Freshman I
Mikemedved21Freshman I
asked in Develop Integrations with Web Services | APIs
Customize Time Entry to Save Notes

Given the issue with the Time Entry Webservice and form, can a user implement in interim fix by customizing the form, or building a new web service endpoint. Our deployment won’t be able to upgrade to 2025R1 in the near future. Thank you Pushing Notes for time activities, and auto completing time activities when creating | Community

433
R
Acumatica Moderator
asommer
Jr Varsity III
asommerJr Varsity III
asked in Develop Integrations with Web Services | APIs
Create ARInvoice from Webhook

Good day, I’m working on a webhook for integration with a third party. The webhook runs find until I try to create an ARInvoice and add an ARTran to the InvoiceEntry. The error I’m getting is in the SM_ARInvoiceEntry.cs file IsLineCreatedFromAppSO method. The base.Base.Accessinfo.ScreenID is null. We have a separate integration using a custom screen with a custom Action, but using webhooks will be much better for our purposes. Is there a way I can set the ScreenID from a webhook in order to create the ARInvoice with ARTran items? Here is the webhook code: namespace EcrsWebhook{ public class EcrsWebhookHandler : PXGraph<ARInvoiceEntry>, IWebhookHandler { private static readonly Newtonsoft.Json.JsonSerializer Serializer = new JsonSerializer(); decimal INFRA_DISCOUNT = (decimal)0.15; public async Task HandleAsync(WebhookContext context, CancellationToken cancellation) { ECRSConfigs MAXIO_KEY; using (JsonTextReader reader = new JsonTextReader(context.Request.CreateTextReader())) { // Creat

11015
asommer
Jr Varsity III
F
Freshman I
FatgalahTimothyFreshman I
asked in Develop Integrations with Web Services | APIs
Upgrading SalesOrder API from 18.200.100 to 20.200.100

I have an api that pushes salesorders and it works if I set the version to 18.200.001. When I move it to 20.200.001 it fails with the error [message] => An error has occurred. [exceptionMessage] => Sequence contains no matching element [exceptionType] => System.InvalidOperationException [stackTrace] => at System.Linq.Enumerable.Single[TSource](IEnumerable`1 source, Func`2 predicate) at PX.Api.ContractBased.EntityExportContextBuilder.ExtractFieldMappingKeyForDetail(String mappingKey, EntityField field, EntityMappingProjection[] entityFields, IMetadataProvider metadataProvider, IEntityMappingKeyService entityMappingKeyService, String endpointName, String version) in C:\build\code_repo\NetTools\PX.Api.ContractBased\EntityExportContextBuilder.cs:line 1343 The only information I can find about changes is on page 55 of https://www.acumatica.com/media/2020/09/AcumaticaERP_IntegrationDevelopmentGuide.pd Where it says‘• The type of the Payments field is changed. • Mapping has changed‘ After I g

333
D
Captain II
N
Freshman I
nikhils20Freshman I
asked in Develop Integrations with Web Services | APIs
REST API for: To put instance in Maintenance Mode

I am trying to put my instance in Maintenance mode via REST API, as we are publishing Customization Projects VIA REST APIs, but cannot find anything on how to put instance in Lockout or Maintenance Mode ..

883
harutyungevorgyan
Jr Varsity I
I
Varsity I
IvanVarsity I
asked in Develop Integrations with Web Services | APIs
Last supported Acumatica version ?

Hi, What is last Acumatica supported version? Second moment, which I need to clarify, how to find out which endpoint version corresponds to Acumatica version ? Does any endpoint version can be imported for any Acumatica version or there are some rules and logic, which must be followed for correct work ?

9446
T
Freshman I
T
Freshman I
travisk91Freshman I
asked in Develop Integrations with Web Services | APIs
Acumatica Webhooks Fail to make AP or AR invoices

I've built out an Acumatica Webhooks project. I've successfully got it reading the incoming POST, and figuring out what to what to do. So far I can successfully insert Customers, Customer Locations and Projects without an issue. Honestly, from someone who does a fair amount of integration work, this is basically magic. These integrations are as close to real-time as is practical, so amazing work Acumatica. That said, using nearly the same code, I'm trying to insert AP or AR Invoices and I get bizarre or meaningless errors. I’ve stripped that code down to the most basic version, and when running the code that lives in the webhooks dll from a button on a graph it works exactly as expected. When it runs within the webhooks environment itself I get weird errors. For what it’s worth I’m running in 22R2, but I moved the code over to 23r1 and I get the same issues. My case in “in engineering review” so I thought I’d field it here to see if anyone has thoughts on what it is about the AR/AP gra

1113
rimamanaseryan16
Freshman I
jessicapruitt
Freshman II
jessicapruittFreshman II
asked in Develop Integrations with Web Services | APIs
How to write an expression for Export Mapping of Stock and Template products?

I need to write a custom expression to map Brand from ERP to BigCommerce BrandID. it is custom since BigCommerce’s interval is a number and the ERP is a text format. We have a Substitution List designed to map the BrandID to the Brand Name too. The brand is located in Attributes, but I think it may need to be changed to Advanced for a customized expression. For the Substitution Lists, BCBrands is the name of the list. If anyone can point me in the direction for learning how to write the expressions too that would be great. I work in web development, so the expressions look familiar to JavaScript variable syntax.

90
jessicapruitt
Freshman II
E
Jr Varsity II
eellistonJr Varsity II
asked in Develop Integrations with Web Services | APIs
Unable to set the PrimaryContact on the BusinessAccount entity via RestAPI

I am having issues setting the PrimaryContact on a BusinessAccount entity. We are building a customer application form where potentical customers can apply for an account. This data is going to flow into the Business Account entity as a “prospect. The application will contain their business information as well as a list of owners/authorized buyers. These owners will be added as associated contacts to the business account entity. I have all of that working via the RestAPI without much issue. The trouble I am having is setting the first owner (in the list of owners) as the PrimaryContact. I can’t get anything to work. Here are my order of operations: Create the BusinessAccount Iterate over the incoming contacts and create each new contact and associate them to the BusinessAccount ID Call and PUT against the newly created BusinessAccount and pass in the PrimaryContactID of the first Contact in the list from step 2. (this isn’t working) I am doing a PUT to {{MY-BASE-URL}}/entity/PHDCustome

100
E
Jr Varsity II
A
Freshman I
AxsysInvestFreshman I
asked in Develop Integrations with Web Services | APIs
Create PO linked to SO from PO505000 via API

Hi All, I’m trying to generate Demand PO’s linked to SO’s from the PO505000 screen but am finding it will only generate a PO for one line item at a time, rather than the multiple items available for Purchase from the one supplier or multiple suppliers. I’ve created a Custom Endpoint via Web Services linked to the screen, added the ProcessAll button as an Action with OrderNbr and OrderType as parameters: I call via HTTP using Postman and the below Body: I get a 202 back saying its successful. What seems straight forward and works in the GUI with the above filter options, will only ever generate one PO for the first line, no matter how many lines there may be meeting the criteria. Not sure what I’m missing and this seems like a process many people would want to use via API?? Is there something required in the Entity that I am missing?? Any help appreciated :-)

232
A
Freshman I
P
pemith30
asked in Develop Integrations with Web Services | APIs
SMS gateway integration with Acumatica

Has anyone done an SMS gateway integration with Acumatica ? Can you integrate any Bank’s SMS gateway as long as they have the right APIs ?

100
P
R
Freshman I
ryanmiterFreshman I
asked in Develop Integrations with Web Services | APIs
Pushing Notes for time activities, and auto completing time activities when creating

Hi everyone. I’m trying to pass a “notes” field in when creating or updating Employee Time Activities. Below is an example of my request: PUT "/entity/Default/22.200.001/TimeEntry" { "note": "Some notes", "BillableTime": { "value": "01:00" }, "Date": { "value": "2024-02-16T06:00:00-08:00" }, "Summary": { "value": "Hours from Timesheet" }, "EarningType": { "value": "RG" }, "Employee": { "value": "EP00000002" }, "LaborItem": { "value": "CONSULTSR" }, "ProjectID": { "value": "X" }, "TimeSpent": { "value": "01:30" } } The Time Activity gets created, but the notes do not get passed through. Also, I’m trying to run the CompleteTimeEntry action on the PUT "/entity/Default/22.200.001/TimeEntry", but I always get the “Invalid uri structure” error even though I have this as a mapped action: Any ideas what’s happening?

11610
M
Freshman I
G
Freshman I
geoffatsourceFreshman I
asked in Develop Integrations with Web Services | APIs
Purchase Order API: Bug when placing a PO on Hold

When I attempt to release a purchase order from hold via the API, sometimes I get the following error: Operation failed: At least one line is not present in the cost budget of the project. Either add the corresponding budget lines to the project or select the Allow Adding New Items on the Fly check box on the Summary tab of the Projects (PM301000) form I get the same error when try to do so from the user interface: Oddly, if I try a second time, either via a repeating the API request, or by pressing the button again, the error does not occur. What could be going on?

232
A
Jr Varsity I
M
Freshman II
mvinesFreshman II
asked in Develop Integrations with Web Services | APIs
Add Default Salesperson to Customer using API

I am adding customers with the ERP api. Part of this process is assigning the default salesperson to the customer. For things like the MainContact/Address, I can just $extend the customer entity being saved, but this does not seem to work for Salespersons, How do I attach a default salesperson to a customer with the api? PUT /20.200.001/Customer?$expand=Salespersons,MainContact/Address {..."Salespersons": [ { "SalespersonID": {"value": "SALEPERID"}, "Default": {"value": true} } ]...} This will result in 200 OK, but no Salespersons will be assigned to the customer. {..."Salespersons": []...} What do I need to do to get this salesperson assigned to the customer?

353
jinin
Pro 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