v1/hour_accounts

post https://shyftplan.com/api/v1/hour_accounts

Create an hour account for an employment who does not have an hour account yet.

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

employment_id

int32

required

≥ 1

ID of the employment.

hour_type

string

required

Time basis for the contractual hours in the hour account.

activation_date

date-time

required

Activation date of the hour account.

vacation_minutes

int32

Default working minutes equivalent for a day of paid absence, if the absence is calculated according to the employee's regular working hours.

weekly_minutes

integer

Minutes an employee has to work per week, if configured on a weekly basis. This parameter is required if hour_type is weekly. Otherwise this parameter is not permitted. The value has to match the sum of the weekday minutes submitted for the values of the paramters mon_minutes through sun_minutes.

monthly_minutes

int32

Minutes an employee has to work per month, if configured on a monthly basis. This parameter is required if hour_type is monthly. Otherwise, this parameter is not permitted.

mon_minutes

int32

Contractual working minutes on the day.

tue_minutes

int32

Contractual working minutes on the day.

wed_minutes

int32

Contractual working minutes on the day.

thu_minutes

int32

Contractual working minutes on the day.

fri_minutes

int32

Contractual working minutes on the day.

sat_minutes

int32

Contractual working minutes on the day.

sun_minutes

int32

Contractual working minutes on the day.

is_working_on_mon

boolean

Is the employee contracted to work on this particular day each week? For employees with a monthly amount of contractual hours this determines whether a contractual debt time interval (e.g. 420 minutes) is entered into the hour account for the particular week day. The value is calculated by dividing the monthly hours by the number of working days in a particular month. Errors from rounding are equalized on the last working day of the month.

is_working_on_tue

boolean

Is the employee contracted to work on this particular day each week? For employees with a monthly amount of contractual hours this determines whether a contractual debt time interval (e.g. 420 minutes) is entered into the hour account for the particular week day. The value is calculated by dividing the monthly hours by the number of working days in a particular month. Errors from rounding are equalized on the last working day of the month.

is_working_on_wed

boolean

Is the employee contracted to work on this particular day each week? For employees with a monthly amount of contractual hours this determines whether a contractual debt time interval (e.g. 420 minutes) is entered into the hour account for the particular week day. The value is calculated by dividing the monthly hours by the number of working days in a particular month. Errors from rounding are equalized on the last working day of the month.

is_working_on_thu

boolean

Is the employee contracted to work on this particular day each week? For employees with a monthly amount of contractual hours this determines whether a contractual debt time interval (e.g. 420 minutes) is entered into the hour account for the particular week day. The value is calculated by dividing the monthly hours by the number of working days in a particular month. Errors from rounding are equalized on the last working day of the month.

is_working_on_fri

boolean

Is the employee contracted to work on this particular day each week? For employees with a monthly amount of contractual hours this determines whether a contractual debt time interval (e.g. 420 minutes) is entered into the hour account for the particular week day. The value is calculated by dividing the monthly hours by the number of working days in a particular month. Errors from rounding are equalized on the last working day of the month.

is_working_on_sat

boolean

Is the employee contracted to work on this particular day each week? For employees with a monthly amount of contractual hours this determines whether a contractual debt time interval (e.g. 420 minutes) is entered into the hour account for the particular week day. The value is calculated by dividing the monthly hours by the number of working days in a particular month. Errors from rounding are equalized on the last working day of the month.

is_working_on_sun

boolean

Is the employee contracted to work on this particular day each week? For employees with a monthly amount of contractual hours this determines whether a contractual debt time interval (e.g. 420 minutes) is entered into the hour account for the particular week day. The value is calculated by dividing the monthly hours by the number of working days in a particular month. Errors from rounding are equalized on the last working day of the month.

Responses

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url https://shyftplan.com/api/v1/hour_accounts \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "hour_type": "weekly"
8
}
9
'

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

application/json