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.
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
Paylocity company identifier (COID): up to 9 alphanumeric characters for the target company.
Headers
Media type(s) the client can accept in the response (typically application/json).
Query parameters
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.
Number of earning codes per page.
Default Value: 20
Maximum Value: 100 Used together with offset for offset/limit pagination.
Pagination offset. Uses item-index offset semantics: this is the number of resources to skip (not a page number). Pair with limit for paging.
Response headers
When the request sets includeTotalCount=true, the API returns this header with the total number of resources available (even if only one page is returned).