Portal/Instance Identifier: acumatica.ipaas.com or AcumaticaERP
Version: 22.200.001
BaseURL
Staging/Production:
https://{Instance Identifier}/entity/Default/{Version}
NOTES: The {Instance Identifier} shown above is just a placeholder - replace it with your actual Acumatica API URL. Since you might have multiple test environments, this identifier will be different for each one.
The {Version} shown above is also a placeholder for your actual Acumatica API version in the URL. Depending on your test environment setup, this version number might be different.
Table of Contents
Customer Endpoints
Get a Customer with Addresses by CustomerID: (GET)
[BaseURL]/Customer/{CustomerID}?$expand=ShippingContact/Address,BillingContact/Address,PrimaryContact/Address,MainContact,MainContact/AddressGet all Customers for Polling: (GET)
[BaseURL]/Customer?$filter=LastModifiedDateTime gt datetimeoffset'{lastModifiedDT}'Create a Customer with Addresses: (PUT)
[BaseURL]/Customer?$expand=ShippingContact,BillingContact,PrimaryContact,MainContact,MainContact/Address
Update a Customer with Addresses: (PUT)
[BaseURL]/Customer?$expand=ShippingContact,BillingContact,PrimaryContact,MainContact,MainContact/Address&filter=CustomerID eq '{CustomerID}'Warehouse Endpoints
Get a Warehouse by WarehouseID: (GET)
[BaseURL]/Warehouse/{WarehouseID}StockItem Endpoints
Get a StockItem with Warehouse Details by StockItemID: (GET)
[BaseURL]/Customer/StockItem/{StockItemID}?$expand=WarehouseDetailsGet all StockItems for Polling: (GET)
[BaseURL]/StockItem?$filter=LastModifiedDateTime gt datetimeoffset'{lastModifiedDT}'Sales Order Endpoints
Get a Sales Order with Addresses, Tax Details & Payments by SalesOrderID: (GET)
[BaseURL]/SalesOrder/{SalesOrderID}?$expand=Details,TaxDetails,BillToAddress,ShipToAddress,BillToContact,ShipToContact,PaymentsCreate/Update Sales Order with Addresses, Line Item, Tax Details & Payments: (PUT)
[BaseURL]/SalesOrder?$expand=Details,TaxDetails,BillToAddress,ShipToAddress,BillToContact,ShipToContact
Invoice Endpoints
Get an Invoice by InvoiceID: (GET)
[BaseURL]/Invoice/{InvoiceID}Create/Update an Invoice: (PUT)
[BaseURL]/Invoice
Shipment Endpoints
Get Shipment with Packages by ShipmentNo: (GET)
[BaseURL]/Shipment?$filter=ShipmentNbr eq '{shipmentNo_}'&$expand=Orders,PackagesGet all Shipments for Polling: (GET)
[BaseURL]/Shipment?$expand=Orders,Packages&$top={limit}&$skip={page * limit}&$filter=LastModifiedDateTime ge datetimeoffset'{utcMinus4TimeString}'Create/Update Shipment with Packages: (PUT)
[BaseURL]/Shipment?$expand=Packages
OAuth Endpoints
To Get Access Token & Refresh Token with Cookies: (POST)
https://{Instance Identifier}/identity/connect/tokenTo Get New Access Token with Cookies using Refresh Token: (POST)
https://{Instance Identifier}/identity/connect/tokenUtility/Generic Endpoints
Get Sales Order with Shipments by OrderNO: (GET)
[BaseURL]/SalesOrder?$filter=OrderNbr eq '{OrderNO}'&$expand=shipmentsGet Customer by matching Email in Billing Contact of Customer: (GET)
[BaseURL]/Customer?$expand=BillingContact&$filter=BillingContact/Email eq '{emailAddress}'Get Customer by matching Email in Shipping Contact of Customer: (GET)
[BaseURL]/Customer?$expand=ShippingContact&$filter=ShippingContact/Email eq '{emailAddress}'Get Customer by matching Email in Primary Contact of Customer: (GET)
[BaseURL]/Customer?$expand=PrimaryContact&$filter=PrimaryContact/Email eq '{emailAddress}'Get Customer by matching Email in Main Contact of Customer: (GET)
[BaseURL]/Customer?$expand=MainContact&$filter=MainContact/Email eq '{emailAddress}'Get StockItem by matching SKU: (GET)
[BaseURL]/StockItem/{SKU}?$expand=WarehouseDetailsGet all Taxes: (GET)
[BaseURL]/Tax
Get all TaxZones: (GET)
[BaseURL]/TaxZone