Sign in

v1

latestSwagger 2.02026-07-133225142.0 KB
Earnings

Get Earning by Earning Code and Start Date

Get Earnings returns the single earning with the provided earning code and start date for the selected employee.

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

Path parameters

companyIdstring required

Company Id

employeeIdstring required

Employee Id

earningCodestring required

Earning Code

startDatestring required

Start Date

Response

Successfully retrieved

agencystring nullable

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

amountnumber nullable

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

annualMaximumnumber nullable

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 nullable

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 nullable

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

costCenter2string nullable

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

costCenter3string nullable

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

earningCodestring nullable required

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

effectiveDatestring paylocity-date nullable

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 nullable

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

frequencystring nullable

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

goalnumber nullable

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

hoursOrUnitsnumber nullable

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 nullable

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

jobCodestring nullable

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

miscellaneousInfostring nullable

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

paidTowardsGoalnumber nullable

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

payPeriodMaximumnumber nullable

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

payPeriodMinimumnumber nullable

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

ratenumber nullable

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

rateCodestring nullable

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

startDatestring paylocity-date nullable required

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