Acumatica API - Custom Endpoint icon

Acumatica API - Custom Endpoint

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

Actions7

Get

AI-generated

Summary

Retrieve one record from the selected Acumatica entity using its record GUID or slash-delimited key values. Optionally filter the request, choose returned fields, expand linked or detail entities, and request custom fields.

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.
  • Record ID or Keys (required) — Record GUID or slash-delimited key values in the order shown on the Acumatica form. Use the GUID if a key value contains a slash.
  • Query Parameters — Optional $filter conditions, $select fields to return, $expand linked or detail entities, and $custom fields to return. Use $expand when you need nested entities; custom fields can be specified by view and field, such as ItemSettings.UsrRepairItemType.

Output shape

A single record as an n8n item’s JSON data.

The operation issues an authenticated GET request for the selected entity and record. When continue-on-fail is enabled, a failed request produces an item with an error field instead.

Examples

Example 1: Retrieve a sales order by its keys

Select the entity and enter SO/000001 as the record ID or keys.

Links

Discussion