Get Earnings setup (Extended)

Gets list of all Earnings configuration for current payroll.
This call returns information needed for proper rendering of payroll earnings (aka Timesheet) editor.
Setup call doesn't return data and you have to call also Get list of earnings endpoint.

This endpoint can be called only by System and Admin level users.

Employee call will return Forbidden result even for Employee own company.
Result doesn't include GTL-SYS and FRNG-HSA earning codes. They are reserved for system a they cannot be modified. Amounts for these earning codes are calculated automatically during the payroll according to benefits.
Extended functionality: Returns list Workers' Compensation Codes which can be set on payline.

Path Params
int32
required

ID of Company

int32
required

Payroll Run ID. ID is returned from Start Default Payroll or Start Named Payroll endpoint.

Headers
string
Defaults to 1.0

The requested API version

string
Defaults to 1.0

The requested API version

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Response

Language
Credentials
Bearer
jwt
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json
text/plain