Configuration API Requests
Learn about Tax Configuration API requests.
Tax Configuration requests
Taxability category requests
Request | Endpoint | Method | Description |
---|---|---|---|
List Taxability Drivers | /v2/taxability-categories | GET | This 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} | GET | This request retrieves a taxability category by id. |
List Taxability Category Descendants | /v2/taxability-categories/{id}/hierarchy | GET | This request returns a list of the requested taxability category, and all its descendants, using pre-order tree traversal. |
Commodity code requests
Request | Endpoint | Method | Description |
---|---|---|---|
List Commodity Code Types | /v2/commodity-codes | GET | This request returns a list of supported commodity code types. |
List Commodity Codes for a Type | /v2/commodity-codes/{type} | GET | This 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} | GET | This request returns commodity code mapping information for a commodity code. |
Taxability driver requests
Request | Endpoint | Method | Description |
---|---|---|---|
Create a Taxability Driver | /v2/taxability-drivers | POST | This request creates a taxability driver. |
List Taxability Drivers | /v2/taxability-drivers | GET | This 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-drivers | GET | This request retrieves a taxability driver by id. |
Update a Taxability Driver | v2/taxability-drivers/{id} | PUT | This request updates a taxability driver. |
Delete a Taxability Driver | v2/taxability-drivers/{id} | DELETE | This request deletes a taxability driver. |
Location requests
Request | Endpoint | Method | Description |
---|---|---|---|
Create Locations | v2/locations | POST | This request creates one or more locations. |
List Locations | v2/locations | GET | This request returns a list of locations ordered by owningPartyId . You can filter by owningPartyId eq operator. |
Retrieve a Location by ID | v2/locations/{id} | GET | This request retrieves a location by id. |
Update a Location | v2/locations/{id} | PUT | This request updates a location configuration. All elements are replaced. |
Delete a Location | v2/locations | DELETE | This request deletes a location. |
Taxability mapping requests
Request | Endpoint | Method | Description |
---|---|---|---|
Create a Taxability Mapping | v2/taxability-mappings | POST | This request creates a taxability mapping. |
List Taxability Mappings | v2/taxability-mappings | GET | This 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 ID | v2/taxability-mappings/{id} | GET | This 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} | DELETE | This request deletes a taxability mapping. |
Registration requests
Request | Endpoint | Method | Description |
---|---|---|---|
Create Registrations | v2/registrations | POST | This request creates one or more registrations. |
List Registrations | v2/registrations | GET | Returns a list of registrations ordered by owningPartyId . You can filter by owningPartyId and registrationType using eq operator. |
Retrieve a Registration by ID | v2/registrations/{id} | GET | This request retrieves a registration by id. |
Update a Registration | v2/registrations/{id} | PUT | This request updates a registration configuration. All elements are replaced. |
Delete a Registration | v2/registrations/{id} | DELETE | This request deletes a registration. |
Taxpayer requests
Request | Endpoint | Method | Description |
---|---|---|---|
Create a Taxpayer | v2/taxpayers | POST | This request creates a taxpayer. |
List Taxpayers | /v2/taxpayers | GET | Returns 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} | GET | This request retrieves a registration by id. |
Update a Taxpayer | /v2/taxpayers/{id} | PUT | This request updates a taxpayer. |
Updated 3 months ago