EmploymentContractTemplate

Staff5 EndpointsTimeTracking / EmploymentContractTemplate

This method will get all EmploymentContractTemplate Objects

GET/api/time/employment/contract_template

Query parameters

`id`integer
`deleted`boolean	This property is used to mark an entity as deleted / archived \| Default value: false
`name`string
`templateType`string
`workTimeMode`string
`employmentContractGroup`string
`searchString`string	text to search for in the list
`orderFieldName`string	name of the order field
`orderFieldSort`string	sorting modeAllowed: `DESCASC`
`page`integer	page of the list
`pageSize`integer	number of entries for each page
`withMaxPageNumber`string	returns the number of pages available as a header if this is set

Responses

200Returns a list of EmploymentContractTemplate objectsarray<EmploymentContractTemplate>

Show fields (40)

idinteger
Primary key of the contract template. Internal ID.
template_typestring
Type of the template, for example full-time or part-time.
work_time_modestring
Work time mode of the template.
vacation_days_modestring
U01: how yearVacationDays of the template is meant. MANUAL copies the value as it is; PROPORTIONAL treats it as the entitlement for the template's working days per week and scales it to the working days of the new contract (30 days at 5 days/week → 18 at 3).
leadership_may_change_weekdaysboolean
L13/U22: leads of contracts of this type may hand in a dated redistribution of the weekly working days as a change request.
week_total_hoursnumber (float)
Total working hours per week.
reserved_hours_preparationnumber (float)
L03: weekly hours reserved for Vorbereitung - part of the contract hours but not plannable in the shift plan. null = none.
reserved_hours_follow_upnumber (float)
L03: weekly hours reserved for Nachbereitung - part of the contract hours but not plannable in the shift plan. null = none.
reserved_hours_travelnumber (float)
L03: weekly hours reserved for Fahrt - part of the contract hours but not plannable in the shift plan. null = none.
reserved_hours_flexiblenumber (float)
L03: weekly hours reserved for freie Einteilung - part of the contract hours but not plannable in the shift plan. null = none.
flexible_vacation_daysnumber (float)
U02/U18: how many of the yearly vacation days of this category are held back for supplement requests instead of the annual plan. null = the installation default (setting non_work_time_flexible_vacation_days).
supplement_processing_deadline_daysinteger
U20: processing deadline of a supplement request of this category in days after receipt (Teamer: 14). null = the general deadline of the installation.
week_total_daysnumber (float)
Total working days per week.
monday_hoursnumber (float)
Working hours on Monday.
tuesday_hoursnumber (float)
Working hours on Tuesday.
wednesday_hoursnumber (float)
Working hours on Wednesday.
thursday_hoursnumber (float)
Working hours on Thursday.
friday_hoursnumber (float)
Working hours on Friday.
saturday_hoursnumber (float)
Working hours on Saturday.
sunday_hoursnumber (float)
Working hours on Sunday.
year_vacation_daysnumber (float)
Vacation days per year.
holiday_credit_modestring
How holiday credit is calculated, for example fixed or by hours.
holiday_credit_fixed_secondsinteger
Fixed holiday credit in seconds.
planning_weekdays_bitmaskinteger
Bitmask of the weekdays planned in the template.
netto_hour_costnumber (float)
Net cost per hour.
brutto_hour_costnumber (float)
Gross cost per hour.
probation_monthsinteger
probation period in months, informational
default_contract_duration_monthsinteger
default fixed term in months (null = unlimited), informational
monthly_earnings_limitnumber (float)
warning limit, e.g. the Minijob earnings limit - maintained as data, never hardcoded
max_week_hours_limitnumber (float)
warning limit, e.g. 20h for working students
allow_app_time_trackingboolean
Employees may track time in the app.
allow_scanner_time_trackingboolean
Employees may track time with the scanner.
allow_app_non_work_time_managementboolean
Employees may manage absences in the app.
employment_contract_groupEmploymentContractGroup
Contract group the template belongs to.
Show fields (25)
- staged_absence_approvalboolean
  null inherits the organization; false explicitly disables staged approval.
- shift_booking_syncboolean
  L35: shifts as availabilities / appointments in the booking area; null inherits the organisation, false switches it off for this group.
- idinteger
  Primary key of the contract group. Internal ID.
- week_total_hoursnumber (float)
  Total working hours per week.
- week_total_daysnumber (float)
  Working days per week.
- year_vacation_daysnumber (float)
  Vacation days per year.
- month_vacation_daysnumber (float)
  Vacation days per month.
- year_vacation_weeksnumber (float)
  Vacation weeks per year.
- monday_hoursnumber (float)
  Working hours on Monday.
- tuesday_hoursnumber (float)
  Working hours on Tuesday.
- wednesday_hoursnumber (float)
  Working hours on Wednesday.
- thursday_hoursnumber (float)
  Working hours on Thursday.
- friday_hoursnumber (float)
  Working hours on Friday.
- saturday_hoursnumber (float)
  Working hours on Saturday.
- sunday_hoursnumber (float)
  Working hours on Sunday.
- netto_hour_costnumber (float)
  Net cost per hour.
- brutto_hour_costnumber (float)
  Gross cost per hour.
- allow_app_time_trackingboolean
  Whether time tracking in the app is allowed.
- allow_scanner_time_trackingboolean
  Whether time tracking with a scanner is allowed.
- allow_app_non_work_time_managementboolean
  Whether non-work time can be managed in the app.
- request_lead_time_daysinteger
  Days an absence request of this group has to be handed in ahead of its first day. null falls back to the installation wide setting - an existing group therefore behaves exactly as before.
- school_holiday_regionSchoolHolidayRegion
  U09: the school calendar of this group when it differs from the organisation's (apprentices attending school in another Bundesland). null = the organisation's.
- search_stringstring
  Text that the entity can be searched by.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- namestring
  Name of the entity.
sort_orderinteger
Sort order of the template in lists.
search_stringstring
Text that the entity can be searched by.
deletedboolean
This property is used to mark an entity as deleted / archived
namestring
Name of the entity.
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.

Request

