Sign in

v1

latestOpenAPI 3.0.42026-07-2481154567.6 KB
Recurring Earnings

Get Employee Earning by resourceId

Summary Description

This function will allow the API user to get details for a particular earning code that occurs in the past/present/future.

get/apiHub/payroll/v1/companies/{companyId}/employees/{employeeId}/earnings/{earningCode}/{resourceId}

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

earningCodestring required

Earning Code

resourceIdstring uuid required

Resource ID of the record

Headers

testModeboolean

If true all responses are mocked and generated randomly

Response

OK

idstring uuid

Resource ID of the record

companyIdstring nullable

The Paylocity Company Identifier. This is the unique value provided by Paylocity to each specific Payroll Entity

employeeIdstring nullable

The Paylocity Employee ID. This is a unique value per Paylocity Company ID

codestring nullable

Earning Code

frequencystring nullable

Frequency determines how often the earning amount is applied in payroll

selfInsuredboolean nullable

Self Insured Flag

recordType'Current' | 'Future' | 'Historical' | 'Unknown' nullable

The recordType field in our API plays a vital role in defining the current state of the record under consideration. This attribute can hold three different values, each describing a distinct temporal stage of the record.

  1. Historical: If the recordType is set as 'Historical', it signifies that the record in question pertains to past data or events. This attribute is typically used for records that have been archived or are no longer active.
  2. Current: A 'Current' recordType indicates that the record is active and relevant to the present time. These records are currently in use and contain up-to-date information.
  3. Future dated: The 'Future dated' recordType is used for records that are scheduled for a future date. They represent planned or expected data or events. By using the recordType field, users can accurately categorize their records based on their temporal status, making it easier to sort, manage, and analyze data effectively.
amountnumber double nullable

Amount of Earning

ratenumber double nullable

Earning Code Rate

calculationCodestring nullable

Earning Calculation Code

unitsnumber double nullable

Hours or Units Worked

rateCodestring nullable

Rate Code

agencystring nullable

Agency Code

miscellaneousInfostring nullable

Miscellaneous Info

effectiveDatestring date-time nullable

Effective Date of Earning

beginCheckDatestring date-time nullable

Begin Check Date of Earning

endCheckDatestring date-time nullable

The date you select will become the last date that this earning appears on the employee's paycheck