GET api/admin/Taxes/SimpleExtended?Country={Country}&State={State}&County={County}&City={City}&PostalCode={PostalCode}&Plus4StartRange={Plus4StartRange}&Plus4EndRange={Plus4EndRange}&TaxCodeID={TaxCodeID}
Gets Tax Rates from the Simple Extended Taxes tables.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
Country |
Input Country in which the resulting output values will be returned. Ex, if "USA" is provided and the country is valid, the results will show values from the Simplified Tax Extended table for the country "USA". Any additional values provided beyond this field will also be assessed when providing the output, meaning that City, State, Country, County, etc. can all be evaluated at the same time for granularity. |
string |
Max length: 50 |
State |
Input Country in which the resulting output values will be returned. Ex, if “Oregon” is provided and the State is valid, the results will show values from the Simplified Tax Extended table for the State “Oregon”. Any additional values provided beyond this field will also be assessed when providing the output, meaning that City, State, Country, County, etc. can all be evaluated at the same time for granularity. |
string |
Max length: 50 |
County |
Input County in which the resulting output values will be returned. Ex, if “Hillsborough” is provided and the County is valid, the results will show values from the Simplified Tax Extended table for the County “Hillsborough”. Any additional values provided beyond this field will also be assessed when providing the output, meaning that City, State, Country, County, etc. can all be evaluated at the same time for granularity. |
string |
Max length: 50 |
City |
Input City in which the resulting output values will be returned. Ex, if “Portland” is provided and the City is valid, the results will show values from the Simplified Tax Extended table for the City “Portland”. Any additional values provided beyond this field will also be assessed when providing the output, meaning that City, State, Country, County, etc. can all be evaluated at the same time for granularity. |
string |
Max length: 50 |
PostalCode |
Input Postal Code in which the resulting output values will be returned. Ex, if “54321” is provided and the Postal Code is valid, the results will show values from the Simplified Tax Extended table for the Postal Code “54321”. Any additional values provided beyond this field will also be assessed when providing the output, meaning that City, State, Country, County, etc. can all be evaluated at the same time for granularity. |
string |
Max length: 50 |
Plus4StartRange |
Input +4 Zip Code Starting Range in which the resulting output values will be returned. Ex, if “1234” is provided and the Postal Code is valid, the results will show values from the Simplified Tax Extended table for the +4 Zip Code Range “1234” until the provided End Range or 9999. Any additional values provided beyond this field will also be assessed when providing the output, meaning that City, State, Country, County, etc. can all be evaluated at the same time for granularity. Must provide a postal code when using this parameter. If this value is provided but no value for Plus4EndRange is provided, the Plus4EndRange will be assumed to be 9999. |
integer |
None. |
Plus4EndRange |
Input +4 Zip Code End Range in which the resulting output values will be returned. Ex, if “1234” is provided and the Postal Code is valid, the results will show values from the Simplified Tax Extended table for the +4 Zip Code Start range or 0000 until “1234”. Any additional values provided beyond this field will also be assessed when providing the output, meaning that City, State, Country, County, etc. can all be evaluated at the same time for granularity. Must provide a postal code when using this parameter. If this value is provided but no value for Plus4StartRange is provided, the Plus4StartRange will be assumed to be 0000. |
integer |
None. |
TaxCodeID |
Input Postal Code in which the resulting output values will be returned. Ex, if “54321” is provided and the Postal Code is valid, the results will show values from the Simplified Tax Extended table for the Postal Code “54321”. Any additional values provided beyond this field will also be assessed when providing the output, meaning that City, State, Country, County, etc. can all be evaluated at the same time for granularity. |
string |
Max length: 50 |
Body Parameters
None.
Response Information
Resource Description
Collection of TaxSimpleExtendedViewModelName | Description | Type | Additional information |
---|---|---|---|
TaxCodeID |
TaxCodeID for the returned value. |
string |
None. |
Country |
Country for the returned value. |
string |
Required Max length: 50 |
State |
State for the returned value. |
string |
Max length: 50 |
County |
County for the returned value. |
string |
Max length: 50 |
City |
City for the returned value. |
string |
Max length: 50 |
PostalCode |
Postal Code for the returned value. |
string |
Max length: 50 |
Plus4StartRange |
Zip Code + 4 Start Range, if applicable. |
integer |
None. |
Plus4EndRange |
Zip Code + 4 End Range, if applicable. |
integer |
None. |
CountryTaxRate |
Tax Rate for the country, if applicable. |
decimal number |
None. |
StateTaxRate |
Tax Rate for the State, if applicable. |
decimal number |
None. |
CountyTaxRate |
Tax Rate for the County, if applicable. |
decimal number |
None. |
CityTaxRate |
Tax Rate for the City, if applicable |
decimal number |
None. |
CityLocalTaxRate |
Tax Rate for the City Local, if applicable. |
decimal number |
None. |
RoundingTypeID |
ID of the rounding type used. |
integer |
None. |
RoundingType |
Description of the rounding type used. |
string |
None. |
Response Formats
application/xml, text/xml
<ListOfTaxSimpleExtendedViewModel> <TaxSimpleExtendedViewModel> <TaxCodeID>sample string 1</TaxCodeID> <Country>sample string 2</Country> <State>sample string 3</State> <County>sample string 4</County> <City>sample string 5</City> <PostalCode>sample string 6</PostalCode> <Plus4StartRange>1</Plus4StartRange> <Plus4EndRange>1</Plus4EndRange> <CountryTaxRate>7</CountryTaxRate> <StateTaxRate>8</StateTaxRate> <CountyTaxRate>9</CountyTaxRate> <CityTaxRate>10</CityTaxRate> <CityLocalTaxRate>11</CityLocalTaxRate> <RoundingTypeID>12</RoundingTypeID> <RoundingType>sample string 13</RoundingType> </TaxSimpleExtendedViewModel> <TaxSimpleExtendedViewModel> <TaxCodeID>sample string 1</TaxCodeID> <Country>sample string 2</Country> <State>sample string 3</State> <County>sample string 4</County> <City>sample string 5</City> <PostalCode>sample string 6</PostalCode> <Plus4StartRange>1</Plus4StartRange> <Plus4EndRange>1</Plus4EndRange> <CountryTaxRate>7</CountryTaxRate> <StateTaxRate>8</StateTaxRate> <CountyTaxRate>9</CountyTaxRate> <CityTaxRate>10</CityTaxRate> <CityLocalTaxRate>11</CityLocalTaxRate> <RoundingTypeID>12</RoundingTypeID> <RoundingType>sample string 13</RoundingType> </TaxSimpleExtendedViewModel> </ListOfTaxSimpleExtendedViewModel>
application/json, text/json
[ { "TaxCodeID": "sample string 1", "Country": "sample string 2", "State": "sample string 3", "County": "sample string 4", "City": "sample string 5", "PostalCode": "sample string 6", "Plus4StartRange": 1, "Plus4EndRange": 1, "CountryTaxRate": 7.0, "StateTaxRate": 8.0, "CountyTaxRate": 9.0, "CityTaxRate": 10.0, "CityLocalTaxRate": 11.0, "RoundingTypeID": 12, "RoundingType": "sample string 13" }, { "TaxCodeID": "sample string 1", "Country": "sample string 2", "State": "sample string 3", "County": "sample string 4", "City": "sample string 5", "PostalCode": "sample string 6", "Plus4StartRange": 1, "Plus4EndRange": 1, "CountryTaxRate": 7.0, "StateTaxRate": 8.0, "CountyTaxRate": 9.0, "CityTaxRate": 10.0, "CityLocalTaxRate": 11.0, "RoundingTypeID": 12, "RoundingType": "sample string 13" } ]