curl --request GET \
  --url https://your-instance.iw-erp.de/api/time/employment/contract_template \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://your-instance.iw-erp.de/api/time/employment/contract_template', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/time/employment/contract_template"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your-instance.iw-erp.de/api/time/employment/contract_template', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/time/employment/contract_template"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/time/employment/contract_template")
  .get()
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/time/employment/contract_template"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/employment_contract_template_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await EmploymentContractTemplateController.getAll();
if (result.success) {
  print(result.data);
}

Response 200 application/json

[
  {
    "id": 42,
    "name": "Beispiel",
    "template_type": "string",
    "work_time_mode": "string",
    "vacation_days_mode": "string",
    "leadership_may_change_weekdays": true,
    "week_total_hours": 1.5,
    "reserved_hours_preparation": 1.5,
    "reserved_hours_follow_up": 1.5,
    "reserved_hours_travel": 1.5
  }
]

Add a new EmploymentContractTemplate

POST/api/time/employment/contract_template

Request body application/json

dataEmploymentContractTemplate2
Show fields (35)
- template_typestring
  Type of the template, for example full-time or part-time.
- work_time_modestring
  Work time mode of the template.
- vacation_days_modestring
  U01: how yearVacationDays of the template is meant. MANUAL copies the value as it is; PROPORTIONAL treats it as the entitlement for the template's working days per week and scales it to the working days of the new contract (30 days at 5 days/week → 18 at 3).
- leadership_may_change_weekdaysboolean
  L13/U22: leads of contracts of this type may hand in a dated redistribution of the weekly working days as a change request.
- week_total_hoursnumber (float)
  Total working hours per week.
- reserved_hours_preparationnumber (float)
  L03: weekly hours reserved for Vorbereitung - part of the contract hours but not plannable in the shift plan. null = none.
- reserved_hours_follow_upnumber (float)
  L03: weekly hours reserved for Nachbereitung - part of the contract hours but not plannable in the shift plan. null = none.
- reserved_hours_travelnumber (float)
  L03: weekly hours reserved for Fahrt - part of the contract hours but not plannable in the shift plan. null = none.
- reserved_hours_flexiblenumber (float)
  L03: weekly hours reserved for freie Einteilung - part of the contract hours but not plannable in the shift plan. null = none.
- flexible_vacation_daysnumber (float)
  U02/U18: how many of the yearly vacation days of this category are held back for supplement requests instead of the annual plan. null = the installation default (setting non_work_time_flexible_vacation_days).
- supplement_processing_deadline_daysinteger
  U20: processing deadline of a supplement request of this category in days after receipt (Teamer: 14). null = the general deadline of the installation.
- week_total_daysnumber (float)
  Total working days per week.
- monday_hoursnumber (float)
  Working hours on Monday.
- tuesday_hoursnumber (float)
  Working hours on Tuesday.
- wednesday_hoursnumber (float)
  Working hours on Wednesday.
- thursday_hoursnumber (float)
  Working hours on Thursday.
- friday_hoursnumber (float)
  Working hours on Friday.
- saturday_hoursnumber (float)
  Working hours on Saturday.
- sunday_hoursnumber (float)
  Working hours on Sunday.
- year_vacation_daysnumber (float)
  Vacation days per year.
- holiday_credit_modestring
  How holiday credit is calculated, for example fixed or by hours.
- holiday_credit_fixed_secondsinteger
  Fixed holiday credit in seconds.
- planning_weekdays_bitmaskinteger
  Bitmask of the weekdays planned in the template.
- netto_hour_costnumber (float)
  Net cost per hour.
- brutto_hour_costnumber (float)
  Gross cost per hour.
- probation_monthsinteger
  probation period in months, informational
- default_contract_duration_monthsinteger
  default fixed term in months (null = unlimited), informational
- monthly_earnings_limitnumber (float)
  warning limit, e.g. the Minijob earnings limit - maintained as data, never hardcoded
- max_week_hours_limitnumber (float)
  warning limit, e.g. 20h for working students
- allow_app_time_trackingboolean
  Employees may track time in the app.
- allow_scanner_time_trackingboolean
  Employees may track time with the scanner.
- allow_app_non_work_time_managementboolean
  Employees may manage absences in the app.
- sort_orderinteger
  Sort order of the template in lists.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- namestring
  Name of the entity.

Responses

200Add a new EmploymentContractTemplateEmploymentContractTemplate

Show fields (40)

idinteger
Primary key of the contract template. Internal ID.
template_typestring
Type of the template, for example full-time or part-time.
work_time_modestring
Work time mode of the template.
vacation_days_modestring
U01: how yearVacationDays of the template is meant. MANUAL copies the value as it is; PROPORTIONAL treats it as the entitlement for the template's working days per week and scales it to the working days of the new contract (30 days at 5 days/week → 18 at 3).
leadership_may_change_weekdaysboolean
L13/U22: leads of contracts of this type may hand in a dated redistribution of the weekly working days as a change request.
week_total_hoursnumber (float)
Total working hours per week.
reserved_hours_preparationnumber (float)
L03: weekly hours reserved for Vorbereitung - part of the contract hours but not plannable in the shift plan. null = none.
reserved_hours_follow_upnumber (float)
L03: weekly hours reserved for Nachbereitung - part of the contract hours but not plannable in the shift plan. null = none.
reserved_hours_travelnumber (float)
L03: weekly hours reserved for Fahrt - part of the contract hours but not plannable in the shift plan. null = none.
reserved_hours_flexiblenumber (float)
L03: weekly hours reserved for freie Einteilung - part of the contract hours but not plannable in the shift plan. null = none.
flexible_vacation_daysnumber (float)
U02/U18: how many of the yearly vacation days of this category are held back for supplement requests instead of the annual plan. null = the installation default (setting non_work_time_flexible_vacation_days).
supplement_processing_deadline_daysinteger
U20: processing deadline of a supplement request of this category in days after receipt (Teamer: 14). null = the general deadline of the installation.
week_total_daysnumber (float)
Total working days per week.
monday_hoursnumber (float)
Working hours on Monday.
tuesday_hoursnumber (float)
Working hours on Tuesday.
wednesday_hoursnumber (float)
Working hours on Wednesday.
thursday_hoursnumber (float)
Working hours on Thursday.
friday_hoursnumber (float)
Working hours on Friday.
saturday_hoursnumber (float)
Working hours on Saturday.
sunday_hoursnumber (float)
Working hours on Sunday.
year_vacation_daysnumber (float)
Vacation days per year.
holiday_credit_modestring
How holiday credit is calculated, for example fixed or by hours.
holiday_credit_fixed_secondsinteger
Fixed holiday credit in seconds.
planning_weekdays_bitmaskinteger
Bitmask of the weekdays planned in the template.
netto_hour_costnumber (float)
Net cost per hour.
brutto_hour_costnumber (float)
Gross cost per hour.
probation_monthsinteger
probation period in months, informational
default_contract_duration_monthsinteger
default fixed term in months (null = unlimited), informational
monthly_earnings_limitnumber (float)
warning limit, e.g. the Minijob earnings limit - maintained as data, never hardcoded
max_week_hours_limitnumber (float)
warning limit, e.g. 20h for working students
allow_app_time_trackingboolean
Employees may track time in the app.
allow_scanner_time_trackingboolean
Employees may track time with the scanner.
allow_app_non_work_time_managementboolean
Employees may manage absences in the app.
employment_contract_groupEmploymentContractGroup
Contract group the template belongs to.
Show fields (25)
- staged_absence_approvalboolean
  null inherits the organization; false explicitly disables staged approval.
