curl --request POST \
--url https://api.watchdog.no/v1/companies/{id}/archive \
--header 'Authorization: Bearer <token>'const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.watchdog.no/v1/companies/{id}/archive', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.watchdog.no/v1/companies/{id}/archive"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text){
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"country": "<string>",
"registration_number": "<string>",
"registration_exception_reason": "<string>",
"description": "<string>",
"register": {
"name": "<string>",
"status": "confirmed",
"registered_name": "<string>",
"bankrupt": true,
"winding_up": true,
"checked_at": "2023-11-07T05:31:56Z"
},
"peppol_available": true,
"identity_problems": [
"missing_country"
],
"archived_at": "2023-11-07T05:31:56Z",
"erasure_requested_at": "2023-11-07T05:31:56Z"
}{
"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": "company_has_open_work",
"message": "company_has_open_work: invoices wait for approval, approved invoices are not sent, or work runs for the company (previewCompanyArchive counts them). last_company: it is the only company of the workspace in use.",
"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"
}
}Archive a company
Archives a company that stopped being used: it receives nothing new and nothing automated runs for it, while its invoices, orders and history stay readable to members with access. Its Peppol receiver and the connections that serve only it are switched off; a connection shared with other companies keeps serving them. An invoice or order that still arrives for it, over a shared connection, Peppol or the workspace’s email address, is not imported: its import ends with company_archived. First finish or cancel its open work (previewCompanyArchive). Recorded in the workspace’s activity. Undo with unarchiveCompany; archiving an archived company changes nothing.
curl --request POST \
--url https://api.watchdog.no/v1/companies/{id}/archive \
--header 'Authorization: Bearer <token>'const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.watchdog.no/v1/companies/{id}/archive', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.watchdog.no/v1/companies/{id}/archive"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text){
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"country": "<string>",
"registration_number": "<string>",
"registration_exception_reason": "<string>",
"description": "<string>",
"register": {
"name": "<string>",
"status": "confirmed",
"registered_name": "<string>",
"bankrupt": true,
"winding_up": true,
"checked_at": "2023-11-07T05:31:56Z"
},
"peppol_available": true,
"identity_problems": [
"missing_country"
],
"archived_at": "2023-11-07T05:31:56Z",
"erasure_requested_at": "2023-11-07T05:31:56Z"
}{
"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": "company_has_open_work",
"message": "company_has_open_work: invoices wait for approval, approved invoices are not sent, or work runs for the company (previewCompanyArchive counts them). last_company: it is the only company of the workspace in use.",
"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
Headers
Response
The archived company.
What the company's legal identity still lacks; empty when complete. missing_country: no country. missing_registration_number: neither a number nor a reason for having none. not_in_register: the country's register holds no company with the number.
missing_country, missing_registration_number, not_in_register