Payroll Sample API calls
After you create credentials for the application, you can interact with Vertex Payroll Tax using a Postman project that includes various pre-made test API calls. This project includes many of the scenarios you may encounter when using the application, such as:
- GeoCode and Address Cleansing lookups
- Various types of tax calculation calls
- Sample query calls
The tax calls include both standard tax calculations and complex scenarios involving multiple workplace scenarios, forms, and tax overrides.
Postman is a free third-party application that can be downloaded here: https://www.postman.com/.
For instructions on how to set up your Payroll credentials in Postman and for our Postman projects, search Vertex Community.
JSON example snippets
The following are snippets of what example JSON files in trial and production (prod) environments look like.
You can download the full Postman sample script files here.
Payroll trial Calc + GeoCodes Postman scripts
{
"info": {
"\_postman_id": "73f6e50d-16a7-4c2a-bfa3-5b9631fbb85d",
"name": "Payroll Trial Calc + Geocodes",
"schema": "<https://schema.getpostman.com/json/collection/v2.1.0/collection.json">,
"\_exporter_id": "4777440"
},
"item": \[
{
"name": "Geocoder",
"request": {
"method": "POST",
"header": \[],
"body": {
"mode": "raw",
"raw": "{\\r\\n \"state\": {\\r\\n \"name\": \"Pennsylvania\",\\r\\n \"isPrefix\": true\\r\\n },\\r\\n \"postalCode\": \"19087-2340\"\\r\\n }",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "<https://payroll-test.vertexcloud.com/location/v1.0/geocodes">,
"protocol": "https",
"host": \[
"payroll-test",
"vertexcloud",
"com"
],
"path": \[
"location",
"v1.0",
"geocodes"
]
}
},
"response": \[]
},
{
"name": "geocode search zip+city+state",
"request": {
"method": "POST",
"header": \[],
"body": {
"mode": "raw",
"raw": "{\\r\\n \"city\": {\\r\\n \"name\": \"Acworth\",\\r\\n \"isPrefix\": true,\\r\\n \"isCompressed\": true\\r\\n },\\r\\n \"state\": {\\r\\n \"name\": \"Georgia\",\\r\\n \"isPrefix\": true\\r\\n },\\r\\n \"postalCode\": \"301021398\"\\r\\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "<https://payroll-test.vertexcloud.com/location/v1.0/geocodes">,
"protocol": "https",
"host": \[
"payroll-test",
"vertexcloud",
"com"
],
"path": \[
"location",
"v1.0",
"geocodes"
]
}
},
Payroll prod Calc + GeoCodes Postman scripts
### {
"info": {
"\_postman_id": "5fe44334-ca54-467c-916d-73f59ce44cd5",
"name": "Payroll Prod Calc + Geocodes",
"schema": "<https://schema.getpostman.com/json/collection/v2.1.0/collection.json">,
"\_exporter_id": "4777440"
},
"item": \[
{
"name": "geocode search zip+city+state",
"request": {
"method": "POST",
"header": \[],
"body": {
"mode": "raw",
"raw": "{\\r\\n \"city\": {\\r\\n \"name\": \"Acworth\",\\r\\n \"isPrefix\": true,\\r\\n \"isCompressed\": true\\r\\n },\\r\\n \"state\": {\\r\\n \"name\": \"Georgia\",\\r\\n \"isPrefix\": true\\r\\n },\\r\\n \"postalCode\": \"301021398\"\\r\\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "<https://payroll.vertexcloud.com/location/v1.0/geocodes">,
"protocol": "https",
"host": \[
"payroll",
"vertexcloud",
"com"
],
"path": \[
"location",
"v1.0",
"geocodes"
]
}
},
Payroll trial Address Cleansing Postman scripts
{
"info": {
"\_postman_id": "acd83373-9666-4cd2-b7fb-63ed1ee47d49",
"name": "Payroll Trial Address Cleansing",
"schema": "<https://schema.getpostman.com/json/collection/v2.1.0/collection.json">,
"\_exporter_id": "4777440"
},
"item": \[
{
"name": "Address Cleansing",
"request": {
"method": "POST",
"header": \[],
"body": {
"mode": "raw",
"raw": "{\\r\\n\\r\\n \"city\": \"Glenview\",\\r\\n\\r\\n \"postalCode\": \"40025\",\\r\\n\\r\\n \"state\": \"KY\",\\r\\n\\r\\n \"streetAddress1\": \"3300 Arden Rd\"\\r\\n\\r\\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "<https://payroll-test.vertexcloud.com/location/v1.0/address-cleanse">,
"protocol": "https",
"host": \[
"payroll-test",
"vertexcloud",
"com"
],
"path": \[
"location",
"v1.0",
"address-cleanse"
]
}
},
"response": \[]
},
{
"name": "Address Cleansing 2",
"request": {
"method": "POST",
"header": \[],
"body": {
"mode": "raw",
"raw": "{\\r\\n \"streetAddress1\": \"266 ridge milk drive\",\\r\\n \"streetAddress2\": \"string\",\\r\\n \"city\": \"Acmeworth\",\\r\\n \"county\": \"Cobb\",\\r\\n \"state\": \"GA\",\\r\\n \"postalCode\": \"30102\"\\r\\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "<https://payroll-test.vertexcloud.com/location/v1.0/address-cleanse">,
"protocol": "https",
"host": \[
"payroll-test",
"vertexcloud",
"com"
],
"path": \[
"location",
"v1.0",
"address-cleanse"
]
}
},
Payroll prod Address Cleansing Postman scripts
### {
"info": {
"\_postman_id": "125722ea-55c8-432b-b72c-112b4c910594",
"name": "Payroll Prod Address Cleansing",
"schema": "<https://schema.getpostman.com/json/collection/v2.1.0/collection.json">,
"\_exporter_id": "4777440"
},
"item": \[
{
"name": "Address Cleansing",
"request": {
"method": "POST",
"header": \[],
"body": {
"mode": "raw",
"raw": "{\\r\\n \"city\": \"Glenview\",\\r\\n \"postalCode\": \"40025\",\\r\\n \"state\": \"KY\",\\r\\n \"streetAddress1\": \"3300 Arden Rd\"\\r\\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "<https://payroll.vertexcloud.com/payroll/v1.0/address-cleanse">,
"protocol": "https",
"host": \[
"payroll",
"vertexcloud",
"com"
],
"path": \[
"payroll",
"v1.0",
"address-cleanse"
]
}
},
"response": \[]
},
{
"name": "Address Cleansing 2",
"request": {
"method": "POST",
"header": \[],
"body": {
"mode": "raw",
"raw": "{\\r\\n \"streetAddress1\": \"266 ridge milk drive\",\\r\\n \"streetAddress2\": \"string\",\\r\\n \"city\": \"Acmeworth\",\\r\\n \"county\": \"Cobb\",\\r\\n \"state\": \"GA\",\\r\\n \"postalCode\": \"30102\"\\r\\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "<https://payroll.vertexcloud.com/location/v1.0/address-cleanse">,
"protocol": "https",
"host": \[
"payroll",
"vertexcloud",
"com"
],
"path": \[
"location",
"v1.0",
"address-cleanse"
]
}
},
For information on configuring Postman, go to Configuring Postman to work with Vertex Payroll Tax.
Updated 4 months ago