- shift_booking_syncboolean
  L35: shifts as availabilities / appointments in the booking area; null inherits the organisation, false switches it off for this group.
- idinteger
  Primary key of the contract group. Internal ID.
- week_total_hoursnumber (float)
  Total working hours per week.
- week_total_daysnumber (float)
  Working days per week.
- year_vacation_daysnumber (float)
  Vacation days per year.
- month_vacation_daysnumber (float)
  Vacation days per month.
- year_vacation_weeksnumber (float)
  Vacation weeks per year.
- monday_hoursnumber (float)
  Working hours on Monday.
- tuesday_hoursnumber (float)
  Working hours on Tuesday.
- wednesday_hoursnumber (float)
  Working hours on Wednesday.
- thursday_hoursnumber (float)
  Working hours on Thursday.
- friday_hoursnumber (float)
  Working hours on Friday.
- saturday_hoursnumber (float)
  Working hours on Saturday.
- sunday_hoursnumber (float)
  Working hours on Sunday.
- netto_hour_costnumber (float)
  Net cost per hour.
- brutto_hour_costnumber (float)
  Gross cost per hour.
- allow_app_time_trackingboolean
  Whether time tracking in the app is allowed.
- allow_scanner_time_trackingboolean
  Whether time tracking with a scanner is allowed.
- allow_app_non_work_time_managementboolean
  Whether non-work time can be managed in the app.
- request_lead_time_daysinteger
  Days an absence request of this group has to be handed in ahead of its first day. null falls back to the installation wide setting - an existing group therefore behaves exactly as before.
- school_holiday_regionSchoolHolidayRegion
  U09: the school calendar of this group when it differs from the organisation's (apprentices attending school in another Bundesland). null = the organisation's.
- search_stringstring
  Text that the entity can be searched by.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- namestring
  Name of the entity.
sort_orderinteger
Sort order of the template in lists.
search_stringstring
Text that the entity can be searched by.
deletedboolean
This property is used to mark an entity as deleted / archived
namestring
Name of the entity.
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.

Request

curl --request POST \
  --url https://your-instance.iw-erp.de/api/time/employment/contract_template \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "name": "Beispiel",
    "template_type": "string",
    "work_time_mode": "string",
    "vacation_days_mode": "string",
    "leadership_may_change_weekdays": true,
    "week_total_hours": 1.5
  }
}
'

const options = {
  method: 'POST',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({
    data: {
      name: 'Beispiel',
      template_type: 'string',
      work_time_mode: 'string',
      vacation_days_mode: 'string',
      leadership_may_change_weekdays: true,
      week_total_hours: 1.5
    }
  })
};

fetch('https://your-instance.iw-erp.de/api/time/employment/contract_template', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/time/employment/contract_template"

payload = { "data": {
    "name": "Beispiel",
    "template_type": "string",
    "work_time_mode": "string",
    "vacation_days_mode": "string",
    "leadership_may_change_weekdays": True,
    "week_total_hours": 1.5
  } }
headers = {
  "x-iw-jwt-token": "<TOKEN>",
  "content-type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://your-instance.iw-erp.de/api/time/employment/contract_template', [
  'body' => '{"data":{"name":"Beispiel","template_type":"string","work_time_mode":"string","vacation_days_mode":"string","leadership_may_change_weekdays":true,"week_total_hours":1.5}}',
  'headers' => [
    'content-type' => 'application/json',
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Post,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/time/employment/contract_template"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"name\":\"Beispiel\",\"template_type\":\"string\",\"work_time_mode\":\"string\",\"vacation_days_mode\":\"string\",\"leadership_may_change_weekdays\":true,\"week_total_hours\":1.5}}")
  {
    Headers =
    {
      ContentType = new MediaTypeHeaderValue("application/json")
    }
  }
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"data\":{\"name\":\"Beispiel\",\"template_type\":\"string\",\"work_time_mode\":\"string\",\"vacation_days_mode\":\"string\",\"leadership_may_change_weekdays\":true,\"week_total_hours\":1.5}}");
Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/time/employment/contract_template")
  .post(body)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/time/employment/contract_template"

	payload := strings.NewReader("{\"data\":{\"name\":\"Beispiel\",\"template_type\":\"string\",\"work_time_mode\":\"string\",\"vacation_days_mode\":\"string\",\"leadership_may_change_weekdays\":true,\"week_total_hours\":1.5}}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/employment_contract_template_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/employment_contract_template.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await EmploymentContractTemplateController.post(EmploymentContractTemplate.fromJson({
  "name": "Beispiel",
  "template_type": "string",
  "work_time_mode": "string",
  "vacation_days_mode": "string",
  "leadership_may_change_weekdays": true,
  "week_total_hours": 1.5
}));
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "id": 42,
  "name": "Beispiel",
  "template_type": "string",
  "work_time_mode": "string",
  "vacation_days_mode": "string",
  "leadership_may_change_weekdays": true,
  "week_total_hours": 1.5,
  "reserved_hours_preparation": 1.5,
  "reserved_hours_follow_up": 1.5,
  "reserved_hours_travel": 1.5
}

