> ## Documentation Index > Fetch the complete documentation index at: https://docs.watchdog.no/llms.txt > Use this file to discover all available pages before exploring further. # 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/{id}/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. ## OpenAPI ````yaml /openapi-preview.json post /v1/claims openapi: 3.1.0 info: title: Watchdog API (preview) version: 1.0.0 description: >- Development preview for agreements, price items, document relationships, canonical invoices, alerts and alert topics, claims and attached alerts, shared entity activity and comments, Document uploads, invoice imports, explicit invoice-agreement matching, and workflow runs. This contract is under development and is not served by api.watchdog.no. Request bodies are limited to 2 MiB (2,097,152 bytes), including all JSON fields and line data, except POST /v1/support/contact which permits 32 MiB for base64 attachments. File bytes are uploaded directly to storage. The existing public REST service retains its separate contract. servers: - url: http://localhost:3500 description: Local development Worker security: [] paths: /v1/claims: post: tags: - Claims summary: Create a claim description: >- 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/{id}/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. operationId: createClaim parameters: - name: X-Organization-Id in: header required: false schema: type: string description: >- 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. requestBody: required: true content: application/json: schema: type: object properties: agreement_id: type: string format: uuid title: type: string minLength: 1 maxLength: 200 alerts: type: object properties: alert_ids: type: array items: type: string format: uuid minItems: 1 maxItems: 5000 description: >- Explicit alerts. The command applies to every listed alert or fails: an unknown ID returns 404 and an alert that may not be changed returns 409. filter: type: object properties: mine: type: boolean description: >- Match the shared teams the authenticated user belongs to in this organization. Teams combine with OR; other filters combine with AND. No memberships or saved rules means no matches. Cannot be combined with team_ids when true. team_ids: type: array items: type: string minItems: 1 maxItems: 50 description: >- Shared team IDs (maximum 50; comma-separated in a query string, a JSON array in a command body). Teams combine with OR. Missing, foreign, or personal teams return 404; invalid saved rules return 409. claim_ids: type: array items: type: string minItems: 1 maxItems: 50 description: >- Match alerts currently attached to any selected claim; null matches alerts in no claim. Removed or transferred attachments are excluded. Claim status does not restrict matches; use claim_statuses. has_claim: type: boolean description: >- Use false to select alerts that are not currently attached to any claim. claim_statuses: type: array items: type: string enum: - pending - in_progress - completed - cancelled minItems: 1 maxItems: 50 description: >- Match alerts whose current claim has any of these statuses. invoice_ids: type: array items: type: string format: uuid minItems: 1 maxItems: 50 excluded_invoice_ids: type: array items: type: string format: uuid minItems: 1 maxItems: 50 description: Leave out alerts on any of these invoices. agreement_ids: type: array items: type: string format: uuid minItems: 1 maxItems: 50 excluded_agreement_ids: type: array items: type: string format: uuid minItems: 1 maxItems: 50 description: Leave out alerts for any of these agreements. supplier_ids: type: array items: type: string format: uuid minItems: 1 maxItems: 50 excluded_supplier_ids: type: array items: type: string format: uuid minItems: 1 maxItems: 50 description: Leave out alerts for any of these suppliers. recipient_ids: type: array items: type: string format: uuid minItems: 1 maxItems: 50 excluded_recipient_ids: type: array items: type: string format: uuid minItems: 1 maxItems: 50 description: >- Leave out alerts on invoices for any of these recipients. Alerts on invoices without a recipient still match. tag_ids: type: array items: type: string format: uuid minItems: 1 maxItems: 50 topic_ids: type: array items: type: string minItems: 1 maxItems: 50 description: >- Match alerts in any selected topic; null matches uncategorized alerts. excluded_topic_ids: type: array items: type: string format: uuid minItems: 1 maxItems: 50 description: >- Leave out alerts in any of these topics. Uncategorized alerts still match. has_topic: type: boolean description: Use false to select uncategorized alerts. statuses: type: array items: type: string enum: - pending - claimed - dismissed - credited minItems: 1 maxItems: 50 confidence_levels: type: array items: type: string enum: - high - mid - low - 'null' minItems: 1 maxItems: 50 description: >- Match any listed confidence level; null matches alerts without one. currency_codes: type: array items: type: string pattern: ^[A-Z]{3}$ minItems: 1 maxItems: 50 correction_types: type: array items: type: string enum: - modify_item - modify_invoice - add_item minItems: 1 maxItems: 50 freshness: type: string enum: - current - outdated - unknown impact_min: type: string maxLength: 100 pattern: ^-?\d+(?:\.\d+)?$ description: >- Minimum impact in the organization currency, inclusive. Alerts without an impact never match. impact_max: type: string maxLength: 100 pattern: ^-?\d+(?:\.\d+)?$ description: >- Maximum impact in the organization currency, inclusive. Alerts without an impact never match. issued_from: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Invoice issued on or after this date. issued_through: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Invoice issued on or before this date. created_from: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: >- Created on or after this calendar date in the organization's timezone. created_through: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: >- Created on or before this calendar date in the organization's timezone. search: type: string minLength: 1 maxLength: 200 description: >- Matches, ignoring case, the alert title, explanation and expected line; the supplier; the invoice number, title and line; the agreement title; or the topic title and description. A UUID also matches the alert, invoice, supplier or agreement ID. additionalProperties: false description: >- Every alert matching this filter when the claim is created. Takes the GET /v1/alerts filters with JSON lists and booleans. Matching alerts that may not be added are left out; read the created claim for its counts. excluded_alert_ids: type: array items: type: string format: uuid minItems: 1 maxItems: 5000 description: >- Alerts to leave out of a filter selection. Only valid with filter. additionalProperties: false description: >- Alerts to add in the same transaction, with the rules of POST /v1/claims/{id}/alerts. With alert_ids, an alert that does not qualify fails the request and no claim is created. required: - agreement_id - title additionalProperties: false responses: '201': description: The created claim with its current counts and amounts. headers: X-Request-Id: schema: type: string required: true description: >- Request identifier for support and diagnostics; also included in error bodies. Cache-Control: schema: type: string enum: - private, no-store required: false description: >- Organization-scoped API responses must not be cached. May be absent for requests rejected before routing. X-RateLimit-Limit: schema: type: string example: '120' required: false description: >- Requests per minute for the applicable limiter, when evaluated. Authenticated requests use the credential limit; an IP rejection uses the IP limit. Location: schema: type: string required: true content: application/json: schema: $ref: '#/components/schemas/Claim' '400': description: >- 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). headers: X-Request-Id: schema: type: string required: true description: >- Request identifier for support and diagnostics; also included in error bodies. Cache-Control: schema: type: string enum: - private, no-store required: false description: >- Organization-scoped API responses must not be cached. May be absent for requests rejected before routing. X-RateLimit-Limit: schema: type: string example: '120' required: false description: >- Requests per minute for the applicable limiter, when evaluated. Authenticated requests use the credential limit; an IP rejection uses the IP limit. content: application/json: schema: $ref: '#/components/schemas/Error_validation_error' example: 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 '401': description: Missing or invalid bearer credential. headers: X-Request-Id: schema: type: string required: true description: >- Request identifier for support and diagnostics; also included in error bodies. Cache-Control: schema: type: string enum: - private, no-store required: false description: >- Organization-scoped API responses must not be cached. May be absent for requests rejected before routing. X-RateLimit-Limit: schema: type: string example: '120' required: false description: >- Requests per minute for the applicable limiter, when evaluated. Authenticated requests use the credential limit; an IP rejection uses the IP limit. WWW-Authenticate: schema: type: string required: false description: Bearer authentication challenge, when supplied. content: application/json: schema: $ref: '#/components/schemas/Error_invalid_token' example: error: code: invalid_token message: Missing or invalid bearer credential. request_id: req_example '403': description: >- Access denied: forbidden, token_disabled, organization_required, insufficient_role, or mfa_required. Check the error code and effective permissions. headers: X-Request-Id: schema: type: string required: true description: >- Request identifier for support and diagnostics; also included in error bodies. Cache-Control: schema: type: string enum: - private, no-store required: false description: >- Organization-scoped API responses must not be cached. May be absent for requests rejected before routing. X-RateLimit-Limit: schema: type: string example: '120' required: false description: >- Requests per minute for the applicable limiter, when evaluated. Authenticated requests use the credential limit; an IP rejection uses the IP limit. content: application/json: schema: $ref: >- #/components/schemas/Error_forbidden_token_disabled_organization_required_insufficient_role_mfa_required 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 '404': description: >- The agreement, an alert in alerts.alert_ids within that agreement, or a selected team was not found. No claim was created. headers: X-Request-Id: schema: type: string required: true description: >- Request identifier for support and diagnostics; also included in error bodies. Cache-Control: schema: type: string enum: - private, no-store required: false description: >- Organization-scoped API responses must not be cached. May be absent for requests rejected before routing. X-RateLimit-Limit: schema: type: string example: '120' required: false description: >- Requests per minute for the applicable limiter, when evaluated. Authenticated requests use the credential limit; an IP rejection uses the IP limit. content: application/json: schema: $ref: '#/components/schemas/Error_not_found' 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 '409': description: >- 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. headers: X-Request-Id: schema: type: string required: true description: >- Request identifier for support and diagnostics; also included in error bodies. Cache-Control: schema: type: string enum: - private, no-store required: false description: >- Organization-scoped API responses must not be cached. May be absent for requests rejected before routing. X-RateLimit-Limit: schema: type: string example: '120' required: false description: >- Requests per minute for the applicable limiter, when evaluated. Authenticated requests use the credential limit; an IP rejection uses the IP limit. content: application/json: schema: $ref: '#/components/schemas/Error_conflict' 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 '429': description: The IP or authenticated credential exceeded its request limit. headers: X-Request-Id: schema: type: string required: true description: >- Request identifier for support and diagnostics; also included in error bodies. Cache-Control: schema: type: string enum: - private, no-store required: false description: >- Organization-scoped API responses must not be cached. May be absent for requests rejected before routing. X-RateLimit-Limit: schema: type: string example: '120' required: false description: >- Requests per minute for the applicable limiter, when evaluated. Authenticated requests use the credential limit; an IP rejection uses the IP limit. Retry-After: schema: type: string example: '60' required: true description: Seconds to wait before retrying the request. content: application/json: schema: $ref: '#/components/schemas/Error_rate_limit_exceeded' example: error: code: rate_limit_exceeded message: >- The IP or authenticated credential exceeded its request limit. request_id: req_example '500': description: >- Unexpected server failure. Include the request ID when contacting support. headers: X-Request-Id: schema: type: string required: true description: >- Request identifier for support and diagnostics; also included in error bodies. Cache-Control: schema: type: string enum: - private, no-store required: false description: >- Organization-scoped API responses must not be cached. May be absent for requests rejected before routing. X-RateLimit-Limit: schema: type: string example: '120' required: false description: >- Requests per minute for the applicable limiter, when evaluated. Authenticated requests use the credential limit; an IP rejection uses the IP limit. content: application/json: schema: $ref: '#/components/schemas/Error_internal_error' example: error: code: internal_error message: >- Unexpected server failure. Include the request ID when contacting support. request_id: req_example '503': description: >- Authentication infrastructure is unavailable or rate limited. Honor Retry-After when provided. headers: X-Request-Id: schema: type: string required: true description: >- Request identifier for support and diagnostics; also included in error bodies. Cache-Control: schema: type: string enum: - private, no-store required: false description: >- Organization-scoped API responses must not be cached. May be absent for requests rejected before routing. X-RateLimit-Limit: schema: type: string example: '120' required: false description: >- Requests per minute for the applicable limiter, when evaluated. Authenticated requests use the credential limit; an IP rejection uses the IP limit. Retry-After: schema: type: string example: '60' required: true description: Seconds to wait before retrying the request. content: application/json: schema: $ref: '#/components/schemas/Error_service_unavailable' example: error: code: service_unavailable message: >- Authentication infrastructure is unavailable or rate limited. Honor Retry-After when provided. request_id: req_example security: - ApiKeyBearer: [] - ClerkSessionBearer: [] components: schemas: Claim: type: object properties: id: type: string format: uuid agreement: type: object properties: id: type: string format: uuid title: type: - string - 'null' required: - id - title suppliers: type: array items: type: object properties: id: type: string format: uuid name: type: string required: - id - name title: type: - string - 'null' status: type: string enum: - pending - in_progress - completed - cancelled creator: type: - object - 'null' properties: user_id: type: - string - 'null' label: type: - string - 'null' required: - user_id - label created_at: type: string format: date-time updated_at: type: string format: date-time refund_summary: type: object properties: refund_count: type: integer amount_by_currency: type: array items: type: object properties: currency_code: type: string amount: type: string pattern: ^-?\d+(?:\.\d+)?$ required: - currency_code - amount required: - refund_count - amount_by_currency summary: type: object properties: total: type: object properties: alert_count: type: integer invoice_count: type: integer description: >- Distinct invoices in this population. An invoice with multiple alert statuses counts in each applicable group, but only once in total. topic_count: type: integer description: >- Distinct topics represented by alerts in this population. Alerts without a topic do not contribute. A topic with multiple statuses counts in each applicable group, but only once in total. impact_by_currency: type: array items: type: object properties: currency_code: type: string amount: type: string pattern: ^-?\d+(?:\.\d+)?$ required: - currency_code - amount description: >- Exact amounts in original currencies. Null alert impacts contribute zero. required: - alert_count - invoice_count - topic_count - impact_by_currency description: >- All currently attached alerts. The pending, claimed, credited, and dismissed populations partition it. pending: type: object properties: alert_count: type: integer invoice_count: type: integer description: >- Distinct invoices in this population. An invoice with multiple alert statuses counts in each applicable group, but only once in total. topic_count: type: integer description: >- Distinct topics represented by alerts in this population. Alerts without a topic do not contribute. A topic with multiple statuses counts in each applicable group, but only once in total. impact_by_currency: type: array items: type: object properties: currency_code: type: string amount: type: string pattern: ^-?\d+(?:\.\d+)?$ required: - currency_code - amount description: >- Exact amounts in original currencies. Null alert impacts contribute zero. required: - alert_count - invoice_count - topic_count - impact_by_currency description: >- Attached alerts with status pending; still under review and not yet counted as pursued. claimed: type: object properties: alert_count: type: integer invoice_count: type: integer description: >- Distinct invoices in this population. An invoice with multiple alert statuses counts in each applicable group, but only once in total. topic_count: type: integer description: >- Distinct topics represented by alerts in this population. Alerts without a topic do not contribute. A topic with multiple statuses counts in each applicable group, but only once in total. impact_by_currency: type: array items: type: object properties: currency_code: type: string amount: type: string pattern: ^-?\d+(?:\.\d+)?$ required: - currency_code - amount description: >- Exact amounts in original currencies. Null alert impacts contribute zero. required: - alert_count - invoice_count - topic_count - impact_by_currency description: Attached alerts with status claimed; amounts being pursued. credited: type: object properties: alert_count: type: integer invoice_count: type: integer description: >- Distinct invoices in this population. An invoice with multiple alert statuses counts in each applicable group, but only once in total. topic_count: type: integer description: >- Distinct topics represented by alerts in this population. Alerts without a topic do not contribute. A topic with multiple statuses counts in each applicable group, but only once in total. impact_by_currency: type: array items: type: object properties: currency_code: type: string amount: type: string pattern: ^-?\d+(?:\.\d+)?$ required: - currency_code - amount description: >- Exact amounts in original currencies. Null alert impacts contribute zero. required: - alert_count - invoice_count - topic_count - impact_by_currency description: >- Attached alerts with status credited; amounts are alert impact, not recorded credits or refunds. dismissed: type: object properties: alert_count: type: integer invoice_count: type: integer description: >- Distinct invoices in this population. An invoice with multiple alert statuses counts in each applicable group, but only once in total. topic_count: type: integer description: >- Distinct topics represented by alerts in this population. Alerts without a topic do not contribute. A topic with multiple statuses counts in each applicable group, but only once in total. impact_by_currency: type: array items: type: object properties: currency_code: type: string amount: type: string pattern: ^-?\d+(?:\.\d+)?$ required: - currency_code - amount description: >- Exact amounts in original currencies. Null alert impacts contribute zero. required: - alert_count - invoice_count - topic_count - impact_by_currency description: >- Attached alerts with status dismissed; amounts excluded from pursuit. required: - total - pending - claimed - credited - dismissed required: - id - agreement - suppliers - title - status - creator - created_at - updated_at - refund_summary - summary Error_validation_error: type: object properties: error: type: object properties: code: type: string enum: - validation_error message: type: string request_id: type: string description: type: string details: type: array items: type: object properties: code: type: string field: type: string message: type: string required: - code - field - message maxItems: 20 workflow_run_id: type: string format: uuid import_id: type: string format: uuid existing_party: type: object properties: type: type: string enum: - supplier - recipient id: type: string format: uuid required: - type - id required: - code - message - request_id required: - error Error_invalid_token: type: object properties: error: type: object properties: code: type: string enum: - invalid_token message: type: string request_id: type: string description: type: string details: type: array items: type: object properties: code: type: string field: type: string message: type: string required: - code - field - message maxItems: 20 workflow_run_id: type: string format: uuid import_id: type: string format: uuid existing_party: type: object properties: type: type: string enum: - supplier - recipient id: type: string format: uuid required: - type - id required: - code - message - request_id required: - error Error_forbidden_token_disabled_organization_required_insufficient_role_mfa_required: type: object properties: error: type: object properties: code: type: string enum: - forbidden - token_disabled - organization_required - insufficient_role - mfa_required message: type: string request_id: type: string description: type: string details: type: array items: type: object properties: code: type: string field: type: string message: type: string required: - code - field - message maxItems: 20 workflow_run_id: type: string format: uuid import_id: type: string format: uuid existing_party: type: object properties: type: type: string enum: - supplier - recipient id: type: string format: uuid required: - type - id required: - code - message - request_id required: - error Error_not_found: type: object properties: error: type: object properties: code: type: string enum: - not_found message: type: string request_id: type: string description: type: string details: type: array items: type: object properties: code: type: string field: type: string message: type: string required: - code - field - message maxItems: 20 workflow_run_id: type: string format: uuid import_id: type: string format: uuid existing_party: type: object properties: type: type: string enum: - supplier - recipient id: type: string format: uuid required: - type - id required: - code - message - request_id required: - error Error_conflict: type: object properties: error: type: object properties: code: type: string enum: - conflict message: type: string request_id: type: string description: type: string details: type: array items: type: object properties: code: type: string field: type: string message: type: string required: - code - field - message maxItems: 20 workflow_run_id: type: string format: uuid import_id: type: string format: uuid existing_party: type: object properties: type: type: string enum: - supplier - recipient id: type: string format: uuid required: - type - id required: - code - message - request_id required: - error Error_rate_limit_exceeded: type: object properties: error: type: object properties: code: type: string enum: - rate_limit_exceeded message: type: string request_id: type: string description: type: string details: type: array items: type: object properties: code: type: string field: type: string message: type: string required: - code - field - message maxItems: 20 workflow_run_id: type: string format: uuid import_id: type: string format: uuid existing_party: type: object properties: type: type: string enum: - supplier - recipient id: type: string format: uuid required: - type - id required: - code - message - request_id required: - error Error_internal_error: type: object properties: error: type: object properties: code: type: string enum: - internal_error message: type: string request_id: type: string description: type: string details: type: array items: type: object properties: code: type: string field: type: string message: type: string required: - code - field - message maxItems: 20 workflow_run_id: type: string format: uuid import_id: type: string format: uuid existing_party: type: object properties: type: type: string enum: - supplier - recipient id: type: string format: uuid required: - type - id required: - code - message - request_id required: - error Error_service_unavailable: type: object properties: error: type: object properties: code: type: string enum: - service_unavailable message: type: string request_id: type: string description: type: string details: type: array items: type: object properties: code: type: string field: type: string message: type: string required: - code - field - message maxItems: 20 workflow_run_id: type: string format: uuid import_id: type: string format: uuid existing_party: type: object properties: type: type: string enum: - supplier - recipient id: type: string format: uuid required: - type - id required: - code - message - request_id required: - error securitySchemes: ApiKeyBearer: type: http scheme: bearer description: >- Personal API key. Send X-Organization-Id. The required cumulative level is listed in x-watchdog-permission. ClerkSessionBearer: type: http scheme: bearer description: Clerk session with an active organization. ````