Configuration
Use the Configuration v2 endpoints for setting up companies and branches, and managing existing entities.
Download OpenAPI specification
Some countries and features require using the Configuration v2 resource before you can send documents through Indirect Tax API.
Note:
For countries that require Configuration v1, see this documentation page.
These are the available endpoints in the Organizations sub-resource from Configuration v2:
| HTTP Method | Endpoint | Description |
|---|---|---|
| GET | /v2/configurations/organizations | Retrieves details from all configured organizations. |
| POST | /v2/configurations/organizations | Creates an organization with or without assigned products. |
| GET | /v2/configurations/organizations/{organizationId} | Retrieves details from a given organization using its organizationId. |
| PUT | /v2/configurations/organizations/{organizationId} | Updates an organization's name, its products, or both. |
| GET | /v2/configurations/organizations/{organizationId}/products | Retrieves a list of all the products that have been assigned to an organization. |
| 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. |
These are the available endpoints in the Companies sub-resource from Configuration v2:
| HTTP Method | Endpoint | Description |
|---|---|---|
| GET | /v2/configurations/organizations/{organizationId}/companies | Lists all companies configured in a given organization. |
| POST | /v2/configurations/organizations/{organizationId}/companies | Creates a company in a given organization. |
| PATCH | /v2/configurations/organizations/{organizationId}/companies/{companyId} | Updates a company from a given organization. |
| PATCH | /v2/configurations/organizations/{organizationId}/companies/{companyId}/lock | Locks a company to block POST v1/documents requests for the associated taxId. |
| PATCH | /v2/configurations/organizations/{organizationId}/companies/{companyId}/unlock | Unlocks a company to allow POST v1/documents requests for the associated taxId. |
| PUT | /v2/configurations/organizations/{organizationId}/companies/{companyId}/products | Assigns products to a given company. |
These are the available endpoints in the Company Endpoints sub-resource from Configuration v2:
| HTTP Method | Endpoint | Description |
|---|---|---|
| POST | /v2/configurations/organizations/{organizationId}/companies/{companyId}/endpoints | Creates an endpoint for a company with an optional ERP system identifier. |
| GET | /v2/configurations/organizations/{organizationId}/companies/{companyId}/endpoints | Retrieves a list of endpoints for a given company. |
| 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. |
| DELETE | /v2/configurations/organizations/{organizationId}/companies/{companyId}/endpoints/{endpointId} | Deletes a given endpoint using its ID. |
These are the available endpoints in the Branches sub-resource from Configuration v2:
| HTTP Method | Endpoint | Description |
|---|---|---|
| GET | /v2/configurations/organizations/{organizationId}/companies/{companyId}/branches | Retrieves a list of branches configured in a given company. |
| POST | /v2/configurations/organizations/{organizationId}/companies/{companyId}/branches | Creates a branch in a given company. |
| GET | /v2/configurations/organizations/{organizationId}/companies/branches | Retrieves a list of branches configured in the companies from a given organization. |
| POST | /v2/configurations/organizations/{organizationId}/companies/branches | Provisions the branch configuration from a given organization to the tax authority. |
These are the available endpoints in the Users sub-resource from Configuration v2:
| HTTP Method | Endpoint | Description |
|---|---|---|
| GET | /v2/configurations/organizations/{organizationId}/users | Retrieves all users from a given organization. |
| POST | /v2/configurations/organizations/{organizationId}/users | Creates an organization user and assigns them a role. |
| DELETE | /v2/configurations/organizations/{organizationId}/users/{userId} | Deletes a given organization user. |
These are the available endpoints in the Settings sub-resource from Configuration v2:
| HTTP Method | Endpoint | Description |
|---|---|---|
| GET | /v2/configurations/organizations/{organizationId}/setting-contexts | Retrieves the setting contexts assigned to a given organization. |
| GET | /v2/configurations/organizations/{organizationId}/setting-contexts/{contextName} | Retrieves the organization settings from a specific context. |
| POST | /v2/configurations/workspaces/settings | Creates settings for a specified workspace to configure multiple customers at the workspace level. |
| GET | /v2/configurations/workspaces/setting-contexts | Retrieves all setting contexts available at the workspace level with their total entry counts. |
| GET | /v2/configurations/workspaces/setting-contexts/{contextName} | Retrieves all settings for a specific context at the workspace level. |
| POST | /v2/configurations/organizations/{organizationId}/settings | Creates settings under a predefined context with a variable scope. The scope can be on the organization level, company level, or even system level. |
| GET | /v2/configurations/organizations/{organizationId}/settings/{settingId} | Retrieves a specific setting from an organization. |
| PUT | /v2/configurations/organizations/{organizationId}/settings/{settingId} | Updates values from an existing setting. |
This is the available endpoint in the Roles sub-resource from Configuration v2:
| HTTP Method | Endpoint | Description |
|---|---|---|
| GET | /v2/configurations/roles | Retrieves a list of roles available to a given organization. |
These are the available endpoints in the ERP Systems sub-resource from Configuration v2:
| HTTP Method | Endpoint | Description |
|---|---|---|
| GET | /v2/configurations/organizations/{organizationId}/erpSystem/{erpSystemId}/webhook | Retrieves the Svix Consumer App Portal Link for a specific ERP system to configure endpoints and manage webhook messages. Configure SystemId with "PushingV2" before calling this endpoint. |
| GET | /v2/configurations/erp-systems | Retrieves a list of ERP System configurations for the workspace. |
| POST | /v2/configurations/erp-systems | Creates an ERP System configuration for the workspace. |
| PUT | /v2/configurations/erp-systems/{id} | Updates an existing ERP System configuration in the workspace. |
These are the available endpoints in the Networks sub-resource from Configuration v2:
| HTTP Method | Endpoint | Description |
|---|---|---|
| GET | /v2/configurations/networks | Retrieves a list of networks using the available filters. |
| POST | /v2/configurations/networks/{networkId}/trading-partners/endpoints | Creates a trading partner endpoint for a specific network. |
| PUT | /v2/configurations/networks/{networkId}/trading-partners/endpoints/{endpointId} | Updates a trading partner endpoint for a given network. |
| GET | /v2/configurations/networks/{networkId}/trading-partners/endpoints/{endpointId} | Retrieves a trading partner endpoint by its ID within a given network. |
| DELETE | /v2/configurations/networks/{networkId}/trading-partners/endpoints/{endpointId} | Deletes a trading partner endpoint by its ID within a given network. |
These are the available endpoints in the Under Construction sub-resource from Configuration v2:
| HTTP Method | Endpoint | Description |
|---|---|---|
| GET | /v2/configurations/organizations/{organizationId}/groups | Retrieves a list of groups available to a given organization. |
| POST | /v2/configurations/organizations/{organizationId}/groups | Creates a group for a given organization. |
Note:
These endpoints will be moved to a specific resource when they are fully implemented.