This method will get a single EmploymentContractTemplate with the given id

GET/api/time/employment/contract_template/{id}

Path parameters

idrequiredstring

Responses

200Returns a single EmploymentContractTemplateEmploymentContractTemplate

Show fields (40)

idinteger
Primary key of the contract template. Internal ID.
template_typestring
Type of the template, for example full-time or part-time.
work_time_modestring
Work time mode of the template.
vacation_days_modestring
U01: how yearVacationDays of the template is meant. MANUAL copies the value as it is; PROPORTIONAL treats it as the entitlement for the template's working days per week and scales it to the working days of the new contract (30 days at 5 days/week → 18 at 3).
leadership_may_change_weekdaysboolean
L13/U22: leads of contracts of this type may hand in a dated redistribution of the weekly working days as a change request.
week_total_hoursnumber (float)
Total working hours per week.
reserved_hours_preparationnumber (float)
L03: weekly hours reserved for Vorbereitung - part of the contract hours but not plannable in the shift plan. null = none.
reserved_hours_follow_upnumber (float)
L03: weekly hours reserved for Nachbereitung - part of the contract hours but not plannable in the shift plan. null = none.
reserved_hours_travelnumber (float)
L03: weekly hours reserved for Fahrt - part of the contract hours but not plannable in the shift plan. null = none.
reserved_hours_flexiblenumber (float)
L03: weekly hours reserved for freie Einteilung - part of the contract hours but not plannable in the shift plan. null = none.
flexible_vacation_daysnumber (float)
U02/U18: how many of the yearly vacation days of this category are held back for supplement requests instead of the annual plan. null = the installation default (setting non_work_time_flexible_vacation_days).
supplement_processing_deadline_daysinteger
U20: processing deadline of a supplement request of this category in days after receipt (Teamer: 14). null = the general deadline of the installation.
week_total_daysnumber (float)
Total working days per week.
monday_hoursnumber (float)
Working hours on Monday.
tuesday_hoursnumber (float)
Working hours on Tuesday.
wednesday_hoursnumber (float)
Working hours on Wednesday.
thursday_hoursnumber (float)
Working hours on Thursday.
friday_hoursnumber (float)
Working hours on Friday.
saturday_hoursnumber (float)
Working hours on Saturday.
sunday_hoursnumber (float)
Working hours on Sunday.
year_vacation_daysnumber (float)
Vacation days per year.
holiday_credit_modestring
How holiday credit is calculated, for example fixed or by hours.
holiday_credit_fixed_secondsinteger
Fixed holiday credit in seconds.
planning_weekdays_bitmaskinteger
Bitmask of the weekdays planned in the template.
netto_hour_costnumber (float)
Net cost per hour.
brutto_hour_costnumber (float)
Gross cost per hour.
probation_monthsinteger
probation period in months, informational
default_contract_duration_monthsinteger
default fixed term in months (null = unlimited), informational
monthly_earnings_limitnumber (float)
warning limit, e.g. the Minijob earnings limit - maintained as data, never hardcoded
max_week_hours_limitnumber (float)
warning limit, e.g. 20h for working students
allow_app_time_trackingboolean
Employees may track time in the app.
allow_scanner_time_trackingboolean
Employees may track time with the scanner.
allow_app_non_work_time_managementboolean
Employees may manage absences in the app.
employment_contract_groupEmploymentContractGroup
Contract group the template belongs to.
Show fields (25)
- staged_absence_approvalboolean
  null inherits the organization; false explicitly disables staged approval.
- shift_booking_syncboolean
  L35: shifts as availabilities / appointments in the booking area; null inherits the organisation, false switches it off for this group.
- idinteger
  Primary key of the contract group. Internal ID.
- week_total_hoursnumber (float)
  Total working hours per week.
- week_total_daysnumber (float)
  Working days per week.
- year_vacation_daysnumber (float)
  Vacation days per year.
- month_vacation_daysnumber (float)
  Vacation days per month.
- year_vacation_weeksnumber (float)
  Vacation weeks per year.
- monday_hoursnumber (float)
  Working hours on Monday.
- tuesday_hoursnumber (float)
  Working hours on Tuesday.
- wednesday_hoursnumber (float)
  Working hours on Wednesday.
- thursday_hoursnumber (float)
  Working hours on Thursday.
- friday_hoursnumber (float)
  Working hours on Friday.
- saturday_hoursnumber (float)
  Working hours on Saturday.
- sunday_hoursnumber (float)
  Working hours on Sunday.
- netto_hour_costnumber (float)
  Net cost per hour.
- brutto_hour_costnumber (float)
  Gross cost per hour.
- allow_app_time_trackingboolean
  Whether time tracking in the app is allowed.
- allow_scanner_time_trackingboolean
  Whether time tracking with a scanner is allowed.
- allow_app_non_work_time_managementboolean
  Whether non-work time can be managed in the app.
- request_lead_time_daysinteger
  Days an absence request of this group has to be handed in ahead of its first day. null falls back to the installation wide setting - an existing group therefore behaves exactly as before.
- school_holiday_regionSchoolHolidayRegion
  U09: the school calendar of this group when it differs from the organisation's (apprentices attending school in another Bundesland). null = the organisation's.
- search_stringstring
  Text that the entity can be searched by.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- namestring
  Name of the entity.
sort_orderinteger
Sort order of the template in lists.
search_stringstring
Text that the entity can be searched by.
deletedboolean
This property is used to mark an entity as deleted / archived
namestring
Name of the entity.
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.

Request

