Configuration v1

Configuration v1 includes endpoints for setting up companies and branches and for managing existing entities.

Some countries and features require using the Configuration v1 resource before you can send documents via Indirect Tax API.

Note:

For countries that require Configuration v2, see this documentation page.

Company

These are the available endpoints in the Company sub-resource from Configuration v1:


HTTP Method	Endpoint	Description
GET	v1/config/{countryCode}/companies	Retrieves a list with all the companies configured in a given country.
POST	v1/config/{countryCode}/companies	Creates a company in a given country.
GET	v1/config/{countryCode}/companies/{companyId}	Retrieves a company from a given country.
PATCH	v1/config/{countryCode}/companies{companyId}	Updates a company from a given country.
POST	v1/config/{countryCode}/companies/{companyId}/reset-password	Resets the super admin password from a given company.

These are the available endpoints in the Branch sub-resource from Configuration v1:


HTTP Method	Endpoint	Description	Note
GET	v1/config/{countryCode}/companies/{companyId}/branches	Retrieves all branches configured in a given company.
POST	v1/config/{countryCode}/companies/{companyId}/branches	Creates a branch for a given company.
GET	v1/config/{countryCode}/companies/{companyId}/branches/{branchId}	Retrieves a branch configured in a given company.
PUT	v1/config/{countryCode}/companies/{companyId}/branches/{branchId}	Updates a company's branch, overwriting it.	Credentials can be overwritten using this endpoint.
PATCH	/v1/config/{countryCode}/companies/{companyId}/branches/{branchId}	Updates only the differences in a given branch.	Credentials cannot be updated using this endpoint.
PUT	/v1/config/{countryCode}/companies/{companyId}/branches/{branchId}/credentials/{credentialId}	Overwrites a specified credential from a given branch.