GET Recurring Earning Details for a specific past/present/future earning

get https://dc1demogwext.paylocity.com/apiHub/payroll/v1/companies/{companyId}/employees/{employeeId}/earnings/{earningCode}/{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.

Response

Response body

object

uuid

Resource ID of the record

companyId

string | null

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

employeeId

string | null

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

code

string | null

Earning Code

frequency

string | null

Frequency determines how often the earning amount is applied in payroll

selfInsured

boolean | null

Self Insured Flag

recordType

string | null

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.

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.
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.
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.

Current Future Historical Unknown

amount

double | null

Amount of Earning

rate

double | null

Earning Code Rate

calculationCode

string | null

Earning Calculation Code

units

double | null

Hours or Units Worked

rateCode

string | null

Rate Code

agency

string | null

Agency Code

miscellaneousInfo

string | null

Miscellaneous Info

effectiveDate

date-time | null

Effective Date of Earning

beginCheckDate

date-time | null

Begin Check Date of Earning

endCheckDate

date-time | null

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

distribution

object

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

jobCode

string | null

Job Code Allocation

costCenters

array of objects | null

An array of objects representing the Cost Centers

costCenters

object

level

int32 | null

Cost center level (Levels are 1-3)

code

string | null

Cost Center Code associated with the Level. This must match a Paylocity Cost Center Code

limits

object

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

goal

double | null

The Goal is the deduction/earning limit. When deductions/earnings have met the limit, the employee pay deductions/earnings will stop.
For payroll, this amount is the lifetime deduction/earning limit.
For benefits, this limit amount could be annual.

paidToDate

double | null

Paid to Date tracks the amount paid toward the Goal. The Paid to Date amount will never be more than the Goal amount

payPeriodMinimum

double | null

Minimum for the pay period

payPeriodMaximum

double | null

Maximum for the pay period

annualMaximum

double | null

Entering an amount in the Annual Maximum field will override the system setting, and you'll need to manually manage the maximum each year.
Leave this field blank to keep the system setting.

paidYearToDate

double | null

Amount Paid Year to Date

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url https://dc1demogwext.paylocity.com/apiHub/payroll/v1/companies/companyId/employees/employeeId/earnings/earningCode/resourceId \
3
     --header 'accept: application/json'


xxxxxxxxxx
40
}
1
{
2
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3
  "companyId": "string",
4
  "employeeId": "string",
5
  "code": "string",
6
  "frequency": "string",
7
  "selfInsured": true,
8
  "recordType": "Current",
9
  "amount": 0,
10
  "rate": 0,
11
  "calculationCode": "string",
12
  "units": 0,
13
  "rateCode": "string",
14
  "agency": "string",
15
  "miscellaneousInfo": "string",
16
  "effectiveDate": "2025-04-07T23:12:35.338Z",
17
  "beginCheckDate": "2025-04-07T23:12:35.338Z",
18
  "endCheckDate": "2025-04-07T23:12:35.338Z",
19
  "distribution": {
20
    "jobCode": "string",
21
    "costCenters": [
22
      {
23
        "level": 0,
24
        "code": "string",
25
        "additionalProp": {}

200Success