Record a claim recovery
curl --request POST \
--url https://api.watchdog.no/v1/claims/{id}/recoveries \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": "<string>",
"currency_code": "<string>",
"comment": "<string>",
"credit_note_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: '<string>',
currency_code: '<string>',
comment: '<string>',
credit_note_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://api.watchdog.no/v1/claims/{id}/recoveries', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.watchdog.no/v1/claims/{id}/recoveries"
payload = {
"amount": "<string>",
"currency_code": "<string>",
"comment": "<string>",
"credit_note_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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",
"claim_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": "<string>",
"currency_code": "<string>",
"comment": "<string>",
"credit_note_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"credit_note_number": "<string>",
"source": "manual",
"basis": "exact_note",
"created_by_user_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_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": "conflict",
"message": "The credit note is not a live credit note of the claim's suppliers, is already recorded on this claim, has no amount to default to, or has too little left for this recovery. The message then names what is left and the claims you can see that use it.",
"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"
}
}Claims
Record a claim recovery
Records money the supplier paid back on the claim, optionally with the credit note behind it. With credit_note_id and no amount or currency_code, the recovery takes what is left of the credit note, in its currency. A credit note can be split across claims: the recoveries on it never add up to more than its net amount, and use its currency (400 otherwise). A note without an amount sets no limit. Recording the same credit note twice on a claim returns 409. Repeating this request records another recovery. If the response is lost, list the claim’s recoveries before deciding whether to try again.
Record a claim recovery
curl --request POST \
--url https://api.watchdog.no/v1/claims/{id}/recoveries \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": "<string>",
"currency_code": "<string>",
"comment": "<string>",
"credit_note_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: '<string>',
currency_code: '<string>',
comment: '<string>',
credit_note_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://api.watchdog.no/v1/claims/{id}/recoveries', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.watchdog.no/v1/claims/{id}/recoveries"
payload = {
"amount": "<string>",
"currency_code": "<string>",
"comment": "<string>",
"credit_note_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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",
"claim_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": "<string>",
"currency_code": "<string>",
"comment": "<string>",
"credit_note_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"credit_note_number": "<string>",
"source": "manual",
"basis": "exact_note",
"created_by_user_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_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": "conflict",
"message": "The credit note is not a live credit note of the claim's suppliers, is already recorded on this claim, has no amount to default to, or has too little left for this recovery. The message then names what is left and the claims you can see that use it.",
"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
Body
application/json
Response
The recorded recovery. Retrying records another one.