> ## 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.

# Get claim and recovery totals

> Totals for the claims matching the list filters: claim counts, the attached alerts by status and their impact, and recovery_summary, the money recovered through recoveries. Impact is what the alerts flag, not money recovered. Alert totals leave out cancelled claims unless statuses names the claims to count. To total what was recovered in a period, such as this year, set recovered_from and recovered_through: recovery_summary then counts only recoveries recorded in that window, and the counts and alert totals cover only the claims with such a recovery.



## OpenAPI

````yaml /openapi.json get /v1/claims/metrics
openapi: 3.1.0
info:
  title: Watchdog API
  version: 1.0.0
  description: >-
    The Watchdog API is served from https://api.watchdog.no. Request bodies are
    limited to 2 MiB unless an endpoint says otherwise. Files are uploaded
    directly to storage, not through the API.
servers:
  - url: https://api.watchdog.no
    description: Watchdog API
security: []
paths:
  /v1/claims/metrics:
    get:
      tags:
        - Claims
      summary: Get claim and recovery totals
      description: >-
        Totals for the claims matching the list filters: claim counts, the
        attached alerts by status and their impact, and recovery_summary, the
        money recovered through recoveries. Impact is what the alerts flag, not
        money recovered. Alert totals leave out cancelled claims unless statuses
        names the claims to count. To total what was recovered in a period, such
        as this year, set recovered_from and recovered_through: recovery_summary
        then counts only recoveries recorded in that window, and the counts and
        alert totals cover only the claims with such a recovery.
      operationId: getClaimMetrics
      parameters:
        - name: X-Organization-Id
          in: header
          required: false
          schema:
            type: string
          description: >-
            The organization to act in. Required for personal API keys; list the
            organizations you can access with GET /v1/organizations.
        - name: fields
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
          style: form
          explode: false
          description: >-
            Return only these fields; use dots for nested fields, such as
            counts.pending. Fields: total_count, counts, recovery_summary,
            summary.
        - schema:
            type: array
            items:
              type: string
          required: false
          style: form
          explode: false
          name: view_ids
          in: query
        - schema:
            type: array
            items:
              type: string
              format: uuid
          required: false
          style: form
          explode: false
          name: supplier_ids
          in: query
        - schema:
            type: array
            items:
              type: string
              format: uuid
          required: false
          style: form
          explode: false
          name: agreement_ids
          in: query
        - schema:
            type: array
            items:
              type: string
              format: uuid
            description: >-
              A company scope: claims holding alerts or credit notes of these
              companies, and claims still without either. A claim may span the
              companies its agreement covers: totals then count only these
              companies’ part, and a claim that also holds other companies reads
              as is_partial, without recovery_summary.
          required: false
          description: >-
            A company scope: claims holding alerts or credit notes of these
            companies, and claims still without either. A claim may span the
            companies its agreement covers: totals then count only these
            companies’ part, and a claim that also holds other companies reads
            as is_partial, without recovery_summary.
          style: form
          explode: false
          name: company_ids
          in: query
        - schema:
            type: array
            items:
              type: string
              enum:
                - pending
                - in_progress
                - completed
                - cancelled
          required: false
          style: form
          explode: false
          name: statuses
          in: query
        - schema:
            type: array
            items:
              type: string
              minLength: 1
              maxLength: 200
          required: false
          style: form
          explode: false
          name: creator_user_ids
          in: query
        - schema:
            type: string
            minLength: 1
            maxLength: 200
            description: Claim title or supplier name.
          required: false
          description: Claim title or supplier name.
          name: search
          in: query
        - schema:
            type: string
            pattern: ^\d{4}-\d{2}-\d{2}$
          required: false
          name: created_from
          in: query
        - schema:
            type: string
            pattern: ^\d{4}-\d{2}-\d{2}$
          required: false
          name: created_through
          in: query
        - schema:
            type: string
            pattern: ^\d{4}-\d{2}-\d{2}$
            description: >-
              Date a recovery was recorded. Keeps only claims with such a
              recovery, and recovery_summary counts only those recoveries.
          required: false
          description: >-
            Date a recovery was recorded. Keeps only claims with such a
            recovery, and recovery_summary counts only those recoveries.
          name: recovered_from
          in: query
        - schema:
            type: string
            pattern: ^\d{4}-\d{2}-\d{2}$
          required: false
          name: recovered_through
          in: query
        - schema:
            type: array
            items:
              type: string
              enum:
                - supplier_ids
                - agreement_ids
                - statuses
                - creator_user_ids
            description: List filters to invert.
          required: false
          description: List filters to invert.
          style: form
          explode: false
          name: not
          in: query
      responses:
        '200':
          description: Claim counts and amounts per currency.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClaimMetrics'
        '400':
          description: >-
            The request is invalid. details lists up to 20 field errors. Request
            bodies are limited to 2 MiB.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
          content:
            application/json:
              example:
                error:
                  code: validation_error
                  message: >-
                    The request is invalid. details lists up to 20 field errors.
                    Request bodies are limited to 2 MiB.
                  request_id: req_example
              schema:
                $ref: '#/components/schemas/Error_validation_error'
        '401':
          description: The bearer token is missing or invalid.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
            WWW-Authenticate:
              schema:
                type: string
              required: false
              description: Bearer authentication challenge, when supplied.
          content:
            application/json:
              example:
                error:
                  code: invalid_token
                  message: The bearer token is missing or invalid.
                  request_id: req_example
              schema:
                $ref: '#/components/schemas/Error_invalid_token'
        '403':
          description: >-
            Access denied. The error code says why: forbidden, token_disabled,
            organization_required, insufficient_role or mfa_required.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
          content:
            application/json:
              example:
                error:
                  code: forbidden
                  message: >-
                    Access denied. The error code says why: forbidden,
                    token_disabled, organization_required, insufficient_role or
                    mfa_required.
                  request_id: req_example
              schema:
                $ref: >-
                  #/components/schemas/Error_forbidden_token_disabled_organization_required_insufficient_role_mfa_required
        '404':
          description: The resource does not exist in the current organization.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
          content:
            application/json:
              example:
                error:
                  code: not_found
                  message: The resource does not exist in the current organization.
                  request_id: req_example
              schema:
                $ref: '#/components/schemas/Error_not_found'
        '409':
          description: >-
            One or more selected Views have invalid saved filter rules. Update
            the View filters before retrying.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
          content:
            application/json:
              example:
                error:
                  code: conflict
                  message: >-
                    One or more selected Views have invalid saved filter rules.
                    Update the View filters before retrying.
                  request_id: req_example
              schema:
                $ref: '#/components/schemas/Error_conflict'
        '429':
          description: Too many requests. Wait for the Retry-After delay before retrying.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
            Retry-After:
              schema:
                type: string
                example: '60'
              required: true
              description: Seconds to wait before retrying the request.
          content:
            application/json:
              example:
                error:
                  code: rate_limit_exceeded
                  message: >-
                    Too many requests. Wait for the Retry-After delay before
                    retrying.
                  request_id: req_example
              schema:
                $ref: '#/components/schemas/Error_rate_limit_exceeded'
        '500':
          description: >-
            Unexpected server failure. Include the request ID when contacting
            support.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
          content:
            application/json:
              example:
                error:
                  code: internal_error
                  message: >-
                    Unexpected server failure. Include the request ID when
                    contacting support.
                  request_id: req_example
              schema:
                $ref: '#/components/schemas/Error_internal_error'
        '503':
          description: >-
            Temporarily unavailable. Retry after the Retry-After delay, when
            provided.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
            Retry-After:
              schema:
                type: string
                example: '60'
              required: true
              description: Seconds to wait before retrying the request.
          content:
            application/json:
              example:
                error:
                  code: service_unavailable
                  message: >-
                    Temporarily unavailable. Retry after the Retry-After delay,
                    when provided.
                  request_id: req_example
              schema:
                $ref: '#/components/schemas/Error_service_unavailable'
      security:
        - ApiKeyBearer: []
