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 endpointTaxability Driver description
/taxability-driversGET - 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 nameRetrieve taxability drivers request parameter formatRetrieve taxability drivers request parameter description
topint64Number of returned records to display per page. Default = 20.
skipint64Number of records to skip before displaying records. Must be 0 or greater. Default = 0.
filterstringLimit the returned records to those including the filter criteria, such as customer name or taxpayer name.
countBooleanIf set to true, returns a count of the total records found. Default = false.
orderBystringOrder 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 fieldRetrieve taxability drivers response description
odata.countThe number of taxability driver records retrieved.
valueAn array of objects, one for each taxability driver record retrieved.
UUIDUnique identifier.
codeCode assigned to the taxability driver.
nameTaxability driver name.
startDateDate the taxability driver became active.
endDateDate the taxability driver is no longer active, if any.
noteNote about the taxability driver.
taxpayerTaxpayer 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"
      }
    }
  ]
}