Taxability Drivers
Use the Certificate Center API to retrieve a list of taxability drivers.
Base URL:
https://ccservices.vertexsmb.com/certificate-center/v1/
| Taxability Driver endpoint | Taxability Driver description |
|---|---|
/taxability-drivers | GET - Retrieves a list of taxability drivers based on filter criteria, pagination, and sorting parameters. |
Retrieve taxability drivers
Retrieve a list of taxability drivers records based on your choice of filter criteria. By default, taxability drivers are sorted by their name in ascending order.
Request
All request parameters are optional. Passing a request with no parameters returns all records.
| Retrieve taxability drivers request parameter name | Retrieve taxability drivers request parameter format | Retrieve taxability drivers request parameter description |
|---|---|---|
top | int64 | Number of returned records to display per page. Default = 20. |
skip | int64 | Number of records to skip before displaying records. Must be 0 or greater. Default = 0. |
filter | string | Limit the returned records to those including the filter criteria, such as customer name or taxpayer name. |
count | Boolean | If set to true, returns a count of the total records found. Default = false. |
orderBy | string | Order the results according to any response field by entering it here. Results are in alphabetical or numerical order depending on the field format. |
Example request
curl --request GET \
--url https://vertex-enterprise-group.readme.io/certificate-center/v1/taxability-drivers \
--header 'accept: application/json'
Response
A response includes any number of taxability driver records. Each taxability driver record can include some or all of these fields.
| Retrieve taxability drivers response field | Retrieve taxability drivers response description |
|---|---|
odata.count | The number of taxability driver records retrieved. |
value | An array of objects, one for each taxability driver record retrieved. |
UUID | Unique identifier. |
code | Code assigned to the taxability driver. |
name | Taxability driver name. |
startDate | Date the taxability driver became active. |
endDate | Date the taxability driver is no longer active, if any. |
note | Note about the taxability driver. |
taxpayer | Taxpayer associated with this taxability driver. The taxpayer field includes UUID, code, and name. |
Example response
{
"odata.count": 0,
"value": [
{
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"code": "string",
"name": "string",
"startDate": "2025-09-17",
"endDate": "2025-09-17",
"note": "string",
"taxpayer": {
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"code": "string",
"name": "string"
}
}
]
}
