Menu
Connectors
QuickBooks Online
Manage customers and invoices in QuickBooks Online via the Accounting API, with a generic-request escape hatch for every other resource. Covers auth, request fields, and response access paths.
On this page
Connecting QuickBooks Online
Every action needs a QuickBooks Online connection. It uses Intuit's OAuth 2.0 authorization-code flow: register an app on the Intuit Developer Portal for a Client ID and Client Secret, then authorize the connection and pick a company (realm). The connection stores the access token and the realm (company) id; requests go to <base>/v3/company/<realmId> (the base is Intuit's production or sandbox Accounting API host, set on the connection). The access token is sent as a Bearer token automatically — there's no per-action auth configuration.
Request customization (all actions)
Every action has three optional fields for tailoring the outgoing request:
- Forward All Headers — when on, headers from the workflow's incoming request are forwarded (minus hop-by-hop headers). Off by default.
- Additional Headers — key/value pairs added to the request; these override forwarded headers with the same name.
- Query Parameters — key/value pairs appended to the URL (e.g.
minorversion=73).
Reading the response
Every action's result is at {{<stepReference>.response...}} (see Step Reference):
{{<stepReference>.response.status}}/{{<stepReference>.response.statusText}}— the HTTP status.{{<stepReference>.response.headers.<header-name>}}— a response header.{{<stepReference>.response.data.<field>}}— the parsed QuickBooks response body. QuickBooks wraps a single record in a key named after the entity, so a "Get Customer" step (referencegetCustomer) resolves the customer at{{getCustomer.response.data.Customer.DisplayName}}, and itsSyncToken— which you need to update the record later — at{{getCustomer.response.data.Customer.SyncToken}}.
A non-2xx response does not fail the step — it's returned with the real status code and QuickBooks' Fault body under {{<stepReference>.response.data}}, so you can branch on {{<stepReference>.response.status}}. A network failure is returned as a synthetic 503, any other unexpected error as a synthetic 500.
Create Customer
Create a customer record (POST /customer).
Configuring it
Request body fields:
- Display Name (
displayName) — required; must be unique in the company. - Company Name (
companyName), Email (email, sent asPrimaryEmailAddr.Address), Phone (phone, sent asPrimaryPhone.FreeFormNumber). - Billing Address Line 1 / City / State-Region / Postal Code / Country (
billingLine1,billingCity,billingRegion,billingPostalCode,billingCountry) — assembled intoBillAddr(only sent if Line 1 or City is set;billingRegionmaps toCountrySubDivisionCode). - Additional Data (JSON) (
additionalData) — a JSON object string merged into the QuickBooksCustomerpayload as-is, for any field the form doesn't expose. Invalid JSON fails the step before the request is sent.
Reading the response
{{createCustomer.response.data.Customer.Id}}, {{createCustomer.response.data.Customer.SyncToken}}, {{createCustomer.response.data.Customer.DisplayName}}.
Example
Display Name Acme Corp, Email ap@acme.example, Additional Data {"Notes": "Net 30"}.
Get Customer
Retrieve a customer by id (GET /customer/{customerId}).
Configuring it
- Customer ID (
customerId) — required, interpolated into the path.
Reading the response
{{getCustomer.response.data.Customer}} — e.g. {{getCustomer.response.data.Customer.Balance}} (open balance), {{getCustomer.response.data.Customer.PrimaryEmailAddr.Address}}.
Create Invoice
Create an invoice (POST /invoice).
Configuring it
Request body fields:
- Customer ID (
customerId) — required, sent asCustomerRef.value. - Line Items (JSON) (
lineItems) — required, a JSON array string. Each entry becomes aSalesItemLineDetailline:itemId→ItemRef.value, plusamount→Amount,description→Description,quantity→Qty,unitPrice→UnitPrice. Example:[{"itemId":"1","amount":100,"description":"Consulting","quantity":2,"unitPrice":50}]. - Due Date (
dueDate) —YYYY-MM-DD, sent asDueDate. - Additional Data (JSON) (
additionalData) — merged into theInvoicepayload as-is (e.g.{"CustomerMemo": {"value": "Thank you"}}).
Reading the response
{{createInvoice.response.data.Invoice.Id}}, {{createInvoice.response.data.Invoice.DocNumber}}, {{createInvoice.response.data.Invoice.TotalAmt}}, {{createInvoice.response.data.Invoice.Balance}}.
Get Invoice
Retrieve an invoice by id (GET /invoice/{invoiceId}).
Configuring it
- Invoice ID (
invoiceId) — required, interpolated into the path.
Reading the response
{{getInvoice.response.data.Invoice}} — e.g. {{getInvoice.response.data.Invoice.Balance}}, {{getInvoice.response.data.Invoice.EmailStatus}}, {{getInvoice.response.data.Invoice.Line}}.
Generic Request
Call any QuickBooks Online endpoint not covered above — Query, Payment, Estimate, Item, Account, Bill, batch, and so on.
Configuring it
- Path (
path) — required, relative to the company API base (/v3/company/<realmId>), e.g./query?query=select * from Itemor/payment/123. - HTTP Method (
method) — required, one ofGET,POST,PUT,PATCH,DELETE. Defaults toGET. - Request Body (JSON) (
body) — for write methods; parsed according to theContent-Typeheader (JSON by default).
Reading the response
{{genericRequest.response.data.<field>}} — shape depends on the endpoint. For a query, results are typically at {{genericRequest.response.data.QueryResponse.<Entity>}}.
Example
Path /query?query=select * from Customer where DisplayName = 'Acme Corp', Method GET — to look a customer up by name (the dedicated Get Customer action only takes an id).
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.