---
title: "Create an Employee Pay Rates Search"
method: POST
path: "/v2/companies/{companyId}/employeePayRateSearches"
tags: ["Pay Rate Searches"]
---

# Create an Employee Pay Rates Search

`POST /v2/companies/{companyId}/employeePayRateSearches`

> 🚧 Beta Phase
> 
> This resource is in closed beta.  Paylocity Technology Partners interested may contact the marketplace team to explore early adopter opportunities at [marketplaceapisupport@paylocity.com](mailto:marketplaceapisupport@paylocity.com) 

**Summary Description**

 Performs a pay rates search for the specified company according to the search parameters passed in the request body.

## Path parameters

- `companyId` string, required

## Request body

- PayRateSearchesRequest
  - `effectiveDateFlag` 'History' | 'Future' | 'All' — A flag that defines which effective dated records should be returned. If not defined the response body will contain the only the current pay rate for each employee.
  - `employeeIds` string[] — The employee IDs to search pay rates for

## Response `200`

Pay rates matching the provided search criteria

- object[]
  - `employeeId` string — The employee ID
  - `payRates` object[] — An array of pay rates for the specified employee
    - `annualSalary` number — Employee annual salary
    - `baseRate` number — Employee base rate, used for Hourly employees
    - `beginCheckDate` string, date-time — The date of the first check on which the new pay rate will appear
    - `defaultHours` number — Employee default hours consistently worked
    - `effectiveDate` string, date-time — The date the employee's pay rate takes effect
    - `isAutoPay` boolean — If set to True, employee will be paid automatically using defaultHours
    - `payFrequency` string — Employee current pay frequency. Common values are `A` (Annual), `B` (Bi-Weekly), `D` (Daily), `M` (Monthly), `S` (Semi-Monthly), `Q` (Quarterly), `W` (Weekly)
    - `payType` string — Employee pay type (rate code). Valid values are `Hourly` or `Salary`
    - `ratePer` string — Employee base rate frequency used with payType Hourly. Common values are `Hour`, `Week`. Default is `Hour`
    - `rateType` 'History' | 'Current' | 'Future' — The effective dated type of the pay rate record
    - `salary` number — Employee gross salary per pay period used with payType Salary

## Other responses

- `400` — Bad request. Returned when the request contains invalid values or is missing required properties.
- `401` — Unauthorized
- `403` — Forbidden. If the client ID associated with the bearer token doesn't have required authorization claims assigned.
- `429` — Too Many Requests
- `500` — Internal Server Error

---

[API](https://skmtc.net/paylocity/apis/assessments-api.md) · [All operations](https://skmtc.net/paylocity/apis/assessments-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/paylocity/assessments-api/revisions/dd22ab229153/schema)