GET Employee Earnings List

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

Summary Description

This function will allow the API user to GET a list of all active earnings associated with 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

Query Params

filter

string

The API Filter, by defining specific conditions, enables developers to fine-tune data from API calls for more precise results, enhancing application efficiency and user-friendliness. For more information review the Filtering page

limit

int32

Defaults to 20

Number of results per page.
Default Value: 250
Maximum Value: 250

offset

int32

Defaults to 0

Pagination offset

Headers

testMode

boolean

If true all responses are mocked and generated randomly

Authorization

string

Authorization token. Ex. Bearer ...

Response

Response body

array of objects

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

limits

object

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

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://dc1demogwext.paylocity.com/apiHub/payroll/v1/companies/companyId/employees/employeeId/earnings?limit=20&offset=0' \
3
     --header 'accept: application/json'


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

200Success