{
"error": {
"code": "validation_error",
"message": "The request is invalid. details lists up to 20 field errors. Request bodies are limited to 2 MiB.",
"request_id": "req_example"
}
}
{
"error": {
"code": "invalid_token",
"message": "The bearer token is missing or invalid.",
"request_id": "req_example"
}
}
{
"error": {
"code": "not_found",
"message": "The resource does not exist in the current organization.",
"request_id": "req_example"
}
}
{
"error": {
"code": "conflict",
"message": "conflict: the selection changed since the preview, it is too large, the run cannot be retried, or the Idempotency-Key was used for a different request. nothing_to_check: no pair in the selection can be checked. Nothing was started.",
"request_id": "req_example"
}
}
{
"error": {
"code": "rate_limit_exceeded",
"message": "Too many requests. Wait for the Retry-After delay before retrying.",
"request_id": "req_example"
}
}
{
"error": {
"code": "internal_error",
"message": "Unexpected server failure. Include the request ID when contacting support.",
"request_id": "req_example"
}
}
{
"error": {
"code": "service_unavailable",
"message": "The checks were admitted but not every start was confirmed. Location names an unconfirmed run, and the Idempotency-Key header carries the key (the generated one if you sent none); repeat the request with that key rather than a new one.",
"request_id": "req_example"
}
}
Compliance checks
Start compliance checks
Checks invoices against their matched agreements and purchase orders. A check that completes closes its pair’s current alerts as replaced, keeping their decisions for reference, and opens its findings as new pending alerts; a check that fails changes nothing. One agreement check workflow runs per agreement. Pairs an open claim holds, pairs already being checked and invoices that cannot be checked are always left out; the preview’s exclusions count them. One request starts at most 5,000 agreement checks across 50 agreements, 500 purchase-order checks and 500 duplicate checks, all or nothing; larger selections return 409. A workflow_run_ids entry means a check started, not that it finished: follow each workflow run. Send an Idempotency-Key to repeat a request safely after a lost response.
{
"error": {
"code": "validation_error",
"message": "The request is invalid. details lists up to 20 field errors. Request bodies are limited to 2 MiB.",
"request_id": "req_example"
}
}
{
"error": {
"code": "invalid_token",
"message": "The bearer token is missing or invalid.",
"request_id": "req_example"
}
}
{
"error": {
"code": "not_found",
"message": "The resource does not exist in the current organization.",
"request_id": "req_example"
}
}
{
"error": {
"code": "conflict",
"message": "conflict: the selection changed since the preview, it is too large, the run cannot be retried, or the Idempotency-Key was used for a different request. nothing_to_check: no pair in the selection can be checked. Nothing was started.",
"request_id": "req_example"
}
}
{
"error": {
"code": "rate_limit_exceeded",
"message": "Too many requests. Wait for the Retry-After delay before retrying.",
"request_id": "req_example"
}
}
{
"error": {
"code": "internal_error",
"message": "Unexpected server failure. Include the request ID when contacting support.",
"request_id": "req_example"
}
}
{
"error": {
"code": "service_unavailable",
"message": "The checks were admitted but not every start was confirmed. Location names an unconfirmed run, and the Idempotency-Key header carries the key (the generated one if you sent none); repeat the request with that key rather than a new one.",
"request_id": "req_example"
}
}
Authorizations
Authorization
string
header
required
Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).
Headers
X-Organization-Id
string
The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.
Idempotency-Key
string
Optional protection for safely retrying a request after a timeout or lost response. Choose a unique value (for example, a UUID) for each action and reuse it with the same input when retrying. Omit it for a normal request.
Required string length: 1 - 200
Pattern: ^[\x21-\x7e]+$
Body
application/json
scope
object
required
agreements: agreement_ids, or every agreement filter matches (the whole collection, not a page), minus excluded_agreement_ids; at most 1,000. topics: the invoices behind some topics of one agreement, include_uncategorized adding its alerts without a topic; a pair is handled as a whole, so its alerts in other topics change too (other_topic_alert_count). retry: the failed or cancelled items of an agreement check, with mode again.
Option 1
Option 2
Option 3
Option 4
Option 5
Show child attributes
mode
enum<string>
default:outstanding
outstanding: only pairs (invoice–agreement or invoice–purchase order) without a completed check. again: completed pairs too, replacing their alerts; on an invoices scope it also checks each invoice for duplicates again, replacing its duplicate alerts.
Available options:
outstanding,
again
invoices
object
Which of the scope’s invoices to take: all (minus exclusions), a sample of ten, or a hand-picked set.
Option 1
Option 2
Option 3
Show child attributes
issued_from
string<date>
Only invoices issued on or after this date.
issued_through
string<date>
Only invoices issued on or before this date.
company_ids
string<uuid>[]
Only these workspace companies: their invoices under agreements covering them, as for a member with access to just those companies. Omit for every company the caller can access. An unknown or inaccessible company is 404.
Required array length: 1 - 1000 elements
preview
boolean
default:false
true: return what the command would do and its fingerprint, changing nothing.
fingerprint
string
The fingerprint of a preview. When sent, the command runs only if the selection still resolves to exactly what was previewed; omit it to act on the current state.
Required string length: 64
Response
With preview: true, the preview (CheckSelectionPreview). Otherwise a repeated Idempotency-Key: the original result, with Location naming its first workflow run.
Option 1
Option 2
options
object
required
What each check mode would run in this scope, whichever mode is selected.
Show child attributes
fingerprint
string
required
sample_invoice_ids
string<uuid>[] | null
required
agreements
object[]
required
Show child attributes
invoice_count
integer
required
check_count
integer
required
purchase_order_check_count
integer
required
Invoice–purchase order checks the selection runs, beside the agreement checks.
duplicate_check_count
integer
required
Invoices the selection checks for duplicates again: with mode again on an invoices scope, each of its invoices.
exceeds_limit
boolean
required
maximum_checks
integer
required
maximum_runs
integer
required
exclusions
object[]
required
Invoice–agreement pairs in scope that the selected mode leaves out, by reason.
Show child attributes
other_topic_alert_count
integer
required
Replaced alerts that belong to topics outside a topic scope.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Watchdog Help Center","public":true,"description":"Guides for using Watchdog and integrating with the Watchdog API.","colors":{"primary":"#534AB7","light":"#8892E2","dark":"#6D78D5"},"logo":{"light":"https://mintcdn.com/watchdog-7cea1057/Dh-eFmjGLovXU6Kl/assets/logo-light.svg?fit=max\u0026auto=format\u0026n=Dh-eFmjGLovXU6Kl\u0026q=85\u0026s=86a9912b557a144bb94ec96beb1015f2","dark":"https://mintcdn.com/watchdog-7cea1057/Dh-eFmjGLovXU6Kl/assets/logo-dark.svg?fit=max\u0026auto=format\u0026n=Dh-eFmjGLovXU6Kl\u0026q=85\u0026s=9822ea65fa3bea7cc676786ee0c7cb14","href":"/"},"favicon":"https://mintcdn.com/watchdog-7cea1057/Dh-eFmjGLovXU6Kl/assets/favicon.svg?fit=max\u0026auto=format\u0026n=Dh-eFmjGLovXU6Kl\u0026q=85\u0026s=0a8a123bda5ec654b4d387427a855ec1","api":{"playground":{"display":"none"},"examples":{"defaults":"required","languages":["curl","javascript","python"],"prefill":false,"autogenerate":true},"url":"full"},"footer":{"links":[{"header":"Watchdog","items":[{"label":"Website","href":"https://watchdog.no"},{"label":"Support","href":"mailto:support@watchdog.no"}]}]},"seo":{"metatags":{"canonical":"https://docs.watchdog.no"},"organization":{"name":"Watchdog","url":"https://watchdog.no","logo":"https://docs.watchdog.no/assets/logo-light.svg"},"indexing":"navigable","trailingSlash":false},"contextual":{"options":["copy","view"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Watchdog","icon":"house","href":"https://watchdog.no"}]},"languages":[{"language":"en","default":true,"navbar":{"links":[{"href":"mailto:support@watchdog.no","label":"Support"}],"primary":{"type":"button","label":"Open Watchdog","href":"https://app.watchdog.no"}},"href":""},{"language":"no","footer":{"links":[{"header":"Watchdog","items":[{"label":"Nettside","href":"https://watchdog.no"},{"label":"Kundestøtte","href":"mailto:support@watchdog.no"}]}]},"navbar":{"links":[{"href":"mailto:support@watchdog.no","label":"Kundestøtte"}],"primary":{"type":"button","label":"Åpne Watchdog","href":"https://app.watchdog.no"}},"href":"no"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"watchdog-7cea1057","hasAudioNarration":false,"actualSubdomain":"watchdog-7cea1057","customDomains":["docs.watchdog.no"],"gitSource":{"type":"github","owner":"watchdog-no","repo":"watchdog-monorepo","deployBranch":"main","contentDirectory":"docs/help-center","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6afd9b25fd124ae05f54c66b","clientVersion":"0.0.4177","searchFilterCounts":[{"language":"en","tag":"API","count":300},{"language":"en","tag":"Endpoints","count":282},{"language":"en","tag":"Invoices","count":48},{"language":"en","tag":"Integrations","count":41},{"language":"en","tag":"Agreements","count":36},{"language":"en","tag":"User guides","count":33},{"language":"no","tag":"Brukerveiledninger","count":33},{"language":"en","tag":"Purchase orders","count":31},{"language":"en","tag":"Use Watchdog","count":29},{"language":"no","tag":"Bruk Watchdog","count":29},{"language":"en","tag":"Companies","count":21},{"language":"en","tag":"Documents","count":18},{"language":"no","tag":"Integrasjoner","count":18},{"language":"no","tag":"Bruk Watchdog med KI","count":6},{"language":"no","tag":"Kom i gang","count":3},{"language":"no","tag":"Administrasjon","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"rbac-expansion","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":"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":"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":"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":"editor-metadata","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},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"privacy":{"consentBanner":{"enabled":true}},"googleFontsInlined":false},"customCss":[{"filePath":"snippets/copy-value.css","content":".copy-value-button{opacity:0;transition:opacity 150ms}tr:hover .copy-value-button,.copy-value-button:focus-visible,.copy-value-button[data-copied=\"true\"]{opacity:1}@media (hover: none){.copy-value-button{opacity:1}}"}],"page":{"pagePath":"api-reference/endpoints/compliance-checks/start-compliance-checks","slug":"/api-reference/endpoints/compliance-checks/start-compliance-checks","pageMetadata":{"title":"Start compliance checks","description":"Checks invoices against their matched agreements and purchase orders. A check that completes closes its pair's current alerts as replaced, keeping their decisions for reference, and opens its findings as new pending alerts; a check that fails changes nothing. One agreement check workflow runs per agreement. Pairs an open claim holds, pairs already being checked and invoices that cannot be checked are always left out; the preview's exclusions count them. One request starts at most 5,000 agreement checks across 50 agreements, 500 purchase-order checks and 500 duplicate checks, all or nothing; larger selections return 409. A workflow_run_ids entry means a check started, not that it finished: follow each workflow run. Send an Idempotency-Key to repeat a request safely after a lost response.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/checks","href":"/api-reference/endpoints/compliance-checks/start-compliance-checks","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: \"Checks invoices against their matched agreements and purchase orders. A check that completes closes its pair’s current alerts as replaced, keeping their decisions for reference, and opens its findings as new pending alerts; a check that fails changes nothing. One agreement check workflow runs per agreement. Pairs an open claim holds, pairs already being checked and invoices that cannot be checked are always left out; the preview’s exclusions count them. One request starts at most 5,000 agreement checks across 50 agreements, 500 purchase-order checks and 500 duplicate checks, all or nothing; larger selections return 409. A workflow_run_ids entry means a check started, not that it finished: follow each workflow run. Send an Idempotency-Key to repeat a request safely after a lost response.\"\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":"Start compliance checks","description":"Checks invoices against their matched agreements and purchase orders. A check that completes closes its pair's current alerts as replaced, keeping their decisions for reference, and opens its findings as new pending alerts; a check that fails changes nothing. One agreement check workflow runs per agreement. Pairs an open claim holds, pairs already being checked and invoices that cannot be checked are always left out; the preview's exclusions count them. One request starts at most 5,000 agreement checks across 50 agreements, 500 purchase-order checks and 500 duplicate checks, all or nothing; larger selections return 409. A workflow_run_ids entry means a check started, not that it finished: follow each workflow run. Send an Idempotency-Key to repeat a request safely after a lost response.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/checks","href":"/api-reference/endpoints/compliance-checks/start-compliance-checks","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"startChecks","summary":"Start compliance checks","description":"Checks invoices against their matched agreements and purchase orders. A check that completes closes its pair's current alerts as replaced, keeping their decisions for reference, and opens its findings as new pending alerts; a check that fails changes nothing. One agreement check workflow runs per agreement. Pairs an open claim holds, pairs already being checked and invoices that cannot be checked are always left out; the preview's exclusions count them. One request starts at most 5,000 agreement checks across 50 agreements, 500 purchase-order checks and 500 duplicate checks, all or nothing; larger selections return 409. A workflow_run_ids entry means a check started, not that it finished: follow each workflow run. Send an Idempotency-Key to repeat a request safely after a lost response.","tags":["Compliance checks"],"parameters":["909d4bd9-72f1-440f-a9b0-039e542adf15","9b4f3eb9-4b96-4477-b361-45c362673582"],"security":["e7a42b1b-0801-47bc-ac9c-1ad61f362b7e"],"x-watchdog-access":"scoped","x-watchdog-permission":"write","x-watchdog-authentication":"organization","x-watchdog-public":true,"x-watchdog-mcp":true,"requestBody":"a696e324-4a4f-420c-8266-73c5d029dda7","responses":{"200":"2f2ccb02-566c-471a-a1ae-c25c5f10b122","202":"e4b74473-b061-468f-81bd-490279bb4cd5","400":"d71d85f0-ac1f-4fb3-8c4c-2160ef51e3f6","401":"c4354683-29b8-4f10-bc36-3d6586dd40bc","403":"4992a688-15a8-4acc-ac29-9a90d3ee3073","404":"fb4ab38f-1bed-436c-ac7a-e041702afea8","409":"3631325c-3478-43dc-9424-3da79a63eb84","429":"6c5b2c89-a665-4b1c-ae07-83a26e1a28fa","500":"bcb381c0-74b6-4ba0-b8f1-e36e4adb4572","503":"696576a3-b4a1-4845-b379-190535e85321"},"method":"post","type":"path","servers":["0f259b2e-ff56-4327-8143-523787cf2165"],"path":"/v1/checks","baseUrlOptions":["https://api.watchdog.no"],"title":"Start compliance checks","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","urlDisplay":"full"},"dependencies":{"parameters":{"909d4bd9-72f1-440f-a9b0-039e542adf15":{"name":"X-Organization-Id","in":"header","required":false,"schema":{"type":"string","isRequired":false,"description":"The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.","uniqueKey":"","typeLabel":"string"},"description":"The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations."},"9b4f3eb9-4b96-4477-b361-45c362673582":{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","minLength":1,"maxLength":200,"pattern":"^[\\x21-\\x7e]+$","isRequired":false,"description":"Optional protection for safely retrying a request after a timeout or lost response. Choose a unique value (for example, a UUID) for each action and reuse it with the same input when retrying. Omit it for a normal request.","uniqueKey":"","typeLabel":"string"},"description":"Optional protection for safely retrying a request after a timeout or lost response. Choose a unique value (for example, a UUID) for each action and reuse it with the same input when retrying. Omit it for a normal request."}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"scope":{"oneOf":[{"type":"object","description":"agreements: agreement_ids, or every agreement filter matches (the whole collection, not a page), minus excluded_agreement_ids; at most 1,000. topics: the invoices behind some topics of one agreement, include_uncategorized adding its alerts without a topic; a pair is handled as a whole, so its alerts in other topics change too (other_topic_alert_count). retry: the failed or cancelled items of an agreement check, with mode again.","required":["type","invoice_ids"],"properties":{"type":{"type":"string","enum":["invoices"],"isRequired":true,"uniqueKey":"scope.oneOf.0.type","typeLabel":"enum\u003cstring>"},"invoice_ids":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"scope.oneOf.0.invoice_ids.items.[INDEX]","typeLabel":"string\u003cuuid>"},"minItems":1,"maxItems":1000,"description":"Up to 1,000 invoices. Every agreement matched to one is in scope, and the purchase order accepted for one.","isRequired":true,"uniqueKey":"scope.oneOf.0.invoice_ids","typeLabel":"string\u003cuuid>[]"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"scope.oneOf.0","typeLabel":"object"},{"type":"object","description":"agreements: agreement_ids, or every agreement filter matches (the whole collection, not a page), minus excluded_agreement_ids; at most 1,000. topics: the invoices behind some topics of one agreement, include_uncategorized adding its alerts without a topic; a pair is handled as a whole, so its alerts in other topics change too (other_topic_alert_count). retry: the failed or cancelled items of an agreement check, with mode again.","required":["type"],"properties":{"type":{"type":"string","enum":["agreements"],"isRequired":true,"uniqueKey":"scope.oneOf.1.type","typeLabel":"enum\u003cstring>"},"filter":{"type":"object","properties":{"view_ids":{"type":"array","items":{"type":"string","uniqueKey":"scope.oneOf.1.filter.view_ids.items.[INDEX]","typeLabel":"string"},"uniqueKey":"scope.oneOf.1.filter.view_ids","typeLabel":"string[]"},"ids":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"scope.oneOf.1.filter.ids.items.[INDEX]","typeLabel":"string\u003cuuid>"},"uniqueKey":"scope.oneOf.1.filter.ids","typeLabel":"string\u003cuuid>[]"},"renewal_action_kinds":{"type":"array","items":{"type":"string","enum":["cancel_by","renew_by","automatic_notice","missing_details","none"],"uniqueKey":"scope.oneOf.1.filter.renewal_action_kinds.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"The next renewal action. cancel_by: renews unless cancelled by the deadline; renew_by: ends unless renewed by it; automatic_notice: no expiration date, ends with the notice period, so no deadline; missing_details: no deadline can be computed; none: no renewal left.","uniqueKey":"scope.oneOf.1.filter.renewal_action_kinds","typeLabel":"enum\u003cstring>[]"},"renewal_deadline_from":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","uniqueKey":"scope.oneOf.1.filter.renewal_deadline_from","typeLabel":"string"},"renewal_deadline_through":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","uniqueKey":"scope.oneOf.1.filter.renewal_deadline_through","typeLabel":"string"},"upcoming_through":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"A renewal deadline or expiration date from today (organization's timezone) through this date: what must be cancelled, renewed or will end soon.","uniqueKey":"scope.oneOf.1.filter.upcoming_through","typeLabel":"string"},"search":{"type":"string","minLength":1,"maxLength":200,"description":"Agreement title or a supplier name.","uniqueKey":"scope.oneOf.1.filter.search","typeLabel":"string"},"statuses":{"type":"array","items":{"type":"string","enum":["draft","active","archived"],"uniqueKey":"scope.oneOf.1.filter.statuses.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"draft: being set up; active: invoices are checked against it; archived: no longer checked. Says nothing about whether the term is in force: use valid_on for that.","uniqueKey":"scope.oneOf.1.filter.statuses","typeLabel":"enum\u003cstring>[]"},"supplier_ids":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"scope.oneOf.1.filter.supplier_ids.items.[INDEX]","typeLabel":"string\u003cuuid>"},"uniqueKey":"scope.oneOf.1.filter.supplier_ids","typeLabel":"string\u003cuuid>[]"},"recipient_ids":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"scope.oneOf.1.filter.recipient_ids.items.[INDEX]","typeLabel":"string\u003cuuid>"},"description":"Includes agreements for any recipient.","uniqueKey":"scope.oneOf.1.filter.recipient_ids","typeLabel":"string\u003cuuid>[]"},"company_ids":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"scope.oneOf.1.filter.company_ids.items.[INDEX]","typeLabel":"string\u003cuuid>"},"minItems":1,"maxItems":1000,"description":"Agreements that cover any of these companies. A shared agreement appears once, with its alert numbers and counts for those companies' invoices only.","uniqueKey":"scope.oneOf.1.filter.company_ids","typeLabel":"string\u003cuuid>[]"},"tag_ids":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"scope.oneOf.1.filter.tag_ids.items.[INDEX]","typeLabel":"string\u003cuuid>"},"uniqueKey":"scope.oneOf.1.filter.tag_ids","typeLabel":"string\u003cuuid>[]"},"owner_user_ids":{"type":"array","items":{"type":"string","minLength":1,"maxLength":200,"pattern":"^[A-Za-z0-9_-]+$","uniqueKey":"scope.oneOf.1.filter.owner_user_ids.items.[INDEX]","typeLabel":"string"},"description":"Case-sensitive.","uniqueKey":"scope.oneOf.1.filter.owner_user_ids","typeLabel":"string[]"},"has_owner":{"type":"boolean","description":"false: agreements with no owner; true: agreements with an owner. Removing a member unassigns their agreements. Combined with owner_user_ids, false matches nothing.","uniqueKey":"scope.oneOf.1.filter.has_owner","typeLabel":"boolean"},"auto_check_new_invoices":{"type":"boolean","description":"true: agreements whose new matching invoices are checked automatically; false: those checked only when someone runs a check.","uniqueKey":"scope.oneOf.1.filter.auto_check_new_invoices","typeLabel":"boolean"},"has_alert_verdicts":{"type":"array","items":{"type":"string","enum":["pending","accepted","dismissed","skipped"],"uniqueKey":"scope.oneOf.1.filter.has_alert_verdicts.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"At least one alert with any of these verdicts; with has_alert_credited, on the same alert.","uniqueKey":"scope.oneOf.1.filter.has_alert_verdicts","typeLabel":"enum\u003cstring>[]"},"has_alert_credited":{"type":"boolean","description":"At least one alert (not) credited.","uniqueKey":"scope.oneOf.1.filter.has_alert_credited","typeLabel":"boolean"},"review_status":{"type":"string","enum":["to_review","reviewed"],"description":"to_review: at least one live alert still to review (pending). reviewed: live alerts, every one of them confirmed, a false alarm or unsure. Agreements without live alerts match neither.","uniqueKey":"scope.oneOf.1.filter.review_status","typeLabel":"enum\u003cstring>"},"effective_from":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Excludes agreements without one.","uniqueKey":"scope.oneOf.1.filter.effective_from","typeLabel":"string"},"effective_through":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","uniqueKey":"scope.oneOf.1.filter.effective_through","typeLabel":"string"},"expiration_from":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Excludes agreements without one.","uniqueKey":"scope.oneOf.1.filter.expiration_from","typeLabel":"string"},"expiration_through":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","uniqueKey":"scope.oneOf.1.filter.expiration_through","typeLabel":"string"},"valid_on":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"In force on this date: effective on or before it and expiring on or after it. A missing date counts as open-ended.","uniqueKey":"scope.oneOf.1.filter.valid_on","typeLabel":"string"},"join_operator":{"type":"string","enum":["and","or"],"description":"or combines only supplier_ids and tag_ids.","uniqueKey":"scope.oneOf.1.filter.join_operator","typeLabel":"enum\u003cstring>"},"not":{"type":"array","items":{"type":"string","enum":["statuses","supplier_ids","recipient_ids","tag_ids","owner_user_ids","renewal_action_kinds"],"uniqueKey":"scope.oneOf.1.filter.not.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"List filters to invert.","uniqueKey":"scope.oneOf.1.filter.not","typeLabel":"enum\u003cstring>[]"}},"additionalProperties":false,"uniqueKey":"scope.oneOf.1.filter","typeLabel":"object"},"agreement_ids":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"scope.oneOf.1.agreement_ids.items.[INDEX]","typeLabel":"string\u003cuuid>"},"maxItems":1000,"uniqueKey":"scope.oneOf.1.agreement_ids","typeLabel":"string\u003cuuid>[]"},"excluded_agreement_ids":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"scope.oneOf.1.excluded_agreement_ids.items.[INDEX]","typeLabel":"string\u003cuuid>"},"maxItems":1000,"default":[],"uniqueKey":"scope.oneOf.1.excluded_agreement_ids","typeLabel":"string\u003cuuid>[]"},"agreement_version_status":{"type":"string","enum":["current","older"],"description":"The alert assessed the current agreement version or an older one; an unknown version or no agreement matches neither.","uniqueKey":"scope.oneOf.1.agreement_version_status","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"scope.oneOf.1","typeLabel":"object"},{"type":"object","description":"agreements: agreement_ids, or every agreement filter matches (the whole collection, not a page), minus excluded_agreement_ids; at most 1,000. topics: the invoices behind some topics of one agreement, include_uncategorized adding its alerts without a topic; a pair is handled as a whole, so its alerts in other topics change too (other_topic_alert_count). retry: the failed or cancelled items of an agreement check, with mode again.","required":["type","agreement_id","topic_ids"],"properties":{"type":{"type":"string","enum":["topics"],"isRequired":true,"uniqueKey":"scope.oneOf.2.type","typeLabel":"enum\u003cstring>"},"agreement_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"scope.oneOf.2.agreement_id","typeLabel":"string\u003cuuid>"},"topic_ids":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"scope.oneOf.2.topic_ids.items.[INDEX]","typeLabel":"string\u003cuuid>"},"maxItems":1000,"isRequired":true,"uniqueKey":"scope.oneOf.2.topic_ids","typeLabel":"string\u003cuuid>[]"},"include_uncategorized":{"type":"boolean","default":false,"uniqueKey":"scope.oneOf.2.include_uncategorized","typeLabel":"boolean"},"agreement_version_status":{"type":"string","enum":["current","older"],"description":"The alert assessed the current agreement version or an older one; an unknown version or no agreement matches neither.","uniqueKey":"scope.oneOf.2.agreement_version_status","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"scope.oneOf.2","typeLabel":"object"},{"type":"object","description":"agreements: agreement_ids, or every agreement filter matches (the whole collection, not a page), minus excluded_agreement_ids; at most 1,000. topics: the invoices behind some topics of one agreement, include_uncategorized adding its alerts without a topic; a pair is handled as a whole, so its alerts in other topics change too (other_topic_alert_count). retry: the failed or cancelled items of an agreement check, with mode again.","required":["type","workflow_run_id"],"properties":{"type":{"type":"string","enum":["retry"],"isRequired":true,"uniqueKey":"scope.oneOf.3.type","typeLabel":"enum\u003cstring>"},"workflow_run_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"scope.oneOf.3.workflow_run_id","typeLabel":"string\u003cuuid>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"scope.oneOf.3","typeLabel":"object"},{"type":"object","description":"agreements: agreement_ids, or every agreement filter matches (the whole collection, not a page), minus excluded_agreement_ids; at most 1,000. topics: the invoices behind some topics of one agreement, include_uncategorized adding its alerts without a topic; a pair is handled as a whole, so its alerts in other topics change too (other_topic_alert_count). retry: the failed or cancelled items of an agreement check, with mode again.","required":["type","purchase_order_ids"],"properties":{"type":{"type":"string","enum":["purchase_orders"],"isRequired":true,"uniqueKey":"scope.oneOf.4.type","typeLabel":"enum\u003cstring>"},"purchase_order_ids":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"scope.oneOf.4.purchase_order_ids.items.[INDEX]","typeLabel":"string\u003cuuid>"},"minItems":1,"maxItems":1000,"description":"Up to 1,000 purchase orders. Checks their accepted invoices against them only.","isRequired":true,"uniqueKey":"scope.oneOf.4.purchase_order_ids","typeLabel":"string\u003cuuid>[]"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"scope.oneOf.4","typeLabel":"object"}],"isRequired":true,"uniqueKey":"scope","typeLabel":"object"},"mode":{"type":"string","enum":["outstanding","again"],"default":"outstanding","description":"outstanding: only pairs (invoice–agreement or invoice–purchase order) without a completed check. again: completed pairs too, replacing their alerts; on an invoices scope it also checks each invoice for duplicates again, replacing its duplicate alerts.","uniqueKey":"mode","typeLabel":"enum\u003cstring>"},"invoices":{"oneOf":[{"type":"object","description":"Which of the scope’s invoices to take: all (minus exclusions), a sample of ten, or a hand-picked set.","default":{"type":"all","excluded_invoice_ids":[]},"required":["type"],"properties":{"type":{"type":"string","enum":["all"],"isRequired":true,"uniqueKey":"invoices.oneOf.0.type","typeLabel":"enum\u003cstring>"},"excluded_invoice_ids":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"invoices.oneOf.0.excluded_invoice_ids.items.[INDEX]","typeLabel":"string\u003cuuid>"},"maxItems":5000,"default":[],"description":"Invoices left out of an otherwise complete selection.","uniqueKey":"invoices.oneOf.0.excluded_invoice_ids","typeLabel":"string\u003cuuid>[]"}},"additionalProperties":false,"uniqueKey":"invoices.oneOf.0","typeLabel":"object"},{"type":"object","description":"Which of the scope’s invoices to take: all (minus exclusions), a sample of ten, or a hand-picked set.","default":{"type":"all","excluded_invoice_ids":[]},"required":["type","seed"],"properties":{"type":{"type":"string","enum":["sample"],"isRequired":true,"uniqueKey":"invoices.oneOf.1.type","typeLabel":"enum\u003cstring>"},"seed":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"invoices.oneOf.1.seed","typeLabel":"string\u003cuuid>"},"invoice_ids":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"invoices.oneOf.1.invoice_ids.items.[INDEX]","typeLabel":"string\u003cuuid>"},"maxItems":10,"description":"Invoice IDs returned by the preview, pinned until the user changes the selection.","uniqueKey":"invoices.oneOf.1.invoice_ids","typeLabel":"string\u003cuuid>[]"}},"additionalProperties":false,"uniqueKey":"invoices.oneOf.1","typeLabel":"object"},{"type":"object","description":"Which of the scope’s invoices to take: all (minus exclusions), a sample of ten, or a hand-picked set.","default":{"type":"all","excluded_invoice_ids":[]},"required":["type","invoice_ids"],"properties":{"type":{"type":"string","enum":["selected"],"isRequired":true,"uniqueKey":"invoices.oneOf.2.type","typeLabel":"enum\u003cstring>"},"invoice_ids":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"invoices.oneOf.2.invoice_ids.items.[INDEX]","typeLabel":"string\u003cuuid>"},"maxItems":5000,"isRequired":true,"uniqueKey":"invoices.oneOf.2.invoice_ids","typeLabel":"string\u003cuuid>[]"}},"additionalProperties":false,"uniqueKey":"invoices.oneOf.2","typeLabel":"object"}],"uniqueKey":"invoices","typeLabel":"object"},"issued_from":{"type":"string","format":"date","description":"Only invoices issued on or after this date.","uniqueKey":"issued_from","typeLabel":"string\u003cdate>"},"issued_through":{"type":"string","format":"date","description":"Only invoices issued on or before this date.","uniqueKey":"issued_through","typeLabel":"string\u003cdate>"},"company_ids":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"company_ids.items.[INDEX]","typeLabel":"string\u003cuuid>"},"minItems":1,"maxItems":1000,"description":"Only these workspace companies: their invoices under agreements covering them, as for a member with access to just those companies. Omit for every company the caller can access. An unknown or inaccessible company is 404.","uniqueKey":"company_ids","typeLabel":"string\u003cuuid>[]"},"preview":{"type":"boolean","default":false,"description":"true: return what the command would do and its fingerprint, changing nothing.","uniqueKey":"preview","typeLabel":"boolean"},"fingerprint":{"type":"string","minLength":64,"maxLength":64,"description":"The fingerprint of a preview. When sent, the command runs only if the selection still resolves to exactly what was previewed; omit it to act on the current state.","uniqueKey":"fingerprint","typeLabel":"string"}},"required":["scope"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"scope":{"type":"invoices","invoice_ids":["3c90c3cc-0d44-4b50-8888-8dd25736052a"]},"mode":"outstanding","invoices":{"type":"all","excluded_invoice_ids":[]},"issued_from":"2023-12-25","issued_through":"2023-12-25","company_ids":["3c90c3cc-0d44-4b50-8888-8dd25736052a"],"preview":false,"fingerprint":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"2f2ccb02-566c-471a-a1ae-c25c5f10b122":{"description":"With preview: true, the preview (CheckSelectionPreview). Otherwise a repeated Idempotency-Key: the original result, with Location naming its first workflow run.","headers":{"X-Request-Id":{"schema":{"type":"string"},"required":true,"description":"Request ID, also included in error bodies. Include it when contacting support."},"Cache-Control":{"schema":{"type":"string","enum":["private, no-store","private, no-store, no-transform"]},"required":false,"description":"API responses are private and must not be cached."},"X-RateLimit-Limit":{"schema":{"type":"string","example":"500"},"required":false,"description":"Requests allowed per minute for this credential, or failed API key attempts allowed per minute from this IP address."},"Location":{"schema":{"type":"string"},"required":false,"description":"Relative URL of the created or accepted resource."}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["options","fingerprint","sample_invoice_ids","agreements","invoice_count","check_count","purchase_order_check_count","duplicate_check_count","exceeds_limit","maximum_checks","maximum_runs","exclusions","other_topic_alert_count"],"properties":{"options":{"type":"object","properties":{"outstanding":{"type":"object","properties":{"invoice_count":{"type":"integer","description":"Every invoice this mode could check in the scope, before exclusions or sampling.","isRequired":true,"uniqueKey":"oneOf.0.options.outstanding.invoice_count","typeLabel":"integer"},"replaced_alert_count":{"type":"integer","description":"Current alerts that a successful check replaces, after exclusions and sampling.","isRequired":true,"uniqueKey":"oneOf.0.options.outstanding.replaced_alert_count","typeLabel":"integer"},"handled_alert_count":{"type":"integer","description":"The replaced alerts someone has reviewed: confirmed, false alarm or unsure.","isRequired":true,"uniqueKey":"oneOf.0.options.outstanding.handled_alert_count","typeLabel":"integer"}},"required":["invoice_count","replaced_alert_count","handled_alert_count"],"isRequired":true,"uniqueKey":"oneOf.0.options.outstanding","typeLabel":"object"},"again":{"type":"object","properties":{"invoice_count":{"type":"integer","description":"Every invoice this mode could check in the scope, before exclusions or sampling.","isRequired":true,"uniqueKey":"oneOf.0.options.again.invoice_count","typeLabel":"integer"},"replaced_alert_count":{"type":"integer","description":"Current alerts that a successful check replaces, after exclusions and sampling.","isRequired":true,"uniqueKey":"oneOf.0.options.again.replaced_alert_count","typeLabel":"integer"},"handled_alert_count":{"type":"integer","description":"The replaced alerts someone has reviewed: confirmed, false alarm or unsure.","isRequired":true,"uniqueKey":"oneOf.0.options.again.handled_alert_count","typeLabel":"integer"}},"required":["invoice_count","replaced_alert_count","handled_alert_count"],"isRequired":true,"uniqueKey":"oneOf.0.options.again","typeLabel":"object"}},"required":["outstanding","again"],"description":"What each check mode would run in this scope, whichever mode is selected.","isRequired":true,"uniqueKey":"oneOf.0.options","typeLabel":"object"},"fingerprint":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.fingerprint","typeLabel":"string"},"sample_invoice_ids":{"oneOf":[{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"oneOf.0.sample_invoice_ids.oneOf.0.items.[INDEX]","typeLabel":"string\u003cuuid>"},"isRequired":true,"uniqueKey":"oneOf.0.sample_invoice_ids.oneOf.0","typeLabel":"string\u003cuuid>[]"},{"type":"null","items":{"type":"string","format":"uuid"},"isRequired":true,"uniqueKey":"oneOf.0.sample_invoice_ids.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.sample_invoice_ids","typeLabel":"string\u003cuuid>[] | null"},"agreements":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"oneOf.0.agreements.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"title":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.agreements.items.[INDEX].title.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.0.agreements.items.[INDEX].title.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.agreements.items.[INDEX].title","typeLabel":"string | null"},"reasons":{"type":"array","items":{"type":"string","enum":["inactive","missing_title","missing_supplier","missing_content","documents_not_ready","documents_too_large"],"uniqueKey":"oneOf.0.agreements.items.[INDEX].reasons.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"oneOf.0.agreements.items.[INDEX].reasons","typeLabel":"enum\u003cstring>[]"},"check_count":{"type":"integer","isRequired":true,"uniqueKey":"oneOf.0.agreements.items.[INDEX].check_count","typeLabel":"integer"}},"required":["id","title","reasons","check_count"],"uniqueKey":"oneOf.0.agreements.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"oneOf.0.agreements","typeLabel":"object[]"},"invoice_count":{"type":"integer","isRequired":true,"uniqueKey":"oneOf.0.invoice_count","typeLabel":"integer"},"check_count":{"type":"integer","isRequired":true,"uniqueKey":"oneOf.0.check_count","typeLabel":"integer"},"purchase_order_check_count":{"type":"integer","description":"Invoice–purchase order checks the selection runs, beside the agreement checks.","isRequired":true,"uniqueKey":"oneOf.0.purchase_order_check_count","typeLabel":"integer"},"duplicate_check_count":{"type":"integer","description":"Invoices the selection checks for duplicates again: with mode again on an invoices scope, each of its invoices.","isRequired":true,"uniqueKey":"oneOf.0.duplicate_check_count","typeLabel":"integer"},"exceeds_limit":{"type":"boolean","isRequired":true,"uniqueKey":"oneOf.0.exceeds_limit","typeLabel":"boolean"},"maximum_checks":{"type":"integer","isRequired":true,"uniqueKey":"oneOf.0.maximum_checks","typeLabel":"integer"},"maximum_runs":{"type":"integer","isRequired":true,"uniqueKey":"oneOf.0.maximum_runs","typeLabel":"integer"},"exclusions":{"type":"array","items":{"type":"object","properties":{"reason":{"type":"string","enum":["not_ready","not_checkable","claimed","running","completed"],"isRequired":true,"uniqueKey":"oneOf.0.exclusions.items.[INDEX].reason","typeLabel":"enum\u003cstring>"},"count":{"type":"integer","isRequired":true,"uniqueKey":"oneOf.0.exclusions.items.[INDEX].count","typeLabel":"integer"}},"required":["reason","count"],"uniqueKey":"oneOf.0.exclusions.items.[INDEX]","typeLabel":"object"},"description":"Invoice–agreement pairs in scope that the selected mode leaves out, by reason.","isRequired":true,"uniqueKey":"oneOf.0.exclusions","typeLabel":"object[]"},"other_topic_alert_count":{"type":"integer","description":"Replaced alerts that belong to topics outside a topic scope.","isRequired":true,"uniqueKey":"oneOf.0.other_topic_alert_count","typeLabel":"integer"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","required":["agreements","mode","workflow_run_ids","invoice_count","check_count","purchase_order_check_count","duplicate_check_count"],"properties":{"agreements":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"oneOf.1.agreements.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"title":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.agreements.items.[INDEX].title.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.1.agreements.items.[INDEX].title.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.agreements.items.[INDEX].title","typeLabel":"string | null"},"check_count":{"type":"integer","isRequired":true,"uniqueKey":"oneOf.1.agreements.items.[INDEX].check_count","typeLabel":"integer"}},"required":["id","title","check_count"],"uniqueKey":"oneOf.1.agreements.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"oneOf.1.agreements","typeLabel":"object[]"},"mode":{"type":"string","enum":["outstanding","again"],"isRequired":true,"uniqueKey":"oneOf.1.mode","typeLabel":"enum\u003cstring>"},"workflow_run_ids":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"oneOf.1.workflow_run_ids.items.[INDEX]","typeLabel":"string\u003cuuid>"},"description":"One agreement check per agreement. Started, not finished: follow each run.","isRequired":true,"uniqueKey":"oneOf.1.workflow_run_ids","typeLabel":"string\u003cuuid>[]"},"invoice_count":{"type":"integer","isRequired":true,"uniqueKey":"oneOf.1.invoice_count","typeLabel":"integer"},"check_count":{"type":"integer","isRequired":true,"uniqueKey":"oneOf.1.check_count","typeLabel":"integer"},"purchase_order_check_count":{"type":"integer","description":"Invoice–purchase order checks, already complete when this returns: they compare stored terms and need no workflow.","isRequired":true,"uniqueKey":"oneOf.1.purchase_order_check_count","typeLabel":"integer"},"duplicate_check_count":{"type":"integer","description":"Invoices checked for duplicates again, already complete when this returns. Each check replaces that invoice's duplicate alerts, so a decided one comes back pending; the supplier's other invoices of its number keep theirs.","isRequired":true,"uniqueKey":"oneOf.1.duplicate_check_count","typeLabel":"integer"}},"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"options":{"outstanding":{"invoice_count":123,"replaced_alert_count":123,"handled_alert_count":123},"again":{"invoice_count":123,"replaced_alert_count":123,"handled_alert_count":123}},"fingerprint":"\u003cstring>","sample_invoice_ids":["3c90c3cc-0d44-4b50-8888-8dd25736052a"],"agreements":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","title":"\u003cstring>","reasons":["inactive"],"check_count":123}],"invoice_count":123,"check_count":123,"purchase_order_check_count":123,"duplicate_check_count":123,"exceeds_limit":true,"maximum_checks":123,"maximum_runs":123,"exclusions":[{"reason":"not_ready","count":123}],"other_topic_alert_count":123}}},"exampleType":"generated"}},"exampleType":"generated"},"e4b74473-b061-468f-81bd-490279bb4cd5":{"description":"Checks started. Location names the first workflow run.","headers":{"X-Request-Id":{"schema":{"type":"string"},"required":true,"description":"Request ID, also included in error bodies. Include it when contacting support."},"Cache-Control":{"schema":{"type":"string","enum":["private, no-store","private, no-store, no-transform"]},"required":false,"description":"API responses are private and must not be cached."},"X-RateLimit-Limit":{"schema":{"type":"string","example":"500"},"required":false,"description":"Requests allowed per minute for this credential, or failed API key attempts allowed per minute from this IP address."},"Location":{"schema":{"type":"string"},"required":false,"description":"Relative URL of the created or accepted resource."}},"content":{"application/json":{"schema":{"type":"object","properties":{"agreements":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"agreements.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"title":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"agreements.items.[INDEX].title.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"agreements.items.[INDEX].title.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"agreements.items.[INDEX].title","typeLabel":"string | null"},"check_count":{"type":"integer","isRequired":true,"uniqueKey":"agreements.items.[INDEX].check_count","typeLabel":"integer"}},"required":["id","title","check_count"],"uniqueKey":"agreements.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"agreements","typeLabel":"object[]"},"mode":{"type":"string","enum":["outstanding","again"],"isRequired":true,"uniqueKey":"mode","typeLabel":"enum\u003cstring>"},"workflow_run_ids":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"workflow_run_ids.items.[INDEX]","typeLabel":"string\u003cuuid>"},"description":"One agreement check per agreement. Started, not finished: follow each run.","isRequired":true,"uniqueKey":"workflow_run_ids","typeLabel":"string\u003cuuid>[]"},"invoice_count":{"type":"integer","isRequired":true,"uniqueKey":"invoice_count","typeLabel":"integer"},"check_count":{"type":"integer","isRequired":true,"uniqueKey":"check_count","typeLabel":"integer"},"purchase_order_check_count":{"type":"integer","description":"Invoice–purchase order checks, already complete when this returns: they compare stored terms and need no workflow.","isRequired":true,"uniqueKey":"purchase_order_check_count","typeLabel":"integer"},"duplicate_check_count":{"type":"integer","description":"Invoices checked for duplicates again, already complete when this returns. Each check replaces that invoice's duplicate alerts, so a decided one comes back pending; the supplier's other invoices of its number keep theirs.","isRequired":true,"uniqueKey":"duplicate_check_count","typeLabel":"integer"}},"required":["agreements","mode","workflow_run_ids","invoice_count","check_count","purchase_order_check_count","duplicate_check_count"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"agreements":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","title":"\u003cstring>","check_count":123}],"mode":"outstanding","workflow_run_ids":["3c90c3cc-0d44-4b50-8888-8dd25736052a"],"invoice_count":123,"check_count":123,"purchase_order_check_count":123,"duplicate_check_count":123}}},"exampleType":"generated"}},"exampleType":"generated"},"d71d85f0-ac1f-4fb3-8c4c-2160ef51e3f6":{"description":"The request is invalid. details lists up to 20 field errors. Request bodies are limited to 2 MiB.","headers":{"X-Request-Id":{"schema":{"type":"string"},"required":true,"description":"Request ID, also included in error bodies. Include it when contacting support."},"Cache-Control":{"schema":{"type":"string","enum":["private, no-store","private, no-store, no-transform"]},"required":false,"description":"API responses are private and must not be cached."},"X-RateLimit-Limit":{"schema":{"type":"string","example":"500"},"required":false,"description":"Requests allowed per minute for this credential, or failed API key attempts allowed per minute from this IP address."}},"content":{"application/json":{"example":{"error":{"code":"validation_error","message":"The request is invalid. details lists up to 20 field errors. Request bodies are limited to 2 MiB.","request_id":"req_example"}},"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["validation_error"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"description":{"type":"string","uniqueKey":"error.description","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].code","typeLabel":"string"},"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["code","field","message"],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"maxItems":20,"uniqueKey":"error.details","typeLabel":"object[]"},"workflow_run_id":{"type":"string","format":"uuid","uniqueKey":"error.workflow_run_id","typeLabel":"string\u003cuuid>"},"import_id":{"type":"string","format":"uuid","uniqueKey":"error.import_id","typeLabel":"string\u003cuuid>"},"existing_party":{"type":"object","properties":{"type":{"type":"string","enum":["supplier","recipient"],"isRequired":true,"uniqueKey":"error.existing_party.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"error.existing_party.id","typeLabel":"string\u003cuuid>"}},"required":["type","id"],"uniqueKey":"error.existing_party","typeLabel":"object"}},"required":["code","message","request_id"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"validation_error","message":"The request is invalid. details lists up to 20 field errors. Request bodies are limited to 2 MiB.","request_id":"req_example"}}}},"exampleType":"examples"}},"exampleType":"examples"},"c4354683-29b8-4f10-bc36-3d6586dd40bc":{"description":"The bearer token is missing or invalid.","headers":{"X-Request-Id":{"schema":{"type":"string"},"required":true,"description":"Request ID, also included in error bodies. Include it when contacting support."},"Cache-Control":{"schema":{"type":"string","enum":["private, no-store","private, no-store, no-transform"]},"required":false,"description":"API responses are private and must not be cached."},"X-RateLimit-Limit":{"schema":{"type":"string","example":"500"},"required":false,"description":"Requests allowed per minute for this credential, or failed API key attempts allowed per minute from this IP address."},"WWW-Authenticate":{"schema":{"type":"string"},"required":false,"description":"Bearer authentication challenge, when supplied."}},"content":{"application/json":{"example":{"error":{"code":"invalid_token","message":"The bearer token is missing or invalid.","request_id":"req_example"}},"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["invalid_token"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"description":{"type":"string","uniqueKey":"error.description","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].code","typeLabel":"string"},"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["code","field","message"],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"maxItems":20,"uniqueKey":"error.details","typeLabel":"object[]"},"workflow_run_id":{"type":"string","format":"uuid","uniqueKey":"error.workflow_run_id","typeLabel":"string\u003cuuid>"},"import_id":{"type":"string","format":"uuid","uniqueKey":"error.import_id","typeLabel":"string\u003cuuid>"},"existing_party":{"type":"object","properties":{"type":{"type":"string","enum":["supplier","recipient"],"isRequired":true,"uniqueKey":"error.existing_party.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"error.existing_party.id","typeLabel":"string\u003cuuid>"}},"required":["type","id"],"uniqueKey":"error.existing_party","typeLabel":"object"}},"required":["code","message","request_id"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_token","message":"The bearer token is missing or invalid.","request_id":"req_example"}}}},"exampleType":"examples"}},"exampleType":"examples"},"4992a688-15a8-4acc-ac29-9a90d3ee3073":{"description":"Access denied. The error code says why: forbidden, token_disabled, organization_required, insufficient_role or mfa_required.","headers":{"X-Request-Id":{"schema":{"type":"string"},"required":true,"description":"Request ID, also included in error bodies. Include it when contacting support."},"Cache-Control":{"schema":{"type":"string","enum":["private, no-store","private, no-store, no-transform"]},"required":false,"description":"API responses are private and must not be cached."},"X-RateLimit-Limit":{"schema":{"type":"string","example":"500"},"required":false,"description":"Requests allowed per minute for this credential, or failed API key attempts allowed per minute from this IP address."}},"content":{"application/json":{"example":{"error":{"code":"forbidden","message":"Access denied. The error code says why: forbidden, token_disabled, organization_required, insufficient_role or mfa_required.","request_id":"req_example"}},"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","token_disabled","organization_required","insufficient_role","mfa_required"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"description":{"type":"string","uniqueKey":"error.description","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].code","typeLabel":"string"},"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["code","field","message"],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"maxItems":20,"uniqueKey":"error.details","typeLabel":"object[]"},"workflow_run_id":{"type":"string","format":"uuid","uniqueKey":"error.workflow_run_id","typeLabel":"string\u003cuuid>"},"import_id":{"type":"string","format":"uuid","uniqueKey":"error.import_id","typeLabel":"string\u003cuuid>"},"existing_party":{"type":"object","properties":{"type":{"type":"string","enum":["supplier","recipient"],"isRequired":true,"uniqueKey":"error.existing_party.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"error.existing_party.id","typeLabel":"string\u003cuuid>"}},"required":["type","id"],"uniqueKey":"error.existing_party","typeLabel":"object"}},"required":["code","message","request_id"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"forbidden","message":"Access denied. The error code says why: forbidden, token_disabled, organization_required, insufficient_role or mfa_required.","request_id":"req_example"}}}},"exampleType":"examples"}},"exampleType":"examples"},"fb4ab38f-1bed-436c-ac7a-e041702afea8":{"description":"The resource does not exist in the current organization.","headers":{"X-Request-Id":{"schema":{"type":"string"},"required":true,"description":"Request ID, also included in error bodies. Include it when contacting support."},"Cache-Control":{"schema":{"type":"string","enum":["private, no-store","private, no-store, no-transform"]},"required":false,"description":"API responses are private and must not be cached."},"X-RateLimit-Limit":{"schema":{"type":"string","example":"500"},"required":false,"description":"Requests allowed per minute for this credential, or failed API key attempts allowed per minute from this IP address."}},"content":{"application/json":{"example":{"error":{"code":"not_found","message":"The resource does not exist in the current organization.","request_id":"req_example"}},"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["not_found"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"description":{"type":"string","uniqueKey":"error.description","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].code","typeLabel":"string"},"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["code","field","message"],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"maxItems":20,"uniqueKey":"error.details","typeLabel":"object[]"},"workflow_run_id":{"type":"string","format":"uuid","uniqueKey":"error.workflow_run_id","typeLabel":"string\u003cuuid>"},"import_id":{"type":"string","format":"uuid","uniqueKey":"error.import_id","typeLabel":"string\u003cuuid>"},"existing_party":{"type":"object","properties":{"type":{"type":"string","enum":["supplier","recipient"],"isRequired":true,"uniqueKey":"error.existing_party.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"error.existing_party.id","typeLabel":"string\u003cuuid>"}},"required":["type","id"],"uniqueKey":"error.existing_party","typeLabel":"object"}},"required":["code","message","request_id"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"not_found","message":"The resource does not exist in the current organization.","request_id":"req_example"}}}},"exampleType":"examples"}},"exampleType":"examples"},"3631325c-3478-43dc-9424-3da79a63eb84":{"description":"conflict: the selection changed since the preview, it is too large, the run cannot be retried, or the Idempotency-Key was used for a different request. nothing_to_check: no pair in the selection can be checked. Nothing was started.","headers":{"X-Request-Id":{"schema":{"type":"string"},"required":true,"description":"Request ID, also included in error bodies. Include it when contacting support."},"Cache-Control":{"schema":{"type":"string","enum":["private, no-store","private, no-store, no-transform"]},"required":false,"description":"API responses are private and must not be cached."},"X-RateLimit-Limit":{"schema":{"type":"string","example":"500"},"required":false,"description":"Requests allowed per minute for this credential, or failed API key attempts allowed per minute from this IP address."}},"content":{"application/json":{"example":{"error":{"code":"conflict","message":"conflict: the selection changed since the preview, it is too large, the run cannot be retried, or the Idempotency-Key was used for a different request. nothing_to_check: no pair in the selection can be checked. Nothing was started.","request_id":"req_example"}},"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["conflict","nothing_to_check"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"description":{"type":"string","uniqueKey":"error.description","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].code","typeLabel":"string"},"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["code","field","message"],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"maxItems":20,"uniqueKey":"error.details","typeLabel":"object[]"},"workflow_run_id":{"type":"string","format":"uuid","uniqueKey":"error.workflow_run_id","typeLabel":"string\u003cuuid>"},"import_id":{"type":"string","format":"uuid","uniqueKey":"error.import_id","typeLabel":"string\u003cuuid>"},"existing_party":{"type":"object","properties":{"type":{"type":"string","enum":["supplier","recipient"],"isRequired":true,"uniqueKey":"error.existing_party.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"error.existing_party.id","typeLabel":"string\u003cuuid>"}},"required":["type","id"],"uniqueKey":"error.existing_party","typeLabel":"object"}},"required":["code","message","request_id"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"conflict","message":"conflict: the selection changed since the preview, it is too large, the run cannot be retried, or the Idempotency-Key was used for a different request. nothing_to_check: no pair in the selection can be checked. Nothing was started.","request_id":"req_example"}}}},"exampleType":"examples"}},"exampleType":"examples"},"6c5b2c89-a665-4b1c-ae07-83a26e1a28fa":{"description":"Too many requests. Wait for the Retry-After delay before retrying.","headers":{"X-Request-Id":{"schema":{"type":"string"},"required":true,"description":"Request ID, also included in error bodies. Include it when contacting support."},"Cache-Control":{"schema":{"type":"string","enum":["private, no-store","private, no-store, no-transform"]},"required":false,"description":"API responses are private and must not be cached."},"X-RateLimit-Limit":{"schema":{"type":"string","example":"500"},"required":false,"description":"Requests allowed per minute for this credential, or failed API key attempts allowed per minute from this IP address."},"Retry-After":{"schema":{"type":"string","example":"60"},"required":true,"description":"Seconds to wait before retrying the request."}},"content":{"application/json":{"example":{"error":{"code":"rate_limit_exceeded","message":"Too many requests. Wait for the Retry-After delay before retrying.","request_id":"req_example"}},"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"description":{"type":"string","uniqueKey":"error.description","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].code","typeLabel":"string"},"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["code","field","message"],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"maxItems":20,"uniqueKey":"error.details","typeLabel":"object[]"},"workflow_run_id":{"type":"string","format":"uuid","uniqueKey":"error.workflow_run_id","typeLabel":"string\u003cuuid>"},"import_id":{"type":"string","format":"uuid","uniqueKey":"error.import_id","typeLabel":"string\u003cuuid>"},"existing_party":{"type":"object","properties":{"type":{"type":"string","enum":["supplier","recipient"],"isRequired":true,"uniqueKey":"error.existing_party.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"error.existing_party.id","typeLabel":"string\u003cuuid>"}},"required":["type","id"],"uniqueKey":"error.existing_party","typeLabel":"object"}},"required":["code","message","request_id"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"rate_limit_exceeded","message":"Too many requests. Wait for the Retry-After delay before retrying.","request_id":"req_example"}}}},"exampleType":"examples"}},"exampleType":"examples"},"bcb381c0-74b6-4ba0-b8f1-e36e4adb4572":{"description":"Unexpected server failure. Include the request ID when contacting support.","headers":{"X-Request-Id":{"schema":{"type":"string"},"required":true,"description":"Request ID, also included in error bodies. Include it when contacting support."},"Cache-Control":{"schema":{"type":"string","enum":["private, no-store","private, no-store, no-transform"]},"required":false,"description":"API responses are private and must not be cached."},"X-RateLimit-Limit":{"schema":{"type":"string","example":"500"},"required":false,"description":"Requests allowed per minute for this credential, or failed API key attempts allowed per minute from this IP address."}},"content":{"application/json":{"example":{"error":{"code":"internal_error","message":"Unexpected server failure. Include the request ID when contacting support.","request_id":"req_example"}},"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["internal_error"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"description":{"type":"string","uniqueKey":"error.description","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].code","typeLabel":"string"},"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["code","field","message"],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"maxItems":20,"uniqueKey":"error.details","typeLabel":"object[]"},"workflow_run_id":{"type":"string","format":"uuid","uniqueKey":"error.workflow_run_id","typeLabel":"string\u003cuuid>"},"import_id":{"type":"string","format":"uuid","uniqueKey":"error.import_id","typeLabel":"string\u003cuuid>"},"existing_party":{"type":"object","properties":{"type":{"type":"string","enum":["supplier","recipient"],"isRequired":true,"uniqueKey":"error.existing_party.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"error.existing_party.id","typeLabel":"string\u003cuuid>"}},"required":["type","id"],"uniqueKey":"error.existing_party","typeLabel":"object"}},"required":["code","message","request_id"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"internal_error","message":"Unexpected server failure. Include the request ID when contacting support.","request_id":"req_example"}}}},"exampleType":"examples"}},"exampleType":"examples"},"696576a3-b4a1-4845-b379-190535e85321":{"description":"The checks were admitted but not every start was confirmed. Location names an unconfirmed run, and the Idempotency-Key header carries the key (the generated one if you sent none); repeat the request with that key rather than a new one.","headers":{"X-Request-Id":{"schema":{"type":"string"},"required":true,"description":"Request ID, also included in error bodies. Include it when contacting support."},"Cache-Control":{"schema":{"type":"string","enum":["private, no-store","private, no-store, no-transform"]},"required":false,"description":"API responses are private and must not be cached."},"X-RateLimit-Limit":{"schema":{"type":"string","example":"500"},"required":false,"description":"Requests allowed per minute for this credential, or failed API key attempts allowed per minute from this IP address."},"Location":{"schema":{"type":"string"},"required":false,"description":"Relative URL of the created or accepted resource."},"Retry-After":{"schema":{"type":"string","example":"60"},"required":false,"description":"Seconds to wait before retrying the request."},"Idempotency-Key":{"schema":{"type":"string"},"required":false,"description":"The key to repeat this request with."}},"content":{"application/json":{"example":{"error":{"code":"service_unavailable","message":"The checks were admitted but not every start was confirmed. Location names an unconfirmed run, and the Idempotency-Key header carries the key (the generated one if you sent none); repeat the request with that key rather than a new one.","request_id":"req_example"}},"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["service_unavailable"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"description":{"type":"string","uniqueKey":"error.description","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].code","typeLabel":"string"},"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["code","field","message"],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"maxItems":20,"uniqueKey":"error.details","typeLabel":"object[]"},"workflow_run_id":{"type":"string","format":"uuid","uniqueKey":"error.workflow_run_id","typeLabel":"string\u003cuuid>"},"import_id":{"type":"string","format":"uuid","uniqueKey":"error.import_id","typeLabel":"string\u003cuuid>"},"existing_party":{"type":"object","properties":{"type":{"type":"string","enum":["supplier","recipient"],"isRequired":true,"uniqueKey":"error.existing_party.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"error.existing_party.id","typeLabel":"string\u003cuuid>"}},"required":["type","id"],"uniqueKey":"error.existing_party","typeLabel":"object"}},"required":["code","message","request_id"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"service_unavailable","message":"The checks were admitted but not every start was confirmed. Location names an unconfirmed run, and the Idempotency-Key header carries the key (the generated one if you sent none); repeat the request with that key rather than a new one.","request_id":"req_example"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"e7a42b1b-0801-47bc-ac9c-1ad61f362b7e":{"ApiKeyBearer":{"type":"http","scheme":"bearer","description":"Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).","scopes":[],"schemeName":"ApiKeyBearer"}}},"servers":{"0f259b2e-ff56-4327-8143-523787cf2165":{"url":"https://api.watchdog.no","description":"Watchdog API"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).","scopes":[],"schemeName":"ApiKeyBearer"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"ApiKeyBearer","name":"Authorization"}],"title":"ApiKeyBearer"}]},"originalFileLocation":"openapi.json"},"subdomain":"watchdog-7cea1057","siteName":"Watchdog Help Center","title":"Start compliance checks - Watchdog Help Center","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/endpoints/compliance-checks/start-compliance-checks","matchLevel":0},"no":{"href":"/no","matchLevel":4}}},"lastModified":"2026-11-18T12:33:59.282Z","originalFileLocation":"api-reference/endpoints/compliance-checks/start-compliance-checks.mdx","locale":"en"},"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=\"Checks invoices against their matched agreements and purchase orders. A check that completes closes its pair\u0026#x27;s current alerts as replaced, keeping their decisions for reference, and opens its findings as new pending alerts; a check that fails changes nothing. One agreement check workflow runs per agreement. Pairs an open claim holds, pairs already being checked and invoices that cannot be checked are always left out; the preview\u0026#x27;s exclusions count them. One request starts at most 5,000 agreement checks across 50 agreements, 500 purchase-order checks and 500 duplicate checks, all or nothing; larger selections return 409. A workflow_run_ids entry means a check started, not that it finished: follow each workflow run. Send an Idempotency-Key to repeat a request safely after a lost response.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Watchdog Help Center\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/watchdog-7cea1057/6F6OCFT8gZxc3FZT/_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/watchdog-7cea1057/6F6OCFT8gZxc3FZT/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/watchdog-7cea1057/6F6OCFT8gZxc3FZT/_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/watchdog-7cea1057/6F6OCFT8gZxc3FZT/_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/watchdog-7cea1057/6F6OCFT8gZxc3FZT/_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/watchdog-7cea1057/6F6OCFT8gZxc3FZT/_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/watchdog-7cea1057/6F6OCFT8gZxc3FZT/_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/watchdog-7cea1057/6F6OCFT8gZxc3FZT/_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/watchdog-7cea1057/6F6OCFT8gZxc3FZT/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Start compliance checks - Watchdog Help Center\">\u003cmeta data-mint-head property=\"og:description\" content=\"Checks invoices against their matched agreements and purchase orders. A check that completes closes its pair\u0026#x27;s current alerts as replaced, keeping their decisions for reference, and opens its findings as new pending alerts; a check that fails changes nothing. One agreement check workflow runs per agreement. Pairs an open claim holds, pairs already being checked and invoices that cannot be checked are always left out; the preview\u0026#x27;s exclusions count them. One request starts at most 5,000 agreement checks across 50 agreements, 500 purchase-order checks and 500 duplicate checks, all or nothing; larger selections return 409. A workflow_run_ids entry means a check started, not that it finished: follow each workflow run. Send an Idempotency-Key to repeat a request safely after a lost response.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Watchdog Help Center\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.watchdog.no/api-reference/endpoints/compliance-checks/start-compliance-checks\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://watchdog-7cea1057.mintlify.site/_mintlify/api/og/v2?division=Compliance+checks\u0026amp;title=Start+compliance+checks\u0026amp;description=Checks+invoices+against+their+matched+agreements+and+purchase+orders.+A+check+that+completes+closes+its+pair%27s+current+alerts+as+replaced%2C+keeping+their+decisio\u0026amp;theme=3ce0d3a3382d965df629a40c\u0026amp;signature=4a2edb0e79b0965e19f4c1ef9dadd60562370265d8a75306beb1cad321862fdd\">\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=\"Start compliance checks - Watchdog Help Center\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Checks invoices against their matched agreements and purchase orders. A check that completes closes its pair\u0026#x27;s current alerts as replaced, keeping their decisions for reference, and opens its findings as new pending alerts; a check that fails changes nothing. One agreement check workflow runs per agreement. Pairs an open claim holds, pairs already being checked and invoices that cannot be checked are always left out; the preview\u0026#x27;s exclusions count them. One request starts at most 5,000 agreement checks across 50 agreements, 500 purchase-order checks and 500 duplicate checks, all or nothing; larger selections return 409. A workflow_run_ids entry means a check started, not that it finished: follow each workflow run. Send an Idempotency-Key to repeat a request safely after a lost response.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://watchdog-7cea1057.mintlify.site/_mintlify/api/og/v2?division=Compliance+checks\u0026amp;title=Start+compliance+checks\u0026amp;description=Checks+invoices+against+their+matched+agreements+and+purchase+orders.+A+check+that+completes+closes+its+pair%27s+current+alerts+as+replaced%2C+keeping+their+decisio\u0026amp;theme=3ce0d3a3382d965df629a40c\u0026amp;signature=4a2edb0e79b0965e19f4c1ef9dadd60562370265d8a75306beb1cad321862fdd\">\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/watchdog-7cea1057/6F6OCFT8gZxc3FZT/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Watchdog Help Center\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#534AB7\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.watchdog.no/api-reference/endpoints/compliance-checks/start-compliance-checks\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoints/compliance-checks/start-compliance-checks.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://watchdog.no/#organization\",\"name\":\"Watchdog\",\"url\":\"https://watchdog.no\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://docs.watchdog.no/assets/logo-light.svg\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.watchdog.no#website\",\"name\":\"Watchdog Help Center\",\"url\":\"https://docs.watchdog.no\",\"publisher\":{\"@id\":\"https://watchdog.no/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.watchdog.no/api-reference/endpoints/compliance-checks/start-compliance-checks#webpage\",\"url\":\"https://docs.watchdog.no/api-reference/endpoints/compliance-checks/start-compliance-checks\",\"name\":\"Start compliance checks\",\"description\":\"Checks invoices against their matched agreements and purchase orders. A check that completes closes its pair's current alerts as replaced, keeping their decisions for reference, and opens its findings as new pending alerts; a check that fails changes nothing. One agreement check workflow runs per agreement. Pairs an open claim holds, pairs already being checked and invoices that cannot be checked are always left out; the preview's exclusions count them. One request starts at most 5,000 agreement checks across 50 agreements, 500 purchase-order checks and 500 duplicate checks, all or nothing; larger selections return 409. A workflow_run_ids entry means a check started, not that it finished: follow each workflow run. Send an Idempotency-Key to repeat a request safely after a lost response.\",\"dateModified\":\"2026-11-18T12:33:59.282Z\",\"isPartOf\":{\"@id\":\"https://docs.watchdog.no#website\"},\"breadcrumb\":{\"@id\":\"https://docs.watchdog.no/api-reference/endpoints/compliance-checks/start-compliance-checks#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.watchdog.no/api-reference/endpoints/compliance-checks/start-compliance-checks#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.watchdog.no/api-reference/endpoints/overview/get-the-organization-overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Compliance checks\",\"item\":\"https://docs.watchdog.no/api-reference/endpoints/compliance-checks/list-compliance-checks\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Start compliance checks\",\"item\":\"https://docs.watchdog.no/api-reference/endpoints/compliance-checks/start-compliance-checks\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.watchdog.no/api-reference/endpoints/compliance-checks/start-compliance-checks#apireference\",\"headline\":\"Start compliance checks\",\"name\":\"Start compliance checks\",\"description\":\"Checks invoices against their matched agreements and purchase orders. A check that completes closes its pair's current alerts as replaced, keeping their decisions for reference, and opens its findings as new pending alerts; a check that fails changes nothing. One agreement check workflow runs per agreement. Pairs an open claim holds, pairs already being checked and invoices that cannot be checked are always left out; the preview's exclusions count them. One request starts at most 5,000 agreement checks across 50 agreements, 500 purchase-order checks and 500 duplicate checks, all or nothing; larger selections return 409. A workflow_run_ids entry means a check started, not that it finished: follow each workflow run. Send an Idempotency-Key to repeat a request safely after a lost response.\",\"url\":\"https://docs.watchdog.no/api-reference/endpoints/compliance-checks/start-compliance-checks\",\"mainEntityOfPage\":{\"@id\":\"https://docs.watchdog.no/api-reference/endpoints/compliance-checks/start-compliance-checks#webpage\"},\"dateModified\":\"2026-11-18T12:33:59.282Z\",\"publisher\":{\"@id\":\"https://watchdog.no/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.watchdog.no#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Watchdog Help Center\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Watchdog\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/endpoints/compliance-checks/start-compliance-checks.md","siteName":"Watchdog Help Center","nav":{"global":{"anchors":[{"anchor":"Watchdog","icon":"house","href":"https://watchdog.no"}]},"languages":[{"language":"en","default":true,"navbar":{"links":[{"href":"mailto:support@watchdog.no","label":"Support"}],"primary":{"type":"button","label":"Open Watchdog","href":"https://app.watchdog.no"}},"tabs":[{"tab":"User guides","icon":"book-open","pages":[{"title":"User guides","href":""}]},{"tab":"API","icon":"code","groups":[{"group":"Start here","pages":[{"title":"Watchdog API","icon":"code","tag":"Beta","href":"/api-reference/introduction"},{"title":"Quickstart","icon":"terminal","href":"/api-reference/quickstart"},{"title":"Authentication and API keys","icon":"key","href":"/api-reference/authentication"},{"title":"Upload invoices","icon":"file-arrow-up","href":"/api-reference/upload-invoices"},{"title":"API conventions","icon":"key","href":"/api-reference/conventions"},{"title":"Views","icon":"filter","href":"/api-reference/views"},{"title":"Teams","icon":"users","href":"/api-reference/teams"},{"title":"Changelog","icon":"bullhorn","href":"/api-reference/changelog"}]},{"group":"Understand your data","pages":[{"title":"Overview and search","href":"/api-reference/overview-search"},{"title":"Invoices","icon":"file-invoice","href":"/api-reference/invoices"},{"title":"Alerts","icon":"bell","href":"/api-reference/alerts"},{"title":"Claims","icon":"hand-holding-dollar","href":"/api-reference/claims"},{"title":"Agreements","icon":"file-contract","href":"/api-reference/agreements"},{"title":"Matching","icon":"link","href":"/api-reference/matching"},{"title":"Compliance checks","icon":"shield-check","href":"/api-reference/compliance-checks"},{"title":"Integrations and syncs","icon":"plug","href":"/api-reference/integrations"},{"title":"Workflow runs","icon":"list-check","href":"/api-reference/workflow-runs"},{"title":"Activity and comments","href":"/api-reference/activity"}]},{"group":"Endpoints","pages":[{"group":"Home and search","pages":[{"title":"Get the organization overview","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/overview","href":"/api-reference/endpoints/overview/get-the-organization-overview"},{"title":"Get the AP flow statistics","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/overview/ap-flow","href":"/api-reference/endpoints/overview/get-the-ap-flow-statistics"},{"title":"Find agreements, invoices, alerts, topics and claims by name","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/search","href":"/api-reference/endpoints/search/find-agreements-invoices-alerts-topics-and-claims-by-name"}]},{"group":"Identity","pages":[{"title":"Get the current user","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/me","href":"/api-reference/endpoints/identity/get-the-current-user"}]},{"group":"Organizations","pages":[{"title":"List your organizations","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organizations","href":"/api-reference/endpoints/organizations/list-your-organizations"},{"title":"Get an organization","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/organization","href":"/api-reference/endpoints/organizations/get-an-organization"},{"title":"Set the organization logo","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/organization/logo","href":"/api-reference/endpoints/organizations/set-the-organization-logo"},{"title":"Update an organization","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/organization","href":"/api-reference/endpoints/organizations/update-an-organization"}]},{"group":"Companies","pages":[{"title":"List companies","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/companies","href":"/api-reference/endpoints/companies/list-companies"},{"title":"Create a company","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/companies","href":"/api-reference/endpoints/companies/create-a-company"},{"title":"Get a company","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/companies/{id}","href":"/api-reference/endpoints/companies/get-a-company"},{"title":"Update a company","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/companies/{id}","href":"/api-reference/endpoints/companies/update-a-company"},{"title":"Generate a description of a company","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/companies/{id}/description/generate","href":"/api-reference/endpoints/companies/generate-a-description-of-a-company"},{"title":"Preview archiving a company","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/companies/{id}/archive/preview","href":"/api-reference/endpoints/companies/preview-archiving-a-company"},{"title":"Archive a company","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/companies/{id}/archive","href":"/api-reference/endpoints/companies/archive-a-company"},{"title":"Unarchive a company","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/companies/{id}/unarchive","href":"/api-reference/endpoints/companies/unarchive-a-company"},{"title":"Preview exporting a company","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/companies/{id}/export/preview","href":"/api-reference/endpoints/companies/preview-exporting-a-company"},{"title":"Export a company's data","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/companies/{id}/export","href":"/api-reference/endpoints/companies/export-a-companys-data"},{"title":"Preview erasing a company","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/companies/{id}/erasure/preview","href":"/api-reference/endpoints/companies/preview-erasing-a-company"},{"title":"Request erasure of a company","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/companies/{id}/erasure","href":"/api-reference/endpoints/companies/request-erasure-of-a-company"},{"title":"Cancel a company's erasure","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/companies/{id}/erasure","href":"/api-reference/endpoints/companies/cancel-a-companys-erasure"},{"title":"Get how a company receives invoices","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/companies/{id}/reception","href":"/api-reference/endpoints/companies/get-how-a-company-receives-invoices"},{"title":"Give a company its own invoice address","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/companies/{id}/email-address","href":"/api-reference/endpoints/companies/give-a-company-its-own-invoice-address"},{"title":"List a company's delivery addresses","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/companies/{id}/delivery-addresses","href":"/api-reference/endpoints/companies/list-a-companys-delivery-addresses"},{"title":"Add a delivery address to a company","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/companies/{id}/delivery-addresses","href":"/api-reference/endpoints/companies/add-a-delivery-address-to-a-company"},{"title":"Change a company's delivery address","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/companies/{id}/delivery-addresses/{address_id}","href":"/api-reference/endpoints/companies/change-a-companys-delivery-address"},{"title":"List the countries with a company register","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/companies/register/countries","href":"/api-reference/endpoints/companies/list-the-countries-with-a-company-register"},{"title":"Search a country's company register","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/companies/register/search","href":"/api-reference/endpoints/companies/search-a-countrys-company-register"},{"title":"Preview a company's legal identity","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/companies/register/preview","href":"/api-reference/endpoints/companies/preview-a-companys-legal-identity"}]},{"group":"Members","pages":[{"title":"List who has access: organization members and roles","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/members","href":"/api-reference/endpoints/members/list-who-has-access:-organization-members-and-roles"},{"title":"Get an organization member","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/members/{user_id}","href":"/api-reference/endpoints/members/get-an-organization-member"},{"title":"Update a member","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/members/{user_id}","href":"/api-reference/endpoints/members/update-a-member"},{"title":"Remove an organization member","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/members/{user_id}","href":"/api-reference/endpoints/members/remove-an-organization-member"}]},{"group":"Invitations","pages":[{"title":"List organization invitations","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/invitations","href":"/api-reference/endpoints/invitations/list-organization-invitations"},{"title":"Get an organization invitation","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/invitations/{id}","href":"/api-reference/endpoints/invitations/get-an-organization-invitation"},{"title":"Invite organization members","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/invitations","href":"/api-reference/endpoints/invitations/invite-organization-members"},{"title":"Revoke an organization invitation","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/invitations/{id}","href":"/api-reference/endpoints/invitations/revoke-an-organization-invitation"}]},{"group":"Notifications","pages":[{"title":"Read notification preferences","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/notifications/preferences","href":"/api-reference/endpoints/notifications/read-notification-preferences"},{"title":"Update notification preferences","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/notifications/preferences","href":"/api-reference/endpoints/notifications/update-notification-preferences"},{"title":"Follow a View","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/notifications/followed-views/{view_id}","href":"/api-reference/endpoints/notifications/follow-a-view"},{"title":"Unfollow a View","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/notifications/followed-views/{view_id}","href":"/api-reference/endpoints/notifications/unfollow-a-view"},{"title":"List notification channels","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/notifications/channels","href":"/api-reference/endpoints/notifications/list-notification-channels"},{"title":"Create a notification channel","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/notifications/channels","href":"/api-reference/endpoints/notifications/create-a-notification-channel"},{"title":"Read a notification channel","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/notifications/channels/{id}","href":"/api-reference/endpoints/notifications/read-a-notification-channel"},{"title":"Disconnect a notification channel","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/notifications/channels/{id}","href":"/api-reference/endpoints/notifications/disconnect-a-notification-channel"}]},{"group":"Views","pages":[{"title":"List shared Views","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/views","href":"/api-reference/endpoints/views/list-shared-views"},{"title":"Get a shared View","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/views/{id}","href":"/api-reference/endpoints/views/get-a-shared-view"},{"title":"Create a shared View","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/views","href":"/api-reference/endpoints/views/create-a-shared-view"},{"title":"Update a shared View","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/views/{id}","href":"/api-reference/endpoints/views/update-a-shared-view"},{"title":"Delete a shared View","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/views/{id}","href":"/api-reference/endpoints/views/delete-a-shared-view"}]},{"group":"Teams","pages":[{"title":"List teams","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/teams","href":"/api-reference/endpoints/teams/list-teams"},{"title":"Get a team","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/teams/{id}","href":"/api-reference/endpoints/teams/get-a-team"},{"title":"Create a team","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/teams","href":"/api-reference/endpoints/teams/create-a-team"},{"title":"Update a team","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/teams/{id}","href":"/api-reference/endpoints/teams/update-a-team"},{"title":"Delete a team","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/teams/{id}","href":"/api-reference/endpoints/teams/delete-a-team"}]},{"group":"Approval rules","pages":[{"title":"List approval rules","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/approval-rules","href":"/api-reference/endpoints/approval-rules/list-approval-rules"},{"title":"Get an approval rule","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/approval-rules/{id}","href":"/api-reference/endpoints/approval-rules/get-an-approval-rule"},{"title":"Create an approval rule","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/approval-rules","href":"/api-reference/endpoints/approval-rules/create-an-approval-rule"},{"title":"Update an approval rule","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/approval-rules/{id}","href":"/api-reference/endpoints/approval-rules/update-an-approval-rule"},{"title":"Delete an approval rule","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/approval-rules/{id}","href":"/api-reference/endpoints/approval-rules/delete-an-approval-rule"},{"title":"Order approval rules","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/approval-rules/order","href":"/api-reference/endpoints/approval-rules/order-approval-rules"}]},{"group":"Approval policy","pages":[{"title":"Get the approval policy","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/approval-policy","href":"/api-reference/endpoints/approval-policy/get-the-approval-policy"},{"title":"Update the approval policy","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/approval-policy","href":"/api-reference/endpoints/approval-policy/update-the-approval-policy"}]},{"group":"Usage","pages":[{"title":"List usage by billing period","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/usage","href":"/api-reference/endpoints/usage/list-usage-by-billing-period"},{"title":"Get usage policy","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/usage/policy","href":"/api-reference/endpoints/usage/get-usage-policy"},{"title":"List usage policy revisions","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/usage/policy/revisions","href":"/api-reference/endpoints/usage/list-usage-policy-revisions"},{"title":"Update usage overage policy","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/usage/policy","href":"/api-reference/endpoints/usage/update-usage-overage-policy"}]},{"group":"Agreements","pages":[{"title":"List agreements","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/agreements","href":"/api-reference/endpoints/agreements/list-agreements"},{"title":"Count agreements by status","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/agreements/counts","href":"/api-reference/endpoints/agreements/count-agreements-by-status"},{"title":"Get an agreement","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/agreements/{id}","href":"/api-reference/endpoints/agreements/get-an-agreement"},{"title":"List suggested instruction edits","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/agreements/{id}/context-suggestions","href":"/api-reference/endpoints/agreements/list-suggested-instruction-edits"},{"title":"List the Views that include an agreement","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/agreements/{id}/views","href":"/api-reference/endpoints/agreements/list-the-views-that-include-an-agreement"},{"title":"Create an agreement","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/agreements","href":"/api-reference/endpoints/agreements/create-an-agreement"},{"title":"Suggest agreement details","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/agreements/{id}/suggest-details","href":"/api-reference/endpoints/agreements/suggest-agreement-details"},{"title":"Refresh an agreement's invoice matching","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/matching/refresh","href":"/api-reference/endpoints/agreements/refresh-an-agreements-invoice-matching"},{"title":"Find matching purchase orders","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/agreements/{id}/purchase-order-matching","href":"/api-reference/endpoints/agreements/find-matching-purchase-orders"},{"title":"List excluded invoices","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/agreements/{id}/invoice-exclusions","href":"/api-reference/endpoints/agreements/list-excluded-invoices"},{"title":"Exclude invoices from an agreement","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/agreements/{id}/invoice-exclusions","href":"/api-reference/endpoints/agreements/exclude-invoices-from-an-agreement"},{"title":"Restore excluded invoices","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/agreements/{id}/invoice-exclusions/delete","href":"/api-reference/endpoints/agreements/restore-excluded-invoices"},{"title":"Accept a suggested instruction edit","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/agreements/{id}/context-suggestions/{suggestion_id}/accept","href":"/api-reference/endpoints/agreements/accept-a-suggested-instruction-edit"},{"title":"Reject a suggested instruction edit","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/agreements/{id}/context-suggestions/{suggestion_id}/reject","href":"/api-reference/endpoints/agreements/reject-a-suggested-instruction-edit"},{"title":"Teach the agreement a rule from alerts (don't flag this again)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/agreements/{id}/teach","href":"/api-reference/endpoints/agreements/teach-the-agreement-a-rule-from-alerts-dont-flag-this-again"},{"title":"Edit an agreement","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/agreements/{id}","href":"/api-reference/endpoints/agreements/edit-an-agreement"},{"title":"Preview deleting an agreement","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/agreements/{id}/delete/preview","href":"/api-reference/endpoints/agreements/preview-deleting-an-agreement"},{"title":"Delete an agreement","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/agreements/{id}","href":"/api-reference/endpoints/agreements/delete-an-agreement"},{"group":"Tags","pages":[{"title":"List agreement tags","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/agreements/tags","href":"/api-reference/endpoints/agreement-tags/list-agreement-tags"},{"title":"Create an agreement tag","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/agreements/tags","href":"/api-reference/endpoints/agreement-tags/create-an-agreement-tag"},{"title":"Rename an agreement tag","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/agreements/tags/{id}","href":"/api-reference/endpoints/agreement-tags/rename-an-agreement-tag"},{"title":"Preview deleting an agreement tag","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/agreements/tags/{id}/delete/preview","href":"/api-reference/endpoints/agreement-tags/preview-deleting-an-agreement-tag"},{"title":"Delete an agreement tag","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/agreements/tags/{id}","href":"/api-reference/endpoints/agreement-tags/delete-an-agreement-tag"}]},{"group":"Prices","pages":[{"title":"List the agreed prices of an agreement","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/agreements/{id}/price-items","href":"/api-reference/endpoints/agreement-prices/list-the-agreed-prices-of-an-agreement"},{"title":"Export agreement prices as CSV","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/agreements/{id}/price-items/export","href":"/api-reference/endpoints/agreement-prices/export-agreement-prices-as-csv"},{"title":"Add agreement prices","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/agreements/{id}/price-items","href":"/api-reference/endpoints/agreement-prices/add-agreement-prices"},{"title":"Edit agreement prices","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/agreements/{id}/price-items","href":"/api-reference/endpoints/agreement-prices/edit-agreement-prices"},{"title":"Remove matching agreement prices","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/agreements/{id}/price-items/delete","href":"/api-reference/endpoints/agreement-prices/remove-matching-agreement-prices"}]},{"group":"Documents","pages":[{"title":"List agreement documents","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/agreements/{id}/documents","href":"/api-reference/endpoints/agreement-documents/list-agreement-documents"},{"title":"Import documents to an agreement","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/agreements/{id}/document-imports","href":"/api-reference/endpoints/agreement-documents/import-documents-to-an-agreement"},{"title":"Edit document role or position","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/agreements/{id}/documents/{document_id}","href":"/api-reference/endpoints/agreement-documents/edit-document-role-or-position"},{"title":"Unlink an agreement document","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/agreements/{id}/documents/{document_id}","href":"/api-reference/endpoints/agreement-documents/unlink-an-agreement-document"}]},{"group":"Price imports","pages":[{"title":"List price imports","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/agreements/{id}/price-imports","href":"/api-reference/endpoints/agreement-price-imports/list-price-imports"},{"title":"Get a price import","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/agreements/{id}/price-imports/{import_id}","href":"/api-reference/endpoints/agreement-price-imports/get-a-price-import"},{"title":"Get a link to download the rows a price import extracted","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/agreements/{id}/price-imports/{import_id}/download","href":"/api-reference/endpoints/agreement-price-imports/get-a-link-to-download-the-rows-a-price-import-extracted"},{"title":"Import prices from documents","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/agreements/{id}/price-imports","href":"/api-reference/endpoints/agreement-price-imports/import-prices-from-documents"}]}]},{"group":"Alerts","pages":[{"title":"List alerts","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/alerts","href":"/api-reference/endpoints/alerts/list-alerts"},{"title":"Total alert amounts, overall or per supplier, agreement, topic or month","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/alerts/metrics","href":"/api-reference/endpoints/alerts/total-alert-amounts-overall-or-per-supplier-agreement-topic-or-month"},{"title":"Get an alert","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/alerts/{id}","href":"/api-reference/endpoints/alerts/get-an-alert"},{"title":"List alert topics","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/alert-topics","href":"/api-reference/endpoints/alerts/list-alert-topics"},{"title":"Get an alert topic","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/alert-topics/{id}","href":"/api-reference/endpoints/alerts/get-an-alert-topic"},{"title":"Export selected alerts","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/alerts/export","href":"/api-reference/endpoints/alerts/export-selected-alerts"},{"title":"Get a topic proposal","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/alert-topic-proposals/{id}","href":"/api-reference/endpoints/alerts/get-a-topic-proposal"},{"title":"Create an alert","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/alerts","href":"/api-reference/endpoints/alerts/create-an-alert"},{"title":"Create an alert topic","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/alert-topics","href":"/api-reference/endpoints/alerts/create-an-alert-topic"},{"title":"Update alerts: confirm, mark as false alarm, skip, move back to review, add to or remove from a claim, move to another topic","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/alerts/update","href":"/api-reference/endpoints/alerts/update-alerts:-confirm-mark-as-false-alarm-skip-move-back-to-review-add-to-or-remove-from-a-claim-move-to-another-topic"},{"title":"Delete selected alerts","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/alerts/delete","href":"/api-reference/endpoints/alerts/delete-selected-alerts"},{"title":"Categorize an agreement's alerts","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/agreements/{id}/alert-topics/reconcile","href":"/api-reference/endpoints/alerts/categorize-an-agreements-alerts"},{"title":"Propose a topic merge or split","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/alert-topic-proposals","href":"/api-reference/endpoints/alerts/propose-a-topic-merge-or-split"},{"title":"Apply a topic proposal","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/alert-topic-proposals/{id}/apply","href":"/api-reference/endpoints/alerts/apply-a-topic-proposal"},{"title":"Update an alert: edit, confirm, mark as false alarm, skip, move back to review, add to a claim, move to another topic","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/alerts/{id}","href":"/api-reference/endpoints/alerts/update-an-alert:-edit-confirm-mark-as-false-alarm-skip-move-back-to-review-add-to-a-claim-move-to-another-topic"},{"title":"Edit an alert topic","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/alert-topics/{id}","href":"/api-reference/endpoints/alerts/edit-an-alert-topic"},{"title":"Delete an alert topic","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/alert-topics/{id}","href":"/api-reference/endpoints/alerts/delete-an-alert-topic"}]},{"group":"Claims","pages":[{"title":"List claims","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/claims","href":"/api-reference/endpoints/claims/list-claims"},{"title":"Get claim and recovery totals","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/claims/metrics","href":"/api-reference/endpoints/claims/get-claim-and-recovery-totals"},{"title":"Get a claim","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/claims/{id}","href":"/api-reference/endpoints/claims/get-a-claim"},{"title":"List claim recoveries","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/claims/{id}/recoveries","href":"/api-reference/endpoints/claims/list-claim-recoveries"},{"title":"List credit notes that may answer a claim","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/claims/{id}/credit-note-suggestions","href":"/api-reference/endpoints/claims/list-credit-notes-that-may-answer-a-claim"},{"title":"Export a claim","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/claims/{id}/export","href":"/api-reference/endpoints/claims/export-a-claim"},{"title":"List claim invoice documents","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/claims/{id}/documents","href":"/api-reference/endpoints/claims/list-claim-invoice-documents"},{"title":"Create a claim","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/claims","href":"/api-reference/endpoints/claims/create-a-claim"},{"title":"Preview adding alerts to a claim","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/claims/alerts/preview","href":"/api-reference/endpoints/claims/preview-adding-alerts-to-a-claim"},{"title":"Delete a claim","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/claims/{id}","href":"/api-reference/endpoints/claims/delete-a-claim"},{"title":"Record a claim recovery","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/claims/{id}/recoveries","href":"/api-reference/endpoints/claims/record-a-claim-recovery"},{"title":"Update a claim","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/claims/{id}","href":"/api-reference/endpoints/claims/update-a-claim"},{"title":"Update a recovery","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/recoveries/{id}","href":"/api-reference/endpoints/claims/update-a-recovery"},{"title":"Delete a recovery","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/recoveries/{id}","href":"/api-reference/endpoints/claims/delete-a-recovery"}]},{"group":"Compliance checks","pages":[{"title":"List compliance checks","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/compliance-checks","href":"/api-reference/endpoints/compliance-checks/list-compliance-checks"},{"title":"Get a compliance check","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/compliance-checks/{id}","href":"/api-reference/endpoints/compliance-checks/get-a-compliance-check"},{"title":"List compliance check findings","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/compliance-checks/{id}/findings","href":"/api-reference/endpoints/compliance-checks/list-compliance-check-findings"},{"title":"Get a compliance check transcript","description":"Shows how the check reached its result: each tool call it made, in order, with its reason and result, followed by the final summary. An alert links its check through provenance.retained_check.","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/compliance-checks/{id}/transcript","href":"/api-reference/endpoints/compliance-checks/get-a-compliance-check-transcript"},{"title":"Start compliance checks","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/checks","href":"/api-reference/endpoints/compliance-checks/start-compliance-checks"},{"title":"Reset compliance checks","description":"Starts a selection of invoice–agreement pairs over: cancels their unfinished checks, deletes their alerts, whoever created them, and marks them unchecked, so the next check evaluates them again. Alerts of a pair an open claim holds are kept. Completed compliance checks are retained. Nothing is started. A reset takes at most 50,000 pairs at once. An empty selection resets nothing and returns zeros. Repeating a reset deletes nothing more.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/checks/reset","href":"/api-reference/endpoints/compliance-checks/reset-compliance-checks"}]},{"group":"Documents","pages":[{"title":"List documents","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/documents","href":"/api-reference/endpoints/documents/list-documents"},{"title":"Get document metadata","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/documents/{id}","href":"/api-reference/endpoints/documents/get-document-metadata"},{"title":"Get a link to download a document","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/documents/{id}/download","href":"/api-reference/endpoints/documents/get-a-link-to-download-a-document"},{"title":"Read the text of a document or agreement contract","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/documents/{id}/text","href":"/api-reference/endpoints/documents/read-the-text-of-a-document-or-agreement-contract"},{"title":"Download selected documents as a ZIP archive","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/documents/download-archive","href":"/api-reference/endpoints/documents/download-selected-documents-as-a-zip-archive"},{"title":"Get a link to upload a document","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/documents/upload","href":"/api-reference/endpoints/documents/get-a-link-to-upload-a-document"},{"title":"Upload a document","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/documents/upload/direct","href":"/api-reference/endpoints/documents/upload-a-document"},{"title":"Extract document text","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/documents/{id}/extract","href":"/api-reference/endpoints/documents/extract-document-text"},{"title":"Index an agreement document","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/documents/{id}/index","href":"/api-reference/endpoints/documents/index-an-agreement-document"},{"title":"Search what the agreement text says about a subject","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/documents/search","href":"/api-reference/endpoints/documents/search-what-the-agreement-text-says-about-a-subject"},{"title":"Delete unused documents","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/documents/delete","href":"/api-reference/endpoints/documents/delete-unused-documents"}]},{"group":"Invoice imports","pages":[{"title":"List invoice imports","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/invoices/imports","href":"/api-reference/endpoints/invoice-imports/list-invoice-imports"},{"title":"Get an invoice import","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/invoices/imports/{id}","href":"/api-reference/endpoints/invoice-imports/get-an-invoice-import"},{"title":"Import an invoice from documents","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/invoices/imports","href":"/api-reference/endpoints/invoice-imports/import-an-invoice-from-documents"},{"title":"Import as an invoice","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/invoices/imports/{id}/import-as-invoice","href":"/api-reference/endpoints/invoice-imports/import-as-an-invoice"},{"title":"Choose the supplier of an import","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/invoices/imports/{id}/letter-creditor","href":"/api-reference/endpoints/invoice-imports/choose-the-supplier-of-an-import"},{"title":"Remove selected imports from history","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/invoices/imports/delete","href":"/api-reference/endpoints/invoice-imports/remove-selected-imports-from-history"},{"title":"List what was received and needs attention","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/intake/needs-attention","href":"/api-reference/endpoints/invoice-imports/list-what-was-received-and-needs-attention"},{"title":"Mark needs-attention items as handled","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/intake/needs-attention/handle","href":"/api-reference/endpoints/invoice-imports/mark-needs-attention-items-as-handled"},{"title":"Reopen handled needs-attention items","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/intake/needs-attention/reopen","href":"/api-reference/endpoints/invoice-imports/reopen-handled-needs-attention-items"},{"title":"Report needs-attention items to Watchdog support","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/intake/needs-attention/report","href":"/api-reference/endpoints/invoice-imports/report-needs-attention-items-to-watchdog-support"},{"title":"List received invoice emails","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/intake/emails","href":"/api-reference/endpoints/invoice-imports/list-received-invoice-emails"}]},{"group":"Invoices","pages":[{"title":"Total invoice spend, overall or per supplier, recipient or month","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/invoices/metrics","href":"/api-reference/endpoints/invoices/total-invoice-spend-overall-or-per-supplier-recipient-or-month"},{"title":"Count active invoices in each lifecycle phase and status","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/invoices/lifecycle-counts","href":"/api-reference/endpoints/invoices/count-active-invoices-in-each-lifecycle-phase-and-status"},{"title":"Find what was paid for a product across invoices","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/invoices/line-items","href":"/api-reference/endpoints/invoices/find-what-was-paid-for-a-product-across-invoices"},{"title":"Export selected invoices as CSV","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/invoices/export","href":"/api-reference/endpoints/invoices/export-selected-invoices-as-csv"},{"title":"List the columns of the invoice export","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/invoices/export/columns","href":"/api-reference/endpoints/invoices/list-the-columns-of-the-invoice-export"},{"title":"Find invoices by supplier, number, date or status","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/invoices","href":"/api-reference/endpoints/invoices/find-invoices-by-supplier-number-date-or-status"},{"title":"Get an invoice","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/invoices/{id}","href":"/api-reference/endpoints/invoices/get-an-invoice"},{"title":"Get an invoice's checks","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/invoices/{id}/checks","href":"/api-reference/endpoints/invoices/get-an-invoices-checks"},{"title":"List invoice line items","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/invoices/{id}/line-items","href":"/api-reference/endpoints/invoices/list-invoice-line-items"},{"title":"List linked invoices of every category","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/invoices/{id}/matched-invoices","href":"/api-reference/endpoints/invoices/list-linked-invoices-of-every-category"},{"title":"List invoice documents","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/invoices/{id}/documents","href":"/api-reference/endpoints/invoices/list-invoice-documents"},{"title":"Get an invoice as a PDF","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/invoices/{id}/pdf","href":"/api-reference/endpoints/invoices/get-an-invoice-as-a-pdf"},{"title":"List matched agreements","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/invoices/{id}/agreements","href":"/api-reference/endpoints/invoices/list-matched-agreements"},{"title":"Get invoice coding","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/invoices/{id}/coding","href":"/api-reference/endpoints/invoices/get-invoice-coding"},{"title":"List invoice reminders","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/invoices/{id}/reminders","href":"/api-reference/endpoints/invoices/list-invoice-reminders"},{"title":"Link or unlink a letter claim and its original invoice","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/invoices/{id}/letter-claims/{claim_id}/link","href":"/api-reference/endpoints/invoices/link-or-unlink-a-letter-claim-and-its-original-invoice"},{"title":"Import an original included in a letter PDF","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/invoices/{id}/letter-claims/{claim_id}/import-original","href":"/api-reference/endpoints/invoices/import-an-original-included-in-a-letter-pdf"},{"title":"Find a letter original in Tripletex","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/invoices/{id}/letter-claims/{claim_id}/lookup-original","href":"/api-reference/endpoints/invoices/find-a-letter-original-in-tripletex"},{"title":"Preview rereading an invoice or letter","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/invoices/{id}/classification/preview","href":"/api-reference/endpoints/invoices/preview-rereading-an-invoice-or-letter"},{"title":"Reread an invoice or letter with a corrected interpretation","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/invoices/{id}/classification","href":"/api-reference/endpoints/invoices/reread-an-invoice-or-letter-with-a-corrected-interpretation"},{"title":"Choose an invoice's company","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/invoices/{id}/company","href":"/api-reference/endpoints/invoices/choose-an-invoices-company"},{"title":"Get invoice readiness","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/invoices/{id}/readiness","href":"/api-reference/endpoints/invoices/get-invoice-readiness"},{"title":"Create an invoice from structured data","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/invoices","href":"/api-reference/endpoints/invoices/create-an-invoice-from-structured-data"},{"title":"Restore an invoice","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/invoices/{id}/restore","href":"/api-reference/endpoints/invoices/restore-an-invoice"},{"title":"Send an invoice to the accounting system","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/invoices/{id}/transfer","href":"/api-reference/endpoints/invoices/send-an-invoice-to-the-accounting-system"},{"title":"Book a sent invoice in the accounting system","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/invoices/{id}/book","href":"/api-reference/endpoints/invoices/book-a-sent-invoice-in-the-accounting-system"},{"title":"Add or remove invoice approvers","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/invoices/update-approvers","href":"/api-reference/endpoints/invoices/add-or-remove-invoice-approvers"},{"title":"Set an invoice's approval steps","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/invoices/{id}/approval-steps","href":"/api-reference/endpoints/invoices/set-an-invoices-approval-steps"},{"title":"Preview who cannot see invoices before assigning approvers","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/invoices/approver-visibility","href":"/api-reference/endpoints/invoices/preview-who-cannot-see-invoices-before-assigning-approvers"},{"title":"Add a matched invoice","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/invoices/{id}/matched-invoices","href":"/api-reference/endpoints/invoices/add-a-matched-invoice"},{"title":"Refresh an invoice","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/invoices/{id}/refresh","href":"/api-reference/endpoints/invoices/refresh-an-invoice"},{"title":"Attach a document to an invoice","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/invoices/{id}/documents","href":"/api-reference/endpoints/invoices/attach-a-document-to-an-invoice"},{"title":"Suggest invoice coding","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/invoices/{id}/coding/suggest","href":"/api-reference/endpoints/invoices/suggest-invoice-coding"},{"title":"Clear invoice coding","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/invoices/{id}/coding/clear","href":"/api-reference/endpoints/invoices/clear-invoice-coding"},{"title":"Make a document the primary invoice document","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/invoices/{id}/documents/{document_id}","href":"/api-reference/endpoints/invoices/make-a-document-the-primary-invoice-document"},{"title":"Update an invoice, or send, approve, hold, close or mark it paid","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/invoices/{id}","href":"/api-reference/endpoints/invoices/update-an-invoice-or-send-approve-hold-close-or-mark-it-paid"},{"title":"Code invoice lines","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/invoices/{id}/coding","href":"/api-reference/endpoints/invoices/code-invoice-lines"},{"title":"Soft-delete an invoice","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/invoices/{id}","href":"/api-reference/endpoints/invoices/soft-delete-an-invoice"},{"title":"Remove a matched invoice","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/invoices/{id}/matched-invoices/{match_id}","href":"/api-reference/endpoints/invoices/remove-a-matched-invoice"},{"title":"Unlink an invoice document","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/invoices/{id}/documents/{document_id}","href":"/api-reference/endpoints/invoices/unlink-an-invoice-document"}]},{"group":"Purchase orders","pages":[{"title":"List purchase orders","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/purchase-orders","href":"/api-reference/endpoints/purchase-orders/list-purchase-orders"},{"title":"Count purchase orders","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/purchase-orders/metrics","href":"/api-reference/endpoints/purchase-orders/count-purchase-orders"},{"title":"Count purchase orders without totals","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/purchase-orders/counts","href":"/api-reference/endpoints/purchase-orders/count-purchase-orders-without-totals"},{"title":"Get a purchase order","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/purchase-orders/{id}","href":"/api-reference/endpoints/purchase-orders/get-a-purchase-order"},{"title":"List purchase order revisions","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/purchase-orders/{id}/revisions","href":"/api-reference/endpoints/purchase-orders/list-purchase-order-revisions"},{"title":"Check a purchase order against its agreement","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/purchase-orders/{id}/agreement-check","href":"/api-reference/endpoints/purchase-orders/check-a-purchase-order-against-its-agreement"},{"title":"List an agreement's prices as purchase order lines","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/purchase-orders/agreement-prices","href":"/api-reference/endpoints/purchase-orders/list-an-agreements-prices-as-purchase-order-lines"},{"title":"Export a purchase order","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/purchase-orders/{id}/export","href":"/api-reference/endpoints/purchase-orders/export-a-purchase-order"},{"title":"Create a purchase order","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/purchase-orders","href":"/api-reference/endpoints/purchase-orders/create-a-purchase-order"},{"title":"Preview a purchase order","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/purchase-orders/preview","href":"/api-reference/endpoints/purchase-orders/preview-a-purchase-order"},{"title":"Preview a purchase order's references","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/purchase-orders/preview/references","href":"/api-reference/endpoints/purchase-orders/preview-a-purchase-orders-references"},{"title":"Update a purchase order","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/purchase-orders/{id}","href":"/api-reference/endpoints/purchase-orders/update-a-purchase-order"},{"title":"Add or remove purchase order approvers","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/purchase-orders/{id}/update-approvers","href":"/api-reference/endpoints/purchase-orders/add-or-remove-purchase-order-approvers"},{"title":"Record goods received","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/purchase-orders/{id}/receipts","href":"/api-reference/endpoints/purchase-orders/record-goods-received"},{"title":"Push a purchase order to an accounting system","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/purchase-orders/{id}/pushes","href":"/api-reference/endpoints/purchase-orders/push-a-purchase-order-to-an-accounting-system"},{"title":"Delete a draft purchase order","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/purchase-orders/{id}","href":"/api-reference/endpoints/purchase-orders/delete-a-draft-purchase-order"},{"group":"Documents","pages":[{"title":"List purchase order documents","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/purchase-orders/{id}/documents","href":"/api-reference/endpoints/purchase-order-documents/list-purchase-order-documents"},{"title":"Attach a document to a purchase order","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/purchase-orders/{id}/documents","href":"/api-reference/endpoints/purchase-order-documents/attach-a-document-to-a-purchase-order"},{"title":"Remove a document from a purchase order","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/purchase-orders/{id}/documents/{document_id}","href":"/api-reference/endpoints/purchase-order-documents/remove-a-document-from-a-purchase-order"}]},{"group":"Supplier email","pages":[{"title":"Read purchase order correspondence","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/purchase-orders/{id}/correspondence","href":"/api-reference/endpoints/purchase-orders/read-purchase-order-correspondence"},{"title":"Revoke the purchase order reply address","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/purchase-orders/{id}/reply-address","href":"/api-reference/endpoints/purchase-orders/revoke-the-purchase-order-reply-address"}]},{"group":"Imports","pages":[{"title":"Get a purchase order import","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/purchase-orders/imports/{id}","href":"/api-reference/endpoints/purchase-order-imports/get-a-purchase-order-import"},{"title":"Create a purchase order from documents","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/purchase-orders/imports","href":"/api-reference/endpoints/purchase-order-imports/create-a-purchase-order-from-documents"}]},{"group":"Invoices","pages":[{"title":"List invoices related to a purchase order","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/purchase-orders/{id}/invoices","href":"/api-reference/endpoints/purchase-orders/list-invoices-related-to-a-purchase-order"},{"title":"Reconcile invoices referencing a purchase order","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/purchase-orders/{id}/invoices/refresh","href":"/api-reference/endpoints/purchase-orders/reconcile-invoices-referencing-a-purchase-order"},{"title":"List invoice purchase order decisions","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/invoices/{id}/purchase-orders","href":"/api-reference/endpoints/invoices/list-invoice-purchase-order-decisions"},{"title":"Accept a purchase order for an invoice","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/invoices/{id}/purchase-orders","href":"/api-reference/endpoints/invoices/accept-a-purchase-order-for-an-invoice"},{"title":"Reject or unlink an invoice purchase order","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/invoices/{id}/purchase-orders/{poId}","href":"/api-reference/endpoints/invoices/reject-or-unlink-an-invoice-purchase-order"},{"title":"Reset purchase orders to automatic matching","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/invoices/{id}/purchase-orders/reset","href":"/api-reference/endpoints/invoices/reset-purchase-orders-to-automatic-matching"},{"title":"List which purchase order each invoice line bills","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/invoices/{id}/purchase-orders/allocations","href":"/api-reference/endpoints/invoices/list-which-purchase-order-each-invoice-line-bills"},{"title":"Assign whole invoice lines to purchase orders","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/invoices/{id}/purchase-orders/allocations","href":"/api-reference/endpoints/invoices/assign-whole-invoice-lines-to-purchase-orders"}]}]},{"group":"Suppliers and recipients","pages":[{"title":"List suppliers or recipients","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/parties","href":"/api-reference/endpoints/suppliers-and-recipients/list-suppliers-or-recipients"},{"title":"Get a supplier or recipient","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/parties/{id}","href":"/api-reference/endpoints/suppliers-and-recipients/get-a-supplier-or-recipient"},{"title":"Create a supplier or recipient","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/parties","href":"/api-reference/endpoints/suppliers-and-recipients/create-a-supplier-or-recipient"},{"title":"Find a supplier or recipient by organization or VAT number","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/parties/match","href":"/api-reference/endpoints/suppliers-and-recipients/find-a-supplier-or-recipient-by-organization-or-vat-number"},{"title":"Update a supplier or recipient","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/parties/{id}","href":"/api-reference/endpoints/suppliers-and-recipients/update-a-supplier-or-recipient"},{"title":"List likely duplicate suppliers or recipients","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/parties/duplicates","href":"/api-reference/endpoints/suppliers-and-recipients/list-likely-duplicate-suppliers-or-recipients"},{"title":"Export suppliers or recipients","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/parties/export","href":"/api-reference/endpoints/suppliers-and-recipients/export-suppliers-or-recipients"},{"title":"Merge suppliers or recipients","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/parties/{id}/merge","href":"/api-reference/endpoints/suppliers-and-recipients/merge-suppliers-or-recipients"},{"title":"Delete unused suppliers or recipients","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/parties/delete","href":"/api-reference/endpoints/suppliers-and-recipients/delete-unused-suppliers-or-recipients"},{"title":"List the accounting system's suppliers","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/parties/erp-suppliers","href":"/api-reference/endpoints/suppliers-and-recipients/list-the-accounting-systems-suppliers"},{"title":"List a supplier's links to the accounting system","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/parties/{id}/erp-links","href":"/api-reference/endpoints/suppliers-and-recipients/list-a-suppliers-links-to-the-accounting-system"},{"title":"Link a supplier to the accounting system","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/parties/{id}/erp-links","href":"/api-reference/endpoints/suppliers-and-recipients/link-a-supplier-to-the-accounting-system"},{"title":"Create a supplier in the accounting system","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/parties/{id}/erp-links/create","href":"/api-reference/endpoints/suppliers-and-recipients/create-a-supplier-in-the-accounting-system"},{"title":"Unlink a supplier from the accounting system","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/parties/{id}/erp-links/unlink","href":"/api-reference/endpoints/suppliers-and-recipients/unlink-a-supplier-from-the-accounting-system"}]},{"group":"Integrations","pages":[{"title":"List integration providers","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/integration-providers","href":"/api-reference/endpoints/integrations/list-integration-providers"},{"title":"List accounting integrations and their health","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/integrations","href":"/api-reference/endpoints/integrations/list-accounting-integrations-and-their-health"},{"title":"Create an integration","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/integrations","href":"/api-reference/endpoints/integrations/create-an-integration"},{"title":"Test an integration","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/integrations/test","href":"/api-reference/endpoints/integrations/test-an-integration"},{"title":"List the provider’s ledger accounts","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/integrations/ledger-accounts","href":"/api-reference/endpoints/integrations/list-the-provider’s-ledger-accounts"},{"title":"Retrieve an integration","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/integrations/{id}","href":"/api-reference/endpoints/integrations/retrieve-an-integration"},{"title":"Update an integration","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/integrations/{id}","href":"/api-reference/endpoints/integrations/update-an-integration"},{"title":"Delete an integration","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/integrations/{id}","href":"/api-reference/endpoints/integrations/delete-an-integration"},{"title":"List the provider’s suppliers","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/integrations/{id}/suppliers","href":"/api-reference/endpoints/integrations/list-the-provider’s-suppliers"},{"title":"List the provider’s companies","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/integrations/{id}/companies","href":"/api-reference/endpoints/integrations/list-the-provider’s-companies"},{"title":"List the connection's companies","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/integrations/{id}/company-links","href":"/api-reference/endpoints/integrations/list-the-connections-companies"},{"title":"Link a connection's company","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/integrations/{id}/company-links/{link_id}","href":"/api-reference/endpoints/integrations/link-a-connections-company"},{"title":"Make workspace companies of a connection's companies","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/integrations/{id}/company-links/create-companies","href":"/api-reference/endpoints/integrations/make-workspace-companies-of-a-connections-companies"},{"title":"Start a sync","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/integrations/{id}/syncs","href":"/api-reference/endpoints/integrations/start-a-sync"},{"title":"List syncs","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/integrations/{id}/syncs","href":"/api-reference/endpoints/integrations/list-syncs"},{"title":"Retrieve a sync","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/integrations/{id}/syncs/{sync_id}","href":"/api-reference/endpoints/integrations/retrieve-a-sync"},{"title":"Check the sign-in sending goes through","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/integrations/{id}/sign-in/check","href":"/api-reference/endpoints/integrations/check-the-sign-in-sending-goes-through"},{"title":"Remove the sign-in sending goes through","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/integrations/{id}/sign-in","href":"/api-reference/endpoints/integrations/remove-the-sign-in-sending-goes-through"},{"title":"List ledger accounts","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/ledger-accounts","href":"/api-reference/endpoints/integrations/list-ledger-accounts"},{"title":"List VAT codes","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/vat-codes","href":"/api-reference/endpoints/integrations/list-vat-codes"},{"title":"List dimensions","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/dimensions","href":"/api-reference/endpoints/integrations/list-dimensions"},{"title":"List dimension values","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/dimension-values","href":"/api-reference/endpoints/integrations/list-dimension-values"},{"title":"List accounting sources","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/accounting-sources","href":"/api-reference/endpoints/integrations/list-accounting-sources"}]},{"group":"Workflow runs","pages":[{"title":"List workflow runs","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/workflow-runs","href":"/api-reference/endpoints/workflow-runs/list-workflow-runs"},{"title":"Get a workflow run","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/workflow-runs/{id}","href":"/api-reference/endpoints/workflow-runs/get-a-workflow-run"},{"title":"List workflow run items","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/workflow-runs/{id}/items","href":"/api-reference/endpoints/workflow-runs/list-workflow-run-items"},{"title":"Cancel one workflow item","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/workflow-runs/{id}/items/{item_id}/cancel","href":"/api-reference/endpoints/workflow-runs/cancel-one-workflow-item"},{"title":"Cancel a workflow run","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/workflow-runs/{id}/cancel","href":"/api-reference/endpoints/workflow-runs/cancel-a-workflow-run"},{"title":"Retry a workflow run","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/workflow-runs/{id}/retry","href":"/api-reference/endpoints/workflow-runs/retry-a-workflow-run"}]},{"group":"Activity and comments","pages":[{"title":"Read an entity activity timeline","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/activity","href":"/api-reference/endpoints/activity/read-an-entity-activity-timeline"},{"title":"Get a comment","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/comments/{id}","href":"/api-reference/endpoints/comments/get-a-comment"},{"title":"List comment replies","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/comments/{id}/replies","href":"/api-reference/endpoints/comments/list-comment-replies"},{"title":"Create a comment or reply","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/comments","href":"/api-reference/endpoints/comments/create-a-comment-or-reply"},{"title":"Edit your comment","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/comments/{id}","href":"/api-reference/endpoints/comments/edit-your-comment"},{"title":"Delete your comment","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/comments/{id}","href":"/api-reference/endpoints/comments/delete-your-comment"}]}]}]}]},{"language":"no","footer":{"links":[{"header":"Watchdog","items":[{"label":"Nettside","href":"https://watchdog.no"},{"label":"Kundestøtte","href":"mailto:support@watchdog.no"}]}]},"navbar":{"links":[{"href":"mailto:support@watchdog.no","label":"Kundestøtte"}],"primary":{"type":"button","label":"Åpne Watchdog","href":"https://app.watchdog.no"}},"pages":[{"title":"no","href":"/no"}]}]},"basePath":"","title":"Start compliance checks - Watchdog Help Center","deploymentId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","buildId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-jJHA3WSo.js","utils-DbZn3Mjn.js","cloneDeep-CnBnaSyy.js","_Uint8Array-CMQtTgBR.js","isObject-FP1Yky1u.js","utils-Bl2DvzOJ.js","addUniqueKeysToSchema-BwOLo9p1.js","snippetPresets-BBiPpKa-.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-C0px4Tml.js","isEqual-zAyttAAO.js","usePlaygroundInputsStore-Dell6dGw.js","shallow-0VKqkSqN.js","getApiPlaygroundDisplay-CP_ctPEB.js","CodeSnippet-5L35ic0s.js","CodeSnippets-DOXbNhJw.js","Page-DRLI_2Ue.js","getPastedJson-VhzT9m2P.js","icon-CD8_AtCO.js","MethodPill-DGgOMftG.js","DuplicateIcon-DZ6A_EtN.js","createIcon-DUl4oM5f.js","DynamicMarkdown-BGHukeRM.js","SectionHeading-ChrEUs8u.js","axios-vUo_bRtp.js","Markdown-Dj-na-_-.js","dist-C5gjFYHe.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-DEBW87tT.js"]}