curl --request POST \
--url http://localhost:3500/v1/claims \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"agreement_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({agreement_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', title: '<string>'})
};
fetch('http://localhost:3500/v1/claims', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "http://localhost:3500/v1/claims"
payload = {
"agreement_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>"
}
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",
"agreement": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>"
},
"suppliers": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
],
"title": "<string>",
"status": "pending",
"creator": {
"user_id": "<string>",
"label": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"refund_summary": {
"refund_count": 123,
"amount_by_currency": [
{
"currency_code": "<string>",
"amount": "<string>"
}
]
},
"summary": {
"total": {
"alert_count": 123,
"invoice_count": 123,
"topic_count": 123,
"impact_by_currency": [
{
"currency_code": "<string>",
"amount": "<string>"
}
]
},
"pending": {
"alert_count": 123,
"invoice_count": 123,
"topic_count": 123,
"impact_by_currency": [
{
"currency_code": "<string>",
"amount": "<string>"
}
]
},
"claimed": {
"alert_count": 123,
"invoice_count": 123,
"topic_count": 123,
"impact_by_currency": [
{
"currency_code": "<string>",
"amount": "<string>"
}
]
},
"credited": {
"alert_count": 123,
"invoice_count": 123,
"topic_count": 123,
"impact_by_currency": [
{
"currency_code": "<string>",
"amount": "<string>"
}
]
},
"dismissed": {
"alert_count": 123,
"invoice_count": 123,
"topic_count": 123,
"impact_by_currency": [
{
"currency_code": "<string>",
"amount": "<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 agreement, an alert in alerts.alert_ids within that agreement, or a selected team was not found. No claim was created.",
"request_id": "req_example"
}
}{
"error": {
"code": "conflict",
"message": "The agreement is deleted or not active or archived, an alert in alerts.alert_ids does not qualify, the filter selects too many alerts, a selected alert changed while the command ran, or a selected team has invalid saved rules. No claim was created.",
"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"
}
}Create a claim
Creates a pending claim in an owned, nondeleted active or archived agreement. Titles need not be unique. Optionally send alerts to add alerts in the same transaction, using the rules of POST /v1/claims//alerts: alerts.alert_ids or alerts.filter, at most 5000 alerts. If the request fails, no claim is created. Creation is non-idempotent: retrying can create another claim. No Idempotency-Key is supported; inspect the list after an uncertain response before creating again.
curl --request POST \
--url http://localhost:3500/v1/claims \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"agreement_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({agreement_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', title: '<string>'})
};
fetch('http://localhost:3500/v1/claims', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "http://localhost:3500/v1/claims"
payload = {
"agreement_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>"
}
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",
"agreement": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>"
},
"suppliers": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
],
"title": "<string>",
"status": "pending",
"creator": {
"user_id": "<string>",
"label": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"refund_summary": {
"refund_count": 123,
"amount_by_currency": [
{
"currency_code": "<string>",
"amount": "<string>"
}
]
},
"summary": {
"total": {
"alert_count": 123,
"invoice_count": 123,
"topic_count": 123,
"impact_by_currency": [
{
"currency_code": "<string>",
"amount": "<string>"
}
]
},
"pending": {
"alert_count": 123,
"invoice_count": 123,
"topic_count": 123,
"impact_by_currency": [
{
"currency_code": "<string>",
"amount": "<string>"
}
]
},
"claimed": {
"alert_count": 123,
"invoice_count": 123,
"topic_count": 123,
"impact_by_currency": [
{
"currency_code": "<string>",
"amount": "<string>"
}
]
},
"credited": {
"alert_count": 123,
"invoice_count": 123,
"topic_count": 123,
"impact_by_currency": [
{
"currency_code": "<string>",
"amount": "<string>"
}
]
},
"dismissed": {
"alert_count": 123,
"invoice_count": 123,
"topic_count": 123,
"impact_by_currency": [
{
"currency_code": "<string>",
"amount": "<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 agreement, an alert in alerts.alert_ids within that agreement, or a selected team was not found. No claim was created.",
"request_id": "req_example"
}
}{
"error": {
"code": "conflict",
"message": "The agreement is deleted or not active or archived, an alert in alerts.alert_ids does not qualify, the filter selects too many alerts, a selected alert changed while the command ran, or a selected team has invalid saved rules. No claim was created.",
"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
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.
Body
Response
The created claim with its current counts and amounts.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
pending, in_progress, completed, cancelled Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes