Attach a claim credit note
curl --request POST \
--url http://localhost:3500/v1/claims/{id}/credit-notes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"credit_note_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({credit_note_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'})
};
fetch('http://localhost:3500/v1/claims/{id}/credit-notes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "http://localhost:3500/v1/claims/{id}/credit-notes"
payload = { "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){
"credit_note": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"extraction_confirmed": true,
"extraction_confirmed_at": "2023-11-07T05:31:56Z",
"extraction_confirmed_by_user_id": "<string>",
"invoice_number": "<string>",
"title": "<string>",
"category": "invoice",
"issued_date": "2023-12-25",
"due_date": "2023-12-25",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"currency_code": "<string>",
"total_amount_excluding_vat": "1250.00",
"total_amount_including_vat": "1250.00",
"financially_valid": true,
"financial_errors": [
{
"code": "missing_financial_inputs",
"field": "<string>",
"message": "<string>"
}
],
"alert_summary": {
"scope": {
"type": "invoice",
"agreement_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"checks": {
"status": "not_checkable",
"completed": 1,
"total": 1,
"reasons": [
"credit_note"
]
},
"counts": {
"pending": 1,
"claimed": 1,
"dismissed": 1,
"credited": 1
},
"is_fully_credited": true,
"has_credit_note_match": true
},
"supplier_name": "<string>",
"recipient_name": "<string>",
"review_recommended": true,
"extraction_confidence": "high",
"relationships": {
"linked_credit_note_count": 1,
"matched_invoice_count": 1
},
"supplier_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"recipient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"supplier_snapshot": {
"name": "<string>",
"organization_number": "<string>"
},
"recipient_snapshot": {
"name": "<string>",
"organization_number": "<string>"
}
},
"direct_attachment": {
"attached_at": "2023-11-07T05:31:56Z",
"refund_created_by_attachment": true,
"refund": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": "<string>",
"currency_code": "<string>",
"comment": "<string>",
"credit_note_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_by_user_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
},
"matched_invoices": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>"
}
]
}{
"error": {
"code": "validation_error",
"message": "Invalid request format, parameters, or body. Details contain up to 20 actionable field errors; the complete encoded request body must be at most 2 MiB (2,097,152 bytes).",
"request_id": "req_example"
}
}{
"error": {
"code": "invalid_token",
"message": "Missing or invalid bearer credential.",
"request_id": "req_example"
}
}{
"error": {
"code": "forbidden",
"message": "Access denied: forbidden, token_disabled, organization_required, insufficient_role, or mfa_required. Check the error code and effective permissions.",
"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 refund or credit-note relationship conflicts with the current state.",
"request_id": "req_example"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "The IP or authenticated credential exceeded its request limit.",
"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": "Authentication infrastructure is unavailable or rate limited. Honor Retry-After when provided.",
"request_id": "req_example"
}
}Claims
Attach a claim credit note
Optionally creates a refund from the absolute net note amount in its own currency. A duplicate attachment returns 409. Attachment alone does not record recovery.
Attach a claim credit note
curl --request POST \
--url http://localhost:3500/v1/claims/{id}/credit-notes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"credit_note_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({credit_note_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'})
};
fetch('http://localhost:3500/v1/claims/{id}/credit-notes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "http://localhost:3500/v1/claims/{id}/credit-notes"
payload = { "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){
"credit_note": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"extraction_confirmed": true,
"extraction_confirmed_at": "2023-11-07T05:31:56Z",
"extraction_confirmed_by_user_id": "<string>",
"invoice_number": "<string>",
"title": "<string>",
"category": "invoice",
"issued_date": "2023-12-25",
"due_date": "2023-12-25",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"currency_code": "<string>",
"total_amount_excluding_vat": "1250.00",
"total_amount_including_vat": "1250.00",
"financially_valid": true,
"financial_errors": [
{
"code": "missing_financial_inputs",
"field": "<string>",
"message": "<string>"
}
],
"alert_summary": {
"scope": {
"type": "invoice",
"agreement_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"checks": {
"status": "not_checkable",
"completed": 1,
"total": 1,
"reasons": [
"credit_note"
]
},
"counts": {
"pending": 1,
"claimed": 1,
"dismissed": 1,
"credited": 1
},
"is_fully_credited": true,
"has_credit_note_match": true
},
"supplier_name": "<string>",
"recipient_name": "<string>",
"review_recommended": true,
"extraction_confidence": "high",
"relationships": {
"linked_credit_note_count": 1,
"matched_invoice_count": 1
},
"supplier_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"recipient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"supplier_snapshot": {
"name": "<string>",
"organization_number": "<string>"
},
"recipient_snapshot": {
"name": "<string>",
"organization_number": "<string>"
}
},
"direct_attachment": {
"attached_at": "2023-11-07T05:31:56Z",
"refund_created_by_attachment": true,
"refund": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": "<string>",
"currency_code": "<string>",
"comment": "<string>",
"credit_note_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_by_user_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
},
"matched_invoices": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>"
}
]
}{
"error": {
"code": "validation_error",
"message": "Invalid request format, parameters, or body. Details contain up to 20 actionable field errors; the complete encoded request body must be at most 2 MiB (2,097,152 bytes).",
"request_id": "req_example"
}
}{
"error": {
"code": "invalid_token",
"message": "Missing or invalid bearer credential.",
"request_id": "req_example"
}
}{
"error": {
"code": "forbidden",
"message": "Access denied: forbidden, token_disabled, organization_required, insufficient_role, or mfa_required. Check the error code and effective permissions.",
"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 refund or credit-note relationship conflicts with the current state.",
"request_id": "req_example"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "The IP or authenticated credential exceeded its request limit.",
"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": "Authentication infrastructure is unavailable or rate limited. Honor Retry-After when provided.",
"request_id": "req_example"
}
}Authorizations
ApiKeyBearerClerkSessionBearer
Personal API key. Send X-Organization-Id. The required cumulative level is listed in x-watchdog-permission.
Headers
Required for personal API keys. Target one organization you have access to. Migrated keys may omit it to use their original organization. For Clerk sessions, it must match the active organization.
Path Parameters
Response
Attached credit note.