Sign in

v1

latestOpenAPI 3.0.42026-07-2481154567.6 KB
Earnings

Get Earnings by Earning Code

Get Earnings returns all earnings with the provided earning code for the selected employee.

get/v2/companies/{companyId}/employees/{employeeId}/earnings/{earningCode}

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

employeeIdstring required

The Paylocity Employee ID. This is a unique value per Paylocity Company ID. Allowable Values: 10 char max

earningCodestring required

Earning Code

Response

Successfully retrieved

agencystring

Third-party agency associated with earning. Must match Company setup.<br />Max length: 10

amountnumber

Value that matches CalculationCode to add to gross wages. For percentage (%), enter whole number (10 = 10%). <br />Decimal(12,2)

annualMaximumnumber

Year to Date dollar amount not to be exceeded for an earning in the calendar year. Used only with company driven maximums. <br />Decimal(12,2)

calculationCodestring

Defines how earnings are calculated. Common values are % (percentage of gross), flat (flat dollar amount). Defaulted to the Company setup calcCode for earning. <br />Max length: 20

costCenter1string

Cost Center associated with earning. Must match Company setup.<br /> Max length: 10

costCenter2string

Cost Center associated with earning. Must match Company setup.<br /> Max length: 10

costCenter3string

Cost Center associated with earning. Must match Company setup.<br /> Max length: 10

earningCodestring required

Earning code. Must match Company setup. <br />Max length: 10

effectiveDatestring paylocity-date

Date earning is active. Defaulted to run date or check date based on Company setup. Common formats are MM-DD-CCYY, CCYY-MM-DD.

endDatestring paylocity-date

Stop date of an earning. Common formats are MM-DD-CCYY, CCYY-MM-DD.

frequencystring

Needed if earning is applied differently from the payroll frequency (one time earning for example).<br /> Max length: 5

goalnumber

Dollar amount. The employee earning will stop when the goal amount is reached.<br /> Decimal(12,2)

hoursOrUnitsnumber

The value is used in conjunction with the Rate field. When entering Group Term Life Insurance (GTL), it should contain the full amount of the group term life insurance policy. <br /> Decimal(12,2)

isSelfInsuredboolean

Used for ACA. If not entered, defaulted to Company earning setup.

jobCodestring

Job code associated with earnings. Must match Company setup.<br /> Max length: 20

miscellaneousInfostring

Information to print on the check stub if agency is set up for this earning. <br />Max length: 50

paidTowardsGoalnumber

Amount already paid to employee toward goal. <br /> Decimal(12,2)

payPeriodMaximumnumber

Maximum amount of the earning on a single paycheck. <br /> Decimal(12,2)

payPeriodMinimumnumber

Minimum amount of the earning on a single paycheck. <br /> Decimal(12,2)

ratenumber

Rate is used in conjunction with the hoursOrUnits field. <br /> Decimal(12,2)

rateCodestring

Rate Code applies to additional pay rates entered for an employee. Must match Company setup. <br /> Max length: 10

startDatestring paylocity-date required

Start date of an earning based on payroll calendar. Common formats are MM-DD-CCYY, CCYY-MM-DD.