curl --request GET \
  --url https://your-instance.iw-erp.de/api/time/employment/contract_template/42 \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://your-instance.iw-erp.de/api/time/employment/contract_template/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/time/employment/contract_template/42"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your-instance.iw-erp.de/api/time/employment/contract_template/42', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/time/employment/contract_template/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/time/employment/contract_template/42")
  .get()
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/time/employment/contract_template/42"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/employment_contract_template_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await EmploymentContractTemplateController.get('42');
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "id": 42,
  "name": "Beispiel",
  "template_type": "string",
  "work_time_mode": "string",
  "vacation_days_mode": "string",
  "leadership_may_change_weekdays": true,
  "week_total_hours": 1.5,
  "reserved_hours_preparation": 1.5,
  "reserved_hours_follow_up": 1.5,
  "reserved_hours_travel": 1.5
}

Update a EmploymentContractTemplate

PUT/api/time/employment/contract_template/{id}

Path parameters

idrequiredstring

Request body application/json

dataEmploymentContractTemplate2
Show fields (35)
- template_typestring
  Type of the template, for example full-time or part-time.
- work_time_modestring
  Work time mode of the template.
- vacation_days_modestring
  U01: how yearVacationDays of the template is meant. MANUAL copies the value as it is; PROPORTIONAL treats it as the entitlement for the template's working days per week and scales it to the working days of the new contract (30 days at 5 days/week → 18 at 3).
- leadership_may_change_weekdaysboolean
  L13/U22: leads of contracts of this type may hand in a dated redistribution of the weekly working days as a change request.
- week_total_hoursnumber (float)
  Total working hours per week.
- reserved_hours_preparationnumber (float)
  L03: weekly hours reserved for Vorbereitung - part of the contract hours but not plannable in the shift plan. null = none.
- reserved_hours_follow_upnumber (float)
  L03: weekly hours reserved for Nachbereitung - part of the contract hours but not plannable in the shift plan. null = none.
- reserved_hours_travelnumber (float)
  L03: weekly hours reserved for Fahrt - part of the contract hours but not plannable in the shift plan. null = none.
- reserved_hours_flexiblenumber (float)
  L03: weekly hours reserved for freie Einteilung - part of the contract hours but not plannable in the shift plan. null = none.
- flexible_vacation_daysnumber (float)
  U02/U18: how many of the yearly vacation days of this category are held back for supplement requests instead of the annual plan. null = the installation default (setting non_work_time_flexible_vacation_days).
- supplement_processing_deadline_daysinteger
  U20: processing deadline of a supplement request of this category in days after receipt (Teamer: 14). null = the general deadline of the installation.
- week_total_daysnumber (float)
  Total working days per week.
- monday_hoursnumber (float)
  Working hours on Monday.
- tuesday_hoursnumber (float)
  Working hours on Tuesday.
- wednesday_hoursnumber (float)
  Working hours on Wednesday.
- thursday_hoursnumber (float)
  Working hours on Thursday.
- friday_hoursnumber (float)
  Working hours on Friday.
- saturday_hoursnumber (float)
  Working hours on Saturday.
- sunday_hoursnumber (float)
  Working hours on Sunday.
- year_vacation_daysnumber (float)
  Vacation days per year.
- holiday_credit_modestring
  How holiday credit is calculated, for example fixed or by hours.
- holiday_credit_fixed_secondsinteger
  Fixed holiday credit in seconds.
- planning_weekdays_bitmaskinteger
  Bitmask of the weekdays planned in the template.
- netto_hour_costnumber (float)
  Net cost per hour.
- brutto_hour_costnumber (float)
  Gross cost per hour.
- probation_monthsinteger
  probation period in months, informational
- default_contract_duration_monthsinteger
  default fixed term in months (null = unlimited), informational
- monthly_earnings_limitnumber (float)
  warning limit, e.g. the Minijob earnings limit - maintained as data, never hardcoded
- max_week_hours_limitnumber (float)
  warning limit, e.g. 20h for working students
- allow_app_time_trackingboolean
  Employees may track time in the app.
- allow_scanner_time_trackingboolean
  Employees may track time with the scanner.
- allow_app_non_work_time_managementboolean
  Employees may manage absences in the app.
- sort_orderinteger
  Sort order of the template in lists.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- namestring
  Name of the entity.

Responses

200Update a EmploymentContractTemplateEmploymentContractTemplate

Show fields (40)

idinteger
Primary key of the contract template. Internal ID.
template_typestring
Type of the template, for example full-time or part-time.
work_time_modestring
Work time mode of the template.
vacation_days_modestring
U01: how yearVacationDays of the template is meant. MANUAL copies the value as it is; PROPORTIONAL treats it as the entitlement for the template's working days per week and scales it to the working days of the new contract (30 days at 5 days/week → 18 at 3).
leadership_may_change_weekdaysboolean
L13/U22: leads of contracts of this type may hand in a dated redistribution of the weekly working days as a change request.
week_total_hoursnumber (float)
Total working hours per week.
reserved_hours_preparationnumber (float)
L03: weekly hours reserved for Vorbereitung - part of the contract hours but not plannable in the shift plan. null = none.
reserved_hours_follow_upnumber (float)
L03: weekly hours reserved for Nachbereitung - part of the contract hours but not plannable in the shift plan. null = none.
reserved_hours_travelnumber (float)
L03: weekly hours reserved for Fahrt - part of the contract hours but not plannable in the shift plan. null = none.
reserved_hours_flexiblenumber (float)
L03: weekly hours reserved for freie Einteilung - part of the contract hours but not plannable in the shift plan. null = none.
flexible_vacation_daysnumber (float)
U02/U18: how many of the yearly vacation days of this category are held back for supplement requests instead of the annual plan. null = the installation default (setting non_work_time_flexible_vacation_days).
supplement_processing_deadline_daysinteger
U20: processing deadline of a supplement request of this category in days after receipt (Teamer: 14). null = the general deadline of the installation.
week_total_daysnumber (float)
Total working days per week.
monday_hoursnumber (float)
Working hours on Monday.
tuesday_hoursnumber (float)
Working hours on Tuesday.
wednesday_hoursnumber (float)
Working hours on Wednesday.
thursday_hoursnumber (float)
Working hours on Thursday.
friday_hoursnumber (float)
Working hours on Friday.
saturday_hoursnumber (float)
Working hours on Saturday.
sunday_hoursnumber (float)
Working hours on Sunday.
year_vacation_daysnumber (float)
Vacation days per year.
holiday_credit_modestring
How holiday credit is calculated, for example fixed or by hours.
holiday_credit_fixed_secondsinteger
Fixed holiday credit in seconds.
planning_weekdays_bitmaskinteger
Bitmask of the weekdays planned in the template.
netto_hour_costnumber (float)
Net cost per hour.
brutto_hour_costnumber (float)
Gross cost per hour.
probation_monthsinteger
probation period in months, informational
default_contract_duration_monthsinteger
default fixed term in months (null = unlimited), informational
monthly_earnings_limitnumber (float)
warning limit, e.g. the Minijob earnings limit - maintained as data, never hardcoded
max_week_hours_limitnumber (float)
warning limit, e.g. 20h for working students
allow_app_time_trackingboolean
Employees may track time in the app.
allow_scanner_time_trackingboolean
Employees may track time with the scanner.
allow_app_non_work_time_managementboolean
Employees may manage absences in the app.
employment_contract_groupEmploymentContractGroup
Contract group the template belongs to.
Show fields (25)
- staged_absence_approvalboolean
  null inherits the organization; false explicitly disables staged approval.
