GET a List of Earning Codes by Company ID

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

Summary Description

The GET Earning Codes List by Company ID endpoint, retrieves a comprehensive list of Earning Codes from the Paylocity system with each call. Earning codes, also known as earning kinds or pay codes, are alphanumeric or numeric labels employed by organizations to classify and monitor various forms of earnings or income that employees get as part of their compensation. These codes have multiple crucial applications in payroll management, accounting, and compensation administration. Pagination can be achieved by using the "earnings" parameter and specifying the values of "limit" and "offset" to decide the quantity of records to be retrieved. The utilization of the "limit" option permits the user to restrict the quantity of rows that are retrieved from a query, whereas the "offset" option enables the omission of a designated number of rows preceding the commencement of the result set. The utilization of both the limit and offset parameters in a query allows for the skipping of rows as well as the restriction of the number of rows returned.

Use Cases

The API enables payroll departments to oversee earning codes linked to various forms of compensation, such as standard salary, overtime, bonuses, and incentives. This guarantees precise and effective payroll computations.
Compensation Management: HR teams can employ the API to view earning codes for diverse work titles and staff groups. This allows firms to maintain alignment with compensation policies and industry norms.
Benefits Administration involves the inclusion of earning codes that contain not just wage components but also other benefits like as health insurance, retirement contributions, and stock options. The API facilitates the monitoring and administration of these varied compensation components.
Time and Attendance Integration: By integrating with time and attendance systems, the API may automate the computation of earnings using data on hours worked, shifts, and attendance.

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

Query Params

includeTotalCount

boolean

Defaults to true

A boolean value representing whether the API should return the total number of resources available (even though only a subset may be returned). When includeTotalCount=true, then the X-Pcty-Total-Count response header should be added to the response and will specify the total number of records available. APIs that support X-Pcty-Total-Count should include this parameter in their specification.

limit

int32

Defaults to 20

Number of earning codes per page.
Default Value: 20
Maximum Value: 100

offset

int32

Defaults to 0

Pagination offset.

Headers

Authorization

string

Authorization token. Ex. Bearer ...

testMode

boolean

Defaults to false

If true all responses are mocked and generated randomly.

Response

Response body

array of objects

object

companyId

string | null

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

code

string | null

Unique identifier for specific types of earnings associated with employees' compensation packages. It plays a crucial role in accurately calculating, categorizing, and recording various forms of income and compensation.

description

string | null

A detailed textual explanation or label that provides additional context and meaning to the associated code or entity.

checkStubDescription

string | null

A descriptive text that appears on an employee's check stub, offering transparency and clarity regarding the payment.

w2Box

string | null

A reference to a specific box on a W-2 tax form, aiding in the accurate reporting of various types of income and deductions.

printOnCheckStub

string | null

An indicator specifying whether the associated information or description should be printed on an employee's check stub.

payPeriodMaximum

double | null

The maximum limit or threshold applicable to a pay period, often used to define the upper limit of compensation within a specific period.

payPeriodMinimum

double | null

The minimum threshold or floor amount for compensation within a pay period, ensuring that compensation meets a minimum standard.

annualMaximum

double | null

The highest allowable amount or limit for compensation within an annual period, setting an upper boundary for earnings.

overrideRate

double | null

An overridden rate for the earning.

addToRate

double | null

A field indicating whether a specific amount should be added to an existing rate or compensation structure.

rateMultiplier

double | null

A numerical multiplier used to calculate rates or compensation, allowing for flexible rate adjustments.

calculationCode

string | null

A code used in calculations to determine specific values or outcomes, assisting in complex computation scenarios.

rateCode

string | null

The code associated with the earning rate.

amount

double | null

The numerical value representing a specific amount, often used in financial calculations and compensation.

frequency

string | null

The frequency at which the earning is taken (e.g., weekly, monthly).

rate

double | null

The rate of compensation associated with a particular entity or item, indicating payment per unit of time or work.

agency

string | null

The agency or organization associated with the earning.

relatedDeductionCode

string | null

The code of the related deduction, if applicable.

reduceAutoPay

boolean | null

An indicator specifying whether automatic payments should be reduced based on certain conditions or criteria.

exemptTaxes

array of strings | null

An array of tax codes from which the earning is exempt.

exemptTaxes

blockedTaxes

array of strings | null

An array of tax codes that are blocked from applying to the earning.

blockedTaxes

costCenterMatrixId

int32 | null

An identifier that associates an entity or item with a cost center matrix, facilitating cost allocation and tracking.

isActive

boolean | null

An indicator denoting the current status or active state of an entity or item, assisting in management and decision-making.

includeInHoursWorked

boolean | null

An indicator specifying whether the associated data should be included in calculations related to hours worked.

includeOnYtdCompChart

boolean | null

An indicator specifying whether the data should be included on a year-to-date compensation chart or report.

source

int32 | null

The origin or source of data, indicating where the information was derived or obtained from within the system.

wasUsedInPayroll

boolean | null

An indicator confirming whether the data was utilized in payroll processing, ensuring transparency in payroll calculations.

benefitType

string | null

The type of benefit associated with the earning.

selfInsured

boolean | null

An indicator indicating whether an entity or item is self-insured, meaning it assumes responsibility for insurance coverage.

isEmployerPaidMedicalLeave

boolean | null

An indicator specifying whether an entity or item is related to employer-paid medical leave, offering clarity on benefit coverage.

classificationCode

string | null

The classification code associated with the earning.

wageType

string | null

The type of wage associated with the earning.

type

object

Language


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


xxxxxxxxxx
51
]
1
[
2
  {
3
    "companyId": "string",
4
    "code": "string",
5
    "description": "string",
6
    "checkStubDescription": "string",
7
    "w2Box": "string",
8
    "printOnCheckStub": "string",
9
    "payPeriodMaximum": 0,
10
    "payPeriodMinimum": 0,
11
    "annualMaximum": 0,
12
    "overrideRate": 0,
13
    "addToRate": 0,
14
    "rateMultiplier": 0,
15
    "calculationCode": "string",
16
    "rateCode": "string",
17
    "amount": 0,
18
    "frequency": "string",
19
    "rate": 0,
20
    "agency": "string",
21
    "relatedDeductionCode": "string",
22
    "reduceAutoPay": true,
23
    "exemptTaxes": [
24
      "string"
25
    ],

200Success