> ## 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 alerts > Lists alerts: deviations found between an invoice and its agreement, such as an overcharge. The state of an alert is independent facets, each with its own filter: verdict (pending means no decision yet), credit, claim and claim status, validity, and whether its inputs changed since the check (changed_since_check). Words like open or unresolved have no fixed meaning: combine the filters for what the user means, or ask. Dismissed alerts and alerts with changed inputs are included unless filtered out; alerts that stopped counting are left out unless validity says otherwise. Sort by impact_amount to rank by money at stake, and use getAlertMetrics for the totals of the same filters. Filter by agreement, supplier, invoice, topic, claim, verdict, confidence or credit; use topic_ids=null for uncategorized alerts. ## OpenAPI ````yaml /openapi.json get /v1/alerts 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/alerts: get: tags: - Alerts summary: List alerts description: >- Lists alerts: deviations found between an invoice and its agreement, such as an overcharge. The state of an alert is independent facets, each with its own filter: verdict (pending means no decision yet), credit, claim and claim status, validity, and whether its inputs changed since the check (changed_since_check). Words like open or unresolved have no fixed meaning: combine the filters for what the user means, or ask. Dismissed alerts and alerts with changed inputs are included unless filtered out; alerts that stopped counting are left out unless validity says otherwise. Sort by impact_amount to rank by money at stake, and use getAlertMetrics for the totals of the same filters. Filter by agreement, supplier, invoice, topic, claim, verdict, confidence or credit; use topic_ids=null for uncategorized alerts. operationId: listAlerts 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: string description: >- Return only these fields of each row, comma-separated; use dots for nested fields, such as credit.at. id is always returned. Fields: id, title, explanation, verdict, credit, correction_type, confidence, questions, impact_amount, currency_code, organization_currency, changed_since_check, invalidation, invoice, invoice_item, agreement, supplier, recipient, topic, claim, dismissal, provenance, correction_relationships, correction_relationships_truncated, created_at, updated_at. - schema: type: string enum: - 'true' - 'false' description: >- Only records matched by the filters of teams you belong to. Teams combine with OR; other filters combine with AND. Cannot be combined with team_ids. required: false description: >- Only records matched by the filters of teams you belong to. Teams combine with OR; other filters combine with AND. Cannot be combined with team_ids. name: mine in: query - schema: type: string description: >- Only records matched by the filters of these teams: at most 50, comma-separated in a query string or an array in a JSON body. Teams combine with OR. Unknown teams return 404. required: false description: >- Only records matched by the filters of these teams: at most 50, comma-separated in a query string or an array in a JSON body. Teams combine with OR. Unknown teams return 404. name: team_ids in: query - schema: type: string description: >- Match alerts in any of these claims; null matches alerts in no claim. required: false description: >- Match alerts in any of these claims; null matches alerts in no claim. name: claim_ids in: query - schema: type: string enum: - 'true' - 'false' description: >- Use false to select alerts that are not currently attached to any claim. required: false description: >- Use false to select alerts that are not currently attached to any claim. name: has_claim in: query - schema: type: string description: >- Match alerts whose current claim has any of these statuses: pending, in_progress, completed, cancelled. required: false description: >- Match alerts whose current claim has any of these statuses: pending, in_progress, completed, cancelled. name: claim_statuses in: query - schema: type: string enum: - and - or description: >- Combine invoice, agreement, supplier, recipient and topic ID filters with AND (default) or OR. Tenant, validity, search and other filters always apply. required: false description: >- Combine invoice, agreement, supplier, recipient and topic ID filters with AND (default) or OR. Tenant, validity, search and other filters always apply. name: join_operator in: query - schema: type: string enum: - is - is_not required: false name: invoice_operator in: query - schema: type: string enum: - is - is_not required: false name: agreement_operator in: query - schema: type: string enum: - is - is_not required: false name: supplier_operator in: query - schema: type: string enum: - is - is_not required: false name: recipient_operator in: query - schema: type: string enum: - is - is_not required: false name: topic_operator in: query - schema: type: string description: Comma-separated, at most 50 values. required: false description: Comma-separated, at most 50 values. name: invoice_ids in: query - schema: type: string description: Comma-separated, at most 50 values. required: false description: Comma-separated, at most 50 values. name: agreement_ids in: query - schema: type: string description: >- Match alerts whose agreement has any of these statuses: draft, active, archived. required: false description: >- Match alerts whose agreement has any of these statuses: draft, active, archived. name: agreement_statuses in: query - schema: type: string description: Comma-separated, at most 50 values. required: false description: Comma-separated, at most 50 values. name: supplier_ids in: query - schema: type: string description: Comma-separated, at most 50 values. required: false description: Comma-separated, at most 50 values. name: recipient_ids in: query - schema: type: string description: Comma-separated, at most 50 values. required: false description: Comma-separated, at most 50 values. name: tag_ids in: query - schema: type: string description: >- Match alerts in any selected topic; null matches uncategorized alerts. required: false description: >- Match alerts in any selected topic; null matches uncategorized alerts. name: topic_ids in: query - schema: type: string enum: - 'true' - 'false' description: Use false to select uncategorized alerts. required: false description: Use false to select uncategorized alerts. name: has_topic in: query - schema: type: string description: >- Match alerts with any of these verdicts, whatever their credit: pending, accepted, dismissed. pending means no decision yet. required: false description: >- Match alerts with any of these verdicts, whatever their credit: pending, accepted, dismissed. pending means no decision yet. name: verdicts in: query - schema: type: string enum: - 'true' - 'false' description: Match alerts with or without a credit, regardless of verdict. required: false description: Match alerts with or without a credit, regardless of verdict. name: credited in: query - schema: type: string description: >- Match credit provenance: credit_note, user. null selects alerts without a credit. required: false description: >- Match credit provenance: credit_note, user. null selects alerts without a credit. name: credit_sources in: query - schema: type: string description: >- Match any listed confidence level: certain, uncertain. null matches alerts without one. required: false description: >- Match any listed confidence level: certain, uncertain. null matches alerts without one. name: confidence_levels in: query - schema: type: string description: Comma-separated, at most 50 values. required: false description: Comma-separated, at most 50 values. name: currency_codes in: query - schema: type: string description: >- Match any of these correction types: modify_item, modify_invoice, add_item. required: false description: >- Match any of these correction types: modify_item, modify_invoice, add_item. name: correction_types in: query - schema: type: string enum: - 'true' - 'false' description: >- true matches alerts whose agreement or invoice changed after the check that found them; false matches alerts whose inputs are unchanged. Alerts that do not record what they assessed match neither. required: false description: >- true matches alerts whose agreement or invoice changed after the check that found them; false matches alerts whose inputs are unchanged. Alerts that do not record what they assessed match neither. name: changed_since_check in: query - schema: type: string enum: - live - invalidated - all description: >- live (default) returns alerts that count; invalidated returns alerts that stopped counting, for example because their invoice no longer matches the agreement. Alerts in claims named by claim_ids are included either way. required: false description: >- live (default) returns alerts that count; invalidated returns alerts that stopped counting, for example because their invoice no longer matches the agreement. Alerts in claims named by claim_ids are included either way. name: validity in: query - schema: type: string maxLength: 100 pattern: ^-?\d+(?:\.\d+)?$ description: >- Minimum impact in the organization currency, inclusive. Alerts without an impact never match. required: false description: >- Minimum impact in the organization currency, inclusive. Alerts without an impact never match. name: impact_min in: query - schema: type: string maxLength: 100 pattern: ^-?\d+(?:\.\d+)?$ description: >- Maximum impact in the organization currency, inclusive. Alerts without an impact never match. required: false description: >- Maximum impact in the organization currency, inclusive. Alerts without an impact never match. name: impact_max in: query - schema: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Invoice issued on or after this date. required: false description: Invoice issued on or after this date. name: issued_from in: query - schema: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Invoice issued on or before this date. required: false description: Invoice issued on or before this date. name: issued_through in: query - schema: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: >- Created on or after this calendar date in the organization's timezone. required: false description: >- Created on or after this calendar date in the organization's timezone. name: created_from in: query - schema: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: >- Created on or before this calendar date in the organization's timezone. required: false description: >- Created on or before this calendar date in the organization's timezone. name: created_through in: query - schema: type: string minLength: 1 maxLength: 200 description: >- Case-insensitive search across alert, invoice, supplier, agreement and topic text. A UUID matches the alert, invoice, supplier or agreement ID. required: false description: >- Case-insensitive search across alert, invoice, supplier, agreement and topic text. A UUID matches the alert, invoice, supplier or agreement ID. name: search in: query - schema: type: integer minimum: 1 maximum: 1000 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 - schema: type: string enum: - created_at - impact_amount - issued_date - invoice_number - supplier - verdict default: created_at description: >- impact_amount sorts by organization-currency impact. Nulls sort last. required: false description: >- impact_amount sorts by organization-currency impact. Nulls sort last. name: sort in: query - schema: type: string enum: - asc - desc default: desc required: false name: direction in: query responses: '200': description: A page of alerts. 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: type: object properties: data: type: array items: $ref: '#/components/schemas/AlertSummary' maxItems: 1000 next_cursor: type: - string - 'null' required: - data - next_cursor '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: schema: $ref: '#/components/schemas/Error_validation_error' 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 '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: schema: $ref: '#/components/schemas/Error_invalid_token' example: error: code: invalid_token message: The bearer token is missing or invalid. request_id: req_example '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: schema: $ref: >- #/components/schemas/Error_forbidden_token_disabled_organization_required_insufficient_role_mfa_required 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 '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: 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: >- One or more selected teams have invalid saved filter rules. Update the team 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: schema: $ref: '#/components/schemas/Error_conflict' example: error: code: conflict message: >- One or more selected teams have invalid saved filter rules. Update the team filters before retrying. request_id: req_example '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: schema: $ref: '#/components/schemas/Error_rate_limit_exceeded' example: error: code: rate_limit_exceeded message: >- Too many requests. Wait for the Retry-After delay before retrying. 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 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/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: >- 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: schema: $ref: '#/components/schemas/Error_service_unavailable' example: error: code: service_unavailable message: >- Temporarily unavailable. Retry after the Retry-After delay, when provided. request_id: req_example security: - ApiKeyBearer: [] components: schemas: AlertSummary: type: object properties: id: type: string format: uuid title: type: - string - 'null' explanation: type: - string - 'null' verdict: type: string enum: - pending - accepted - dismissed description: >- The decision on the finding, independent of claim membership and credit. credit: type: - object - 'null' properties: at: type: string format: date-time source: type: string enum: - credit_note - user credit_note_id: type: - string - 'null' format: uuid description: >- Matched credit-note provenance, if available. Null for a user credit. required: - at - source - credit_note_id description: Supplier credit, independent of the verdict and claim. correction_type: type: string enum: - modify_item - modify_invoice - add_item confidence: type: object properties: level: type: - string - 'null' enum: - certain - uncertain - null reason: type: - string - 'null' required: - level - reason questions: type: array items: type: string description: >- What Watchdog needs answered to decide the alert, mostly on uncertain alerts. Empty when nothing is open. impact_amount: type: - string - 'null' pattern: ^-?\d+(?:\.\d+)?$ currency_code: type: string organization_currency: type: object properties: currency_code: type: string description: The organization's reporting currency from its settings. impact_amount: type: - string - 'null' pattern: ^-?\d+(?:\.\d+)?$ required: - currency_code - impact_amount description: The impact converted with the rate stored on the alert. changed_since_check: type: - object - 'null' properties: agreement: type: boolean description: The agreement has a newer version than the one checked. invoice: type: boolean description: >- The invoice's evidence, such as its lines, amounts or documents, was edited or imported again. required: - agreement - invoice description: >- Whether the agreement or the invoice changed after the check that found this alert. A change does not make the alert wrong; check again to assess it against the new inputs. Null for older alerts that do not record what they assessed. invalidation: type: - object - 'null' properties: at: type: string format: date-time reason: type: string enum: - unmatched required: - at - reason description: >- Set when the alert no longer counts, for example because its invoice no longer matches the agreement. It keeps its verdict, credit and claim, and counts again if the invoice matches again. invoice: type: - object - 'null' properties: id: type: string format: uuid invoice_number: type: - string - 'null' title: type: - string - 'null' description: The invoice's own title; its number is invoice_number. category: type: string enum: - invoice - credit_note - self_billed_invoice issued_date: type: - string - 'null' format: date due_date: type: - string - 'null' format: date currency_code: type: - string - 'null' total_amount_including_vat: type: - string - 'null' pattern: ^-?\d+(?:\.\d+)?$ required: - id - invoice_number - title - category - issued_date - due_date - currency_code - total_amount_including_vat invoice_item: type: - object - 'null' properties: id: type: string format: uuid line_number: type: integer product_code: type: - string - 'null' description: type: - string - 'null' unit: type: - string - 'null' required: - id - line_number - product_code - description - unit readOnly: true description: The current invoice line. Null when no line is linked. agreement: type: - object - 'null' properties: id: type: string format: uuid title: type: - string - 'null' status: type: string enum: - draft - active - archived version: type: integer description: The current agreement version. required: - id - title - status - version supplier: type: - object - 'null' properties: id: type: string format: uuid title: type: - string - 'null' required: - id - title recipient: type: - object - 'null' properties: id: type: string format: uuid title: type: - string - 'null' required: - id - title topic: type: - object - 'null' properties: id: type: string format: uuid title: type: - string - 'null' is_locked: type: boolean required: - id - title - is_locked claim: type: - object - 'null' properties: id: type: string format: uuid title: type: - string - 'null' status: type: string enum: - pending - in_progress - completed - cancelled required: - id - title - status description: The claim this alert is currently attached to, if any. dismissal: type: - object - 'null' properties: id: type: string format: uuid description: Alerts dismissed together with the same reason share this ID. category: type: - string - 'null' enum: - wrong_alert - valid_not_actioning - already_handled - duplicate_covered - other - null note: type: - string - 'null' dismissed_at: type: string format: date-time dismissed_by: type: - object - 'null' properties: user: type: object properties: id: type: string name: type: - string - 'null' deleted: type: boolean description: >- The account was deleted. The name is kept, or null once the account is anonymised. required: - id - name - deleted api_key: type: - object - 'null' properties: id: type: string format: uuid name: type: string required: - id - name description: The API key used, retained after revocation. required: - user - api_key description: >- The person, and API key if one was used. Null when no person is recorded. required: - id - category - note - dismissed_at - dismissed_by description: >- Why the alert was dismissed, while its verdict is dismissed, credited or not. Dismiss it again with a different category or note to change the reason. Reopening or accepting clears it; the alert activity keeps the history. provenance: type: object properties: origin: type: string enum: - check - user - api_key description: >- Who created the alert: a compliance check, a person, or a person through an API key. created_by: type: - object - 'null' properties: user: type: object properties: id: type: string name: type: - string - 'null' deleted: type: boolean description: >- The account was deleted. The name is kept, or null once the account is anonymised. required: - id - name - deleted api_key: type: - object - 'null' properties: id: type: string format: uuid name: type: string required: - id - name description: The API key used, retained after revocation. required: - user - api_key description: >- The person, and API key if one was used. Null for alerts from checks. agreement_version: type: - integer - 'null' description: The agreement version assessed; compare with agreement.version. invoice_fingerprint: type: - string - 'null' retained_check: type: - object - 'null' properties: id: type: string format: uuid required: - id description: >- The compliance check that produced this alert. Null for older alerts. required: - origin - created_by - agreement_version - invoice_fingerprint - retained_check correction_relationships: type: array items: type: object properties: replacement_alert_id: type: string format: uuid replaced_alert_id: type: string format: uuid required: - replacement_alert_id - replaced_alert_id maxItems: 100 description: Links between an added-item alert and the line alerts it replaces. correction_relationships_truncated: type: boolean created_at: type: string format: date-time updated_at: type: string format: date-time required: - id - title - explanation - verdict - credit - correction_type - confidence - questions - impact_amount - currency_code - organization_currency - changed_since_check - invalidation - invoice - invoice_item - agreement - supplier - recipient - topic - claim - dismissal - provenance - correction_relationships - correction_relationships_truncated - created_at - updated_at 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.