> ## 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. # List claim credit notes ## OpenAPI ````yaml /openapi-preview.json get /v1/claims/{id}/credit-notes 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/{id}/credit-notes: get: tags: - Claims summary: List claim credit notes operationId: listClaimCreditNotes 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 - schema: type: integer minimum: 1 maximum: 100 default: 50 description: Maximum number of results per page. required: false description: Maximum number of results per page. name: limit in: query - schema: type: string maxLength: 4096 description: >- Opaque next_cursor from the previous page. Keep the same filters and sort; omit for the first page. required: false description: >- Opaque next_cursor from the previous page. Keep the same filters and sort; omit for the first page. name: cursor in: query responses: '200': description: >- Distinct credit notes ordered by invoice creation time and ID descending. 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: data: type: array items: $ref: '#/components/schemas/ClaimCreditNote' maxItems: 100 next_cursor: type: - string - 'null' required: - data - next_cursor '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 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 '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: ClaimCreditNote: type: object properties: credit_note: $ref: '#/components/schemas/InvoiceSummary' direct_attachment: type: - object - 'null' properties: attached_at: type: string format: date-time refund_created_by_attachment: type: boolean refund: allOf: - $ref: '#/components/schemas/ClaimRefund' - type: - object - 'null' required: - attached_at - refund_created_by_attachment - refund matched_invoices: type: array items: type: object properties: id: type: string format: uuid title: type: - string - 'null' required: - id - title description: >- Claim invoices this credit note is matched to, ordered by invoice number (missing numbers last) and ID; title is the invoice number. required: - credit_note - direct_attachment - matched_invoices 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_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 InvoiceSummary: type: object properties: id: type: string format: uuid extraction_confirmed: type: boolean readOnly: true description: >- Explicit human review acknowledgment; independent of extraction confidence and financial validity. extraction_confirmed_at: type: - string - 'null' format: date-time readOnly: true extraction_confirmed_by_user_id: type: - string - 'null' readOnly: true invoice_number: type: - string - 'null' title: type: - string - 'null' category: type: string enum: - invoice - credit_note - self_billed_invoice issued_date: type: - string - 'null' format: date due_date: type: - string - 'null' format: date created_at: type: string format: date-time updated_at: type: string format: date-time deleted_at: type: - string - 'null' format: date-time currency_code: type: - string - 'null' total_amount_excluding_vat: type: - string - 'null' maxLength: 100 pattern: ^-?\d+(?:\.\d+)?$ description: >- Exact decimal string; retain as decimal text rather than a floating-point number. example: '1250.00' total_amount_including_vat: type: - string - 'null' maxLength: 100 pattern: ^-?\d+(?:\.\d+)?$ description: >- Exact decimal string; retain as decimal text rather than a floating-point number. example: '1250.00' financially_valid: type: boolean readOnly: true description: >- Deterministic arithmetic within a tolerance of 1 currency unit. Does not imply extraction accuracy, compliance, or human approval. 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 readOnly: true alert_summary: $ref: '#/components/schemas/InvoiceAlertSummary' supplier_name: type: - string - 'null' description: Current canonical supplier name. Used by supplier ordering. recipient_name: type: - string - 'null' description: Current canonical recipient name. Used by recipient ordering. review_recommended: type: boolean readOnly: true description: >- Review is recommended for low or medium unconfirmed extraction confidence, an unmatched credit note, or financial invalidity. Uses the same predicate as the review_recommended filter. extraction_confidence: type: string enum: - high - mid - low - unknown description: >- Lowest original header/line confidence from the creating import, when both stages have reliable evidence. Structured, XML and unavailable historical evidence are unknown; manual confirmation does not change this value. relationships: type: object properties: linked_credit_note_count: type: integer minimum: 0 description: >- Recorded credit notes linked to an ordinary or self-billed invoice. matched_invoice_count: type: integer minimum: 0 description: Recorded invoices matched from a credit note. required: - linked_credit_note_count - matched_invoice_count description: >- Recorded org-owned links including soft-deleted counterparts. A match does not establish financial resolution. supplier_id: type: - string - 'null' format: uuid description: Current canonical supplier ID. recipient_id: type: - string - 'null' format: uuid description: Current canonical recipient ID. supplier_snapshot: type: object properties: name: type: - string - 'null' organization_number: type: - string - 'null' required: - name - organization_number description: Supplier details captured on the invoice. recipient_snapshot: type: object properties: name: type: - string - 'null' organization_number: type: - string - 'null' required: - name - organization_number description: Recipient details captured on the invoice. required: - id - extraction_confirmed - extraction_confirmed_at - extraction_confirmed_by_user_id - invoice_number - title - category - issued_date - due_date - created_at - updated_at - deleted_at - currency_code - total_amount_excluding_vat - total_amount_including_vat - financially_valid - financial_errors - alert_summary - supplier_name - recipient_name - review_recommended - extraction_confidence - relationships - supplier_id - recipient_id - supplier_snapshot - recipient_snapshot ClaimRefund: type: object properties: id: type: string format: uuid amount: type: string currency_code: type: string comment: type: - string - 'null' credit_note_id: type: - string - 'null' format: uuid created_by_user_id: type: - string - 'null' created_at: type: string format: date-time updated_at: type: string format: date-time required: - id - amount - currency_code - comment - credit_note_id - created_by_user_id - created_at - updated_at InvoiceAlertSummary: type: object properties: scope: type: object properties: type: type: string enum: - invoice - selected_agreements description: >- invoice evaluates overall coverage and all retained alerts; selected_agreements evaluates only selected current matches. agreement_ids: type: - array - 'null' items: type: string format: uuid maxItems: 50 description: >- Null means overall invoice coverage; otherwise only these selected, currently matched agreements. required: - type - agreement_ids checks: type: object properties: status: type: string enum: - not_checkable - checking - not_checked - completed - incomplete completed: type: integer minimum: 0 description: >- Currently matched agreements with a completed check, including outdated or unknown check inputs reported in reasons. total: type: integer minimum: 0 description: Currently matched, nondeleted agreements. reasons: type: array items: type: string enum: - credit_note - credit_note_matched - no_agreements - missing - failed - cancelled - outdated - invoice_changed - unknown description: >- outdated means a completed check read an earlier agreement version or invoice; invoice_changed accompanies it when the invoice is what moved. credit_note_matched means the invoice has a linked completed, nondeleted credit note; active partial or shared credits also block checks. required: - status - completed - total - reasons counts: type: object properties: pending: type: integer minimum: 0 claimed: type: integer minimum: 0 dismissed: type: integer minimum: 0 credited: type: integer minimum: 0 required: - pending - claimed - dismissed - credited description: All retained alerts, including dismissed and outdated alerts. is_fully_credited: type: boolean description: >- A completed, nondeleted credit note uniquely targets this invoice and offsets its total including VAT within 1 currency unit, in the same currency. has_credit_note_match: type: boolean description: >- A recorded match, not verification that findings were financially resolved. required: - scope - checks - counts - is_fully_credited - has_credit_note_match 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. ````