Everything needed to call this workflow: how to start it, every question it may ask (including from workflows it calls), and every way it can end. Derived from the chart on every request, so it always describes the workflow that actually runs.
Derived from the chart; nothing here is stored or hand-written.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"QuBe Sync","colors":{"primary":"#16A34A","light":"#07C983","dark":"#15803D"},"logo":{"light":"https://mintcdn.com/qubesync/gN_APnIajnQKnywV/logo/full-light.png?fit=max\u0026auto=format\u0026n=gN_APnIajnQKnywV\u0026q=85\u0026s=0690db6248367802891c15bad08ae9e9","dark":"https://mintcdn.com/qubesync/gN_APnIajnQKnywV/logo/full-dark.png?fit=max\u0026auto=format\u0026n=gN_APnIajnQKnywV\u0026q=85\u0026s=49fb7c4ae5cb86868e1d029c62580428"},"favicon":{"light":"https://mintcdn.com/qubesync/gN_APnIajnQKnywV/favicon.ico?fit=max\u0026auto=format\u0026n=gN_APnIajnQKnywV\u0026q=85\u0026s=ecfae754138bc13cdcb4d589ad584c71","dark":"https://mintcdn.com/qubesync/gN_APnIajnQKnywV/favicon.ico?fit=max\u0026auto=format\u0026n=gN_APnIajnQKnywV\u0026q=85\u0026s=ecfae754138bc13cdcb4d589ad584c71"},"navbar":{"links":[{"href":"mailto:[email protected]","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://qubesync.com/app"}},"footer":{"socials":{"github":"https://github.com/qubeintegrations","linkedin":"https://linkedin.com/company/qube-integrations"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"QuBe Sync Slack","icon":"slack","href":"https://qubeintegrations.slack.com"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"qubesync","hasAudioNarration":false,"actualSubdomain":"qubesync","customDomains":["docs.qubesync.com"],"gitSource":{"type":"github","owner":"qubeintegrations","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aad80a0e000b4e10f39085c","collectionId":"83ff748c-8826-40c7-94e2-9b020f7a143e","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aad80a0e000b4e10f39085c"},"entitlements":{},"buildId":"6ae8b8241795b614d9d71d8a","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"API Reference","count":332},{"language":"default","tag":"API v2","count":308},{"language":"default","tag":"Workflows","count":30},{"language":"default","tag":"API v1 (legacy)","count":23},{"language":"default","tag":"Guides","count":20},{"language":"default","tag":"Connections","count":19},{"language":"default","tag":"Pre-built Queries","count":12},{"language":"default","tag":"Queued Requests","count":9},{"language":"default","tag":"Build your integration","count":7},{"language":"default","tag":"Data Ext Defs","count":4}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"[data-badge=true]{white-space:nowrap}[data-badge=true] code{background:0 0;border:0;border-radius:0;padding:0}.qube-request{--qr-frame:rgb(243 247 245);--qr-border:rgb(10 15 12 / 0.1);--qr-panel:#fff;--qr-title:rgb(63 67 64);--qr-button:rgb(112 116 114);--qr-button-hover:rgb(63 67 64);--qr-hover:rgb(229 231 235 / 0.5);--qr-focus:rgb(var(--primary));--qr-ink:#1f2328;--qr-method:#0550ae;--qr-muted:#6e7781;--qr-param:#8250df;--qr-key:#116329;--qr-string:#0a3069;--qr-number:#0550ae;--qr-literal:#0550ae;--qr-mono:paperMono, ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, \"Liberation Mono\", \"Courier New\", monospace;min-width:0;max-width:100%;margin:1.25rem 0 2rem;padding:2px;border:1px solid var(--qr-border);border-radius:1rem;background:var(--qr-frame)}.dark .qube-request{--qr-frame:rgb(255 255 255 / 0.05);--qr-border:rgb(255 255 255 / 0.1);--qr-panel:rgb(11 12 14);--qr-title:rgb(206 211 208);--qr-button:rgb(159 163 160);--qr-button-hover:rgb(206 211 208);--qr-hover:rgb(55 65 81 / 0.7);--qr-focus:rgb(var(--primary-light));--qr-ink:#d4d4d4;--qr-method:#569cd6;--qr-muted:#808080;--qr-param:#c586c0;--qr-key:#9cdcfe;--qr-string:#ce9178;--qr-number:#b5cea8;--qr-literal:#569cd6}.qube-request-head{display:flex;align-items:center;gap:.5rem;padding:.25rem .625rem .25rem 1rem;font-size:.75rem;font-weight:500;line-height:1.5rem}.qube-request-title{flex:1;min-width:0;overflow:hidden;text-overflow:ellipsis;white-space:nowrap;color:var(--qr-title)}.qube-request-copy{display:inline-flex;flex:none;align-items:center;gap:.375rem;height:1.625rem;padding:0 .375rem;border:0;border-radius:.5rem;background:0 0;font:inherit;color:var(--qr-button);cursor:pointer}.qube-request-copy:hover{background:var(--qr-hover);color:var(--qr-button-hover)}.qube-request-copy:focus-visible{outline:1px solid var(--qr-focus);outline-offset:0}.qube-request-code{margin:0;padding:.875rem 1rem;overflow-x:auto;border-radius:14px;background:var(--qr-panel);font-family:var(--qr-mono);font-size:.875rem;line-height:1.5rem;color:var(--qr-ink)}.qube-request-code code{display:block;padding:0;background:0 0;font:inherit;color:inherit;white-space:pre}.qube-request-method{font-weight:600;color:var(--qr-method)}.qube-request-prefix{color:var(--qr-muted)}.qube-request-param{color:var(--qr-param)}.qube-request-key{color:var(--qr-key)}.qube-request-string{color:var(--qr-string)}.qube-request-number{color:var(--qr-number)}.qube-request-literal{color:var(--qr-literal)}.qube-points{margin:.5rem 0 1.5rem}.qube-point{display:flex;gap:1rem;padding:1.125rem 0;border-bottom:1px solid rgb(10 15 12/.1)}.qube-point:last-child{border-bottom:0}.dark .qube-point{border-color:rgb(255 255 255/.1)}.qube-point>svg{flex:none;margin-top:.25rem}.qube-point>div{min-width:0}.qube-point [data-as=p]{display:block;margin:0}.qube-point [data-as=p]+[data-as=p]{margin-top:.125rem}"}],"page":{"pagePath":"api-reference/v2/workflows/how-to-use-a-workflow","slug":"/api-reference/v2/workflows/how-to-use-a-workflow","pageMetadata":{"title":"How to use a workflow","description":"Everything needed to call this workflow: how to start it, every question it may ask (including from workflows it calls), and every way it can end. Derived from the chart on every request, so it always describes the workflow that actually runs.","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /workflows/{key}/usage","href":"/api-reference/v2/workflows/how-to-use-a-workflow","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Everything needed to call this workflow: how to start it, every question it may ask (including from workflows it calls), and every way it can end. Derived from the chart on every request, so it always describes the workflow that actually runs.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"How to use a workflow","description":"Everything needed to call this workflow: how to start it, every question it may ask (including from workflows it calls), and every way it can end. Derived from the chart on every request, so it always describes the workflow that actually runs.","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /workflows/{key}/usage","href":"/api-reference/v2/workflows/how-to-use-a-workflow","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Everything needed to call this workflow: how to start it, every question it may ask (including from workflows it calls), and every way it can end. Derived from the chart on every request, so it always describes the workflow that actually runs.","parameters":["3cb2d4ab-22d9-4baf-844f-c44b32008c85","0c1ef631-7c20-49de-b668-e132b783366e"],"responses":{"200":"39dd3859-8de2-46b4-a8fd-a9c68daacb0b","404":"d112e528-db21-49db-a9c1-8ea67b6ac1b1"},"security":["b4244a72-8fe2-4c62-b02f-54cf6e0265fb"],"summary":"How to use a workflow","tags":["Workflows"],"method":"get","type":"path","servers":["acf84d29-d14b-4dd6-933f-31aa602dd68b","b8836037-80c3-4a92-9378-766448db35bb"],"path":"/workflows/{key}/usage","baseUrlOptions":["https://qubesync.com/api/v2","https://dev.qubesync.com/api/v2"],"title":"How to use a workflow","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"3cb2d4ab-22d9-4baf-844f-c44b32008c85":{"description":"The workflow's stable key","in":"path","name":"key","required":true,"schema":{"pattern":"^[a-z][a-z0-9_]{0,63}$","type":"string","isRequired":true,"description":"The workflow's stable key","uniqueKey":"","typeLabel":"string"}},"0c1ef631-7c20-49de-b668-e132b783366e":{"description":"Which chart to describe: a version number, `published` (the default), or `working` for the working copy.","in":"query","name":"version","required":false,"schema":{"type":"string","isRequired":false,"description":"Which chart to describe: a version number, `published` (the default), or `working` for the working copy.","uniqueKey":"","typeLabel":"string"}}},"responses":{"39dd3859-8de2-46b4-a8fd-a9c68daacb0b":{"content":{"application/json":{"schema":{"properties":{"data":{"description":"Derived from the chart; nothing here is stored or hand-written.","properties":{"child_outcomes":{"description":"Per `workflow` state, every outcome the workflow it calls declares. A called workflow's ending arrives as an ordinary `success` (a declared failure as `error`) with `response.outcome` naming it, so a state that does not branch on it carries on as though nothing unusual happened. Each has `state`, `workflow`, `outcome`, `kind` (`success` or `failure`), `description`, `handled_at` (the state, or the state enclosing it, that branches on this outcome; `root on.success` or `root on.error` when the chart's root does; null when nothing does) and `per_item` (true when the state runs once per item, so each element's ending arrives in `response.outcomes` instead). Empty when the workflow calls none, or none that is installed.","items":{"type":"object","uniqueKey":"data.child_outcomes.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"data.child_outcomes","typeLabel":"object[]"},"decision_flow":{"description":"How answering a question works, whatever the question: `asynchronous` (a run waits for an answer indefinitely); `delivery`, the `workflow_run.awaiting_input` webhook a question arrives in (`event`, where it is sent, `signature_header`, `answer_url`, the `payload` envelope, and `order`: how to match a webhook to your record by `reference` and put the run's bodies in order by `revision`); `answer`, the request that answers it (`method`, `path`, `auth`, a `body` template, `data_note`, `token_note` (why the body names the prompt's `token`) and `response`, plus, when the workflow asks anything, a `response_example` of answering its first question and an `error_example` of the 422 a wrong option gets); `poll`, reading the run instead of waiting for the webhook; `cancel`, stopping the run instead (its request, a `note` and its `errors`); `composed`, how a question asked by a workflow this one calls arrives (`applies` is true when this workflow has one); and `errors`, what the decisions endpoint can refuse an answer with (`status`, `code` and `meaning` each).","type":"object","uniqueKey":"data.decision_flow","typeLabel":"object"},"decisions":{"description":"Every question the workflow may ask, including ones asked by workflows it calls (their ids are prefixed by the calling state). Each carries its `kind` (`decision` for a wait state's question, `conflict` for the prompt the engine asks when an update whose `on_conflict` is `ask` meets a stale edit sequence; those come after the wait states' and have id `conflict:\u003cstate>`), the message as authored (for a conflict, `when` says when it is asked), the options and their fields, a `webhook_example` of the payload it arrives in, one `answers` body per option, and `data`: per `prompt.data` key, where it comes from and an `example` of what it carries -- the record from the request that fills it when exactly one does, and a placeholder otherwise; for a conflict, a `description` of each key.","items":{"type":"object","uniqueKey":"data.decisions.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"data.decisions","typeLabel":"object[]"},"matches":{"description":"Every match state the workflow can look a record up by name from, including those of workflows it calls (their `state` is prefixed by the calling state): `state`, `leaf_state` and `workflow` (where it is), `in_child`, `kind` (the list it looks in, as the chart writes it: a kind such as `customer`, or a template), `description`, `refresh` (whether it refreshes the connection's name index from QuickBooks first: `true`, `false`, or the template that says), `exact_only` and `error_handled` (whether the workflow handles a match it can't ask; otherwise the run fails). Each raises `success` whatever it finds, with `response.data` the answer the matches endpoint gives -- `match` (`exact`, `strong`, `candidates` or `none`), `record`, `candidates`, `candidates_total`, `candidates_total_complete` and `index` -- with `index.state` `unavailable` (and no scores) when a standard connection answered from QuickBooks' own filters. No QuickBooks status codes. Empty when it matches nothing.","items":{"type":"object","uniqueKey":"data.matches.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"data.matches","typeLabel":"object[]"},"notifications":{"description":"Every notify state the workflow can send the app data from, including those of workflows it calls (their `state` is prefixed by the calling state): `name` (what the app routes on), `description`, `state` (the webhook's `state`, its path from the run), `leaf_state` and `workflow` (where it is, in the workflow that sends it), `sent_by_child`, `per_item_of` (the calling state that runs once per item, when it is sent from inside one; null otherwise), `error_handled` (whether the workflow handles it not being delivered; otherwise the run fails), `data_example` (what `data` carries, from the chart: a record's identifying fields where it sends a request's response, placeholders for what only exists mid-run) and `webhook_example`, the whole `workflow_run.notification` it arrives in. A run of a workflow with any must be started with a `webhook_url`. Empty when it sends none.","items":{"type":"object","uniqueKey":"data.notifications.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"data.notifications","typeLabel":"object[]"},"outcomes":{"description":"One entry per ending the run can reach: the successes, then the failures the workflow declares, then `failed`. Each has `outcome`, `kind` (`success` or `failure`), `description` and `from_states`, the states that lead there. A success carries `output_keys` and an `output_example`, and so does a declared failure with an output of its own: per key, its `values` when they are known (a key that is `${meta.outcome}` has the ending's own name), else `source`, the states whose responses feed it, with that operation's `shape` when there is one; `may_be_null` flags a key that may not be set. `completed` is listed only when something in the chart reaches it, or when the workflow declares no success of its own. A declared failure lists the `errors` it can carry; `failed` is always listed, with the messages this workflow can end with (`authored_errors`), the ones that carry a QuickBooks message or a called workflow's error through (`dynamic_errors`), and the engine's own (`engine_errors`).","items":{"type":"object","uniqueKey":"data.outcomes.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"data.outcomes","typeLabel":"object[]"},"per_item":{"description":"One entry per `workflow` state that runs once per element of a list: `state` (its path), `workflow` (the key it calls), `each` (the list, as the chart writes it), `as` (the name each element is bound to; `item` unless the state names another), `on_item_error` (`stop` or `continue`), `stop_on` (the called workflow's endings that end the loop at the element that ends in one, starting none after it; `[]` for none), and `sentence`, the same said in one sentence. Empty when nothing in the workflow runs once per item.","items":{"type":"object","uniqueKey":"data.per_item.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"data.per_item","typeLabel":"object[]"},"request_errors":{"description":"Per request state, the QuickBooks status codes its operation can raise and whether this workflow handles each one; `settle`, whether a request QuickBooks never answered is settled before the state raises anything; and `on_conflict`, for an update, what happens when the record changed after it was read (`ask`, `overwrite` or `fail`; null for anything that is not an update). A request state whose `operation` is a template (`${input.\u003cname>.operation}`) is listed with `operation` null, `operation_template` the template and no codes, since the operation is decided when the run starts.","items":{"type":"object","uniqueKey":"data.request_errors.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"data.request_errors","typeLabel":"object[]"},"run_json_example":{"type":"object","uniqueKey":"data.run_json_example","typeLabel":"object"},"start":{"description":"The request that starts a run: method, path, an example body, the input JSON Schema, and a note per declared input.","type":"object","uniqueKey":"data.start","typeLabel":"object"},"states":{"description":"What each run state means, in lifecycle order.","items":{"type":"object","uniqueKey":"data.states.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"data.states","typeLabel":"object[]"},"webhooks":{"description":"The webhooks a run of this workflow sends, each with `event` and `when`: `workflow_run.awaiting_input`, `workflow_run.notification` when it has notify states, and the three endings.","items":{"type":"object","uniqueKey":"data.webhooks.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"data.webhooks","typeLabel":"object[]"},"workflow":{"description":"key, name, description and state: `draft` or `published` for a workflow, `template` for a shipped template read before it's installed.","type":"object","uniqueKey":"data.workflow","typeLabel":"object"}},"type":"object","uniqueKey":"data","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"child_outcomes":[{}],"decision_flow":{},"decisions":[{}],"matches":[{}],"notifications":[{}],"outcomes":[{}],"per_item":[{}],"request_errors":[{}],"run_json_example":{},"start":{},"states":[{}],"webhooks":[{}],"workflow":{}}}}},"exampleType":"generated"}},"description":"The usage contract","exampleType":"generated"},"d112e528-db21-49db-a9c1-8ea67b6ac1b1":{"content":{"application/json":{"schema":{"description":"What a refused request answers with. The one key is errors, and its shape says what went wrong: a sentence when the endpoint explains the refusal in words (a parameter the operation does not take, a key already taken, a run that has already ended); an object with detail, and a code when there is one, when the request named nothing that exists or may not do what it asked (402, 403, 404, and a CLI session's 401), or an answer to a run's question was refused (the decisions endpoint's 400, 409 and 422, which always carry a code to branch on); an object of fields, each a list of messages, when a record failed validation and nothing was saved; a list of {path, message} problems when a submitted document or input fails validation. A request without a usable API key gets a 401 Basic challenge with the plain-text body Unauthorized, not JSON.","properties":{"errors":{"oneOf":[{"type":"string","title":"A sentence","example":"unknown parameter: \"emial\"","isRequired":true,"uniqueKey":"errors.oneOf.0","typeLabel":"string"},{"type":"object","title":"Detail and code","required":["detail"],"properties":{"detail":{"example":"Not Found","type":"string","isRequired":true,"uniqueKey":"errors.oneOf.1.detail","typeLabel":"string"},"code":{"example":"read_only_session","type":"string","uniqueKey":"errors.oneOf.1.code","typeLabel":"string"}},"isRequired":true,"uniqueKey":"errors.oneOf.1","typeLabel":"Detail and code · object"},{"type":"object","title":"Field by field","example":{"webhook_url":["may not contain a username or password"]},"additionalProperties":{"items":{"type":"string","uniqueKey":"errors.oneOf.2.additionalProperties.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"errors.oneOf.2.additionalProperties","typeLabel":"string[]"},"isRequired":true,"uniqueKey":"errors.oneOf.2","typeLabel":"Field by field · object"},{"type":"array","items":{"properties":{"message":{"example":"is required","type":"string","isRequired":true,"uniqueKey":"errors.oneOf.3.items.[INDEX].message","typeLabel":"string"},"path":{"example":"input.customer","type":"string","isRequired":true,"uniqueKey":"errors.oneOf.3.items.[INDEX].path","typeLabel":"string"}},"required":["path","message"],"type":"object","uniqueKey":"errors.oneOf.3.items.[INDEX]","typeLabel":"object"},"title":"Located problems","isRequired":true,"uniqueKey":"errors.oneOf.3","typeLabel":"Located problems · object[]"}],"isRequired":true,"uniqueKey":"errors","typeLabel":"string | Detail and code · object | Field by field · object | Located problems · object[]"}},"required":["errors"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":"unknown parameter: \"emial\""}}},"exampleType":"generated"}},"description":"No workflow with that key","exampleType":"generated"}},"security":{"b4244a72-8fe2-4c62-b02f-54cf6e0265fb":{"apiKey":{"description":"Use your app's API key as the username, and leave the password blank","scheme":"basic","type":"http","scopes":[],"schemeName":"apiKey"}}},"servers":{"acf84d29-d14b-4dd6-933f-31aa602dd68b":{"description":"v2 API","url":"https://qubesync.com/api/v2"},"b8836037-80c3-4a92-9378-766448db35bb":{"description":"Local development server","url":"https://dev.qubesync.com/api/v2"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"description":"Use your app's API key as the username, and leave the password blank","scheme":"basic","type":"http","scopes":[],"schemeName":"apiKey"},"schema":{"title":"Basic Auth","type":"object","description":"Use your app's API key as the username, and leave the password blank","isRequired":true,"properties":{"username":{"type":"string","uniqueKey":"username","isRequired":true,"typeLabel":"string","deprecated":false},"password":{"type":"string","uniqueKey":"password","isRequired":true,"typeLabel":"string","deprecated":false}},"additionalProperties":false,"deprecated":false},"schemeName":"apiKey","name":"Authorization"}],"title":"apiKey"}]},"originalFileLocation":"api-reference/v2/openapi.json"},"subdomain":"qubesync","siteName":"QuBe Sync","title":"How to use a workflow - QuBe Sync","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-02T16:20:12.837Z","originalFileLocation":"api-reference/v2/workflows/how-to-use-a-workflow.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Everything needed to call this workflow: how to start it, every question it may ask (including from workflows it calls), and every way it can end. Derived from the chart on every request, so it always describes the workflow that actually runs.\">\u003cmeta data-mint-head name=\"application-name\" content=\"QuBe Sync\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/qubesync/GrEUn7G8W5QJHTqH/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/qubesync/GrEUn7G8W5QJHTqH/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/qubesync/GrEUn7G8W5QJHTqH/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/qubesync/GrEUn7G8W5QJHTqH/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/qubesync/GrEUn7G8W5QJHTqH/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/qubesync/GrEUn7G8W5QJHTqH/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/qubesync/GrEUn7G8W5QJHTqH/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/qubesync/GrEUn7G8W5QJHTqH/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/qubesync/GrEUn7G8W5QJHTqH/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"How to use a workflow - QuBe Sync\">\u003cmeta data-mint-head property=\"og:description\" content=\"Everything needed to call this workflow: how to start it, every question it may ask (including from workflows it calls), and every way it can end. Derived from the chart on every request, so it always describes the workflow that actually runs.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"QuBe Sync\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.qubesync.com/api-reference/v2/workflows/how-to-use-a-workflow\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://qubesync.mintlify.app/_mintlify/api/og/v2?division=Workflows\u0026amp;title=How+to+use+a+workflow\u0026amp;description=Everything+needed+to+call+this+workflow%3A+how+to+start+it%2C+every+question+it+may+ask+%28including+from+workflows+it+calls%29%2C+and+every+way+it+can+end.+Derived+from+\u0026amp;theme=c2fec557b6516639b3d250f1\u0026amp;signature=ed7ef3e79052e0c573eacadb42fc5746f68a89495c3e81671953c9b28d988e40\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"How to use a workflow - QuBe Sync\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Everything needed to call this workflow: how to start it, every question it may ask (including from workflows it calls), and every way it can end. Derived from the chart on every request, so it always describes the workflow that actually runs.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://qubesync.mintlify.app/_mintlify/api/og/v2?division=Workflows\u0026amp;title=How+to+use+a+workflow\u0026amp;description=Everything+needed+to+call+this+workflow%3A+how+to+start+it%2C+every+question+it+may+ask+%28including+from+workflows+it+calls%29%2C+and+every+way+it+can+end.+Derived+from+\u0026amp;theme=c2fec557b6516639b3d250f1\u0026amp;signature=ed7ef3e79052e0c573eacadb42fc5746f68a89495c3e81671953c9b28d988e40\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/qubesync/GrEUn7G8W5QJHTqH/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"QuBe Sync\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#16A34A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.qubesync.com/api-reference/v2/workflows/how-to-use-a-workflow\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/v2/workflows/how-to-use-a-workflow.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.qubesync.com/#organization\",\"name\":\"QuBe Sync\",\"url\":\"https://docs.qubesync.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/qubesync/gN_APnIajnQKnywV/logo/full-light.png?fit=max\u0026auto=format\u0026n=gN_APnIajnQKnywV\u0026q=85\u0026s=0690db6248367802891c15bad08ae9e9\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.qubesync.com#website\",\"name\":\"QuBe Sync\",\"url\":\"https://docs.qubesync.com\",\"publisher\":{\"@id\":\"https://docs.qubesync.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.qubesync.com/api-reference/v2/workflows/how-to-use-a-workflow#webpage\",\"url\":\"https://docs.qubesync.com/api-reference/v2/workflows/how-to-use-a-workflow\",\"name\":\"How to use a workflow\",\"description\":\"Everything needed to call this workflow: how to start it, every question it may ask (including from workflows it calls), and every way it can end. Derived from the chart on every request, so it always describes the workflow that actually runs.\",\"dateModified\":\"2026-11-02T16:20:12.837Z\",\"isPartOf\":{\"@id\":\"https://docs.qubesync.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.qubesync.com/api-reference/v2/workflows/how-to-use-a-workflow#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.qubesync.com/api-reference/v2/workflows/how-to-use-a-workflow#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API v2\",\"item\":\"https://docs.qubesync.com/api-reference/v2/connections/list-connections\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Workflows\",\"item\":\"https://docs.qubesync.com/api-reference/v2/workflows/list-workflow-runs-for-a-connection\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"How to use a workflow\",\"item\":\"https://docs.qubesync.com/api-reference/v2/workflows/how-to-use-a-workflow\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.qubesync.com/api-reference/v2/workflows/how-to-use-a-workflow#apireference\",\"headline\":\"How to use a workflow\",\"name\":\"How to use a workflow\",\"description\":\"Everything needed to call this workflow: how to start it, every question it may ask (including from workflows it calls), and every way it can end. Derived from the chart on every request, so it always describes the workflow that actually runs.\",\"url\":\"https://docs.qubesync.com/api-reference/v2/workflows/how-to-use-a-workflow\",\"mainEntityOfPage\":{\"@id\":\"https://docs.qubesync.com/api-reference/v2/workflows/how-to-use-a-workflow#webpage\"},\"dateModified\":\"2026-11-02T16:20:12.837Z\",\"publisher\":{\"@id\":\"https://docs.qubesync.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.qubesync.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"QuBe Sync\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"QuBe Sync","nav":{"global":{"anchors":[{"anchor":"QuBe Sync Slack","icon":"slack","href":"https://qubeintegrations.slack.com"}]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"API reference","sidebarTitle":"Introduction","icon":"book","href":"/api-reference/introduction"}]},{"group":"API v2","pages":[{"group":"Connections","pages":[{"title":"List connections","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections","href":"/api-reference/v2/connections/list-connections"},{"title":"Create a connection","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections","href":"/api-reference/v2/connections/create-a-connection"},{"title":"Get a connection","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}","href":"/api-reference/v2/connections/get-a-connection"},{"title":"Update a connection","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}","href":"/api-reference/v2/connections/update-a-connection"},{"title":"Remove a connection","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json delete /connections/{connection_id}","href":"/api-reference/v2/connections/remove-a-connection"},{"title":"Regenerate the onboarding URL","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/onboarding-url","href":"/api-reference/v2/connections/regenerate-the-onboarding-url"},{"title":"Generate or set a password","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/password","href":"/api-reference/v2/connections/generate-or-set-a-password"},{"title":"Get the QWC file","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/qwc","href":"/api-reference/v2/connections/get-the-qwc-file"},{"title":"Get the simulator's state","deprecated":null,"version":null,"tag":"Beta","openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/simulator","href":"/api-reference/v2/connections/get-the-simulators-state"},{"title":"Set simulator faults","deprecated":null,"version":null,"tag":"Beta","openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/simulator","href":"/api-reference/v2/connections/set-simulator-faults"},{"title":"Reset the simulator","deprecated":null,"version":null,"tag":"Beta","openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/simulator/reset","href":"/api-reference/v2/connections/reset-the-simulator"},{"title":"Run the simulator now","deprecated":null,"version":null,"tag":"Beta","openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/simulator/sync","href":"/api-reference/v2/connections/run-the-simulator-now"}]},{"group":"Queued Requests","pages":[{"title":"List queued requests","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/queued-requests","href":"/api-reference/v2/queued-requests/list-queued-requests"},{"title":"Queue a qbXML request","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/queued-requests","href":"/api-reference/v2/queued-requests/queue-a-qbxml-request"},{"title":"Get a queued request","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/queued-requests/{id}","href":"/api-reference/v2/queued-requests/get-a-queued-request"},{"title":"Discard a queued request","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/queued-requests/{id}/discard","href":"/api-reference/v2/queued-requests/discard-a-queued-request"},{"title":"List the pages of a multi-page (iterated) response","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/queued-requests/{id}/pages","href":"/api-reference/v2/queued-requests/list-the-pages-of-a-multi-page-iterated-response"}]},{"group":"Matching","pages":[{"title":"Match a name","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/matches","href":"/api-reference/v2/matching/match-a-name"},{"title":"Opt in to matching","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/name-index","href":"/api-reference/v2/matching/opt-in-to-matching"}]},{"group":"Workflows","pages":[{"title":"List workflow runs for a connection","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/workflow-runs","href":"/api-reference/v2/workflows/list-workflow-runs-for-a-connection"},{"title":"Start a workflow run","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/workflow-runs","href":"/api-reference/v2/workflows/start-a-workflow-run"},{"title":"Get a workflow run","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/workflow-runs/{run_id}","href":"/api-reference/v2/workflows/get-a-workflow-run"},{"title":"Delete a finished workflow run","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json delete /connections/{connection_id}/workflow-runs/{run_id}","href":"/api-reference/v2/workflows/delete-a-finished-workflow-run"},{"title":"Cancel a workflow run","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/workflow-runs/{run_id}/cancel","href":"/api-reference/v2/workflows/cancel-a-workflow-run"},{"title":"Answer a run that is awaiting input","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/workflow-runs/{run_id}/decisions","href":"/api-reference/v2/workflows/answer-a-run-that-is-awaiting-input"},{"title":"A workflow run's event log","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/workflow-runs/{run_id}/events","href":"/api-reference/v2/workflows/a-workflow-runs-event-log"},{"title":"Resend a run's latest event","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/workflow-runs/{run_id}/redeliver","href":"/api-reference/v2/workflows/resend-a-runs-latest-event"},{"title":"Search for the record a question's field means","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/workflow-runs/{run_id}/search","href":"/api-reference/v2/workflows/search-for-the-record-a-questions-field-means"},{"title":"List workflow templates","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /workflow-templates","href":"/api-reference/v2/workflows/list-workflow-templates"},{"title":"Get a workflow template","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /workflow-templates/{key}","href":"/api-reference/v2/workflows/get-a-workflow-template"},{"title":"Install a workflow template","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /workflow-templates/{key}/install","href":"/api-reference/v2/workflows/install-a-workflow-template"},{"title":"How to use a workflow template, before it's installed","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /workflow-templates/{key}/usage","href":"/api-reference/v2/workflows/how-to-use-a-workflow-template-before-its-installed"},{"title":"How to use a workflow template, as Markdown","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /workflow-templates/{key}/usage.md","href":"/api-reference/v2/workflows/how-to-use-a-workflow-template-as-markdown"},{"title":"List workflows","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /workflows","href":"/api-reference/v2/workflows/list-workflows"},{"title":"The workflow chart JSON Schema","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /workflows/schema","href":"/api-reference/v2/workflows/the-workflow-chart-json-schema"},{"title":"The workflow chart JSON Schema, unauthenticated","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /workflows/schema.json","href":"/api-reference/v2/workflows/the-workflow-chart-json-schema-unauthenticated"},{"title":"Your workflows' input types","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /workflows/types","href":"/api-reference/v2/workflows/your-workflows-input-types"},{"title":"Validate a chart without saving it","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /workflows/validate","href":"/api-reference/v2/workflows/validate-a-chart-without-saving-it"},{"title":"Get a workflow","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /workflows/{key}","href":"/api-reference/v2/workflows/get-a-workflow"},{"title":"Create or replace a workflow","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /workflows/{key}","href":"/api-reference/v2/workflows/create-or-replace-a-workflow"},{"title":"Delete a workflow","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json delete /workflows/{key}","href":"/api-reference/v2/workflows/delete-a-workflow"},{"title":"Publish the working copy","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /workflows/{key}/publish","href":"/api-reference/v2/workflows/publish-the-working-copy"},{"title":"Unpublish a workflow","description":"Clears the published version. The versions themselves stay -- history is append-only. Refused while a published workflow calls this one.","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /workflows/{key}/unpublish","href":"/api-reference/v2/workflows/unpublish-a-workflow"},{"title":"How to use a workflow","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /workflows/{key}/usage","href":"/api-reference/v2/workflows/how-to-use-a-workflow"},{"title":"How to use a workflow, as Markdown","description":"The same contract as one Markdown document, intended to be handed to whatever is writing the calling code.","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /workflows/{key}/usage.md","href":"/api-reference/v2/workflows/how-to-use-a-workflow-as-markdown"},{"title":"A workflow's published versions","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /workflows/{key}/versions","href":"/api-reference/v2/workflows/a-workflows-published-versions"},{"title":"One published version","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /workflows/{key}/versions/{number}","href":"/api-reference/v2/workflows/one-published-version"}]},{"group":"Account Tax Line Infos","pages":[{"title":"List account tax line infos","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/account-tax-line-infos","href":"/api-reference/v2/account-tax-line-infos/list-account-tax-line-infos"}]},{"group":"Accounts","pages":[{"title":"List accounts","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/accounts","href":"/api-reference/v2/accounts/list-accounts"},{"title":"Update account","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/accounts","href":"/api-reference/v2/accounts/update-account"},{"title":"Create account","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/accounts","href":"/api-reference/v2/accounts/create-account"}]},{"group":"Aging Reports","pages":[{"title":"List aging reports","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/aging-reports","href":"/api-reference/v2/aging-reports/list-aging-reports"}]},{"group":"Alerts","pages":[{"title":"List alerts","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/alerts","href":"/api-reference/v2/alerts/list-alerts"},{"title":"Create alert","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/alerts","href":"/api-reference/v2/alerts/create-alert"},{"title":"Delete alert","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json delete /connections/{connection_id}/alerts","href":"/api-reference/v2/alerts/delete-alert"}]},{"group":"Ar Refund Credit Cards","pages":[{"title":"List ar refund credit cards","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/ar-refund-credit-cards","href":"/api-reference/v2/ar-refund-credit-cards/list-ar-refund-credit-cards"},{"title":"Create ar refund credit card","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/ar-refund-credit-cards","href":"/api-reference/v2/ar-refund-credit-cards/create-ar-refund-credit-card"}]},{"group":"Bar Codes","pages":[{"title":"List bar codes","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/bar-codes","href":"/api-reference/v2/bar-codes/list-bar-codes"}]},{"group":"Bill Payment Checks","pages":[{"title":"List bill payment checks","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/bill-payment-checks","href":"/api-reference/v2/bill-payment-checks/list-bill-payment-checks"},{"title":"Update bill payment check","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/bill-payment-checks","href":"/api-reference/v2/bill-payment-checks/update-bill-payment-check"},{"title":"Create bill payment check","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/bill-payment-checks","href":"/api-reference/v2/bill-payment-checks/create-bill-payment-check"}]},{"group":"Bill Payment Credit Cards","pages":[{"title":"List bill payment credit cards","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/bill-payment-credit-cards","href":"/api-reference/v2/bill-payment-credit-cards/list-bill-payment-credit-cards"},{"title":"Create bill payment credit card","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/bill-payment-credit-cards","href":"/api-reference/v2/bill-payment-credit-cards/create-bill-payment-credit-card"}]},{"group":"Bill To Pays","pages":[{"title":"List bill to pays","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/bill-to-pays","href":"/api-reference/v2/bill-to-pays/list-bill-to-pays"}]},{"group":"Billing Rates","pages":[{"title":"List billing rates","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/billing-rates","href":"/api-reference/v2/billing-rates/list-billing-rates"},{"title":"Create billing rate","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/billing-rates","href":"/api-reference/v2/billing-rates/create-billing-rate"}]},{"group":"Bills","pages":[{"title":"List bills","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/bills","href":"/api-reference/v2/bills/list-bills"},{"title":"Update bill","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/bills","href":"/api-reference/v2/bills/update-bill"},{"title":"Create bill","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/bills","href":"/api-reference/v2/bills/create-bill"}]},{"group":"Budget Summary Reports","pages":[{"title":"List budget summary reports","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/budget-summary-reports","href":"/api-reference/v2/budget-summary-reports/list-budget-summary-reports"}]},{"group":"Build Assemblies","pages":[{"title":"List build assemblies","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/build-assemblies","href":"/api-reference/v2/build-assemblies/list-build-assemblies"},{"title":"Update build assembly","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/build-assemblies","href":"/api-reference/v2/build-assemblies/update-build-assembly"},{"title":"Create build assembly","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/build-assemblies","href":"/api-reference/v2/build-assemblies/create-build-assembly"}]},{"group":"Charges","pages":[{"title":"List charges","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/charges","href":"/api-reference/v2/charges/list-charges"},{"title":"Update charge","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/charges","href":"/api-reference/v2/charges/update-charge"},{"title":"Create charge","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/charges","href":"/api-reference/v2/charges/create-charge"}]},{"group":"Checks","pages":[{"title":"List checks","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/checks","href":"/api-reference/v2/checks/list-checks"},{"title":"Update check","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/checks","href":"/api-reference/v2/checks/update-check"},{"title":"Create check","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/checks","href":"/api-reference/v2/checks/create-check"}]},{"group":"Classes","pages":[{"title":"List classes","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/classes","href":"/api-reference/v2/classes/list-classes"},{"title":"Update class","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/classes","href":"/api-reference/v2/classes/update-class"},{"title":"Create class","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/classes","href":"/api-reference/v2/classes/create-class"}]},{"group":"Cleared Statuses","pages":[{"title":"Update cleared status","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/cleared-statuses","href":"/api-reference/v2/cleared-statuses/update-cleared-status"}]},{"group":"Companies","pages":[{"title":"List companies","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/companies","href":"/api-reference/v2/companies/list-companies"}]},{"group":"Company Activities","pages":[{"title":"List company activities","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/company-activities","href":"/api-reference/v2/company-activities/list-company-activities"}]},{"group":"Credit Card Charges","pages":[{"title":"List credit card charges","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/credit-card-charges","href":"/api-reference/v2/credit-card-charges/list-credit-card-charges"},{"title":"Update credit card charge","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/credit-card-charges","href":"/api-reference/v2/credit-card-charges/update-credit-card-charge"},{"title":"Create credit card charge","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/credit-card-charges","href":"/api-reference/v2/credit-card-charges/create-credit-card-charge"}]},{"group":"Credit Card Credits","pages":[{"title":"List credit card credits","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/credit-card-credits","href":"/api-reference/v2/credit-card-credits/list-credit-card-credits"},{"title":"Update credit card credit","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/credit-card-credits","href":"/api-reference/v2/credit-card-credits/update-credit-card-credit"},{"title":"Create credit card credit","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/credit-card-credits","href":"/api-reference/v2/credit-card-credits/create-credit-card-credit"}]},{"group":"Credit Memos","pages":[{"title":"List credit memos","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/credit-memos","href":"/api-reference/v2/credit-memos/list-credit-memos"},{"title":"Update credit memo","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/credit-memos","href":"/api-reference/v2/credit-memos/update-credit-memo"},{"title":"Create credit memo","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/credit-memos","href":"/api-reference/v2/credit-memos/create-credit-memo"}]},{"group":"Currencies","pages":[{"title":"List currencies","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/currencies","href":"/api-reference/v2/currencies/list-currencies"},{"title":"Update currency","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/currencies","href":"/api-reference/v2/currencies/update-currency"},{"title":"Create currency","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/currencies","href":"/api-reference/v2/currencies/create-currency"}]},{"group":"Custom Detail Reports","pages":[{"title":"List custom detail reports","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/custom-detail-reports","href":"/api-reference/v2/custom-detail-reports/list-custom-detail-reports"}]},{"group":"Custom Summary Reports","pages":[{"title":"List custom summary reports","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/custom-summary-reports","href":"/api-reference/v2/custom-summary-reports/list-custom-summary-reports"}]},{"group":"Customer Msgs","pages":[{"title":"List customer msgs","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/customer-msgs","href":"/api-reference/v2/customer-msgs/list-customer-msgs"},{"title":"Create customer msg","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/customer-msgs","href":"/api-reference/v2/customer-msgs/create-customer-msg"}]},{"group":"Customer Types","pages":[{"title":"List customer types","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/customer-types","href":"/api-reference/v2/customer-types/list-customer-types"},{"title":"Create customer type","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/customer-types","href":"/api-reference/v2/customer-types/create-customer-type"}]},{"group":"Customers","pages":[{"title":"List customers","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/customers","href":"/api-reference/v2/customers/list-customers"},{"title":"Update customer","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/customers","href":"/api-reference/v2/customers/update-customer"},{"title":"Create customer","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/customers","href":"/api-reference/v2/customers/create-customer"}]},{"group":"Data Event Recovery Infos","pages":[{"title":"List data event recovery infos","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/data-event-recovery-infos","href":"/api-reference/v2/data-event-recovery-infos/list-data-event-recovery-infos"},{"title":"Delete data event recovery info","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json delete /connections/{connection_id}/data-event-recovery-infos","href":"/api-reference/v2/data-event-recovery-infos/delete-data-event-recovery-info"}]},{"group":"Data Ext Defs","pages":[{"title":"List data ext defs","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/data-ext-defs","href":"/api-reference/v2/data-ext-defs/list-data-ext-defs"},{"title":"Update data ext def","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/data-ext-defs","href":"/api-reference/v2/data-ext-defs/update-data-ext-def"},{"title":"Create data ext def","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/data-ext-defs","href":"/api-reference/v2/data-ext-defs/create-data-ext-def"},{"title":"Delete data ext def","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json delete /connections/{connection_id}/data-ext-defs","href":"/api-reference/v2/data-ext-defs/delete-data-ext-def"}]},{"group":"Data Exts","pages":[{"title":"Update data ext","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/data-exts","href":"/api-reference/v2/data-exts/update-data-ext"},{"title":"Create data ext","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/data-exts","href":"/api-reference/v2/data-exts/create-data-ext"},{"title":"Delete data ext","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json delete /connections/{connection_id}/data-exts","href":"/api-reference/v2/data-exts/delete-data-ext"}]},{"group":"Date Driven Terms","pages":[{"title":"List date driven terms","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/date-driven-terms","href":"/api-reference/v2/date-driven-terms/list-date-driven-terms"},{"title":"Create date driven terms","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/date-driven-terms","href":"/api-reference/v2/date-driven-terms/create-date-driven-terms"}]},{"group":"Deposits","pages":[{"title":"List deposits","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/deposits","href":"/api-reference/v2/deposits/list-deposits"},{"title":"Update deposit","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/deposits","href":"/api-reference/v2/deposits/update-deposit"},{"title":"Create deposit","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/deposits","href":"/api-reference/v2/deposits/create-deposit"}]},{"group":"Employee Defaults","pages":[{"title":"List employee defaults","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/employee-defaults","href":"/api-reference/v2/employee-defaults/list-employee-defaults"},{"title":"Update employee default","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/employee-defaults","href":"/api-reference/v2/employee-defaults/update-employee-default"}]},{"group":"Employees","pages":[{"title":"List employees","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/employees","href":"/api-reference/v2/employees/list-employees"},{"title":"Update employee","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/employees","href":"/api-reference/v2/employees/update-employee"},{"title":"Create employee","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/employees","href":"/api-reference/v2/employees/create-employee"}]},{"group":"Entities","pages":[{"title":"List entities","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/entities","href":"/api-reference/v2/entities/list-entities"}]},{"group":"Estimates","pages":[{"title":"List estimates","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/estimates","href":"/api-reference/v2/estimates/list-estimates"},{"title":"Update estimate","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/estimates","href":"/api-reference/v2/estimates/update-estimate"},{"title":"Create estimate","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/estimates","href":"/api-reference/v2/estimates/create-estimate"}]},{"group":"Form1099 Category Account Mappings","pages":[{"title":"List form1099 category account mappings","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/form1099-category-account-mappings","href":"/api-reference/v2/form1099-category-account-mappings/list-form1099-category-account-mappings"},{"title":"Update form1099 category account mapping","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/form1099-category-account-mappings","href":"/api-reference/v2/form1099-category-account-mappings/update-form1099-category-account-mapping"}]},{"group":"General Detail Reports","pages":[{"title":"List general detail reports","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/general-detail-reports","href":"/api-reference/v2/general-detail-reports/list-general-detail-reports"}]},{"group":"General Summary Reports","pages":[{"title":"List general summary reports","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/general-summary-reports","href":"/api-reference/v2/general-summary-reports/list-general-summary-reports"}]},{"group":"Hosts","pages":[{"title":"List hosts","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/hosts","href":"/api-reference/v2/hosts/list-hosts"}]},{"group":"Inventory Adjustments","pages":[{"title":"List inventory adjustments","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/inventory-adjustments","href":"/api-reference/v2/inventory-adjustments/list-inventory-adjustments"},{"title":"Update inventory adjustment","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/inventory-adjustments","href":"/api-reference/v2/inventory-adjustments/update-inventory-adjustment"},{"title":"Create inventory adjustment","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/inventory-adjustments","href":"/api-reference/v2/inventory-adjustments/create-inventory-adjustment"}]},{"group":"Inventory Sites","pages":[{"title":"List inventory sites","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/inventory-sites","href":"/api-reference/v2/inventory-sites/list-inventory-sites"},{"title":"Update inventory site","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/inventory-sites","href":"/api-reference/v2/inventory-sites/update-inventory-site"},{"title":"Create inventory site","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/inventory-sites","href":"/api-reference/v2/inventory-sites/create-inventory-site"}]},{"group":"Invoices","pages":[{"title":"List invoices","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/invoices","href":"/api-reference/v2/invoices/list-invoices"},{"title":"Update invoice","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/invoices","href":"/api-reference/v2/invoices/update-invoice"},{"title":"Create invoice","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/invoices","href":"/api-reference/v2/invoices/create-invoice"}]},{"group":"Item Assemblies Can Builds","pages":[{"title":"List item assemblies can builds","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/item-assemblies-can-builds","href":"/api-reference/v2/item-assemblies-can-builds/list-item-assemblies-can-builds"}]},{"group":"Item Discounts","pages":[{"title":"List item discounts","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/item-discounts","href":"/api-reference/v2/item-discounts/list-item-discounts"},{"title":"Update item discount","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/item-discounts","href":"/api-reference/v2/item-discounts/update-item-discount"},{"title":"Create item discount","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/item-discounts","href":"/api-reference/v2/item-discounts/create-item-discount"}]},{"group":"Item Fixed Assets","pages":[{"title":"List item fixed assets","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/item-fixed-assets","href":"/api-reference/v2/item-fixed-assets/list-item-fixed-assets"},{"title":"Update item fixed asset","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/item-fixed-assets","href":"/api-reference/v2/item-fixed-assets/update-item-fixed-asset"},{"title":"Create item fixed asset","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/item-fixed-assets","href":"/api-reference/v2/item-fixed-assets/create-item-fixed-asset"}]},{"group":"Item Groups","pages":[{"title":"List item groups","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/item-groups","href":"/api-reference/v2/item-groups/list-item-groups"},{"title":"Update item group","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/item-groups","href":"/api-reference/v2/item-groups/update-item-group"},{"title":"Create item group","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/item-groups","href":"/api-reference/v2/item-groups/create-item-group"}]},{"group":"Item Inventories","pages":[{"title":"List item inventories","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/item-inventories","href":"/api-reference/v2/item-inventories/list-item-inventories"},{"title":"Update item inventory","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/item-inventories","href":"/api-reference/v2/item-inventories/update-item-inventory"},{"title":"Create item inventory","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/item-inventories","href":"/api-reference/v2/item-inventories/create-item-inventory"}]},{"group":"Item Inventory Assemblies","pages":[{"title":"List item inventory assemblies","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/item-inventory-assemblies","href":"/api-reference/v2/item-inventory-assemblies/list-item-inventory-assemblies"},{"title":"Update item inventory assembly","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/item-inventory-assemblies","href":"/api-reference/v2/item-inventory-assemblies/update-item-inventory-assembly"},{"title":"Create item inventory assembly","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/item-inventory-assemblies","href":"/api-reference/v2/item-inventory-assemblies/create-item-inventory-assembly"}]},{"group":"Item Non Inventories","pages":[{"title":"List item non inventories","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/item-non-inventories","href":"/api-reference/v2/item-non-inventories/list-item-non-inventories"},{"title":"Update item non inventory","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/item-non-inventories","href":"/api-reference/v2/item-non-inventories/update-item-non-inventory"},{"title":"Create item non inventory","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/item-non-inventories","href":"/api-reference/v2/item-non-inventories/create-item-non-inventory"}]},{"group":"Item Other Charges","pages":[{"title":"List item other charges","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/item-other-charges","href":"/api-reference/v2/item-other-charges/list-item-other-charges"},{"title":"Update item other charge","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/item-other-charges","href":"/api-reference/v2/item-other-charges/update-item-other-charge"},{"title":"Create item other charge","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/item-other-charges","href":"/api-reference/v2/item-other-charges/create-item-other-charge"}]},{"group":"Item Payments","pages":[{"title":"List item payments","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/item-payments","href":"/api-reference/v2/item-payments/list-item-payments"},{"title":"Update item payment","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/item-payments","href":"/api-reference/v2/item-payments/update-item-payment"},{"title":"Create item payment","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/item-payments","href":"/api-reference/v2/item-payments/create-item-payment"}]},{"group":"Item Receipts","pages":[{"title":"List item receipts","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/item-receipts","href":"/api-reference/v2/item-receipts/list-item-receipts"},{"title":"Update item receipt","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/item-receipts","href":"/api-reference/v2/item-receipts/update-item-receipt"},{"title":"Create item receipt","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/item-receipts","href":"/api-reference/v2/item-receipts/create-item-receipt"}]},{"group":"Item Sales Tax Groups","pages":[{"title":"List item sales tax groups","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/item-sales-tax-groups","href":"/api-reference/v2/item-sales-tax-groups/list-item-sales-tax-groups"},{"title":"Update item sales tax group","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/item-sales-tax-groups","href":"/api-reference/v2/item-sales-tax-groups/update-item-sales-tax-group"},{"title":"Create item sales tax group","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/item-sales-tax-groups","href":"/api-reference/v2/item-sales-tax-groups/create-item-sales-tax-group"}]},{"group":"Item Sales Taxes","pages":[{"title":"List item sales taxes","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/item-sales-taxes","href":"/api-reference/v2/item-sales-taxes/list-item-sales-taxes"},{"title":"Update item sales tax","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/item-sales-taxes","href":"/api-reference/v2/item-sales-taxes/update-item-sales-tax"},{"title":"Create item sales tax","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/item-sales-taxes","href":"/api-reference/v2/item-sales-taxes/create-item-sales-tax"}]},{"group":"Item Services","pages":[{"title":"List item services","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/item-services","href":"/api-reference/v2/item-services/list-item-services"},{"title":"Update item service","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/item-services","href":"/api-reference/v2/item-services/update-item-service"},{"title":"Create item service","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/item-services","href":"/api-reference/v2/item-services/create-item-service"}]},{"group":"Item Sites","pages":[{"title":"List item sites","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/item-sites","href":"/api-reference/v2/item-sites/list-item-sites"}]},{"group":"Item Subtotals","pages":[{"title":"List item subtotals","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/item-subtotals","href":"/api-reference/v2/item-subtotals/list-item-subtotals"},{"title":"Update item subtotal","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/item-subtotals","href":"/api-reference/v2/item-subtotals/update-item-subtotal"},{"title":"Create item subtotal","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/item-subtotals","href":"/api-reference/v2/item-subtotals/create-item-subtotal"}]},{"group":"Items","pages":[{"title":"List items","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/items","href":"/api-reference/v2/items/list-items"}]},{"group":"Job Reports","pages":[{"title":"List job reports","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/job-reports","href":"/api-reference/v2/job-reports/list-job-reports"}]},{"group":"Job Types","pages":[{"title":"List job types","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/job-types","href":"/api-reference/v2/job-types/list-job-types"},{"title":"Create job type","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/job-types","href":"/api-reference/v2/job-types/create-job-type"}]},{"group":"Journal Entries","pages":[{"title":"List journal entries","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/journal-entries","href":"/api-reference/v2/journal-entries/list-journal-entries"},{"title":"Update journal entry","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/journal-entries","href":"/api-reference/v2/journal-entries/update-journal-entry"},{"title":"Create journal entry","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/journal-entries","href":"/api-reference/v2/journal-entries/create-journal-entry"}]},{"group":"Leads","pages":[{"title":"List leads","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/leads","href":"/api-reference/v2/leads/list-leads"},{"title":"Update lead","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/leads","href":"/api-reference/v2/leads/update-lead"},{"title":"Create lead","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/leads","href":"/api-reference/v2/leads/create-lead"}]},{"group":"List Deleteds","pages":[{"title":"List list deleteds","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/list-deleteds","href":"/api-reference/v2/list-deleteds/list-list-deleteds"}]},{"group":"List Displays","pages":[{"title":"Update list display","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/list-displays","href":"/api-reference/v2/list-displays/update-list-display"},{"title":"Create list display","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/list-displays","href":"/api-reference/v2/list-displays/create-list-display"}]},{"group":"List Merge","pages":[{"title":"Execute list merge","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/list-merge","href":"/api-reference/v2/list-merge/execute-list-merge"}]},{"group":"Lists","pages":[{"title":"Delete list","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json delete /connections/{connection_id}/lists","href":"/api-reference/v2/lists/delete-list"}]},{"group":"Other Names","pages":[{"title":"List other names","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/other-names","href":"/api-reference/v2/other-names/list-other-names"},{"title":"Update other name","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/other-names","href":"/api-reference/v2/other-names/update-other-name"},{"title":"Create other name","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/other-names","href":"/api-reference/v2/other-names/create-other-name"}]},{"group":"Paychecks","pages":[{"title":"List paychecks","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/paychecks","href":"/api-reference/v2/paychecks/list-paychecks"}]},{"group":"Payment Methods","pages":[{"title":"List payment methods","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/payment-methods","href":"/api-reference/v2/payment-methods/list-payment-methods"},{"title":"Create payment method","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/payment-methods","href":"/api-reference/v2/payment-methods/create-payment-method"}]},{"group":"Payments","pages":[{"title":"Record payment","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/payments","href":"/api-reference/v2/payments/record-payment"}]},{"group":"Payroll Detail Reports","pages":[{"title":"List payroll detail reports","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/payroll-detail-reports","href":"/api-reference/v2/payroll-detail-reports/list-payroll-detail-reports"}]},{"group":"Payroll Item Additions","pages":[{"title":"Update payroll item addition","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/payroll-item-additions","href":"/api-reference/v2/payroll-item-additions/update-payroll-item-addition"},{"title":"Create payroll item addition","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/payroll-item-additions","href":"/api-reference/v2/payroll-item-additions/create-payroll-item-addition"}]},{"group":"Payroll Item Company Contributions","pages":[{"title":"Update payroll item company contribution","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/payroll-item-company-contributions","href":"/api-reference/v2/payroll-item-company-contributions/update-payroll-item-company-contribution"},{"title":"Create payroll item company contribution","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/payroll-item-company-contributions","href":"/api-reference/v2/payroll-item-company-contributions/create-payroll-item-company-contribution"}]},{"group":"Payroll Item Deductions","pages":[{"title":"Update payroll item deduction","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/payroll-item-deductions","href":"/api-reference/v2/payroll-item-deductions/update-payroll-item-deduction"},{"title":"Create payroll item deduction","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/payroll-item-deductions","href":"/api-reference/v2/payroll-item-deductions/create-payroll-item-deduction"}]},{"group":"Payroll Item Direct Deposits","pages":[{"title":"Update payroll item direct deposit","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/payroll-item-direct-deposits","href":"/api-reference/v2/payroll-item-direct-deposits/update-payroll-item-direct-deposit"},{"title":"Create payroll item direct deposit","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/payroll-item-direct-deposits","href":"/api-reference/v2/payroll-item-direct-deposits/create-payroll-item-direct-deposit"}]},{"group":"Payroll Item Non Wages","pages":[{"title":"List payroll item non wages","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/payroll-item-non-wages","href":"/api-reference/v2/payroll-item-non-wages/list-payroll-item-non-wages"}]},{"group":"Payroll Item Taxes","pages":[{"title":"Update payroll item tax","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/payroll-item-taxes","href":"/api-reference/v2/payroll-item-taxes/update-payroll-item-tax"},{"title":"Create payroll item tax","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/payroll-item-taxes","href":"/api-reference/v2/payroll-item-taxes/create-payroll-item-tax"}]},{"group":"Payroll Item Wages","pages":[{"title":"List payroll item wages","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/payroll-item-wages","href":"/api-reference/v2/payroll-item-wages/list-payroll-item-wages"},{"title":"Update payroll item wage","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/payroll-item-wages","href":"/api-reference/v2/payroll-item-wages/update-payroll-item-wage"},{"title":"Create payroll item wage","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/payroll-item-wages","href":"/api-reference/v2/payroll-item-wages/create-payroll-item-wage"}]},{"group":"Payroll Item Workers Compensations","pages":[{"title":"Update payroll item workers compensation","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/payroll-item-workers-compensations","href":"/api-reference/v2/payroll-item-workers-compensations/update-payroll-item-workers-compensation"},{"title":"Create payroll item workers compensation","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/payroll-item-workers-compensations","href":"/api-reference/v2/payroll-item-workers-compensations/create-payroll-item-workers-compensation"}]},{"group":"Payroll Items","pages":[{"title":"List payroll items","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/payroll-items","href":"/api-reference/v2/payroll-items/list-payroll-items"}]},{"group":"Payroll Last Periods","pages":[{"title":"List payroll last periods","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/payroll-last-periods","href":"/api-reference/v2/payroll-last-periods/list-payroll-last-periods"}]},{"group":"Payroll Liability Adjustments","pages":[{"title":"List payroll liability adjustments","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/payroll-liability-adjustments","href":"/api-reference/v2/payroll-liability-adjustments/list-payroll-liability-adjustments"},{"title":"Create payroll liability adjustment","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/payroll-liability-adjustments","href":"/api-reference/v2/payroll-liability-adjustments/create-payroll-liability-adjustment"}]},{"group":"Payroll Liability Checks","pages":[{"title":"List payroll liability checks","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/payroll-liability-checks","href":"/api-reference/v2/payroll-liability-checks/list-payroll-liability-checks"}]},{"group":"Payroll Prior Payments","pages":[{"title":"List payroll prior payments","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/payroll-prior-payments","href":"/api-reference/v2/payroll-prior-payments/list-payroll-prior-payments"},{"title":"Create payroll prior payment","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/payroll-prior-payments","href":"/api-reference/v2/payroll-prior-payments/create-payroll-prior-payment"}]},{"group":"Payroll Summary Reports","pages":[{"title":"List payroll summary reports","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/payroll-summary-reports","href":"/api-reference/v2/payroll-summary-reports/list-payroll-summary-reports"}]},{"group":"Payroll Year To Date Adjustments","pages":[{"title":"List payroll year to date adjustments","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/payroll-year-to-date-adjustments","href":"/api-reference/v2/payroll-year-to-date-adjustments/list-payroll-year-to-date-adjustments"},{"title":"Create payroll year to date adjustment","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/payroll-year-to-date-adjustments","href":"/api-reference/v2/payroll-year-to-date-adjustments/create-payroll-year-to-date-adjustment"}]},{"group":"Preferences","pages":[{"title":"List preferences","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/preferences","href":"/api-reference/v2/preferences/list-preferences"},{"title":"Update preferences","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/preferences","href":"/api-reference/v2/preferences/update-preferences"}]},{"group":"Price Levels","pages":[{"title":"List price levels","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/price-levels","href":"/api-reference/v2/price-levels/list-price-levels"},{"title":"Update price level","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/price-levels","href":"/api-reference/v2/price-levels/update-price-level"},{"title":"Create price level","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/price-levels","href":"/api-reference/v2/price-levels/create-price-level"}]},{"group":"Purchase Orders","pages":[{"title":"List purchase orders","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/purchase-orders","href":"/api-reference/v2/purchase-orders/list-purchase-orders"},{"title":"Update purchase order","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/purchase-orders","href":"/api-reference/v2/purchase-orders/update-purchase-order"},{"title":"Create purchase order","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/purchase-orders","href":"/api-reference/v2/purchase-orders/create-purchase-order"}]},{"group":"Qb Command Exec","pages":[{"title":"Execute QB command exec","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/qb-command-exec","href":"/api-reference/v2/qb-command-exec/execute-qb-command-exec"}]},{"group":"Receive Payment To Deposits","pages":[{"title":"List receive payment to deposits","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/receive-payment-to-deposits","href":"/api-reference/v2/receive-payment-to-deposits/list-receive-payment-to-deposits"}]},{"group":"Receive Payments","pages":[{"title":"List receive payments","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/receive-payments","href":"/api-reference/v2/receive-payments/list-receive-payments"},{"title":"Update receive payment","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/receive-payments","href":"/api-reference/v2/receive-payments/update-receive-payment"}]},{"group":"Sales Orders","pages":[{"title":"List sales orders","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/sales-orders","href":"/api-reference/v2/sales-orders/list-sales-orders"},{"title":"Update sales order","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/sales-orders","href":"/api-reference/v2/sales-orders/update-sales-order"},{"title":"Create sales order","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/sales-orders","href":"/api-reference/v2/sales-orders/create-sales-order"}]},{"group":"Sales Receipts","pages":[{"title":"List sales receipts","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/sales-receipts","href":"/api-reference/v2/sales-receipts/list-sales-receipts"},{"title":"Update sales receipt","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/sales-receipts","href":"/api-reference/v2/sales-receipts/update-sales-receipt"},{"title":"Create sales receipt","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/sales-receipts","href":"/api-reference/v2/sales-receipts/create-sales-receipt"}]},{"group":"Sales Reps","pages":[{"title":"List sales reps","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/sales-reps","href":"/api-reference/v2/sales-reps/list-sales-reps"},{"title":"Update sales rep","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/sales-reps","href":"/api-reference/v2/sales-reps/update-sales-rep"},{"title":"Create sales rep","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/sales-reps","href":"/api-reference/v2/sales-reps/create-sales-rep"}]},{"group":"Sales Tax Codes","pages":[{"title":"List sales tax codes","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/sales-tax-codes","href":"/api-reference/v2/sales-tax-codes/list-sales-tax-codes"},{"title":"Update sales tax code","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/sales-tax-codes","href":"/api-reference/v2/sales-tax-codes/update-sales-tax-code"},{"title":"Create sales tax code","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/sales-tax-codes","href":"/api-reference/v2/sales-tax-codes/create-sales-tax-code"}]},{"group":"Sales Tax Payables","pages":[{"title":"List sales tax payables","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/sales-tax-payables","href":"/api-reference/v2/sales-tax-payables/list-sales-tax-payables"}]},{"group":"Sales Tax Payment Checks","pages":[{"title":"List sales tax payment checks","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/sales-tax-payment-checks","href":"/api-reference/v2/sales-tax-payment-checks/list-sales-tax-payment-checks"},{"title":"Update sales tax payment check","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/sales-tax-payment-checks","href":"/api-reference/v2/sales-tax-payment-checks/update-sales-tax-payment-check"},{"title":"Create sales tax payment check","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/sales-tax-payment-checks","href":"/api-reference/v2/sales-tax-payment-checks/create-sales-tax-payment-check"}]},{"group":"Sales Tax Return Lines","pages":[{"title":"List sales tax return lines","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/sales-tax-return-lines","href":"/api-reference/v2/sales-tax-return-lines/list-sales-tax-return-lines"}]},{"group":"Sales Tax Returns","pages":[{"title":"List sales tax returns","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/sales-tax-returns","href":"/api-reference/v2/sales-tax-returns/list-sales-tax-returns"}]},{"group":"Ship Methods","pages":[{"title":"List ship methods","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/ship-methods","href":"/api-reference/v2/ship-methods/list-ship-methods"},{"title":"Create ship method","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/ship-methods","href":"/api-reference/v2/ship-methods/create-ship-method"}]},{"group":"Special Accounts","pages":[{"title":"Create special account","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/special-accounts","href":"/api-reference/v2/special-accounts/create-special-account"}]},{"group":"Special Items","pages":[{"title":"Create special item","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/special-items","href":"/api-reference/v2/special-items/create-special-item"}]},{"group":"Standard Terms","pages":[{"title":"List standard terms","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/standard-terms","href":"/api-reference/v2/standard-terms/list-standard-terms"},{"title":"Create standard terms","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/standard-terms","href":"/api-reference/v2/standard-terms/create-standard-terms"}]},{"group":"Templates","pages":[{"title":"List templates","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/templates","href":"/api-reference/v2/templates/list-templates"}]},{"group":"Terms","pages":[{"title":"List terms","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/terms","href":"/api-reference/v2/terms/list-terms"}]},{"group":"Time Reports","pages":[{"title":"List time reports","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/time-reports","href":"/api-reference/v2/time-reports/list-time-reports"}]},{"group":"Time Trackings","pages":[{"title":"List time trackings","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/time-trackings","href":"/api-reference/v2/time-trackings/list-time-trackings"},{"title":"Update time tracking","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/time-trackings","href":"/api-reference/v2/time-trackings/update-time-tracking"},{"title":"Create time tracking","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/time-trackings","href":"/api-reference/v2/time-trackings/create-time-tracking"}]},{"group":"To Dos","pages":[{"title":"List to dos","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/to-dos","href":"/api-reference/v2/to-dos/list-to-dos"},{"title":"Update to do","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/to-dos","href":"/api-reference/v2/to-dos/update-to-do"},{"title":"Create to do","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/to-dos","href":"/api-reference/v2/to-dos/create-to-do"}]},{"group":"Transactions","pages":[{"title":"List transactions","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/transactions","href":"/api-reference/v2/transactions/list-transactions"}]},{"group":"Transfer Inventories","pages":[{"title":"List transfer inventories","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/transfer-inventories","href":"/api-reference/v2/transfer-inventories/list-transfer-inventories"},{"title":"Update transfer inventory","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/transfer-inventories","href":"/api-reference/v2/transfer-inventories/update-transfer-inventory"},{"title":"Create transfer inventory","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/transfer-inventories","href":"/api-reference/v2/transfer-inventories/create-transfer-inventory"}]},{"group":"Transfers","pages":[{"title":"List transfers","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/transfers","href":"/api-reference/v2/transfers/list-transfers"},{"title":"Update transfer","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/transfers","href":"/api-reference/v2/transfers/update-transfer"},{"title":"Create transfer","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/transfers","href":"/api-reference/v2/transfers/create-transfer"}]},{"group":"Txn Deleteds","pages":[{"title":"List txn deleteds","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/txn-deleteds","href":"/api-reference/v2/txn-deleteds/list-txn-deleteds"}]},{"group":"Txn Displays","pages":[{"title":"Update txn display","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/txn-displays","href":"/api-reference/v2/txn-displays/update-txn-display"},{"title":"Create txn display","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/txn-displays","href":"/api-reference/v2/txn-displays/create-txn-display"}]},{"group":"Txn Void","pages":[{"title":"Execute txn void","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/txn-void","href":"/api-reference/v2/txn-void/execute-txn-void"}]},{"group":"Txns","pages":[{"title":"Delete txn","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json delete /connections/{connection_id}/txns","href":"/api-reference/v2/txns/delete-txn"}]},{"group":"Unit Of Measure Sets","pages":[{"title":"List unit of measure sets","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/unit-of-measure-sets","href":"/api-reference/v2/unit-of-measure-sets/list-unit-of-measure-sets"},{"title":"Create unit of measure set","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/unit-of-measure-sets","href":"/api-reference/v2/unit-of-measure-sets/create-unit-of-measure-set"}]},{"group":"Vehicle Mileages","pages":[{"title":"List vehicle mileages","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/vehicle-mileages","href":"/api-reference/v2/vehicle-mileages/list-vehicle-mileages"},{"title":"Create vehicle mileage","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/vehicle-mileages","href":"/api-reference/v2/vehicle-mileages/create-vehicle-mileage"}]},{"group":"Vehicles","pages":[{"title":"List vehicles","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/vehicles","href":"/api-reference/v2/vehicles/list-vehicles"},{"title":"Update vehicle","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/vehicles","href":"/api-reference/v2/vehicles/update-vehicle"},{"title":"Create vehicle","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/vehicles","href":"/api-reference/v2/vehicles/create-vehicle"}]},{"group":"Vendor Credits","pages":[{"title":"List vendor credits","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/vendor-credits","href":"/api-reference/v2/vendor-credits/list-vendor-credits"},{"title":"Update vendor credit","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/vendor-credits","href":"/api-reference/v2/vendor-credits/update-vendor-credit"},{"title":"Create vendor credit","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/vendor-credits","href":"/api-reference/v2/vendor-credits/create-vendor-credit"}]},{"group":"Vendor Types","pages":[{"title":"List vendor types","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/vendor-types","href":"/api-reference/v2/vendor-types/list-vendor-types"},{"title":"Create vendor type","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/vendor-types","href":"/api-reference/v2/vendor-types/create-vendor-type"}]},{"group":"Vendors","pages":[{"title":"List vendors","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/vendors","href":"/api-reference/v2/vendors/list-vendors"},{"title":"Update vendor","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/vendors","href":"/api-reference/v2/vendors/update-vendor"},{"title":"Create vendor","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/vendors","href":"/api-reference/v2/vendors/create-vendor"}]},{"group":"Workers Comp Codes","pages":[{"title":"List workers comp codes","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json get /connections/{connection_id}/workers-comp-codes","href":"/api-reference/v2/workers-comp-codes/list-workers-comp-codes"},{"title":"Update workers comp code","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json put /connections/{connection_id}/workers-comp-codes","href":"/api-reference/v2/workers-comp-codes/update-workers-comp-code"},{"title":"Create workers comp code","deprecated":null,"version":null,"openapi":"/api-reference/v2/openapi.json post /connections/{connection_id}/workers-comp-codes","href":"/api-reference/v2/workers-comp-codes/create-workers-comp-code"}]}]},{"group":"API v1 (legacy)","pages":[{"group":"Connections","pages":[{"title":"List all connections","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /connections","href":"/api-reference/v1/connections/list-all-connections"},{"title":"Create a new connection","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json post /connections","href":"/api-reference/v1/connections/create-a-new-connection"},{"title":"Get connection by ID","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /connections/{connection_id}","href":"/api-reference/v1/connections/get-connection-by-id"},{"title":"Delete a connection","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json delete /connections/{connection_id}","href":"/api-reference/v1/connections/delete-a-connection"},{"title":"Generate or set password for a connection","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json post /connections/{connection_id}/password","href":"/api-reference/v1/connections/generate-or-set-password-for-a-connection"},{"title":"Get QWC file for a connection","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /connections/{connection_id}/qwc","href":"/api-reference/v1/connections/get-qwc-file-for-a-connection"},{"title":"Regenerate onboarding URL for a connection","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json post /connections/{connection_id}/onboarding_url","href":"/api-reference/v1/connections/regenerate-onboarding-url-for-a-connection"}]},{"group":"Queued Requests","pages":[{"title":"List queued requests for a connection","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /connections/{connection_id}/queued_requests","href":"/api-reference/v1/queued-requests/list-queued-requests-for-a-connection"},{"title":"Queue a new request","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json post /connections/{connection_id}/queued_requests","href":"/api-reference/v1/queued-requests/queue-a-new-request"},{"title":"Get queued request by ID","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /queued_requests/{request_id}","href":"/api-reference/v1/queued-requests/get-queued-request-by-id"},{"title":"Delete a queued request","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json delete /queued_requests/{request_id}","href":"/api-reference/v1/queued-requests/delete-a-queued-request"}]},{"group":"Pre-built Queries","pages":[{"title":"Query Customers","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /connections/{connection_id}/customers","href":"/api-reference/v1/pre-built-queries/query-customers"},{"title":"Create Customer","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json post /connections/{connection_id}/customers","href":"/api-reference/v1/pre-built-queries/create-customer"},{"title":"Query Invoices","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /connections/{connection_id}/invoices","href":"/api-reference/v1/pre-built-queries/query-invoices"},{"title":"Create Invoice","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json post /connections/{connection_id}/invoices","href":"/api-reference/v1/pre-built-queries/create-invoice"},{"title":"Query Credit Memos","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /connections/{connection_id}/credit_memos","href":"/api-reference/v1/pre-built-queries/query-credit-memos"},{"title":"Create Credit Memo","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json post /connections/{connection_id}/credit_memos","href":"/api-reference/v1/pre-built-queries/create-credit-memo"},{"title":"Modify Data Extension","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json post /connections/{connection_id}/data_ext_mods","href":"/api-reference/v1/pre-built-queries/modify-data-extension"},{"title":"Query Vendors","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /connections/{connection_id}/vendors","href":"/api-reference/v1/pre-built-queries/query-vendors"},{"title":"Query Sales Orders","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /connections/{connection_id}/sales_orders","href":"/api-reference/v1/pre-built-queries/query-sales-orders"},{"title":"Query Items","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /connections/{connection_id}/items","href":"/api-reference/v1/pre-built-queries/query-items"},{"title":"Query Sales Tax Items","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /connections/{connection_id}/sales_tax_items","href":"/api-reference/v1/pre-built-queries/query-sales-tax-items"},{"title":"Query Sales Tax Codes","deprecated":null,"version":null,"openapi":"/api-reference/v1/openapi.json get /connections/{connection_id}/sales_tax_codes","href":"/api-reference/v1/pre-built-queries/query-sales-tax-codes"}]}]}]}]},"basePath":"","title":"How to use a workflow - QuBe Sync","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}