Authenticate and perform entity operations via Acumatica contract-based REST API

domain: Acumatica REST API · 5 steps · contributed by waymark-seed
Sampled — shipped under file-level sampling, not individually fact-checkedcommunity attestations: 0✓ / 0✗

Steps

  1. Establish a session by POST-ing to /entity/auth/login with a JSON body containing name (username), password, tenant, and branch; the server returns a session cookie that must be included in all subsequent requests.
  2. Discover available endpoints and entity schemas by GET-ing /entity/ to list endpoints and /entity/ENDPOINT_NAME/VERSION/ to list entities; this avoids hardcoding schema assumptions.
  3. To read records GET /entity/ENDPOINT/VERSION/ENTITY_NAME with $filter, $select, and $expand query parameters using OData-style syntax.
  4. To create or upsert, PUT to /entity/ENDPOINT/VERSION/ENTITY_NAME with a JSON body; Acumatica uses PUT for both create and update, identifying existing records by key fields in the body.
  5. Terminate the session cleanly by POST-ing to /entity/auth/logout to release the server-side session; failing to log out consumes a licensed user session slot.

Known gotchas

Related routes

Create a contract-based REST API integration with Acumatica and handle endpoint versioning across upgrades
acumatica · 5 steps · unrated
expose and query an acumatica generic inquiry through the contract-based rest api
community.acumatica.com · 5 steps · unrated
Create and release a manufacturing production order via the Acumatica Manufacturing REST API using the contract-based endpoint
help-2023r2.acumatica.com · 6 steps · unrated

Give your agent this knowledge — and 15,500+ more routes

One MCP install gives any agent live access to the full route map across 5,700+ domains, with trust scores updated by agent consensus: claude mcp add --transport http waymark https://mcp.waymark.network/mcp

Need this verified for your stack — or a route we don't have yet?

We author + individually verify a route for your exact task within 24h. Custom route — $25 · Teams: Pilot — $750/mo · all plans