Sovos

Sovos Notifications API

The Notifications API from Sovos — 3 operation(s) for notifications.

GitHub OpenAPI

Operations 4

GET /notifications/{countrycode} Check for new notifications across all documents #
PUT /notifications/{countrycode} Mark notifications as read #
PUT /notifications/{countrycode}/bulk Acknowledge notifications in large batches #
GET /notifications/{countrycode}/{notificationid} Retrieve a specific notification #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/sovos/openapi/sovos-notifications-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/sovos/json-schema/sovos-get-notifications-countrycode-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/sovos/json-schema/sovos-get-documents-countrycode-documentid-notifications-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/sovos/json-schema/sovos-post-oauth-client-credential-accesstoken-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/sovos/json-schema/sovos-post-oauth-token-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/sovos/json-schema/sovos-get-notifications-countrycode-notificationid-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/sovos/json-schema/sovos-put-notifications-countrycode-response-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/sovos:sovos-notifications-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

sovos-notifications-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Sovos Notifications API
  version: '2026-10-14'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-14: 44 operation(s) read from 5 public documentation page(s) (each operation names its page in x-source). This is not the provider''s published contract; Sovos has published no machine-readable contract that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 4
    documentation: 40
    pages-with-code: 2
    pages-read: 5
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-14'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.sovos.com/en/e-invoicing/indirect-tax-api/api-authentication
  - https://docs.sovos.com/en/e-invoicing/indirect-tax-api/how-indirect-tax-api-works
  - https://docs.sovos.com/en/e-invoicing/indirect-tax-api/e-archiving
  - https://docs.sovos.com/en/e-invoicing/indirect-tax-api/identity-verification
  - https://docs.sovos.com/en/e-invoicing/indirect-tax-api/configuration
servers:
- url: https://api-test.sovos.com
security:
- basic: []
tags:
- name: Notifications
paths:
  /notifications/{countrycode}:
    get:
      operationId: get_notifications_countrycode
      tags:
      - Notifications
      summary: Check for new notifications across all documents
      x-source: https://docs.sovos.com/en/e-invoicing/indirect-tax-api/how-indirect-tax-api-works
      parameters:
      - name: countrycode
        in: path
        required: true
        schema:
          type: string
      - name: includeAcknowledged
        in: query
        required: false
        schema:
          type: string
        description: Include read notifications
      - name: page
        in: query
        required: false
        schema:
          type: string
        description: Page number
      - name: perPage
        in: query
        required: false
        schema:
          type: string
        description: Results per page
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetNotificationsCountrycodeResponse'
      x-evidence:
        kind: documentation
    put:
      operationId: put_notifications_countrycode
      tags:
      - Notifications
      summary: Mark notifications as read
      x-source: https://docs.sovos.com/en/e-invoicing/indirect-tax-api/how-indirect-tax-api-works
      parameters:
      - name: countrycode
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutNotificationsCountrycodeRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutNotificationsCountrycodeResponse'
      x-evidence:
        kind: documentation
  /notifications/{countrycode}/bulk:
    put:
      operationId: put_notifications_countrycode_bulk
      tags:
      - Notifications
      summary: Acknowledge notifications in large batches
      x-source: https://docs.sovos.com/en/e-invoicing/indirect-tax-api/how-indirect-tax-api-works
      parameters:
      - name: countrycode
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutNotificationsCountrycodeBulkRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutNotificationsCountrycodeBulkResponse'
      x-evidence:
        kind: documentation
  /notifications/{countrycode}/{notificationid}:
    get:
      operationId: get_notifications_countrycode_notificationid
      tags:
      - Notifications
      summary: Retrieve a specific notification
      x-source: https://docs.sovos.com/en/e-invoicing/indirect-tax-api/how-indirect-tax-api-works
      parameters:
      - name: countrycode
        in: path
        required: true
        schema:
          type: string
      - name: notificationid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetNotificationsCountrycodeNotificationidResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    PutNotificationsCountrycodeBulkResponse:
      type: object
      properties:
        status:
          type: integer
          description: HTTP status code (207 Multi-Status)
        details:
          type: array
          description: Result for each notification in the batch
    PutNotificationsCountrycodeResponse:
      type: object
      properties:
        timestamp:
          type: integer
          description: Unix time stamp of the response
        status:
          type: integer
          description: HTTP status code
        success:
          type: boolean
          description: Request success indicator
        message:
          type: string
          description: Human-readable message
    GetNotificationsCountrycodeResponse:
      type: object
      properties:
        timestamp:
          type: integer
          description: Unix time stamp of the response
        status:
          type: integer
          description: HTTP status code
        success:
          type: boolean
          description: Request success indicator
        message:
          type: string
          description: Human-readable message
        data:
          type: object
          description: Contains pagination state and the notifications array
        data.pageState:
          type: object
          description: Pagination information
        data.pageState.page:
          type: integer
          description: Current page number
        data.pageState.perPage:
          type: integer
          description: Results per page
        data.pageState.totalEntries:
          type: integer
          description: Total notifications available
        data.notifications:
          type: array
          description: Array of notification objects
        data.notifications[].notificationId:
          type: string
          description: Unique notification identifier
        data.notifications[].createdDate:
          type: integer
          description: Unix time stamp when the notification was created
        data.notifications[].appPrefix:
          type: string
          description: Application prefix (for example, "INV")
        data.notifications[].content:
          type: string
          description: Base64-encoded ApplicationResponse XML
        data.notifications[].metadata:
          type: object
          description: Document processing details
        data.notifications[].metadata.productId:
          type: string
          description: Product identifier
        data.notifications[].metadata.documentId:
          type: string
          description: Sovos-generated document ID
        data.notifications[].metadata.erpDocumentId:
          type: string
          description: Your ERP document reference
        data.notifications[].metadata.erpSystemId:
          type: string
          description: Source ERP system identifier
        data.notifications[].metadata.processType:
          type: string
          description: 'Document direction: "0" = outbound, "1" = inbound'
        data.notifications[].metadata.taxId:
          type: string
          description: Company tax ID
        data.notifications[].metadata.sciCloudStatusCode:
          type: string
          description: Current processing status
        data.notifications[].metadata.sciResponseCode:
          type: string
          description: Overall compliance status
        data.notifications[].metadata.sciStatusAction:
          type: string
          description: Action required
    PutNotificationsCountrycodeBulkRequest:
      type: object
      properties:
        status:
          type: string
          description: Must be "read"
        notificationId:
          type: string
          description: Identifier of the notification to acknowledge
      required:
      - status
      - notificationId
    PutNotificationsCountrycodeRequest:
      type: object
      properties:
        status:
          type: string
          description: Must be "read"
        notificationId:
          type: string
          description: Identifier of the notification to acknowledge
      required:
      - status
      - notificationId
    GetNotificationsCountrycodeNotificationidResponse:
      type: object
      properties:
        timestamp:
          type: integer
          description: Unix time stamp of the response
        status:
          type: integer
          description: HTTP status code
        success:
          type: boolean
          description: Request success indicator
        message:
          type: string
          description: Human-readable message
        data:
          type: object
          description: Notification object (same fields as in list response)
  securitySchemes:
    basic:
      type: http
      scheme: basic