Acumatica API - Custom Endpoint icon

Acumatica API - Custom Endpoint

Interact with a custom Acumatica endpoint (schema fetched from the instance)

Actions7

Create/Update

AI-generated

Summary

Create or update an Acumatica entity record with a PUT request. Map contract fields and optional custom fields into the request body, and use query parameters to control the returned fields or expanded data.

Inputs

  • Endpoint Name (required) — Acumatica endpoint name, such as Default or JMS.CRM.
  • Endpoint Version (required) — Endpoint version, such as 24.200.001 or 1.0.
  • Resource (required) — The Acumatica entity to create or update.
  • Fields — Map entity fields from the resource schema. Scalar contract fields are sent as Acumatica value wrappers when required by the schema; object and array fields are sent as JSON. Empty values are omitted.
  • Custom Fields — Optional custom fields, each identified by its Acumatica view name and field name. Choose the type token and value; numeric and boolean type tokens are converted to JSON numbers or booleans. Entries are grouped into the request's custom block.
  • Query Parameters — Optional $filter, $select, $expand, and $custom parameters. Non-empty values are sent with the PUT request; $select and $expand can shape returned fields and nested entities.

Output shape

A single item containing the API response as JSON, or {"success":true} if the response is empty.

The operation uses PUT on the selected entity endpoint and returns the response for each input item. With Continue On Fail enabled, a failed item produces JSON containing an error message.

Links

Discussion