v2/employments

post

https://shyftplan.com/api/v2/employments

Create an employment. Managers can't be created using this API.

Body Params

user_email

string

required

This is a testing sandbox. We advise against using credentials for production accounts here.

E-mail address of the API user.

authentication_token

string

required

This is a testing sandbox. We advise against using credentials for production accounts here.

Authentication token - can be fetched by login action.

company_id

int32

required

≥ 1

ID of a shyftplan account.

first_name

string

required

last_name

string

required

billing_type_id

int32

enum

1 = abrechnen (is billed); 2 = nicht abrechnen (is not billed)

Allowed:

string

email used to login to the employment created

employment_work_hour_attributes

object

Working hours of the employment.

entry_date

date

First day of employment of this employee.

exit_date

date

Last date of employment of this employee.

exit_month_payed_partially

boolean

Defaults to false

is_paid_monthly

boolean

maximum_money_enabled

boolean

Defaults to false

maximum_money

float

note

string

password

string

phone_number

string

sso_only

boolean

Defaults to false

Boolean flag to determine if the user must log in via SSO. Can only be changed by a super-admin

staff_number

string

user_token

int32

Token for punch-timing

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Successfully created

403forbidden