# Sovos Configurations API

**Canonical:** https://apis.io/apis/sovos/sovos-configurations-api/  
**Provider:** Sovos — https://apis.io/providers/sovos/  
**Base URL:** https://api.sovos.com  
**Documentation:** https://docs.sovos.com/en

Sovos Configurations API is one of 6 APIs that [Sovos](https://apis.io/providers/sovos/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include Configurations. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

The Configurations API from Sovos — 24 operation(s) for configurations.

## Operations (36)

| Method | Path | Summary |
|---|---|---|
| PUT | `/v2/configurations/erp-systems/{id}` | Configuration endpoints |
| POST | `/v2/configurations/networks/{networkid}/trading-partners/endpoints` | Configuration endpoints |
| DELETE | `/v2/configurations/networks/{networkid}/trading-partners/endpoints/{endpointid}` | Configuration endpoints |
| GET | `/v2/configurations/networks/{networkid}/trading-partners/endpoints/{endpointid}` | Configuration endpoints |
| PUT | `/v2/configurations/networks/{networkid}/trading-partners/endpoints/{endpointid}` | Configuration endpoints |
| GET | `/v2/configurations/organizations/{organizationid}` | Retrieves details from a given organization using its organizationId |
| PUT | `/v2/configurations/organizations/{organizationid}` | Updates an organization |
| GET | `/v2/configurations/organizations/{organizationid}/companies/branches` | Configuration endpoints |
| POST | `/v2/configurations/organizations/{organizationid}/companies/branches` | Configuration endpoints |
| PATCH | `/v2/configurations/organizations/{organizationid}/companies/{companyid}` | Updates a company from a given organization |
| POST | `/v2/configurations/organizations/{organizationid}/companies/{companyid}/endpoints/async` | Submits an asynchronous company endpoint registration. |
| GET | `/v2/configurations/organizations/{organizationid}/companies/{companyid}/endpoints/async/removal/{requestid}` | Retrieves the status of an asynchronous request to delete all company… |
| GET | `/v2/configurations/organizations/{organizationid}/companies/{companyid}/endpoints/async/{requestid}` | Retrieves the status of an asynchronous company endpoint registration request… |
| DELETE | `/v2/configurations/organizations/{organizationid}/companies/{companyid}/endpoints/{endpointid}` | Deletes a given endpoint using its ID |
| GET | `/v2/configurations/organizations/{organizationid}/companies/{companyid}/endpoints/{endpointid}` | Retrieves details from a given endpoint using its ID |
| PUT | `/v2/configurations/organizations/{organizationid}/companies/{companyid}/endpoints/{endpointid}` | Updates details from a given endpoint using its ID |
| GET | `/v2/configurations/organizations/{organizationid}/companies/{companyid}/{id}` | Retrieves a list of branches configured in a given company |
| PATCH | `/v2/configurations/organizations/{organizationid}/companies/{companyid}/{id}` | Locks a company to block POST v1/documents requests for the associated taxId |
| POST | `/v2/configurations/organizations/{organizationid}/companies/{companyid}/{id}` | Configuration endpoints |
| PATCH | `/v2/configurations/organizations/{organizationid}/companies/{taxid}/identity-validation` | Updates the identity-validation flag of a company identified by tax ID. |
| GET | `/v2/configurations/organizations/{organizationid}/erpSystem/{erpsystemid}/webhook` | Configuration endpoints |
| PUT | `/v2/configurations/organizations/{organizationid}/products` | Assigns available products to a given organization |
| DELETE | `/v2/configurations/organizations/{organizationid}/products/{productid}` | Removes a product from a given organization |
| GET | `/v2/configurations/organizations/{organizationid}/setting-contexts/{contextname}` | Configuration endpoints |
| GET | `/v2/configurations/organizations/{organizationid}/settings/{settingid}` | Configuration endpoints |
| PUT | `/v2/configurations/organizations/{organizationid}/settings/{settingid}` | Configuration endpoints |
| DELETE | `/v2/configurations/organizations/{organizationid}/users/{userid}` | Configuration endpoints |
| GET | `/v2/configurations/organizations/{organizationid}/{id}` | Lists all companies configured in a given organization |
| POST | `/v2/configurations/organizations/{organizationid}/{id}` | Creates a group for a given organization |
| GET | `/v2/configurations/report-setup/{categoryid}` | Retrieves the available report definition options for the given category |
| POST | `/v2/configurations/report-setup/{categoryid}` | Configures which report definitions are active for the given category and scope |
| GET | `/v2/configurations/workspaces/setting-contexts` | Configuration endpoints |
| GET | `/v2/configurations/workspaces/setting-contexts/{contextname}` | Configuration endpoints |
| POST | `/v2/configurations/workspaces/settings` | Configuration endpoints |
| GET | `/v2/configurations/{configurationid}` | Configuration endpoints |
| POST | `/v2/configurations/{configurationid}` | Configuration endpoints |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/sovos/openapi/sovos-configurations-api-openapi.yml
- **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

## Other Sovos APIs (5)

- [Sovos API](https://apis.io/apis/sovos/sovos-api/)
- [Sovos Documents API](https://apis.io/apis/sovos/sovos-documents-api/)
- [Sovos Notifications API](https://apis.io/apis/sovos/sovos-notifications-api/)
- [Sovos OAuth API](https://apis.io/apis/sovos/sovos-oauth-api/)
- [Sovos Taxid Checks API](https://apis.io/apis/sovos/sovos-taxid-checks-api/)

## Tags

Configurations

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/sovos/sovos-configurations-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/sovos/.