Investigator API
POST Search TaxChanges
Overview
Tax changes based on client number refer to the process of identifying, tracking, and applying updates or modifications to a client's tax situation using a unique client identifier (client number).
OperationId: POST Search TaxChanges
Authorization Method(s): OAuth
Verb: POST
End Point: /api/taxchanges/search
Example Request
The following is an json request for this operation.
{
"filters": {
"customerUsageType": "07",
"providerType": "80",
"startDate": {
"year": "2024",
"month": "12",
"day": 1
},
"endDate": {
"year": "2025",
"month": "01",
"day": 1
},
"releaseNumber": null,
"dateType": "Date"
},
"parameters": {
"pgpis": [],
"postalCode": null,
"npanxx": null,
"locations": null,
"address": null,
"stateCountyCity": null,
"geocode": "US48113A0004",
"by": "ProductGroupItem",
"skus": []
},
"clientNumber": "ZREGRSV06",
"searchCountry": "UnitedStates",
"searchOption": "Geocode",
"searchType": "TaxabilityChanges"
}Query parameters in an API operation are key-value pairs that are included in the URL of an API request to filter or modify the data returned by the API. They come after the `?` in the URL and are often used to pass optional parameters like search terms, pagination information, sorting criteria, or filters to narrow down the data in the response.
| Display String | Field Name | Field Type |
|---|---|---|
| Api-version* | api-version | undefined |
Overview
Example Response
The following is an example response you can expect for this operation
{
"results": [
{
"taxabilityChangeId": 0,
"groupID": "",
"groupDescription": "",
"itemID": "",
"itemDescription": "",
"state": "",
"county": "",
"city": "",
"otherLocal": "",
"postalCode": "",
"plus4": "",
"taxAuthority": "",
"taxName": "",
"taxType": "",
"taxTypeDescription": "",
"taxTypeFullDescription": "",
"taxCategory": "",
"taxCategoryDescription": "",
"taxCategoryFullDescription": "",
"currentTaxability": true,
"currentPercentTaxable": 0,
"currentEffectiveDate": "2025-03-12T13:54:43.8671566-06:00",
"previousTaxability": true,
"previousPercentTaxable": 0,
"previousEffectiveDate": "2025-03-12T13:54:43.8671626-06:00",
"customerType": "",
"providerType": "",
"geocode": "",
"locationId": "",
"sales_Use": ""
}
],
"locationResults": [
{
"locationId": "",
"results": [
{
"taxabilityChangeId": 0,
"groupID": "",
"groupDescription": "",
"itemID": "",
"itemDescription": "",
"state": "",
"county": "",
"city": "",
"otherLocal": "",
"postalCode": "",
"plus4": "",
"taxAuthority": "",
"taxName": "",
"taxType": "",
"taxTypeDescription": "",
"taxTypeFullDescription": "",
"taxCategory": "",
"taxCategoryDescription": "",
"taxCategoryFullDescription": "",
"currentTaxability": true,
"currentPercentTaxable": 0,
"currentEffectiveDate": "2025-03-12T13:54:43.8671652-06:00",
"previousTaxability": true,
"previousPercentTaxable": 0,
"previousEffectiveDate": "2025-03-12T13:54:43.8671656-06:00",
"customerType": "",
"providerType": "",
"geocode": "",
"locationId": "",
"sales_Use": ""
}
]
}
],
"errors": []
}
Response codes in an API indicate the outcome of a request. They are three-digit numbers returned by the server to help the client understand if the request was successful, encountered an error, or needs further action. This operation has the following possible responses.
| code | description |
|---|---|
| 200 | Search was successful for the given client number. |
| 401 | User doesn't have access to use the API. |