- shift_booking_syncboolean
  L35: shifts as availabilities / appointments in the booking area; null inherits the organisation, false switches it off for this group.
- idinteger
  Primary key of the contract group. Internal ID.
- week_total_hoursnumber (float)
  Total working hours per week.
- week_total_daysnumber (float)
  Working days per week.
- year_vacation_daysnumber (float)
  Vacation days per year.
- month_vacation_daysnumber (float)
  Vacation days per month.
- year_vacation_weeksnumber (float)
  Vacation weeks per year.
- monday_hoursnumber (float)
  Working hours on Monday.
- tuesday_hoursnumber (float)
  Working hours on Tuesday.
- wednesday_hoursnumber (float)
  Working hours on Wednesday.
- thursday_hoursnumber (float)
  Working hours on Thursday.
- friday_hoursnumber (float)
  Working hours on Friday.
- saturday_hoursnumber (float)
  Working hours on Saturday.
- sunday_hoursnumber (float)
  Working hours on Sunday.
- netto_hour_costnumber (float)
  Net cost per hour.
- brutto_hour_costnumber (float)
  Gross cost per hour.
- allow_app_time_trackingboolean
  Whether time tracking in the app is allowed.
- allow_scanner_time_trackingboolean
  Whether time tracking with a scanner is allowed.
- allow_app_non_work_time_managementboolean
  Whether non-work time can be managed in the app.
- request_lead_time_daysinteger
  Days an absence request of this group has to be handed in ahead of its first day. null falls back to the installation wide setting - an existing group therefore behaves exactly as before.
- school_holiday_regionSchoolHolidayRegion
  U09: the school calendar of this group when it differs from the organisation's (apprentices attending school in another Bundesland). null = the organisation's.
- search_stringstring
  Text that the entity can be searched by.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- namestring
  Name of the entity.
sort_orderinteger
Sort order of the template in lists.
search_stringstring
Text that the entity can be searched by.
deletedboolean
This property is used to mark an entity as deleted / archived
namestring
Name of the entity.
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.

Request

curl --request PUT \
  --url https://your-instance.iw-erp.de/api/time/employment/contract_template/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "name": "Beispiel",
    "template_type": "string",
    "work_time_mode": "string",
    "vacation_days_mode": "string",
    "leadership_may_change_weekdays": true,
    "week_total_hours": 1.5
  }
}
'

const options = {
  method: 'PUT',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({
    data: {
      name: 'Beispiel',
      template_type: 'string',
      work_time_mode: 'string',
      vacation_days_mode: 'string',
      leadership_may_change_weekdays: true,
      week_total_hours: 1.5
    }
  })
};

fetch('https://your-instance.iw-erp.de/api/time/employment/contract_template/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/time/employment/contract_template/42"

payload = { "data": {
    "name": "Beispiel",
    "template_type": "string",
    "work_time_mode": "string",
    "vacation_days_mode": "string",
    "leadership_may_change_weekdays": True,
    "week_total_hours": 1.5
  } }
headers = {
  "x-iw-jwt-token": "<TOKEN>",
  "content-type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://your-instance.iw-erp.de/api/time/employment/contract_template/42', [
  'body' => '{"data":{"name":"Beispiel","template_type":"string","work_time_mode":"string","vacation_days_mode":"string","leadership_may_change_weekdays":true,"week_total_hours":1.5}}',
  'headers' => [
    'content-type' => 'application/json',
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Put,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/time/employment/contract_template/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"name\":\"Beispiel\",\"template_type\":\"string\",\"work_time_mode\":\"string\",\"vacation_days_mode\":\"string\",\"leadership_may_change_weekdays\":true,\"week_total_hours\":1.5}}")
  {
    Headers =
    {
      ContentType = new MediaTypeHeaderValue("application/json")
    }
  }
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"data\":{\"name\":\"Beispiel\",\"template_type\":\"string\",\"work_time_mode\":\"string\",\"vacation_days_mode\":\"string\",\"leadership_may_change_weekdays\":true,\"week_total_hours\":1.5}}");
Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/time/employment/contract_template/42")
  .put(body)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/time/employment/contract_template/42"

	payload := strings.NewReader("{\"data\":{\"name\":\"Beispiel\",\"template_type\":\"string\",\"work_time_mode\":\"string\",\"vacation_days_mode\":\"string\",\"leadership_may_change_weekdays\":true,\"week_total_hours\":1.5}}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/employment_contract_template_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/employment_contract_template.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await EmploymentContractTemplateController.put(EmploymentContractTemplate.fromJson({
  "name": "Beispiel",
  "template_type": "string",
  "work_time_mode": "string",
  "vacation_days_mode": "string",
  "leadership_may_change_weekdays": true,
  "week_total_hours": 1.5
}));
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "id": 42,
  "name": "Beispiel",
  "template_type": "string",
  "work_time_mode": "string",
  "vacation_days_mode": "string",
  "leadership_may_change_weekdays": true,
  "week_total_hours": 1.5,
  "reserved_hours_preparation": 1.5,
  "reserved_hours_follow_up": 1.5,
  "reserved_hours_travel": 1.5
}

