> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/acumatica.md).

# Acumatica

Read and write any entity published by an Acumatica ERP instance: customers, sales orders, invoices, inventory, vendors and more, plus the screen actions that release and post them.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector               | Authentication |
| ----------------------- | -------------- |
| Acumatica               | OAuth sign-in  |
| Acumatica (Credentials) | Credentials    |

#### Acumatica

Connect to Acumatica ERP to read and write any published entity: customers, sales orders, invoices, inventory, vendors and more.

**Set up in Acumatica**

1. In Acumatica, open Connected Applications (SM303010) and register an application with the Authorization Code flow.
2. Add the callback URI shown in StackAI. Record the client ID and secret.
3. Confirm the published web-service endpoint name and contract version. Use Web Service Endpoints (SM207060) for a custom endpoint.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Acumatica**.
2. Complete the connector configuration below. If you do not have access to these settings, ask your StackAI administrator to configure the connector.
3. Select **Connect**, sign in to the provider account, and review the requested access. Complete authorization to return to StackAI.
4. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connector configuration**

| StackAI field    | Required                 | What to enter                                                                                                                                                               |
| ---------------- | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| OAuth Scopes     | Read-only                | api grants contract-based REST access; offline\_access is what makes Acumatica return a refresh token. This value is shown for reference; it is not an editable credential. |
| Client ID        | Yes                      | Client ID of a Connected Application registered on the Connected Applications screen (SM303010), with the Authorization Code flow enabled.                                  |
| Client Secret    | Yes                      | The OAuth Client Secret you received when registering your app with the provider.                                                                                           |
| Redirect URI     | Read-only                | Use this redirect URI when configuring your OAuth application. This value is shown for reference; it is not an editable credential.                                         |
| Instance URL     | Yes                      | Root URL of your Acumatica instance, with no trailing path. The OAuth endpoints live under it at /identity.                                                                 |
| Endpoint Name    | Optional / as applicable | Published web service endpoint to call. Leave as Default unless you publish your own endpoint with extra entities or custom fields (SM207060).                              |
| Endpoint Version | Optional / as applicable | Contract version to pin. GET {instance}/entity lists the versions your instance publishes. An older contract keeps working against a newer instance.                        |

#### Acumatica (Credentials)

Connect to Acumatica ERP with a Connected Application and an ERP user to read and write any published entity: customers, sales orders, invoices, inventory, vendors and more.

**Set up in Acumatica**

1. Prepare the Acumatica account or service that the workflow will access. Grant access to the required resources and operations.
2. **Client ID:** Client ID of a Connected Application registered on the Connected Applications screen (SM303010). Acumatica appends the tenant to the ID, which is what scopes the connection to a single company.
3. **Client Secret:** Shared secret generated for that Connected Application.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Acumatica (Credentials)**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field    | Required                 | What to enter                                                                                                                                                                                     |
| ---------------- | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Instance URL     | Yes                      | Root URL of your Acumatica instance, with no trailing path. A self-hosted instance may sit on any domain.                                                                                         |
| Client ID        | Yes                      | Client ID of a Connected Application registered on the Connected Applications screen (SM303010). Acumatica appends the tenant to the ID, which is what scopes the connection to a single company. |
| Client Secret    | Yes                      | Shared secret generated for that Connected Application.                                                                                                                                           |
| Username         | Yes                      | An Acumatica user with API access and rights to the screens you will call.                                                                                                                        |
| Password         | Yes                      | Password for that Acumatica user.                                                                                                                                                                 |
| Endpoint Name    | Optional / as applicable | Published web service endpoint to call. Leave as Default unless you publish your own endpoint with extra entities or custom fields (SM207060).                                                    |
| Endpoint Version | Optional / as applicable | Contract version to pin. GET {instance}/entity lists the versions your instance publishes. An older contract keeps working against a newer instance.                                              |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **Acumatica** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### List Records

List records of an Acumatica entity.

**Required permissions:** `api`.

**Inputs**

