How can we help?

Make your first call

Check your API setup by making a test call to list your VAT filings.

  • Get a valid Bearer access token.

  • Get your companyId (a UUID that identifies your company in the Sovos platform).

  • Understand the authentication requirements.

You'll make a GET request to list your VAT filings. It's a read-only request that verifies your token works, and it returns filing periods your company has on record. Use the URL that matches your region. See the Base URL section.

  1. Send this GET request:
    curl -X GET \
      "https://api.sovos.com/v1/indirect-tax/vat-filing/filings?companyId=078be7d7-a1c0-44f8-a2ca-5b23b370d242" \
      -H "Authorization: Bearer <your-access-token>" \
      -H "Content-Type: application/json"
  2. Check the response.

    A successful response returns a 200 OK with a list of VAT filing periods for your company:

    {
      "success": true,
      "status": 200,
      "message": "OK",
      "timestamp": 1776333600000,
      "uuid": "7c9e2f1a-4b3d-5e6f-7890-abcdef123456",
      "data": {
        "items": [
          {
            "id": "911",
            "country": "Hungary",
            "countryCode": "HU",
            "dueDate": "2019-03-12",
            "startDate": "2019-01-01",
            "endDate": "2019-03-31",
            "companyId": "078be7d7-a1c0-44f8-a2ca-5b23b370d245",
            "reportType": "VAT",
            "reportName": "HU VAT return Q1",
            "importProfileId": "078be7d7-a1c0-44f8-a2ca-5b23b370d243",
            "status": "Preparation",
            "resultFilesUrl": "https://api.sovos.com/v1/indirect-tax/vat-filing/filings/911/result-files"
          }
        ],
        "pageState": {
          "page": 1,
          "perPage": 50,
          "totalPages": 3,
          "totalEntries": 120
        }
      },
      "errors": []
    }

    Every response from the VAT Filing API uses the same envelope structure, whether the call succeeds or fails. Remember that every request requires the Bearer token in the Authorization header. Without it, the API returns a 401 error.

    Note:

    See the API reference.