Update a EmploymentContractTemplate

PATCH/api/time/employment/contract_template/{id}

Path parameters

idrequiredstring

Request body application/json

dataEmploymentContractTemplate2
Show fields (35)
- template_typestring
  Type of the template, for example full-time or part-time.
- work_time_modestring
  Work time mode of the template.
- vacation_days_modestring
  U01: how yearVacationDays of the template is meant. MANUAL copies the value as it is; PROPORTIONAL treats it as the entitlement for the template's working days per week and scales it to the working days of the new contract (30 days at 5 days/week → 18 at 3).
- leadership_may_change_weekdaysboolean
  L13/U22: leads of contracts of this type may hand in a dated redistribution of the weekly working days as a change request.
- week_total_hoursnumber (float)
  Total working hours per week.
- reserved_hours_preparationnumber (float)
  L03: weekly hours reserved for Vorbereitung - part of the contract hours but not plannable in the shift plan. null = none.
- reserved_hours_follow_upnumber (float)
  L03: weekly hours reserved for Nachbereitung - part of the contract hours but not plannable in the shift plan. null = none.
- reserved_hours_travelnumber (float)
  L03: weekly hours reserved for Fahrt - part of the contract hours but not plannable in the shift plan. null = none.
- reserved_hours_flexiblenumber (float)
  L03: weekly hours reserved for freie Einteilung - part of the contract hours but not plannable in the shift plan. null = none.
- flexible_vacation_daysnumber (float)
  U02/U18: how many of the yearly vacation days of this category are held back for supplement requests instead of the annual plan. null = the installation default (setting non_work_time_flexible_vacation_days).
- supplement_processing_deadline_daysinteger
  U20: processing deadline of a supplement request of this category in days after receipt (Teamer: 14). null = the general deadline of the installation.
- week_total_daysnumber (float)
  Total working days per week.
- monday_hoursnumber (float)
  Working hours on Monday.
- tuesday_hoursnumber (float)
  Working hours on Tuesday.
- wednesday_hoursnumber (float)
  Working hours on Wednesday.
- thursday_hoursnumber (float)
  Working hours on Thursday.
- friday_hoursnumber (float)
  Working hours on Friday.
- saturday_hoursnumber (float)
  Working hours on Saturday.
- sunday_hoursnumber (float)
  Working hours on Sunday.
- year_vacation_daysnumber (float)
  Vacation days per year.
- holiday_credit_modestring
  How holiday credit is calculated, for example fixed or by hours.
- holiday_credit_fixed_secondsinteger
  Fixed holiday credit in seconds.
- planning_weekdays_bitmaskinteger
  Bitmask of the weekdays planned in the template.
- netto_hour_costnumber (float)
  Net cost per hour.
- brutto_hour_costnumber (float)
  Gross cost per hour.
- probation_monthsinteger
  probation period in months, informational
- default_contract_duration_monthsinteger
  default fixed term in months (null = unlimited), informational
- monthly_earnings_limitnumber (float)
  warning limit, e.g. the Minijob earnings limit - maintained as data, never hardcoded
- max_week_hours_limitnumber (float)
  warning limit, e.g. 20h for working students
- allow_app_time_trackingboolean
  Employees may track time in the app.
- allow_scanner_time_trackingboolean
  Employees may track time with the scanner.
- allow_app_non_work_time_managementboolean
  Employees may manage absences in the app.
- sort_orderinteger
  Sort order of the template in lists.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- namestring
  Name of the entity.

Responses

200Update a EmploymentContractTemplateEmploymentContractTemplate

Show fields (40)

idinteger
Primary key of the contract template. Internal ID.
template_typestring
Type of the template, for example full-time or part-time.
work_time_modestring
Work time mode of the template.
vacation_days_modestring
U01: how yearVacationDays of the template is meant. MANUAL copies the value as it is; PROPORTIONAL treats it as the entitlement for the template's working days per week and scales it to the working days of the new contract (30 days at 5 days/week → 18 at 3).
leadership_may_change_weekdaysboolean
L13/U22: leads of contracts of this type may hand in a dated redistribution of the weekly working days as a change request.
week_total_hoursnumber (float)
Total working hours per week.
reserved_hours_preparationnumber (float)
L03: weekly hours reserved for Vorbereitung - part of the contract hours but not plannable in the shift plan. null = none.
reserved_hours_follow_upnumber (float)
L03: weekly hours reserved for Nachbereitung - part of the contract hours but not plannable in the shift plan. null = none.
reserved_hours_travelnumber (float)
L03: weekly hours reserved for Fahrt - part of the contract hours but not plannable in the shift plan. null = none.
reserved_hours_flexiblenumber (float)
L03: weekly hours reserved for freie Einteilung - part of the contract hours but not plannable in the shift plan. null = none.
flexible_vacation_daysnumber (float)
U02/U18: how many of the yearly vacation days of this category are held back for supplement requests instead of the annual plan. null = the installation default (setting non_work_time_flexible_vacation_days).
supplement_processing_deadline_daysinteger
U20: processing deadline of a supplement request of this category in days after receipt (Teamer: 14). null = the general deadline of the installation.
week_total_daysnumber (float)
Total working days per week.
monday_hoursnumber (float)
Working hours on Monday.
tuesday_hoursnumber (float)
Working hours on Tuesday.
wednesday_hoursnumber (float)
Working hours on Wednesday.
thursday_hoursnumber (float)
Working hours on Thursday.
friday_hoursnumber (float)
Working hours on Friday.
saturday_hoursnumber (float)
Working hours on Saturday.
sunday_hoursnumber (float)
Working hours on Sunday.
year_vacation_daysnumber (float)
Vacation days per year.
holiday_credit_modestring
How holiday credit is calculated, for example fixed or by hours.
holiday_credit_fixed_secondsinteger
Fixed holiday credit in seconds.
planning_weekdays_bitmaskinteger
Bitmask of the weekdays planned in the template.
netto_hour_costnumber (float)
Net cost per hour.
brutto_hour_costnumber (float)
Gross cost per hour.
probation_monthsinteger
probation period in months, informational
default_contract_duration_monthsinteger
default fixed term in months (null = unlimited), informational
monthly_earnings_limitnumber (float)
warning limit, e.g. the Minijob earnings limit - maintained as data, never hardcoded
max_week_hours_limitnumber (float)
warning limit, e.g. 20h for working students
allow_app_time_trackingboolean
Employees may track time in the app.
allow_scanner_time_trackingboolean
Employees may track time with the scanner.
allow_app_non_work_time_managementboolean
Employees may manage absences in the app.
employment_contract_groupEmploymentContractGroup
Contract group the template belongs to.
Show fields (25)
- staged_absence_approvalboolean
  null inherits the organization; false explicitly disables staged approval.
