API Reference

Saves phase-1 employment basics such as hire dates and distribution settings.

put
https://example.com/wep/companies//onboarding/start//employmentbasic

Access: System, Admin, and ClientAdmin users only.

Validation depends on whether the onboarding is for a new hire or a rehire.
The returned navigation payload points the client to the next required setup step.

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

Company identifier from the route.

int32
required

Onboarding identifier from the route.

Body Params

Employment-basic values to save for the onboarding.

Request payload for the phase-1 employment-basic step.

date | null

Original hire date for a non-rehire onboarding.
Uses the date wire format.
Data type is validated and must be Number

date | null

Rehire date for a rehire onboarding.
Uses the date wire format.
Data type is validated and must be Number

string | null

Optional client-specific clock number assigned during setup.

int32
enum

Members:

  • 0 - None ( None. )
  • 1 - ClockNumber ( ClockNumber. )
  • 2 - Department ( Department. )
  • 3 - EENumDepartment ( EENumDepartment. )
  • 4 - Division ( Division. )
  • 5 - DistributionMethod ( DistributionMethod. )
  • 255 - Custom ( Custom. )
Allowed:
Headers
string
required
Defaults to 2.0

The requested API version

string
Defaults to 2.0

The requested API version

Responses

Updated about 1 month 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 1 month ago