Minimum Wage Endpoints
Retrieve minimum wage rates by location and ID
There are two minimum wage endpoints that return minimum wage rates:
/prp/v1/minimumwage/location
- returns minimum wage rates by location and effective date/prp/v1/minimumwage/id
- returns minimum wage rates by the minimum wage unique id
Minimum Wage add-on to Payroll Point
Clients can purchase the minimum wage rate add-on to Payroll Point, which provides access to Symmetry's historical and future-looking minimum wage rate database. Leverage the power of the PRP API and Symmetry's location service for wage rate determination.
/minimumwage/location
endpoint
/minimumwage/location
endpointThe /prp/v1/minimumwage/location
endpoint returns minimum wage rates by location (address or longitude/latitude pair) and effective date. The result contains all minimum wage rates for a location and effective date.
Query Parameters
Parameter | Format | Enforcement |
---|---|---|
streetAddress1 | String | Required if latitude and longitude are null |
streetAddress2 | String | Optional |
city | String | Required if latitude and longitude are null |
state | String | Required if latitude and longitude are null |
zipCode | XXXXX or XXXXX-XXXX | Required if latitude and longitude are null |
effectiveDate | YYYY-MM-DD | Required |
latitude | String | Required if address parameters are null |
longitude | String | Required if address parameters are null |
useAddressSuggestion | Boolean | Optional. Read more here. |
Sample Request
curl --location --request GET 'https://api.symmetry.com/prp/v1/minimumwage/location?streetAddress1=123 main st&city=Edison&state=NJ&zipCode=08837&effectiveDate=2021-01-01' \
--header 'Authorization: y0urAPI-KeyG0esH3re'
In this example, parameters are set to the following:
streetAddress1
: 123 Main Stcity
: Edisonstate
: NJzipCode
: 08837effectiveDate
: 2021-01-31
Sample Response
{
"rates": [
{
"mwUid": "00-0-000000000-EXM-012-013",
"state": "Federal",
"stateCode": 0,
"authorityCode": 0,
"authority": "",
"authorityType": "Federal",
"authorityTypeCode": 0,
"rate": "27.63",
"effectiveDate": "2017-01-01",
"majorType": "EXM",
"industryType": "Computer Professionals",
"industryTypeCode": 12,
"minorType": "Minimum Hourly Rate Of Pay Exemption From Overtime Amount",
"minorTypeCode": 13,
"details": "Exempt computer employee",
"updated": "2020-07-07 17:16:03"
}
. . .
],
"normalizedAddress": {
"streetAddress1": "123 Main St",
"city": "Edison",
"state": "NJ",
"zipCode": "08837-2920"
},
"normalizedCoordinates": {
"longitude": -74.358125,
"latitude": 40.522835
}
}
/minimumwage/id
endpoint
/minimumwage/id
endpointThe /prp/v1/minimumwage/id
endpoint returns minimum wage rates by the minimum wage unique id (mwUid
). The minimum wage unique id (mwUid
) string is returned for each tax in the /prp/v1/minimumwage/location
endpoint.
Clients can read more about Symmetry's minimum wage unique ID and the elements that compose the ID in Symmetry's Client Support Center.
Query Parameters
Parameter | Format | Enforcement |
---|---|---|
effectiveDate | YYYY-MM-DD | Optional |
mwUid | String | Required |
industryTypeCode | Number | Optional |
majorType | Number | Optional |
minorTypeCode | Number | Optional |
pageNumber | Number | Optional |
pageSize | Number | Optional |
updatedSince | YYYY-MM-DD | Optional |
Sample Request
curl --location --request GET 'https://api.symmetry.com/prp/v1/minimumwage/id?effectiveDate=2021-01-31&mwUid=6-3-277483-*-*-*&pageNumber=0&pageSize=1' \
--header 'Authorization: y0urAPI-KeyG0esH3re'
In this example, parameters are set to the following:
effectiveDate
: 2021-01-31mwUid
: 6-3-277483---*pageNumber
: 0pageSize
: 1
Sample Response
{
"ratesPage": {
"content": [
{
"mwUid": "06-3-000277483-REG-000-002",
"stateCode": 6,
"state": "California",
"authorityCode": 277483,
"authority": "Campbell",
"authorityType": "City",
"authorityTypeCode": 3,
"rate": "13.00",
"effectiveDate": "2020-01-01",
"majorType": "REG",
"industryType": "",
"industryTypeCode": 0,
"minorType": "26 Employees Or More",
"minorTypeCode": 2,
"details": "26 employees or more",
"note": "",
"updated": "2020-07-07 17:16:03"
}
],
"pageable": {
"sort": {
"unsorted": true,
"sorted": false,
"empty": true
},
"offset": 0,
"pageNumber": 0,
"pageSize": 1,
"unpaged": false,
"paged": true
},
"last": false,
"totalPages": 2,
"totalElements": 2,
"sort": {
"unsorted": true,
"sorted": false,
"empty": true
},
"size": 1,
"number": 0,
"first": true,
"numberOfElements": 1,
"empty": false
}
}
Updated over 1 year ago