- shift_booking_syncboolean
  L35: shifts as availabilities / appointments in the booking area; null inherits the organisation, false switches it off for this group.
- idinteger
  Primary key of the contract group. Internal ID.
- week_total_hoursnumber (float)
  Total working hours per week.
- week_total_daysnumber (float)
  Working days per week.
- year_vacation_daysnumber (float)
  Vacation days per year.
- month_vacation_daysnumber (float)
  Vacation days per month.
- year_vacation_weeksnumber (float)
  Vacation weeks per year.
- monday_hoursnumber (float)
  Working hours on Monday.
- tuesday_hoursnumber (float)
  Working hours on Tuesday.
- wednesday_hoursnumber (float)
  Working hours on Wednesday.
- thursday_hoursnumber (float)
  Working hours on Thursday.
- friday_hoursnumber (float)
  Working hours on Friday.
- saturday_hoursnumber (float)
  Working hours on Saturday.
- sunday_hoursnumber (float)
  Working hours on Sunday.
- netto_hour_costnumber (float)
  Net cost per hour.
- brutto_hour_costnumber (float)
  Gross cost per hour.
- allow_app_time_trackingboolean
  Whether time tracking in the app is allowed.
- allow_scanner_time_trackingboolean
  Whether time tracking with a scanner is allowed.
- allow_app_non_work_time_managementboolean
  Whether non-work time can be managed in the app.
- request_lead_time_daysinteger
  Days an absence request of this group has to be handed in ahead of its first day. null falls back to the installation wide setting - an existing group therefore behaves exactly as before.
- school_holiday_regionSchoolHolidayRegion
  U09: the school calendar of this group when it differs from the organisation's (apprentices attending school in another Bundesland). null = the organisation's.
- search_stringstring
  Text that the entity can be searched by.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- namestring
  Name of the entity.
sort_orderinteger
Sort order of the template in lists.
search_stringstring
Text that the entity can be searched by.
deletedboolean
This property is used to mark an entity as deleted / archived
namestring
Name of the entity.
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.

Request

curl --request PATCH \
  --url https://your-instance.iw-erp.de/api/time/employment/contract_template/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "name": "Beispiel",
    "template_type": "string",
    "work_time_mode": "string",
    "vacation_days_mode": "string",
    "leadership_may_change_weekdays": true,
    "week_total_hours": 1.5
  }
}
'

const options = {
  method: 'PATCH',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({
    data: {
      name: 'Beispiel',
      template_type: 'string',
      work_time_mode: 'string',
      vacation_days_mode: 'string',
      leadership_may_change_weekdays: true,
      week_total_hours: 1.5
    }
  })
};

fetch('https://your-instance.iw-erp.de/api/time/employment/contract_template/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/time/employment/contract_template/42"

payload = { "data": {
    "name": "Beispiel",
    "template_type": "string",
    "work_time_mode": "string",
    "vacation_days_mode": "string",
    "leadership_may_change_weekdays": True,
    "week_total_hours": 1.5
  } }
headers = {
  "x-iw-jwt-token": "<TOKEN>",
  "content-type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://your-instance.iw-erp.de/api/time/employment/contract_template/42', [
  'body' => '{"data":{"name":"Beispiel","template_type":"string","work_time_mode":"string","vacation_days_mode":"string","leadership_may_change_weekdays":true,"week_total_hours":1.5}}',
  'headers' => [
    'content-type' => 'application/json',
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Patch,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/time/employment/contract_template/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"name\":\"Beispiel\",\"template_type\":\"string\",\"work_time_mode\":\"string\",\"vacation_days_mode\":\"string\",\"leadership_may_change_weekdays\":true,\"week_total_hours\":1.5}}")
  {
    Headers =
    {
      ContentType = new MediaTypeHeaderValue("application/json")
    }
  }
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"data\":{\"name\":\"Beispiel\",\"template_type\":\"string\",\"work_time_mode\":\"string\",\"vacation_days_mode\":\"string\",\"leadership_may_change_weekdays\":true,\"week_total_hours\":1.5}}");
Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/time/employment/contract_template/42")
  .patch(body)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/time/employment/contract_template/42"

	payload := strings.NewReader("{\"data\":{\"name\":\"Beispiel\",\"template_type\":\"string\",\"work_time_mode\":\"string\",\"vacation_days_mode\":\"string\",\"leadership_may_change_weekdays\":true,\"week_total_hours\":1.5}}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with package:http (no controller in the iw_erp_api package)

import 'dart:convert';
import 'package:http/http.dart' as http;

final response = await http.patch(
  Uri.parse('https://your-instance.iw-erp.de/api/time/employment/contract_template/42'),
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: jsonEncode({
    "data": {
      "name": "Beispiel",
      "template_type": "string",
      "work_time_mode": "string",
      "vacation_days_mode": "string",
      "leadership_may_change_weekdays": true,
      "week_total_hours": 1.5
    }
  }),
);
print(response.body);

Response 200 application/json

{
  "id": 42,
  "name": "Beispiel",
  "template_type": "string",
  "work_time_mode": "string",
  "vacation_days_mode": "string",
  "leadership_may_change_weekdays": true,
  "week_total_hours": 1.5,
  "reserved_hours_preparation": 1.5,
  "reserved_hours_follow_up": 1.5,
  "reserved_hours_travel": 1.5
}