Taxpayers

Use the Certificate Center API to retrieve a list of taxpayers.

Base URL:

https://ccservices.vertexsmb.com/certificate-center/v1/
Taxpayers endpointTaxpayers description
/taxpayersGET - Retrieves a list of taxpayers based on filter criteria, pagination, and sorting parameters.

Retrieve taxpayers

Retrieves a list of taxpayers based on filter criteria, pagination, and sorting parameters. By default, taxpayers are sorted by their name in ascending order.

Request

All request parameters are optional. Passing a request with no parameters returns all records.

Retrieve taxpayers request parameter nameRetrieve taxpayers request parameter formatRetrieve taxpayers 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/taxpayers \
     --header 'accept: application/json'

Response

A response includes any number of taxpayer records. Each taxpayer record can include some or all of these fields.

Retrieve taxpayers response fieldRetrieve taxpayers response description
odata.countThe number of taxpayer records retrieved.
valueAn array of objects, one for each taxpayer record retrieved.
UUIDUnique identifier.
codeCode assigned to the customer.
nameCustomer name.
startDateDate the customer became active.
endDateDate the customer is no longer active, if any.
noteNote about the taxpayer.
taxpayerTaxpayer associated with this customer. 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"
      }
    }
  ]
}