Connect Acumatica: pull orders and customers in, check inventory

Sign in to your Acumatica instance with a dedicated API user, fill in the instance URL, company, and endpoint version in Integration, test, map, and activate — sales orders and customers flow in and inventory can be checked.

The Acumatica connector connects your Acumatica cloud ERP instance to Integration: it pulls sales orders and customers into the system and lets you check inventory held in Acumatica. One connection serves one Acumatica company. Inventory can be read from Acumatica, but stock changes are not written back to Acumatica through this connection.

Prerequisites#

• An Acumatica instance you can sign in to, and the exact company (tenant) name used at sign-in.
• A login user for this connection — a dedicated API user is recommended — that can read sales orders, customers, and stock items in that company.
• A published endpoint in Acumatica → Web Service Endpoints. If your instance publishes the standard endpoint, its name is usually Default and its version matches your Acumatica release.
• If sign-in for your company requires a branch, know the branch name as well. If sign-in does not ask for a branch, you can leave that field empty later.

Get your credentials#

1. There is no separate key to create for this connector. The credentials are the Acumatica login user itself: prepare a dedicated API user in Acumatica, confirm you can sign in with it, and note its username and password.
2. Note the company (tenant) name exactly as it appears at sign-in, and the branch name if your sign-in requires a branch. These values must match the instance word for word.
3. Note your instance address — the root address of your Acumatica instance, for example https://mycompany.acumatica.com. Do not add /entity at the end.
4. In Acumatica, open Web Service Endpoints and check the published endpoint: note its endpoint name and endpoint version. You only need to fill these in later if they differ from Default and 24.200.001.

Fill it into Integration#

1. Open Integration → Connector Marketplace → Acumatica → New connection.
2. base_url — Instance URL, required: fill in the root address of your Acumatica instance, for example https://mycompany.acumatica.com. Do not add /entity at the end.
3. company — Company, required: fill in the company (tenant) name exactly as it appears when you sign in to Acumatica.
4. branch — Branch, optional: fill this in only if sign-in for your company requires a branch. If sign-in does not ask for a branch, leave it empty.
5. username — Username, required: fill in the login name of the dedicated API user you prepared in Acumatica.
6. password — Password, required: fill in the password of that same login user. It is stored encrypted and never shown back.
7. endpoint_name — Endpoint name, optional: leave it empty if your instance publishes the standard endpoint — the system then uses Default. Fill it in only when Web Service Endpoints shows a different name.
8. endpoint_version — Endpoint version, optional: leave it empty if your instance publishes version 24.200.001 — the system then uses 24.200.001. Fill it in with the exact version shown in Web Service Endpoints when yours differs; the version must match your Acumatica release.

Test the connection#

Click Test connection. The test does two things in order. First it signs in to your instance with the username, password, company, and branch you filled in — sign-in succeeds only when the instance answers and returns a session, which the test then uses right away and signs out again at the end. Then, with that session, it reads a single stock item through the endpoint name and version on the connection. A pass means the sign-in works, the endpoint answers, and the login user can read stock items. The test allows about 12 seconds; if it times out, check that the instance address is reachable and try again. If it fails, keep the exact error code shown — the FAQ below matches each code to its cause and fix.

Mapping / pick a template#

Pick the Acumatica standard template. It maps Acumatica sales orders to standard orders, and brings customers across with them, so order numbers, lines, quantities, and customer details land in the right fields. The fields the template can read come from the endpoint published on your instance, so if your instance publishes a different endpoint name or version than the standard one, set endpoint_name and endpoint_version on the connection first and check the mapping preview again. Before activating, open the preview and confirm that order lines and customer names look right on one real order; inventory lookup reads stock items directly and needs no order mapping.

Activate#

After activation, Integration signs in to your Acumatica instance on the schedule you set, pulls new sales orders and customers in, and answers inventory questions by reading stock items from Acumatica. Each sign-in session is used only for that run and is closed when the run ends. What this connection does not do: it does not write stock changes back to Acumatica, so adjust quantities in Acumatica itself when stock needs correcting there. Watch the first few orders in Runs / Logs before trusting it unattended.

FAQ#

Test fails with ENDPOINT_VERSION_MISMATCH — the stock item read returns 404

Sign-in worked, but the endpoint name or version on the connection does not match the endpoint published on your instance. The test looks for the stock item under the name and version it was given, and the instance has nothing published at that address, so the read comes back 404. This is the most common cause when the login itself is fine.

In Acumatica, open Web Service Endpoints and copy the published endpoint name and version exactly. Put them into endpoint_name and endpoint_version on the connection — or clear both fields if the published endpoint really is Default and 24.200.001. Save and test again.

Test fails with INVALID_CREDENTIALS — sign-in returns 401 or 400

The instance refused the sign-in: the username, the password, or the company name does not match what the instance expects. A company name typed slightly differently from the sign-in screen counts as a wrong credential, and so does a branch the sign-in requires but the connection leaves out.

Sign in to Acumatica in your browser with the same user and confirm the username, password, and company name all work there. Then re-enter username, password, and company on the connection exactly as used in the browser, add branch if that sign-in asks for one, and test again.

Test fails with MISSING_SCOPE — the stock item read returns 401 or 403

Sign-in worked and the endpoint exists, but the login user does not have permission to read stock items in that company. The instance therefore refuses the stock item read even though the user can sign in.

In Acumatica, give the dedicated API user read access to stock items — and to sales orders and customers, which the connection also reads — in that company, or switch the connection to a user that already has that access. Save and test again.

Test fails with MISSING_BASE_URL or MISSING_CREDENTIALS, or sign-in cannot reach the instance

A required field is empty, or the instance address itself is wrong. MISSING_BASE_URL means base_url was left empty; MISSING_CREDENTIALS means username, company, or password is missing. A frequent address mistake is ending base_url with /entity — the connection adds its own paths after the root address, so an address that already carries that suffix points the sign-in at the wrong place.

Fill in every required field — base_url, company, username, and password — and check base_url: use the root address of the instance only, for example https://mycompany.acumatica.com, with nothing after it. Save and test again.