curl --request GET \
--url https://api.watchdog.no/v1/invoices/imports/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.watchdog.no/v1/invoices/imports/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.watchdog.no/v1/invoices/imports/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "queued",
"origin": "upload",
"supersedes_invoice": true,
"deleted_at": "2023-11-07T05:31:56Z",
"primary_document": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"file_name": "<string>",
"mime_type": "<string>",
"file_size": 123,
"page_count": 123,
"md5_checksum": "<string>",
"properties": {
"kind": "workbook",
"sheets": [
{
"name": "<string>",
"hidden": true,
"row_count": 1
}
]
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"version": 123,
"previous_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"source_count": 1,
"attachment_count": 1,
"retryable": true,
"provenance": {
"uploader": {
"user_id": "<string>",
"name": "<string>",
"deleted": true
},
"api_key": {
"name": "<string>"
},
"email": {
"sender": "<string>",
"name": "<string>"
},
"integration": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"type": "<string>",
"deleted": true
}
},
"classification_reason": "<string>",
"outcome": "imported",
"invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workflow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workflow_run_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"failure": {
"code": "<string>",
"message": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"sources": [
{
"document": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"file_name": "<string>",
"mime_type": "<string>",
"file_size": 123,
"page_count": 123,
"md5_checksum": "<string>",
"properties": {
"kind": "workbook",
"sheets": [
{
"name": "<string>",
"hidden": true,
"row_count": 1
}
]
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"version": 123,
"previous_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"role": "primary",
"position": 123
}
],
"sources_next_cursor": "<string>",
"evidence": [
{
"stage": "inspection",
"succeeded": true,
"created_at": "2023-11-07T05:31:56Z",
"confidence_level": "high",
"confidence_reason": "<string>"
}
]
}{
"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": "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"
}
}Get an invoice import
Returns an import’s status, source documents, extraction results and resulting invoice. A completed import has outcome imported, duplicate or not_invoice.
curl --request GET \
--url https://api.watchdog.no/v1/invoices/imports/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.watchdog.no/v1/invoices/imports/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.watchdog.no/v1/invoices/imports/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "queued",
"origin": "upload",
"supersedes_invoice": true,
"deleted_at": "2023-11-07T05:31:56Z",
"primary_document": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"file_name": "<string>",
"mime_type": "<string>",
"file_size": 123,
"page_count": 123,
"md5_checksum": "<string>",
"properties": {
"kind": "workbook",
"sheets": [
{
"name": "<string>",
"hidden": true,
"row_count": 1
}
]
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"version": 123,
"previous_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"source_count": 1,
"attachment_count": 1,
"retryable": true,
"provenance": {
"uploader": {
"user_id": "<string>",
"name": "<string>",
"deleted": true
},
"api_key": {
"name": "<string>"
},
"email": {
"sender": "<string>",
"name": "<string>"
},
"integration": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"type": "<string>",
"deleted": true
}
},
"classification_reason": "<string>",
"outcome": "imported",
"invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workflow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workflow_run_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"failure": {
"code": "<string>",
"message": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"sources": [
{
"document": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"file_name": "<string>",
"mime_type": "<string>",
"file_size": 123,
"page_count": 123,
"md5_checksum": "<string>",
"properties": {
"kind": "workbook",
"sheets": [
{
"name": "<string>",
"hidden": true,
"row_count": 1
}
]
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"version": 123,
"previous_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"role": "primary",
"position": 123
}
],
"sources_next_cursor": "<string>",
"evidence": [
{
"stage": "inspection",
"succeeded": true,
"created_at": "2023-11-07T05:31:56Z",
"confidence_level": "high",
"confidence_reason": "<string>"
}
]
}{
"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": "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
Query Parameters
Return only these fields, comma-separated; use dots for nested fields, such as provenance.uploader. id is always returned. Fields: id, status, origin, supersedes_invoice, deleted_at, primary_document, source_count, attachment_count, retryable, provenance, classification_reason, outcome, invoice_id, workflow_run_id, workflow_run_item_id, failure, created_at, updated_at, sources, sources_next_cursor, evidence.
Response
The import.
queued, running, completed, failed, cancelled How the invoice was submitted.
upload, api, email, integration True when this import replaces an existing invoice from the same source.
Show child attributes
Show child attributes
x >= 0x >= 0Whether the import can be retried.
Show child attributes
Show child attributes
imported, duplicate, not_invoice, null Show child attributes
Show child attributes
Show child attributes
Show child attributes
The latest result of each extraction step, for diagnostics. More steps may be added.
4Show child attributes
Show child attributes