GuidesAPI ReferenceChangelog

Filtering Earnings

What operators are supported for filtering the Earnings API

The following operators are supported to filter data on the Earnings API. The Earnings API interacts with employee-level recurring earnings in the Payroll/HR module. These earnings apply to each paycheck for the employee. The most popular filtering is done by earning code. The code field represents earning code. Sample earnings for an employee are CAR (car allowance), CELL (cell phone allowance), or ERMED (employer-paid medical). Earning codes can be customized per client. Use the Company Codes API to retrieve a list of valid earning codes.

FieldSupported Operator
codeeq,ne,in,sw,ct
frequencyeq,ne,in,sw,ct
selfInsuredeq,ne
amounteq,ne,gt,ge,lt,le,in
rateeq,ne,gt,ge,lt,le,in
calculationCodeeq,ne,in,sw,ct
unitseq,ne,gt,ge,lt,le,in
rateCodeeq,ne,in,sw,ct
agencyeq,ne,in,sw,ct
miscellaneousInfoeq,ne,in,sw,ct
effectiveDateeq,ne,gt,ge,lt,le,in
effectiveFromeq,ne,gt,ge,lt,le,in
effectiveToeq,ne,gt,ge,lt,le,in

Copyright © 2023 Paylocity. All Rights Reserved. Privacy Center | Terms and Conditions | Accessibility