API Reference

Returns client pay codes for a specific company.

get
https://example.com/wep/companies//pay-codes

Access: System, Admin, and ClientAdmin users only.

Without filters, the response contains only active company pay codes whose related master pay type is active.

If effectiveDate is sent, the endpoint applies effective-date filtering using the company pay code
EffectiveFrom value and the coalesced upper bound ClientPayCode.ValidTo ?? MasterPayType.ValidTo.

If excludeMemo=true, pay codes with masterPayType.wageType = Memo are excluded.
Unsupported numeric enum values and non-positive masterPayTypeId values are rejected with 400.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

Company identifier from route.

Query Params
baseOn
array of objects

Optional repeatable filter for master pay-code base-on values.

baseOn
timeOffCategory
array of objects

Optional repeatable filter for client pay-code time-off category values.

timeOffCategory
Allowed:
wageType
array of objects

Optional repeatable filter for master pay-type wage-type values.

wageType
masterPayTypeId
array of int32s

Optional repeatable filter for master pay-type identifiers.

masterPayTypeId
date-time

Optional effective-date filter in date-only format.

boolean

Optional flag to exclude memo wage types.

Headers
string
required
Defaults to 2.0

The requested API version

string
Defaults to 2.0

The requested API version

Responses

Updated about 11 hours ago

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

Updated about 11 hours ago