Create new Recurring Employee Earning

post https://dc1demogwext.paylocity.com/apiHub/payroll/v1/companies/{companyId}/employees/{employeeId}/earnings

Summary Description

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

Path Params

companyId

string

required

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

employeeId

string

required

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

Body Params

A Payroll Earning Code is a specific classification used in payroll systems to categorize the different types of income an employee receives. These codes denote various earnings such as regular hours worked, overtime, bonuses, commissions, or holiday pay, among others. The purpose of these codes is to streamline the payroll process, making it easier to track, manage, and report different types of income. They are essential for accurate payroll calculations and compliance with tax and labor laws.

effectiveFrom

date-time | null

Effective Date of Earning

effectiveTo

date-time | null

End Date of Earning

amount

double | null

Amount of Earning

rate

double | null

Earning Code Rate

units

double | null

Hours or Units Worked

selfInsured

boolean | null

Self Insured Flag

calculationCode

string | null

Earning Calculation Code

frequency

string | null

Frequency determines how often the earning Amount is applied in payroll

agency

string | null

Agency Code

miscellaneousInfo

string | null

Miscellaneous Info

rateCode

string | null

Rate Code

distribution

object

Labor Distribution is the term for the system categorizing (distributing) payroll data among Cost Centers and Job Codes

limits

object

Limits are used to control the amount of an earning or deduction

code

string | null

Earning Code

Headers

Authorization

string

Authorization token. Ex. Bearer ...

Response

200

Success

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url https://dc1demogwext.paylocity.com/apiHub/payroll/v1/companies/companyId/employees/employeeId/earnings \
3
     --header 'content-type: application/*+json'

Click Try It! to start a request and see the response here!