API Reference
Home

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
string
required

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

E-mail address of the API user.

string
required

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

Authentication token - can be fetched by login action.

int32
required
≥ 1

ID of a shyftplan account.

int32
required
≥ 1

ID of the employment.

string
enum
required

Time basis for the contractual hours in the hour account.

Allowed:
date-time
required

Activation date of the hour account.

int32

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

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.

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.

int32

Contractual working minutes on the day.

int32

Contractual working minutes on the day.

int32

Contractual working minutes on the day.

int32

Contractual working minutes on the day.

int32

Contractual working minutes on the day.

int32

Contractual working minutes on the day.

int32

Contractual working minutes on the day.

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.

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.

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.

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.

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.

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.

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

Updated 6 months ago

Language
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 6 months ago