Taxpayers
Use the Certificate Center API to retrieve a list of taxpayers.
Base URL:
https://ccservices.vertexsmb.com/certificate-center/v1/
Taxpayers endpoint | Taxpayers description |
---|---|
/taxpayers | GET - Retrieves a list of taxpayers based on filter criteria, pagination, and sorting parameters. |
Retrieve taxpayers
Retrieve a list of taxpayer records based on your choice of filter criteria.
Request
All request parameters are optional. Passing a request with no parameters returns all records.
Retrieve taxpayers request parameter name | Retrieve taxpayers request parameter format | Retrieve taxpayers 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/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 field | Retrieve taxpayers response description |
---|---|
UUID | Unique identifier. |
code | Code assigned to the customer. |
name | Customer name. |
startDate | Date the customer became active. |
endDate | Date the customer is no longer active, if any. |
note | Note about the taxpayer. |
taxpayer | Taxpayer 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"
}
}
]
}
Updated 19 days ago
What’s Next