| Field          | Type            | Required | Description                                                                                                                                                                                                                                                                                                                                                             |
| -------------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Entity         | select (string) | Yes      | The Acumatica entity to work with. Available values: Account, Bill, BusinessAccount, Case, Contact, Customer, CustomerPayment, Employee, InventoryIssue, InventoryReceipt, Invoice, JournalTransaction, Lead, Opportunity, Payment, Project, PurchaseOrder, PurchaseReceipt, SalesInvoice, SalesOrder, Shipment, StockItem, NonStockItem, TimeEntry, Vendor, Warehouse. |
| Filter         | string          | No       | An OData filter expression narrowing which records come back.                                                                                                                                                                                                                                                                                                           |
| Fields         | string          | No       | Comma-separated fields to return. Empty returns all of them.                                                                                                                                                                                                                                                                                                            |
| Expand         | string          | No       | Comma-separated detail collections or linked entities to include.                                                                                                                                                                                                                                                                                                       |
| Custom Fields  | string          | No       | User-defined or unbound fields to include.                                                                                                                                                                                                                                                                                                                              |
| Limit          | integer         | No       | How many records to return, up to 500. Default: 20.                                                                                                                                                                                                                                                                                                                     |
| Offset         | integer         | No       | How many records to skip before collecting results. Default: 0.                                                                                                                                                                                                                                                                                                         |
| Flatten values | boolean         | No       | Return plain JSON instead of Acumatica's nested value wrappers. Default: true.                                                                                                                                                                                                                                                                                          |

**Outputs**

| Field        | Type    | Description                     |
| ------------ | ------- | ------------------------------- |
| Records      | array   | The matching records.           |
| Record Count | integer | How many records were returned. |

#### Get Record

Get one Acumatica record by ID or key.

**Required permissions:** `api`.

**Inputs**

| Field          | Type            | Required | Description                                                                                                                                                                                                                                                                                                                                                             |
| -------------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Entity         | select (string) | Yes      | The Acumatica entity to work with. Available values: Account, Bill, BusinessAccount, Case, Contact, Customer, CustomerPayment, Employee, InventoryIssue, InventoryReceipt, Invoice, JournalTransaction, Lead, Opportunity, Payment, Project, PurchaseOrder, PurchaseReceipt, SalesInvoice, SalesOrder, Shipment, StockItem, NonStockItem, TimeEntry, Vendor, Warehouse. |
| Record ID      | string          | No       | The record's internal GUID. Use this or the key values, not both.                                                                                                                                                                                                                                                                                                       |
| Key Values     | array           | No       | The record's natural key values, in order. Use this or the ID.                                                                                                                                                                                                                                                                                                          |
| Fields         | string          | No       | Comma-separated fields to return. Empty returns all of them.                                                                                                                                                                                                                                                                                                            |
| Expand         | string          | No       | Comma-separated detail collections or linked entities to include.                                                                                                                                                                                                                                                                                                       |
| Custom Fields  | string          | No       | User-defined or unbound fields to include.                                                                                                                                                                                                                                                                                                                              |
| Flatten values | boolean         | No       | Return plain JSON instead of Acumatica's nested value wrappers. Default: true.                                                                                                                                                                                                                                                                                          |

**Outputs**

| Field     | Type   | Description                 |
| --------- | ------ | --------------------------- |
| Record    | object | The requested record.       |
| Record ID | string | The record's internal GUID. |

#### Create or Update Record

Create or update an Acumatica record.

**Required permissions:** `api`.

**Inputs**

