PApaylocity
Additional Rates

Add/update additional rates

Sends new or updated employee additional rates information directly to Web Pay.

put/v2/companies/{companyId}/employees/{employeeId}/additionalRates

Request

  • Base URL
    https://api.paylocity.com/api
  • URL
    https://api.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}/additionalRates
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.paylocity.com/IdentityServer/connect/token scopes: WebLinkAPI

Path parameters

companyIdstring required

Company Id

employeeIdstring required

Employee Id

Request body

changeReasonstring nullable

Not required. If populated, must match one of the system coded values available in the Additional Rates Change Reason drop down.<br />

costCenter1string nullable

Not required. Valid values must match one of the system coded cost centers available in the Additional Rates Cost Center level 1 drop down. This cell must be in a text format.<br />

costCenter2string nullable

Not required. Valid values must match one of the system coded cost centers available in the Additional Rates Cost Center level 2 drop down. This cell must be in a text format.<br />

costCenter3string nullable

Not required. Valid values must match one of the system coded cost centers available in the Additional Rates Cost Center level 3 drop down. This cell must be in a text format.<br />

effectiveDatestring paylocity-date nullable

Required. Common formats include MM-DD-CCYY, CCYY-MM-DD.<br />

endCheckDatestring paylocity-date nullable

Not required. Must match one of the system coded check dates available in the Additional Rates End Check Date drop down. Common formats include MM-DD-CCYY, CCYY-MM-DD.<br />

jobstring nullable

Not required. If populated, must match one of the system coded values available in the Additional Rates Job drop down.<br />

ratenumber nullable

Required. Enter dollar amount that corresponds to the Per selection.<br />

rateCodestring nullable

Required. If populated, must match one of the system coded values available in the Additional Rates Rate Code drop down.<br />

rateNotesstring nullable

Not required.<br />Max length: 4000<br />

ratePerstring nullable

Required. Valid values are HOUR or WEEK.<br />

shiftstring nullable

Not required. If populated, must match one of the system coded values available in the Additional Rates Shift drop down.<br />

Response

Successfully added or updated

Changes

No recorded changes to this operation across all 4 revisions of this API.