Recurring Earnings

Create Employee Earning [Single]

Summary Description

This function will allow the API user to create a new earning on the employee record.

post/apiHub/payroll/v1/companies/{companyId}/employees/{employeeId}/earnings

Request

Base URL
dc1demogwext.paylocity.com (relative, and the document’s source URL is not known)
URL
dc1demogwext.paylocity.com/apiHub/payroll/v1/companies/{companyId}/employees/{employeeId}/earnings
Auth
none declared

Path parameters

companyIdstring required

The Paylocity Company Identifier. This is the unique value provided by Paylocity to each specific Payroll Entity. Allowable Values: 9 char max

employeeIdstring required

A filter to use to limit results to a specific employee. Allowable Values: 255 char max

Request body

codestring nullable

Earning Code

effectiveFromstring date-time nullable

Effective Date of Earning

effectiveTostring date-time nullable

End Date of Earning

amountnumber double nullable

Amount of Earning

ratenumber double nullable

Earning Code Rate

unitsnumber double nullable

Hours or Units Worked

selfInsuredboolean nullable

Self Insured Flag

calculationCodestring nullable

Earning Calculation Code

frequencystring nullable

Frequency determines how often the earning Amount is applied in payroll

agencystring nullable

Agency Code

miscellaneousInfostring nullable

Miscellaneous Info

rateCodestring nullable

Rate Code

Response

Created

idstring uuid

Resource ID of the record.