> ## 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. # Preview category and pending corrections > Performs no writes. Includes complete financial diagnostics, party resolution, affected matches and claim conflicts. Exact-reference candidates are bounded at 100 and never selected automatically. PATCH reloads and validates current state. ## OpenAPI ````yaml /openapi-preview.json post /v1/invoices/{id}/preview-category-change 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/invoices/{id}/preview-category-change: post: tags: - Invoices summary: Preview category and pending corrections description: >- Performs no writes. Includes complete financial diagnostics, party resolution, affected matches and claim conflicts. Exact-reference candidates are bounded at 100 and never selected automatically. PATCH reloads and validates current state. operationId: previewInvoiceCategoryChange 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. - schema: type: string format: uuid required: true name: id in: path requestBody: required: true content: application/json: schema: type: object properties: supplier_id: type: - string - 'null' format: uuid recipient_id: type: - string - 'null' format: uuid category: type: string enum: - invoice - credit_note - self_billed_invoice invoice_number: type: string minLength: 1 maxLength: 255 title: type: - string - 'null' maxLength: 2000 issued_date: type: string pattern: ^\d{4}-\d{2}-\d{2}$ due_date: type: - string - 'null' pattern: ^\d{4}-\d{2}-\d{2}$ currency_code: type: string pattern: ^[A-Z]{3}$ total_amount_including_vat: type: string maxLength: 100 pattern: ^-?\d+(?:\.\d+)?$ total_amount_excluding_vat: type: - string - 'null' maxLength: 100 pattern: ^-?\d+(?:\.\d+)?$ original_currency_code: type: - string - 'null' pattern: ^[A-Z]{3}$ currency_conversion_rate: type: string maxLength: 100 pattern: ^-?\d+(?:\.\d+)?$ delivery: type: - object - 'null' properties: name: type: - string - 'null' maxLength: 2000 default: null date: type: - string - 'null' pattern: ^\d{4}-\d{2}-\d{2}$ default: null address: type: object properties: street: type: - string - 'null' maxLength: 2000 default: null city: type: - string - 'null' maxLength: 2000 default: null state: type: - string - 'null' maxLength: 2000 default: null postal_code: type: - string - 'null' maxLength: 2000 default: null country_code: type: - string - 'null' pattern: ^[A-Z]{2}$ default: null additionalProperties: false required: - address additionalProperties: false credit_note_invoice_reference: type: - string - 'null' maxLength: 2000 payment_reference: type: - string - 'null' maxLength: 2000 bank_account_number: type: - string - 'null' maxLength: 2000 order_references: type: array items: type: string minLength: 1 maxLength: 2000 maxItems: 50 buyer_reference: type: - string - 'null' maxLength: 2000 seller_reference: type: - string - 'null' maxLength: 2000 contract_reference: type: - string - 'null' maxLength: 2000 project_reference: type: - string - 'null' maxLength: 2000 accounting_cost: type: - string - 'null' maxLength: 2000 line_items: type: array items: type: object properties: id: type: string format: uuid line_number: type: integer exclusiveMinimum: 0 maximum: 2147483647 description: type: - string - 'null' maxLength: 2000 default: null product_code: type: - string - 'null' maxLength: 2000 default: null quantity: type: string maxLength: 100 pattern: ^-?\d+(?:\.\d+)?$ unit: type: - string - 'null' maxLength: 2000 default: null unit_price: type: string maxLength: 100 pattern: ^-?\d+(?:\.\d+)?$ discount_rate: type: string maxLength: 100 pattern: ^-?\d+(?:\.\d+)?$ default: '0' surcharge_rate: type: string maxLength: 100 pattern: ^-?\d+(?:\.\d+)?$ default: '0' vat_rate: type: string maxLength: 100 pattern: ^-?\d+(?:\.\d+)?$ default: '0' total_excluding_vat: type: string maxLength: 100 pattern: ^-?\d+(?:\.\d+)?$ period_start: type: - string - 'null' pattern: ^\d{4}-\d{2}-\d{2}$ default: null period_end: type: - string - 'null' pattern: ^\d{4}-\d{2}-\d{2}$ default: null notes: type: - string - 'null' maxLength: 2000 default: null required: - line_number - quantity - unit_price - total_excluding_vat additionalProperties: false minItems: 1 maxItems: 500 supplier_snapshot: type: - object - 'null' properties: name: type: - string - 'null' maxLength: 2000 main_name: type: - string - 'null' maxLength: 2000 department: type: - string - 'null' maxLength: 2000 organization_number: type: - string - 'null' maxLength: 2000 email: type: - string - 'null' maxLength: 2000 website: type: - string - 'null' maxLength: 2000 address: type: - object - 'null' properties: street: type: - string - 'null' maxLength: 2000 city: type: - string - 'null' maxLength: 2000 state: type: - string - 'null' maxLength: 2000 postal_code: type: - string - 'null' maxLength: 2000 country_code: type: - string - 'null' pattern: ^[A-Z]{2}$ additionalProperties: false additionalProperties: false recipient_snapshot: type: - object - 'null' properties: name: type: - string - 'null' maxLength: 2000 main_name: type: - string - 'null' maxLength: 2000 department: type: - string - 'null' maxLength: 2000 organization_number: type: - string - 'null' maxLength: 2000 email: type: - string - 'null' maxLength: 2000 website: type: - string - 'null' maxLength: 2000 address: type: - object - 'null' properties: street: type: - string - 'null' maxLength: 2000 city: type: - string - 'null' maxLength: 2000 state: type: - string - 'null' maxLength: 2000 postal_code: type: - string - 'null' maxLength: 2000 country_code: type: - string - 'null' pattern: ^[A-Z]{2}$ additionalProperties: false additionalProperties: false payment_override: type: - object - 'null' properties: outstanding_amount: type: string maxLength: 100 pattern: ^-?\d+(?:\.\d+)?$ required: - outstanding_amount additionalProperties: false extraction_confirmed: type: boolean line_item_changes: type: object properties: create: type: array items: type: object properties: line_number: type: integer exclusiveMinimum: 0 maximum: 2147483647 description: type: - string - 'null' maxLength: 2000 default: null product_code: type: - string - 'null' maxLength: 2000 default: null quantity: type: string maxLength: 100 pattern: ^-?\d+(?:\.\d+)?$ unit: type: - string - 'null' maxLength: 2000 default: null unit_price: type: string maxLength: 100 pattern: ^-?\d+(?:\.\d+)?$ discount_rate: type: string maxLength: 100 pattern: ^-?\d+(?:\.\d+)?$ default: '0' surcharge_rate: type: string maxLength: 100 pattern: ^-?\d+(?:\.\d+)?$ default: '0' vat_rate: type: string maxLength: 100 pattern: ^-?\d+(?:\.\d+)?$ default: '0' total_excluding_vat: type: string maxLength: 100 pattern: ^-?\d+(?:\.\d+)?$ period_start: type: - string - 'null' pattern: ^\d{4}-\d{2}-\d{2}$ default: null period_end: type: - string - 'null' pattern: ^\d{4}-\d{2}-\d{2}$ default: null notes: type: - string - 'null' maxLength: 2000 default: null required: - line_number - quantity - unit_price - total_excluding_vat additionalProperties: false maxItems: 500 default: [] update: type: array items: type: object properties: line_number: type: integer exclusiveMinimum: 0 maximum: 2147483647 description: type: - string - 'null' maxLength: 2000 product_code: type: - string - 'null' maxLength: 2000 quantity: type: string maxLength: 100 pattern: ^-?\d+(?:\.\d+)?$ unit: type: - string - 'null' maxLength: 2000 unit_price: type: string maxLength: 100 pattern: ^-?\d+(?:\.\d+)?$ discount_rate: type: string maxLength: 100 pattern: ^-?\d+(?:\.\d+)?$ surcharge_rate: type: string maxLength: 100 pattern: ^-?\d+(?:\.\d+)?$ vat_rate: type: string maxLength: 100 pattern: ^-?\d+(?:\.\d+)?$ total_excluding_vat: type: string maxLength: 100 pattern: ^-?\d+(?:\.\d+)?$ period_start: type: - string - 'null' pattern: ^\d{4}-\d{2}-\d{2}$ period_end: type: - string - 'null' pattern: ^\d{4}-\d{2}-\d{2}$ notes: type: - string - 'null' maxLength: 2000 id: type: string format: uuid required: - id additionalProperties: false maxItems: 500 default: [] remove: type: array items: type: string format: uuid maxItems: 500 default: [] additionalProperties: false matched_invoice_ids: type: array items: type: string format: uuid maxItems: 50 required: - category additionalProperties: false responses: '200': description: Advisory category plan. 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: type: object properties: category: type: string enum: - invoice - credit_note - self_billed_invoice changes: type: array items: type: object properties: field: type: string from: $ref: '#/components/schemas/InvoiceCorrectionValue' to: $ref: '#/components/schemas/InvoiceCorrectionValue' required: - field - from - to line_changes: type: array items: type: object properties: id: type: - string - 'null' format: uuid changes: type: array items: type: object properties: field: type: string from: $ref: '#/components/schemas/InvoiceCorrectionValue' to: $ref: '#/components/schemas/InvoiceCorrectionValue' required: - field - from - to required: - id - changes removed_line_ids: type: array items: type: string format: uuid parties: type: object properties: supplier: type: object properties: id: type: - string - 'null' format: uuid snapshot: type: object properties: name: type: - string - 'null' organization_number: type: - string - 'null' main_name: type: - string - 'null' department: type: - string - 'null' email: type: - string - 'null' website: type: - string - 'null' address: type: object properties: street: type: - string - 'null' city: type: - string - 'null' state: type: - string - 'null' postal_code: type: - string - 'null' country_code: type: - string - 'null' required: - street - city - state - postal_code - country_code required: - name - organization_number - main_name - department - email - website - address required: - id - snapshot recipient: type: object properties: id: type: - string - 'null' format: uuid snapshot: type: object properties: name: type: - string - 'null' organization_number: type: - string - 'null' main_name: type: - string - 'null' department: type: - string - 'null' email: type: - string - 'null' website: type: - string - 'null' address: type: object properties: street: type: - string - 'null' city: type: - string - 'null' state: type: - string - 'null' postal_code: type: - string - 'null' country_code: type: - string - 'null' required: - street - city - state - postal_code - country_code required: - name - organization_number - main_name - department - email - website - address required: - id - snapshot required: - supplier - recipient financially_valid: type: boolean financial_errors: type: array items: type: object properties: code: type: string enum: - missing_financial_inputs - line_calculation_mismatch - invoice_total_mismatch - invoice_subtotal_mismatch - category_amount_mismatch field: type: string message: type: string required: - code - field - message affected_matches: type: array items: type: object properties: id: type: string format: uuid invoice_id: type: string format: uuid action: type: string enum: - retain - remove required: - id - invoice_id - action selected_invoice_ids: type: array items: type: string format: uuid retained_finding_count: type: integer claim_conflicts: type: array items: type: object properties: claim_id: type: string format: uuid reason: type: string required: - claim_id - reason exact_reference_candidates: type: array items: type: object properties: id: type: string format: uuid invoice_number: type: - string - 'null' category: type: string enum: - invoice - credit_note - self_billed_invoice supplier_id: type: - string - 'null' format: uuid currency_code: type: - string - 'null' total_amount_including_vat: type: - string - 'null' required: - id - invoice_number - category - supplier_id - currency_code - total_amount_including_vat candidates_truncated: type: boolean requires_matched_invoice_ids: type: boolean required: - category - changes - line_changes - removed_line_ids - parties - financially_valid - financial_errors - affected_matches - selected_invoice_ids - retained_finding_count - claim_conflicts - exact_reference_candidates - candidates_truncated - requires_matched_invoice_ids '400': description: >- Invalid correction or category selection, including an invalid financial result. 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 correction or category selection, including an invalid financial result. 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 resource does not exist in the current organization. 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 resource does not exist in the current organization. request_id: req_example '409': description: Invoice, relationship, or claim conflict. 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: Invoice, relationship, or claim conflict. 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: InvoiceCorrectionValue: type: - string - number - boolean - 'null' - array - object items: $ref: '#/components/schemas/InvoiceCorrectionValue' additionalProperties: $ref: '#/components/schemas/InvoiceCorrectionValue' 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. ````