curl --request POST \
--url https://api.watchdog.no/v1/integrations/{id}/syncs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://api.watchdog.no/v1/integrations/{id}/syncs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.watchdog.no/v1/integrations/{id}/syncs"
payload = {}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"integration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"trigger": "manual",
"mode": "period",
"period": {
"from": "2023-11-07T05:31:56Z",
"to": "2023-11-07T05:31:56Z"
},
"scope": {
"suppliers": {
"mode": "all",
"items": [
{
"id": "<string>",
"name": "<string>",
"code": "<string>",
"group": {
"kind": "vendor-sites",
"prefixes": [
"<string>"
],
"site_count": 123,
"inactive_site_count": 1
}
}
],
"include_unidentified": true
},
"companies": [
{
"id": "<string>",
"name": "<string>",
"country_code": "<string>",
"accounting_currency_code": "<string>"
}
],
"processing_statuses": [
"<string>"
],
"module_company_codes": {
"costinvoice": [
"<string>"
],
"purchaseorder": [
"<string>"
]
}
},
"max_files": 123,
"status": "queued",
"coverage": "in_progress",
"discovery": {
"state": "executing",
"records_scanned": 123,
"selected": 123,
"deferred": 123,
"skipped": 123
},
"items": {
"queued": 123,
"running": 123,
"completed": 123,
"failed": 123,
"cancelled": 123,
"skipped": 123
},
"invoices": {
"created": 123,
"updated": 123
},
"retryable": true,
"retry_blocked_by": "superseded",
"failure": {
"code": "<string>",
"message": "<string>"
},
"created_by": {
"id": "<string>",
"name": "<string>",
"deleted": true
},
"created_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z",
"workflow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"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": "forbidden",
"message": "Access denied. The error code says why: forbidden, token_disabled, organization_required, insufficient_role or mfa_required.",
"request_id": "req_example"
}
}{
"error": {
"code": "not_found",
"message": "The resource does not exist in the current organization.",
"request_id": "req_example"
}
}{
"error": {
"code": "sync_in_progress",
"message": "A sync is already running (workflow_run_id names it), or the integration is disabled or not tested.",
"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": "Temporarily unavailable. Retry after the Retry-After delay, when provided.",
"request_id": "req_example"
}
}Start a sync
Reads invoices for a period from the provider and imports them. The returned id is also a workflow run ID: follow it with GET /v1/workflow-runs/, whose items list imported and failed invoices. One sync runs per integration at a time. Without Admin access, the scope must name suppliers. Starting a sync cancels a running estimate.
curl --request POST \
--url https://api.watchdog.no/v1/integrations/{id}/syncs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://api.watchdog.no/v1/integrations/{id}/syncs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.watchdog.no/v1/integrations/{id}/syncs"
payload = {}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"integration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"trigger": "manual",
"mode": "period",
"period": {
"from": "2023-11-07T05:31:56Z",
"to": "2023-11-07T05:31:56Z"
},
"scope": {
"suppliers": {
"mode": "all",
"items": [
{
"id": "<string>",
"name": "<string>",
"code": "<string>",
"group": {
"kind": "vendor-sites",
"prefixes": [
"<string>"
],
"site_count": 123,
"inactive_site_count": 1
}
}
],
"include_unidentified": true
},
"companies": [
{
"id": "<string>",
"name": "<string>",
"country_code": "<string>",
"accounting_currency_code": "<string>"
}
],
"processing_statuses": [
"<string>"
],
"module_company_codes": {
"costinvoice": [
"<string>"
],
"purchaseorder": [
"<string>"
]
}
},
"max_files": 123,
"status": "queued",
"coverage": "in_progress",
"discovery": {
"state": "executing",
"records_scanned": 123,
"selected": 123,
"deferred": 123,
"skipped": 123
},
"items": {
"queued": 123,
"running": 123,
"completed": 123,
"failed": 123,
"cancelled": 123,
"skipped": 123
},
"invoices": {
"created": 123,
"updated": 123
},
"retryable": true,
"retry_blocked_by": "superseded",
"failure": {
"code": "<string>",
"message": "<string>"
},
"created_by": {
"id": "<string>",
"name": "<string>",
"deleted": true
},
"created_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z",
"workflow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"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": "forbidden",
"message": "Access denied. The error code says why: forbidden, token_disabled, organization_required, insufficient_role or mfa_required.",
"request_id": "req_example"
}
}{
"error": {
"code": "not_found",
"message": "The resource does not exist in the current organization.",
"request_id": "req_example"
}
}{
"error": {
"code": "sync_in_progress",
"message": "A sync is already running (workflow_run_id names it), or the integration is disabled or not tested.",
"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": "Temporarily unavailable. Retry after the Retry-After delay, when provided.",
"request_id": "req_example"
}
}Authorizations
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
The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.
Path Parameters
Body
First invoice date to read, inclusive.
^\d{4}-\d{2}-\d{2}$Last invoice date to read, inclusive.
^\d{4}-\d{2}-\d{2}$Omit to read the integration’s saved scope. When sent, it replaces the saved scope for this run: every dimension it leaves out reads everything instead of falling back to the saved value.
Show child attributes
Show child attributes
Stop after this many new invoices.
x <= 100000Response
The sync was admitted and is running.
Also the workflow run id: progress, items and cancel use it.
manual, scheduled period reads a requested date range; incremental continues from the last sync.
period, incremental Invoice dates read: from is inclusive, to is exclusive.
Show child attributes
Show child attributes
The scope this run used, frozen when it started.
Show child attributes
Show child attributes
queued, running, completed, failed, cancelled partial: the run ended without reading everything it was asked to (discovery stopped early, invoices were deferred, or it was cancelled). retryable says whether a retry can complete it.
in_progress, full, partial Finding the invoices to import; items then import them one by one.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
POST …/retry would resume discovery or re-queue failed invoices.
superseded, configuration_changed, integration_disabled, active_sync, null Show child attributes
Show child attributes
Show child attributes
Show child attributes