Guides

Configuration API Requests

Learn about Tax Configuration API requests.

Suggest Edits

Tax Configuration requests

Taxability category requests

RequestEndpointMethodDescription
List Taxability Drivers/v2/taxability-categoriesGETThis request retrieves all taxability categories. It returns a list of taxability categories ordered by name. You can filter by code and name using eq operator.
Retrieve a Taxability Category by ID/v2/taxability-categories/{id}GETThis request retrieves a taxability category by id.
List Taxability Category Descendants/v2/taxability-categories/{id}/hierarchyGETThis request returns a list of the requested taxability category, and all its descendants, using pre-order tree traversal.

Commodity code requests

RequestEndpointMethodDescription
List Commodity Code Types/v2/commodity-codesGETThis request returns a list of supported commodity code types.
List Commodity Codes for a Type/v2/commodity-codes/{type}GETThis request returns a list of commodity codes available for a particular type ordered by code. You can filter by name using contains String Function. Case-insensitive search is supported.
Retrieve Mapping for a Commodity Code/v2/commodity-codes/{type}/{codevalue}GETThis request returns commodity code mapping information for a commodity code.

Taxability driver requests

RequestEndpointMethodDescription
Create a Taxability Driver/v2/taxability-driversPOSTThis request creates a taxability driver.
List Taxability Drivers/v2/taxability-driversGETThis request returns a list of taxability drivers ordered by code. You can filter by code, name, and owningTaxpayerId using eq operator.
Retrieve a Taxability Driver by ID/v2/taxability-driversGETThis request retrieves a taxability driver by id.
Update a Taxability Driverv2/taxability-drivers/{id}PUTThis request updates a taxability driver.
Delete a Taxability Driverv2/taxability-drivers/{id}DELETEThis request deletes a taxability driver.

Location requests

RequestEndpointMethodDescription
Create Locationsv2/locationsPOSTThis request creates one or more locations.
List Locationsv2/locationsGETThis request returns a list of locations ordered by owningPartyId. You can filter by owningPartyId eq operator.
Retrieve a Location by IDv2/locations/{id}GETThis request retrieves a location by id.
Update a Locationv2/locations/{id}PUTThis request updates a location configuration. All elements are replaced.
Delete a Locationv2/locationsDELETEThis request deletes a location.

Taxability mapping requests

RequestEndpointMethodDescription
Create a Taxability Mappingv2/taxability-mappingsPOSTThis request creates a taxability mapping.
List Taxability Mappingsv2/taxability-mappingsGETThis request returns a list of taxability mappings ordered by taxability category id. You can filter by categoryId and driverId using eq operator.
Retrieve a Taxability Mapping by IDv2/taxability-mappings/{id}GETThis request returns a list of taxability mappings ordered by taxability category id. You can filter by categoryId and driverId using eq operator.
Delete a Taxability Mapping/v2/taxability-mappings/{id}DELETEThis request deletes a taxability mapping.

Registration requests

RequestEndpointMethodDescription
Create Registrationsv2/registrationsPOSTThis request creates one or more registrations.
List Registrationsv2/registrationsGETReturns a list of registrations ordered by owningPartyId. You can filter by owningPartyId and registrationType using eq operator.
Retrieve a Registration by IDv2/registrations/{id}GETThis request retrieves a registration by id.
Update a Registrationv2/registrations/{id}PUTThis request updates a registration configuration. All elements are replaced.
Delete a Registrationv2/registrations/{id}DELETEThis request deletes a registration.

Taxpayer requests

RequestEndpointMethodDescription
Create a Taxpayerv2/taxpayersPOSTThis request creates a taxpayer.
List Taxpayers/v2/taxpayersGETReturns a list of taxpayers ordered by name. You can filter by code and name using eq operator.
Retrieve a Taxpayer by ID/v2/taxpayers/{id}GETThis request retrieves a registration by id.
Update a Taxpayer/v2/taxpayers/{id}PUTThis request updates a taxpayer.

Updated about 2 months ago