API Reference

Saves detailed global-employment settings for the onboarding.

put
https://example.com/wep/companies//onboarding/start//employmentdetail-global

Access: System, Admin, and ClientAdmin users only.

This variant is only valid for global onboardings and enforces global compensation and pay-period rules.
Referenced work structure entities are validated before the step data is saved.

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

Detailed global-employment settings to save.

Employer-provided global employment details collected during onboarding step 1.

int32
enum

Work Schedule Type

Members:

  • 1 - PartTime ( Part-Time. )
  • 2 - FullTime ( Full-Time. )
  • 3 - Temporary ( Temporary. )
  • 4 - Intern ( Intern. )
  • 5 - Seasonal ( Seasonal. )

Allowed:
int32
enum

Members:

  • 1 - Salaried ( Salaried. )
  • 2 - Hourly ( Hourly. )
  • 3 - Piecework ( Piecework. )
  • 4 - Commissioned ( Commissioned. )
  • 5 - Contractor ( Contractor. )
  • 6 - Owner ( Owner. )
  • 7 - Tipped ( Tipped. )
Allowed:
double | null
required
0 to 9999999

Compensable Hours.

double | null

Compensation amount used for salary-, commission-, owner-, or contractor-based compensation types.

double | null
-214748 to 214748

Hourly rate used for hourly or tipped compensation types.

double | null
-214748 to 214748

Per-unit rate used for piecework compensation.

int32 | null

Number of work units used for piecework compensation.

int32 | null
required

Work Location Id. Use 0 for 'Works From Home'.

int32 | null

Department Id.

int32 | null

Division of the employee, if divisions are active.

int32 | null

Holiday-group identifier assigned to the employee, when applicable.

int32 | null

Position Id

int32
enum

Members:

  • 0 - NA ( N/A. )
  • 1 - Weekly ( Weekly. )
  • 2 - BiWeekly ( Bi-weekly. )
  • 3 - SemiMonthly ( Semi-monthly. )
  • 4 - Monthly ( Monthly. )
Allowed:
string | null

Job description or duties summary.

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