v2/employments

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

Create Employment

Form Data

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 the shyftplan account.

first_name

string

required

last_name

string

required

billing_type_id

int32

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

string

email used to login to the employment created

employment_work_hour_attributes[mon_minutes]

int32

employment_work_hour_attributes[tue_minutes]

int32

employment_work_hour_attributes[wed_minutes]

int32

employment_work_hour_attributes[thu_minutes]

int32

employment_work_hour_attributes[fri_minutes]

int32

employment_work_hour_attributes[sat_minutes]

int32

employment_work_hour_attributes[sun_minutes]

int32

employment_work_hour_attributes[vacation_minutes]

int32

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

Create user as Single Sign-On only user. Password will be ignored if this flag is set

staff_number

string

user_token

int32

Token for punch-timing

Responses

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url https://shyftplan.com/api/v2/employments \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/x-www-form-urlencoded' \
5
     --data exit_month_payed_partially=false \
6
     --data maximum_money_enabled=false \
7
     --data sso_only=false

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

application/json

201Successfully created

403forbidden