Schedule times

Table of content

Retrieve schedule time

URL

https://api.fortnox.se/3/scheduletimes/{EmployeeId}/{Date}

Method

GET

Description

Retrieves schedule time on a specific day for an employee

Response

{
  "ScheduleTime": {
    "EmployeeId": "9978",
    "Date": "2017-01-13",
    "ScheduleId": "HEL",
    "Hours": 8,
    "IWH1": 0,
    "IWH2": 0,
    "IWH3": 0,
    "IWH4": 0,
    "IWH5": 0
  }
}

<?xml version="1.0" encoding="UTF-8"?>
<ScheduleTime>
    <EmployeeId>9978</EmployeeId>
    <Date>2017-01-13</Date>
    <ScheduleId>HEL</ScheduleId>
    <Hours>8</Hours>
    <IWH1>0</IWH1>
    <IWH2>0</IWH2>
    <IWH3>0</IWH3>
    <IWH4>0</IWH4>
    <IWH5>0</IWH5>
</ScheduleTime>

Update schedule time

URL

https://api.fortnox.se/3/scheduletimes/{EmployeeId}/{Date}

Method

PUT

Description

Updates schedule time on a day for an employee

Request

{
  "ScheduleTime": {
    "Hours": "5"
  }
}

<?xml version="1.0" encoding="UTF-8"?>
<ScheduleTime>
    <Hours>5</Hours>
</ScheduleTime>

Response

{
  "ScheduleTime": {
    "EmployeeId": "9978",
    "Date": "2017-01-13",
    "ScheduleId": "HEL",
    "Hours": 5,
    "IWH1": 0,
    "IWH2": 0,
    "IWH3": 0,
    "IWH4": 0,
    "IWH5": 0
  }
}

<?xml version="1.0" encoding="UTF-8"?>
<ScheduleTime>
    <EmployeeId>9978</EmployeeId>
    <Date>2017-01-13</Date>
    <ScheduleId>HEL</ScheduleId>
    <Hours>5</Hours>
    <IWH1>0</IWH1>
    <IWH2>0</IWH2>
    <IWH3>0</IWH3>
    <IWH4>0</IWH4>
    <IWH5>0</IWH5>
</ScheduleTime>

Reset schedule time

URL

https://api.fortnox.se/3/scheduletimes/{EmployeeId}/{Date}/resetday

Method

PUT

Description

Resets schedule time of a day according to the schedule that is assigned to the employee through the employment information

Request

Request body is not necessary for this route.

Request body is not necessary for this route.

Response

{
  "ScheduleTime": {
    "EmployeeId": "9978",
    "Date": "2017-01-13",
    "ScheduleId": "HEL",
    "Hours": 8,
    "IWH1": 0,
    "IWH2": 0,
    "IWH3": 0,
    "IWH4": 0,
    "IWH5": 0
  }
}

<?xml version="1.0" encoding="UTF-8"?>
<ScheduleTime>
    <EmployeeId>9978</EmployeeId>
    <Date>2017-01-13</Date>
    <ScheduleId>HEL</ScheduleId>
    <Hours>8</Hours>
    <IWH1>0</IWH1>
    <IWH2>0</IWH2>
    <IWH3>0</IWH3>
    <IWH4>0</IWH4>
    <IWH5>0</IWH5>
</ScheduleTime>

Properties

Field Type Access Description
EmployeeId  String (15) RW Unique employee-id
Date Date RW Date
ScheduleId String (10) RW Unique schedule-od
Hours Float RW Amount of hours
IWH1 Float RW Amount of hours
IWH2 Float RW Amount of hours
IWH3 Float RW Amount of hours
IWH4 Float RW Amount of hours
IWH5 Float RW Amount of hours