components:
  schemas:
    ClaimMetrics:
      type: object
      properties:
        total_count:
          type: integer
        counts:
          type: object
          properties:
            pending:
              type: integer
            in_progress:
              type: integer
            completed:
              type: integer
            cancelled:
              type: integer
          required:
            - pending
            - in_progress
            - completed
            - cancelled
        recovery_summary:
          type: object
          properties:
            recovery_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:
            - recovery_count
            - amount_by_currency
          description: >-
            Recoveries recorded on the claims: the money recovered, per recovery
            currency. When a list or totals read sets recovered_from or
            recovered_through, only recoveries recorded in that window.
        summary:
          type: object
          properties:
            total:
              type: object
              properties:
                alert_count:
                  type: integer
                impact_by_currency:
                  type: array
                  items:
                    type: object
                    properties:
                      currency_code:
                        type: string
                      amount:
                        type: string
                        pattern: ^-?\d+(?:\.\d+)?$
                    required:
                      - currency_code
                      - amount
                  description: Alert impact per original currency.
              required:
                - alert_count
                - impact_by_currency
              description: All alerts in the claim.
            by_verdict:
              type: object
              properties:
                pending:
                  type: object
                  properties:
                    credited:
                      type: object
                      properties:
                        alert_count:
                          type: integer
                        impact_by_currency:
                          type: array
                          items:
                            type: object
                            properties:
                              currency_code:
                                type: string
                              amount:
                                type: string
                                pattern: ^-?\d+(?:\.\d+)?$
                            required:
                              - currency_code
                              - amount
                          description: Alert impact per original currency.
                      required:
                        - alert_count
                        - impact_by_currency
                    uncredited:
                      type: object
                      properties:
                        alert_count:
                          type: integer
                        impact_by_currency:
                          type: array
                          items:
                            type: object
                            properties:
                              currency_code:
                                type: string
                              amount:
                                type: string
                                pattern: ^-?\d+(?:\.\d+)?$
                            required:
                              - currency_code
                              - amount
                          description: Alert impact per original currency.
                      required:
                        - alert_count
                        - impact_by_currency
                  required:
                    - credited
                    - uncredited
                accepted:
                  type: object
                  properties:
                    credited:
                      type: object
                      properties:
                        alert_count:
                          type: integer
                        impact_by_currency:
                          type: array
                          items:
                            type: object
                            properties:
                              currency_code:
                                type: string
                              amount:
                                type: string
                                pattern: ^-?\d+(?:\.\d+)?$
                            required:
                              - currency_code
                              - amount
                          description: Alert impact per original currency.
                      required:
                        - alert_count
                        - impact_by_currency
                    uncredited:
                      type: object
                      properties:
                        alert_count:
                          type: integer
                        impact_by_currency:
                          type: array
                          items:
                            type: object
                            properties:
                              currency_code:
                                type: string
                              amount:
                                type: string
                                pattern: ^-?\d+(?:\.\d+)?$
                            required:
                              - currency_code
                              - amount
                          description: Alert impact per original currency.
                      required:
                        - alert_count
                        - impact_by_currency
                  required:
                    - credited
                    - uncredited
                dismissed:
                  type: object
                  properties:
                    credited:
                      type: object
                      properties:
                        alert_count:
                          type: integer
                        impact_by_currency:
                          type: array
                          items:
                            type: object
                            properties:
                              currency_code:
                                type: string
                              amount:
                                type: string
                                pattern: ^-?\d+(?:\.\d+)?$
                            required:
                              - currency_code
                              - amount
                          description: Alert impact per original currency.
                      required:
                        - alert_count
                        - impact_by_currency
                    uncredited:
                      type: object
                      properties:
                        alert_count:
                          type: integer
                        impact_by_currency:
                          type: array
                          items:
                            type: object
                            properties:
                              currency_code:
                                type: string
                              amount:
                                type: string
                                pattern: ^-?\d+(?:\.\d+)?$
                            required:
                              - currency_code
                              - amount
                          description: Alert impact per original currency.
                      required:
                        - alert_count
                        - impact_by_currency
                  required:
                    - credited
                    - uncredited
                skipped:
                  type: object
                  properties:
                    credited:
                      type: object
                      properties:
                        alert_count:
                          type: integer
                        impact_by_currency:
                          type: array
                          items:
                            type: object
                            properties:
                              currency_code:
                                type: string
                              amount:
                                type: string
                                pattern: ^-?\d+(?:\.\d+)?$
                            required:
                              - currency_code
                              - amount
                          description: Alert impact per original currency.
                      required:
                        - alert_count
                        - impact_by_currency
                    uncredited:
                      type: object
                      properties:
                        alert_count:
                          type: integer
                        impact_by_currency:
                          type: array
                          items:
                            type: object
                            properties:
                              currency_code:
                                type: string
                              amount:
                                type: string
                                pattern: ^-?\d+(?:\.\d+)?$
                            required:
                              - currency_code
                              - amount
                          description: Alert impact per original currency.
                      required:
                        - alert_count
                        - impact_by_currency
                  required:
                    - credited
                    - uncredited
              required:
                - pending
                - accepted
                - dismissed
                - skipped
              description: >-
                Alerts by verdict, each split into credited and uncredited
                alerts. The claim asks for its accepted (confirmed) alerts;
                members to review, false alarms and unsure (skipped) ones stay
                in the claim but are not claimed. Credited amounts are alert
                impact, not recorded recoveries.
            organization_currency:
              type: object
              properties:
                currency_code:
                  type: string
                  description: The organization's reporting currency from its settings.
                impact_amount:
                  type: string
                  pattern: ^-?\d+(?:\.\d+)?$
                by_verdict:
                  type: object
                  properties:
                    pending:
                      type: object
                      properties:
                        credited:
                          type: object
                          properties:
                            alert_count:
                              type: integer
                            impact_amount:
                              type: string
                              pattern: ^-?\d+(?:\.\d+)?$
                              description: >-
                                Sum of the alerts’ impacts; alerts without an
                                impact add nothing.
                          required:
                            - alert_count
                            - impact_amount
                        uncredited:
                          type: object
                          properties:
                            alert_count:
                              type: integer
                            impact_amount:
                              type: string
                              pattern: ^-?\d+(?:\.\d+)?$
                              description: >-
                                Sum of the alerts’ impacts; alerts without an
                                impact add nothing.
                          required:
                            - alert_count
                            - impact_amount
                      required:
                        - credited
                        - uncredited
                    accepted:
                      type: object
                      properties:
                        credited:
                          type: object
                          properties:
                            alert_count:
                              type: integer
                            impact_amount:
                              type: string
                              pattern: ^-?\d+(?:\.\d+)?$
                              description: >-
                                Sum of the alerts’ impacts; alerts without an
                                impact add nothing.
                          required:
                            - alert_count
                            - impact_amount
                        uncredited:
                          type: object
                          properties:
                            alert_count:
                              type: integer
                            impact_amount:
                              type: string
                              pattern: ^-?\d+(?:\.\d+)?$
                              description: >-
                                Sum of the alerts’ impacts; alerts without an
                                impact add nothing.
                          required:
                            - alert_count
                            - impact_amount
                      required:
                        - credited
                        - uncredited
                    dismissed:
                      type: object
                      properties:
                        credited:
                          type: object
                          properties:
                            alert_count:
                              type: integer
                            impact_amount:
                              type: string
                              pattern: ^-?\d+(?:\.\d+)?$
                              description: >-
                                Sum of the alerts’ impacts; alerts without an
                                impact add nothing.
                          required:
                            - alert_count
                            - impact_amount
                        uncredited:
                          type: object
                          properties:
                            alert_count:
                              type: integer
                            impact_amount:
                              type: string
                              pattern: ^-?\d+(?:\.\d+)?$
                              description: >-
                                Sum of the alerts’ impacts; alerts without an
                                impact add nothing.
                          required:
                            - alert_count
                            - impact_amount
                      required:
                        - credited
                        - uncredited
                    skipped:
                      type: object
                      properties:
                        credited:
                          type: object
                          properties:
                            alert_count:
                              type: integer
                            impact_amount:
                              type: string
                              pattern: ^-?\d+(?:\.\d+)?$
                              description: >-
                                Sum of the alerts’ impacts; alerts without an
                                impact add nothing.
                          required:
                            - alert_count
                            - impact_amount
                        uncredited:
                          type: object
                          properties:
                            alert_count:
                              type: integer
                            impact_amount:
                              type: string
                              pattern: ^-?\d+(?:\.\d+)?$
                              description: >-
                                Sum of the alerts’ impacts; alerts without an
                                impact add nothing.
                          required:
                            - alert_count
                            - impact_amount
                      required:
                        - credited
                        - uncredited
                  required:
                    - pending
                    - accepted
                    - dismissed
                    - skipped
                  description: >-
                    Counts and impact by verdict, each split into credited and
                    uncredited alerts.
              required:
                - currency_code
                - impact_amount
                - by_verdict
              description: >-
                The same alerts in the organization currency: the sum of their
                converted impacts, in total and by verdict. What the claim asks
                for is by_verdict.accepted.
          required:
            - total
            - by_verdict
            - organization_currency
      required:
        - total_count
        - counts
        - recovery_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 sent as a bearer token, together with
        X-Organization-Id. The key must have at least the access level the
        endpoint requires (read, write or admin).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.