PApaylocity
Payroll/HR

Get Earning Codes

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.
get/apiHub/payroll/v1/companies/{companyId}/earnings

Request

  • Base URL
    dc1demogwext.paylocity.com (relative, and the document’s source URL is not known)
  • URL
    dc1demogwext.paylocity.com/apiHub/payroll/v1/companies/{companyId}/earnings
  • Auth
    none declared

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

Query parameters

includeTotalCountboolean

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.

limitinteger

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

offsetinteger

Pagination offset.

Headers

Authorizationstring

Authorization token. Ex. Bearer ...

testModeboolean

If true all responses are mocked and generated randomly.

Response

OK

companyIdstring nullable

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

codestring nullable

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.

descriptionstring nullable

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

checkStubDescriptionstring nullable

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

w2Boxstring nullable

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

printOnCheckStubstring nullable

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

payPeriodMaximumnumber double nullable

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

payPeriodMinimumnumber double nullable

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

annualMaximumnumber double nullable

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

overrideRatenumber double nullable

An overridden rate for the earning.

addToRatenumber double nullable

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

rateMultipliernumber double nullable

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

calculationCodestring nullable

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

rateCodestring nullable

The code associated with the earning rate.

amountnumber double nullable

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

frequencystring nullable

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

ratenumber double nullable

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

agencystring nullable

The agency or organization associated with the earning.

relatedDeductionCodestring nullable

The code of the related deduction, if applicable.

reduceAutoPayboolean nullable

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

exemptTaxesstring[] nullable

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

blockedTaxesstring[] nullable

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

costCenterMatrixIdinteger nullable

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

isActiveboolean nullable

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

includeInHoursWorkedboolean nullable

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

includeOnYtdCompChartboolean nullable

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

sourceinteger nullable

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

wasUsedInPayrollboolean nullable

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

benefitTypestring nullable

The type of benefit associated with the earning.

selfInsuredboolean nullable

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

isEmployerPaidMedicalLeaveboolean nullable

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

classificationCodestring nullable

The classification code associated with the earning.

wageTypestring nullable

The type of wage associated with the earning.

Changes

No recorded changes to this operation across all 1 revision of this API.