Menu
Business Central
Work with Microsoft Dynamics 365 Business Central sales and purchase documents — customers, vendors, items, invoices, orders, and their lines — through the automation API. Covers OAuth auth, the company_id and If-Match requirements, and OData response shapes.
Browse 75 Microsoft Dynamics 365 Business Central actions Business Central · Generic RequestOn this page
Connecting Business Central
Every action needs a Business Central connection configured with OAuth 2.0 (Microsoft Entra ID) credentials for an app registration that has the Financials.ReadWrite.All permission and access to your environment. The token is sent as a Bearer token automatically.
Set the Base URL for your tenant. Every action has a Base URL dropdown offering a production and a sandbox host, but neither includes your Entra tenant id. In practice, pick Custom in that dropdown and enter:
https://api.businesscentral.dynamics.com/v2.0/<tenant-id>/<environment>/api/v1.0
where <environment> is your BC environment name (e.g. Production, Sandbox).
Every action, with its parameters and response fields, is listed in the action reference.
What's covered
Actions come from the Business Central automation API (api/v1.0), narrowed to the sales and purchase document entities: Companies, Items, Customers, Vendors, Sales Invoices, Sales Invoice Lines, Sales Orders, Sales Order Lines, Purchase Invoices, Purchase Invoice Lines. Names read like "List Customers", "Get Customer", "Post Customer" (create), "Patch Customer" (update), "Delete Customer", plus bound actions such as Post, Post and Send, Cancel, and Ship and Invoice. Everything else (general ledger, journals, payments, bank accounts, dimensions, quotes, credit memos, reports, …) is reached with the Generic GET / POST / PUT / PATCH / DELETE Request actions, whose required path is relative to the base URL (e.g. /companies(<company_id>)/salesQuotes).
Company, ids and line items
- company_id — path parameter on almost every action (Companies is the exception). It's the BC company GUID; a "List Companies" step (reference
listCompanies) exposes it at{{listCompanies.response.data.value[0].id}}. All business data lives under a company. - Line-item ids (salesInvoiceLine_id etc.) are string keys and appear quoted in the path.
- Lines can be addressed nested under their document (
.../salesInvoices({salesInvoice_id})/salesInvoiceLines) or flat (.../salesInvoiceLines); scope the flat list with$filter=documentId eq <invoiceGuid>.
Query options, concurrency and request bodies
- Additional Query Parameters — OData v4 options:
$filter,$select,$expand,$top,$skip,$orderby. e.g.$filter=number eq 'C00010'. - Update and Delete require an
If-Matchheader (via Additional Headers). Set it to*to update/delete unconditionally, or to the record's@odata.etagfrom a prior Get for optimistic concurrency. Without it BC returns428 Precondition Required. This also applies to the genericPATCH/DELETEactions. - BC entities have many properties; Override Request Body with hand-written JSON in Request Body (Raw) is often the practical choice for Post/Patch.
Reading the response
Every action's result is at {{<stepReference>.response...}} (see Step Reference): {{<stepReference>.response.status}}, {{<stepReference>.response.headers.<name>}}, and {{<stepReference>.response.data.<field>}} for the body. BC's OData v4 shapes:
- A list —
{{<stepReference>.response.data.value}}is the array. Page with$top/$skip, or follow{{<stepReference>.response.data['@odata.nextLink']}}when present. - A single record / create / update — fields are directly under
data, e.g.{{<stepReference>.response.data.id}}(GUID),{{<stepReference>.response.data.number}}, plus{{<stepReference>.response.data['@odata.etag']}}— keep it to pass asIf-Matchon a later update. - A delete —
204 No Content; confirm with{{<stepReference>.response.status}}. - A bound action (the
Microsoft.NAV.*operations — Post, Send, Cancel, Ship and Invoice, …) — usually204, or the affected document; check{{<stepReference>.response.status}}.
A non-2xx response does not fail the step — it's returned with the real status code and BC's error body ({{<stepReference>.response.data.error.code}}, {{<stepReference>.response.data.error.message}}).
Your first call
- Add a Business Central step and choose List Companies; name it
listCompanies. It needs no company_id. - Run it and read
{{listCompanies.response.data.value[0].id}}(the company GUID) and{{listCompanies.response.data.value[0].name}}. - Add a second step, List Customers, and set company_id to
{{listCompanies.response.data.value[0].id}}. - Limit it with Additional Query Parameters
$top=10, then read{{listCustomers.response.data.value[0].displayName}}.
Also applies here
Step Name
What it's for
Every step in a workflow gets a name — either one you set or a default based on the connector and action (e.g. "Get Order Details", "Send Welcome Email"). It's shown throughout the UI and in your execution history, and it's also the source for the step's Reference — a camelCase identifier auto-generated from the name (e.g. "Get Order Details" → getOrderDetails) — which is what you actually use in {{...}} expressions to read this step's output from later steps. See Step Reference.
Rules
- Must be at least 2 characters, and 50 characters or fewer.
- Must be unique within the workflow — reusing a name that's already taken will be rejected, with a suggested alternative (e.g.
"Get Order Details 2"). - Can't be empty.
Tips
- Prefer a descriptive, human-readable name over a generic one — "Get Order Details" is easier to work with later than "HTTP Request 2", especially once a workflow has a dozen steps.
- Renaming a step updates every reference to it elsewhere in the workflow automatically.
Step Reference
Syntax
Any input field can reference earlier data using {{expression}}. The expression is evaluated as JSONata — so simple dot-paths and more advanced queries (filters, functions) both work.
Referencing a step's output
Use the step's Reference — a camelCase identifier auto-generated from its Name (e.g. "Get Order Details" → getOrderDetails), shown read-only wherever the step's fields are configured — followed by the field path. Elsewhere in these docs this general pattern is written as {{<stepReference>.field.path}}:
{{getOrderDetails.response.data.id}}
{{getOrderDetails.response.status}}
The raw display name won't work here even though it's what you see in the UI — {{Get Order Details.response.data.id}} isn't valid, since a bare name containing spaces isn't a single JSONata identifier. Always use the camelCase Reference.
You can also reference steps by position instead of by reference:
{{steps[0].response.data.id}}
Referencing trigger data
{{trigger.headers.authorization}}
{{trigger.body.customerId}}
{{trigger.query.page}}
{{trigger.params.orderId}}
{{trigger.method}}
{{trigger.path}}
Referencing workflow variables
{{variables.myVariable}}
See Variables for the full list of variable types and more examples, including connection-type variables.
Referencing runtime variables
A separate, mutable namespace written by the Variable connector while a run is in progress — not the same as the workflow-level variables above:
{{runtimeVariables.myVariable}}
Notes
- If an expression can't be resolved (a typo in a step name, a field that doesn't exist), it resolves to an empty string rather than failing the workflow — check your execution history if a value comes through blank.
- Object values are automatically JSON-stringified when interpolated into a string field.
Execution Settings
Fire-and-forget
When enabled, the workflow doesn't wait for this step to complete before moving to the next one. Use it for steps whose result nothing downstream depends on — logging, analytics, notifications — so they don't add latency to the steps that matter.
Continue on error
When enabled, a failure in this step doesn't stop the workflow — execution continues to the next step. The failure is still recorded in the execution history; this just controls whether it's fatal.
Combine the two for steps that are genuinely optional to the outcome: fire-and-forget so they don't add latency, continue-on-error so a failure in them (e.g. an analytics endpoint being briefly down) doesn't take down an otherwise-successful workflow run.
Caching
What it does
When enabled, a step's result is cached for a configurable TTL (time-to-live, in seconds). If the step runs again with the same effective cache key before the TTL expires, the cached result is returned instead of re-running the step.
Configuring it
- Enabled — turn caching on or off for this step.
- TTL — how long (in seconds) a cached result stays valid.
- Cache key template — an expression (supporting the same
{{...}}step reference syntax used elsewhere) that determines what counts as "the same call". By default this is based on the step's resolved input; a custom template lets you cache more narrowly or broadly than that.
When to use it
Good candidates are steps that call something slow or rate-limited but return the same answer for the same input within a short window — a lookup against a rarely-changing external system, for example. Skip it for steps whose result must always be fresh (anything involving live inventory, pricing, or payment state).
Locking
What it does
When enabled, only one execution of this step (for a given lock key) can run at a time. If a second execution tries to run the same step while a lock is held, it waits until the lock is released or the hold period elapses.
Configuring it
- Enabled — turn locking on or off for this step.
- Lock key — an expression (supporting the same
{{...}}step reference syntax used elsewhere) that determines what counts as "the same resource". By default the lock is scoped to the step itself; a custom key lets you lock per-customer, per-order, or any other identifier that needs serialized access. - Period — how long (in seconds) the lock is held before it's automatically released, in case an execution doesn't complete normally.
When to use it
Use it whenever concurrent executions could race on the same resource — e.g. two workflow runs both trying to update the same order's status at once. A lock key scoped to the order id ensures only one of them proceeds at a time.
Last updated 9 October 2026