| Field              | Type            | Required | Description                                                                                                                                                                                                                                                                                                                                                             |
| ------------------ | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Entity             | select (string) | Yes      | The Acumatica entity to work with. Available values: Account, Bill, BusinessAccount, Case, Contact, Customer, CustomerPayment, Employee, InventoryIssue, InventoryReceipt, Invoice, JournalTransaction, Lead, Opportunity, Payment, Project, PurchaseOrder, PurchaseReceipt, SalesInvoice, SalesOrder, Shipment, StockItem, NonStockItem, TimeEntry, Vendor, Warehouse. |
| Fields             | object          | Yes      | The field values to write, as plain JSON.                                                                                                                                                                                                                                                                                                                               |
| Filter             | string          | No       | An OData filter selecting which existing record to update.                                                                                                                                                                                                                                                                                                              |
| Pre-wrapped fields | boolean         | No       | Send Fields exactly as given, without wrapping the values. Default: false.                                                                                                                                                                                                                                                                                              |
| Fields             | string          | No       | Comma-separated fields to return. Empty returns all of them.                                                                                                                                                                                                                                                                                                            |
| Expand             | string          | No       | Comma-separated detail collections or linked entities to include.                                                                                                                                                                                                                                                                                                       |
| Custom Fields      | string          | No       | User-defined or unbound fields to include.                                                                                                                                                                                                                                                                                                                              |
| Flatten values     | boolean         | No       | Return plain JSON instead of Acumatica's nested value wrappers. Default: true.                                                                                                                                                                                                                                                                                          |

**Outputs**

| Field     | Type   | Description                       |
| --------- | ------ | --------------------------------- |
| Record    | object | The record as saved by Acumatica. |
| Record ID | string | The saved record's internal GUID. |

#### Delete Record

Delete an Acumatica record.

**Required permissions:** `api`.

**Inputs**

| Field      | Type            | Required | Description                                                                                                                                                                                                                                                                                                                                                             |
| ---------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Entity     | select (string) | Yes      | The Acumatica entity to work with. Available values: Account, Bill, BusinessAccount, Case, Contact, Customer, CustomerPayment, Employee, InventoryIssue, InventoryReceipt, Invoice, JournalTransaction, Lead, Opportunity, Payment, Project, PurchaseOrder, PurchaseReceipt, SalesInvoice, SalesOrder, Shipment, StockItem, NonStockItem, TimeEntry, Vendor, Warehouse. |
| Record ID  | string          | No       | The record's internal GUID. Use this or the key values, not both.                                                                                                                                                                                                                                                                                                       |
| Key Values | array           | No       | The record's natural key values, in order. Use this or the ID.                                                                                                                                                                                                                                                                                                          |

**Outputs**

| Field   | Type    | Description                                 |
| ------- | ------- | ------------------------------------------- |
| Deleted | boolean | True once Acumatica has deleted the record. |

#### Invoke Action

Run an Acumatica action on a record.

**Required permissions:** `api`.

**Inputs**

| Field             | Type            | Required | Description                                                                                                                                                                                                                                                                                                                                                             |
| ----------------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Entity            | select (string) | Yes      | The Acumatica entity to work with. Available values: Account, Bill, BusinessAccount, Case, Contact, Customer, CustomerPayment, Employee, InventoryIssue, InventoryReceipt, Invoice, JournalTransaction, Lead, Opportunity, Payment, Project, PurchaseOrder, PurchaseReceipt, SalesInvoice, SalesOrder, Shipment, StockItem, NonStockItem, TimeEntry, Vendor, Warehouse. |
| Action Name       | string          | Yes      | The Acumatica action to run on the record.                                                                                                                                                                                                                                                                                                                              |
| Target Record     | object          | Yes      | Which record to run the action on, as plain JSON.                                                                                                                                                                                                                                                                                                                       |
| Action Parameters | object          | No       | Extra values the action needs, as plain JSON.                                                                                                                                                                                                                                                                                                                           |

**Outputs**

| Field       | Type    | Description                                                 |
| ----------- | ------- | ----------------------------------------------------------- |
| Accepted    | boolean | True once Acumatica has accepted the action for processing. |
| Status Code | integer | The HTTP status Acumatica replied with.                     |
| Status URL  | string  | The URL Acumatica exposes for tracking a queued action.     |

### Important behavior

If an operation is denied, check the connection’s granted permissions and the account’s access in the provider. Reauthorize the connection when it needs additional permissions.

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/acumatica.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
