ProcessedEmploymentContractMonth

Staff4 EndpointsTimeTracking / ProcessedEmploymentContractMonth

Get a single ProcessedEmploymentContractMonth

GET/api/time/processed/employment_contract_month/{id}

Path parameters

idrequiredstring

Responses

200Get a single ProcessedEmploymentContractMonthProcessedEmploymentContractMonth

Show fields (53)

idinteger
Primary key of the processed month. Internal ID.
userUser14
User the processed month belongs to.
Show fields (10)
- idinteger
  Primary key of the user. Internal ID of the login user.
- namestring
  Display name of the user. Shown in the UI and in audit entries.
- usernamestring
  Login name of the user. Must be unique across all users.
- emailstring
  E-mail address of the user. Used for login notifications, password resets and as a login alias.
- positioningeneralstring
  Free text describing the position or role of the user.
- crm_personCRMPerson10
  CRM person linked to this login user. Connects the login account with the person record.
- profile_picture_urlstring
  URL of the profile picture of the user.
- archivedboolean
  Marks the user as archived. Archived users are kept for history and are not active.
- require2faboolean
  Two-factor authentication is required for this user.
- search_stringstring
  Text that the entity can be searched by.
contractEmploymentContract6
Employment contract the processed month belongs to.
Show fields (43)
- staged_absence_approvalboolean
  null inherits group then organization policy; existing installations stay off.
- idinteger
  Primary key of the employment contract. Internal ID.
- tokenstring
  Public token of the contract. Used instead of the ID.
- userUser14
  Login user of the employee.
- week_total_hoursnumber (float)
  Total working hours per week.
- week_total_daysnumber (float)
  Total working days 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.
- week_full_time_total_daysnumber (float)
  Total working days per week for a full-time contract.
- 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.
- startstring (date-time)
  Start date of the contract.
- endstring (date-time)
  End date of the contract.
- fixed_term_statusstring
  Befristung: PERMANENT (unbefristet, default), FIXED_TERM or EXTENDED (FIXED_TERM_STATUS_*).
- fixed_term_endstring (date-time)
  Befristet bis (erster Zeitraum).
- fixed_term_extension_endstring (date-time)
  Befristet bis nach Verlängerung.
- probation_endstring (date-time)
  Probezeit bis; filled from the template's probationMonths when a contract is created without it.
- numberstring
  Contract number.
- descriptionstring
  Description of the contract.
- archivedboolean
  The contract is archived.
- allow_app_time_trackingboolean
  The employee may track time in the app.
- allow_scanner_time_trackingboolean
  The employee may track time with the scanner.
- allow_app_non_work_time_managementboolean
  The employee may manage absences in the app.
- force_no_auto_breakboolean
  Automatic breaks are not added for this contract.
- work_time_modestring
  How the target working time is defined - null behaves as WEEKDAY_HOURS so existing contracts keep their previous behaviour unchanged.
- holiday_credit_modestring
  Holiday credit for WEEK_TOTAL contracts - null behaves as WEEKDAY_TARGET (previous behaviour, only meaningful for WEEKDAY_HOURS contracts).
- holiday_credit_fixed_secondsinteger
  Fixed holiday credit in seconds.
- planning_weekdays_bitmaskinteger
  ISO weekday bitmask (Mo=1 ... So=64) of the days this WEEK_TOTAL contract can be planned / takes vacation on - null behaves as Mo-Fr.
- request_lead_time_daysinteger
  Days an absence request has to be handed in ahead of its first day ("Bearbeitungs- frist"). null falls back to the contract group and from there to the installation wide setting, so an existing contract keeps behaving exactly as before.
- shift_booking_syncboolean
  L35: shifts as availabilities / appointments in the booking area; null inherits the group (which inherits the organisation).
- search_stringstring
  Text that the entity can be searched by.
start_monthinteger
Month the processed period starts.
start_yearinteger
Year the processed period starts.
start_wtsinteger
calculated seconds from last month as start balance
overtime_last_year_wtsinteger
calculated overtime seconds from last year as start balance
end_wtsinteger
calculated result of worked seconds for this month
correction_wtsinteger
manual correction for worked seconds for this month
real_wtsinteger
real worked seconds for this month
planned_wtsinteger
planned worked seconds for this month
live_end_wtsinteger
calculated result of worked seconds for this month until today
live_real_wtsinteger
real worked seconds for this month until today
live_planned_wtsinteger
planned worked seconds for this month until today
live_wts_statusstring
status of the live wts
start_vdnumber (float)
calculated vacation days from last month as start balance
unconfirmed_start_vdnumber (float)
calculated vacation days from last month as start balance that are unconfirmed
start_sum_vdnumber (float)
calculated vacation days for year until last month
start_last_year_vdnumber (float)
calculated open vacation days from last year as start balance
end_last_year_vdnumber (float)
calculated open vacation days from last year as end balance
correction_last_year_vdnumber (float)
manual correction for vacation days from last year
real_last_year_vdnumber (float)
real used vacation days for this month from last year
start_real_last_year_vdnumber (float)
real used vacation days summed up until start of current month
end_real_last_year_vdnumber (float)
real used vacation days summed up until end of current month
expired_last_year_vdnumber (float)
calculated expired vacation days from last year
start_expired_last_year_vdnumber (float)
sum of expired vacation days at start of month
end_expired_last_year_vdnumber (float)
sum of expired vacation days at end of month
end_vdnumber (float)
calculated result of vacation days for this month
unconfirmed_end_vdnumber (float)
calculated result of vacation days for this month that are unconfirmed
end_sum_vdnumber (float)
calculated result of vacation days for year until this month
new_vdnumber (float)
new vacation days for this month from contract
correction_vdnumber (float)
manual correction for vacation days for this month
real_vdnumber (float)
real used vacation days for this month
unconfirmed_real_vdnumber (float)
real used vacation days for this month that are unconfirmed
real_wdnumber (float)
real work days for this month
start_sdnumber (float)
calculated sick days from last month as start balance
unconfirmed_start_sdnumber (float)
calculated sick days from last month as start balance that are unconfirmed
end_sdnumber (float)
calculated result of sick days for this month
unconfirmed_end_sdnumber (float)
calculated result of sick days for this month that are unconfirmed
correction_sdnumber (float)
manual correction for sick days for this month
real_sdnumber (float)
real sick days for this month
unconfirmed_real_sdnumber (float)
real sick days for this month that are unconfirmed
start_csdnumber (float)
calculated child sick days (Kind krank, § 45 SGB V) of the year up to last month as start balance
unconfirmed_start_csdnumber (float)
calculated child sick days from last month as start balance that are unconfirmed
end_csdnumber (float)
calculated child sick days of the year up to this month
unconfirmed_end_csdnumber (float)
calculated child sick days of the year up to this month that are unconfirmed
correction_csdnumber (float)
manual correction for child sick days for this month
real_csdnumber (float)
real child sick days for this month - counted apart from the own sick days
unconfirmed_real_csdnumber (float)
real child sick days for this month that are unconfirmed
dirtyboolean
mark for recalculation
search_stringstring
Text that the entity can be searched by.
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/processed/employment_contract_month/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/processed/employment_contract_month/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/processed/employment_contract_month/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/processed/employment_contract_month/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/processed/employment_contract_month/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/processed/employment_contract_month/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/processed/employment_contract_month/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/time_tracking_processed_employment_contract_month_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 TimeTrackingProcessedEmploymentContractMonthController.get('42');
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "id": 42,
  "user": {
    "id": 42,
    "name": "Beispiel",
    "username": "lena.hartmann@example.org",
    "email": "lena.hartmann@example.org",
    "profile_picture_url": "https://vynst.de",
    "positioningeneral": "string",
    "crm_person": {
      "id": 42,
      "first_name": "Lena",
      "last_name": "Hartmann",
      "title": "Beispiel",
      "language": "de",
      "support_description": "Text",
      "profile_picture_url": "https://vynst.de",
      "address_street": "Jakobistr. 39",
      "address_city": "Hannover",
      "address_zip": "30163"
    },
    "archived": true,
    "require2fa": true,
    "search_string": "string"
  },
  "contract": {
    "id": 42,
    "description": "Text",
    "staged_absence_approval": true,
    "token": "string",
    "user": {
      "id": 42,
      "name": "Beispiel",
      "username": "lena.hartmann@example.org",
      "email": "lena.hartmann@example.org",
      "profile_picture_url": "https://vynst.de",
      "positioningeneral": "string",
      "archived": true,
      "require2fa": true,
      "search_string": "string"
    },
    "week_total_hours": 1.5,
    "week_total_days": 1.5,
    "reserved_hours_preparation": 1.5,
    "reserved_hours_follow_up": 1.5,
    "reserved_hours_travel": 1.5
  },
  "start_month": 1,
  "start_year": 1,
  "start_wts": 1,
  "overtime_last_year_wts": 1,
  "end_wts": 1,
  "correction_wts": 1,
  "real_wts": 1
}

Update a single ProcessedEmploymentContractMonth

PUT/api/time/processed/employment_contract_month/{id}

Path parameters

idrequiredstring

Request body application/json

dataProcessedEmploymentContractMonth2
Show fields (5)
- correction_wtsinteger
  manual correction for worked seconds for this month
- correction_last_year_vdnumber (float)
  manual correction for vacation days from last year
- correction_vdnumber (float)
  manual correction for vacation days for this month
- correction_sdnumber (float)
  manual correction for sick days for this month
- correction_csdnumber (float)
  manual correction for child sick days for this month

Responses

200Update a single ProcessedEmploymentContractMonthProcessedEmploymentContractMonth

Show fields (53)

idinteger
Primary key of the processed month. Internal ID.
userUser14
User the processed month belongs to.
Show fields (10)
- idinteger
  Primary key of the user. Internal ID of the login user.
- namestring
  Display name of the user. Shown in the UI and in audit entries.
- usernamestring
  Login name of the user. Must be unique across all users.
- emailstring
  E-mail address of the user. Used for login notifications, password resets and as a login alias.
- positioningeneralstring
  Free text describing the position or role of the user.
- crm_personCRMPerson10
  CRM person linked to this login user. Connects the login account with the person record.
- profile_picture_urlstring
  URL of the profile picture of the user.
- archivedboolean
  Marks the user as archived. Archived users are kept for history and are not active.
- require2faboolean
  Two-factor authentication is required for this user.
- search_stringstring
  Text that the entity can be searched by.
contractEmploymentContract6
Employment contract the processed month belongs to.
Show fields (43)
- staged_absence_approvalboolean
  null inherits group then organization policy; existing installations stay off.
- idinteger
  Primary key of the employment contract. Internal ID.
- tokenstring
  Public token of the contract. Used instead of the ID.
- userUser14
  Login user of the employee.
- week_total_hoursnumber (float)
  Total working hours per week.
- week_total_daysnumber (float)
  Total working days 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.
- week_full_time_total_daysnumber (float)
  Total working days per week for a full-time contract.
- 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.
- startstring (date-time)
  Start date of the contract.
- endstring (date-time)
  End date of the contract.
- fixed_term_statusstring
  Befristung: PERMANENT (unbefristet, default), FIXED_TERM or EXTENDED (FIXED_TERM_STATUS_*).
- fixed_term_endstring (date-time)
  Befristet bis (erster Zeitraum).
- fixed_term_extension_endstring (date-time)
  Befristet bis nach Verlängerung.
- probation_endstring (date-time)
  Probezeit bis; filled from the template's probationMonths when a contract is created without it.
- numberstring
  Contract number.
- descriptionstring
  Description of the contract.
- archivedboolean
  The contract is archived.
- allow_app_time_trackingboolean
  The employee may track time in the app.
- allow_scanner_time_trackingboolean
  The employee may track time with the scanner.
- allow_app_non_work_time_managementboolean
  The employee may manage absences in the app.
- force_no_auto_breakboolean
  Automatic breaks are not added for this contract.
- work_time_modestring
  How the target working time is defined - null behaves as WEEKDAY_HOURS so existing contracts keep their previous behaviour unchanged.
- holiday_credit_modestring
  Holiday credit for WEEK_TOTAL contracts - null behaves as WEEKDAY_TARGET (previous behaviour, only meaningful for WEEKDAY_HOURS contracts).
- holiday_credit_fixed_secondsinteger
  Fixed holiday credit in seconds.
- planning_weekdays_bitmaskinteger
  ISO weekday bitmask (Mo=1 ... So=64) of the days this WEEK_TOTAL contract can be planned / takes vacation on - null behaves as Mo-Fr.
- request_lead_time_daysinteger
  Days an absence request has to be handed in ahead of its first day ("Bearbeitungs- frist"). null falls back to the contract group and from there to the installation wide setting, so an existing contract keeps behaving exactly as before.
- shift_booking_syncboolean
  L35: shifts as availabilities / appointments in the booking area; null inherits the group (which inherits the organisation).
- search_stringstring
  Text that the entity can be searched by.
start_monthinteger
Month the processed period starts.
start_yearinteger
Year the processed period starts.
start_wtsinteger
calculated seconds from last month as start balance
overtime_last_year_wtsinteger
calculated overtime seconds from last year as start balance
end_wtsinteger
calculated result of worked seconds for this month
correction_wtsinteger
manual correction for worked seconds for this month
real_wtsinteger
real worked seconds for this month
planned_wtsinteger
planned worked seconds for this month
live_end_wtsinteger
calculated result of worked seconds for this month until today
live_real_wtsinteger
real worked seconds for this month until today
live_planned_wtsinteger
planned worked seconds for this month until today
live_wts_statusstring
status of the live wts
start_vdnumber (float)
calculated vacation days from last month as start balance
unconfirmed_start_vdnumber (float)
calculated vacation days from last month as start balance that are unconfirmed
start_sum_vdnumber (float)
calculated vacation days for year until last month
start_last_year_vdnumber (float)
calculated open vacation days from last year as start balance
end_last_year_vdnumber (float)
calculated open vacation days from last year as end balance
correction_last_year_vdnumber (float)
manual correction for vacation days from last year
real_last_year_vdnumber (float)
real used vacation days for this month from last year
start_real_last_year_vdnumber (float)
real used vacation days summed up until start of current month
end_real_last_year_vdnumber (float)
real used vacation days summed up until end of current month
expired_last_year_vdnumber (float)
calculated expired vacation days from last year
start_expired_last_year_vdnumber (float)
sum of expired vacation days at start of month
end_expired_last_year_vdnumber (float)
sum of expired vacation days at end of month
end_vdnumber (float)
calculated result of vacation days for this month
unconfirmed_end_vdnumber (float)
calculated result of vacation days for this month that are unconfirmed
end_sum_vdnumber (float)
calculated result of vacation days for year until this month
new_vdnumber (float)
new vacation days for this month from contract
correction_vdnumber (float)
manual correction for vacation days for this month
real_vdnumber (float)
real used vacation days for this month
unconfirmed_real_vdnumber (float)
real used vacation days for this month that are unconfirmed
real_wdnumber (float)
real work days for this month
start_sdnumber (float)
calculated sick days from last month as start balance
unconfirmed_start_sdnumber (float)
calculated sick days from last month as start balance that are unconfirmed
end_sdnumber (float)
calculated result of sick days for this month
unconfirmed_end_sdnumber (float)
calculated result of sick days for this month that are unconfirmed
correction_sdnumber (float)
manual correction for sick days for this month
real_sdnumber (float)
real sick days for this month
unconfirmed_real_sdnumber (float)
real sick days for this month that are unconfirmed
start_csdnumber (float)
calculated child sick days (Kind krank, § 45 SGB V) of the year up to last month as start balance
unconfirmed_start_csdnumber (float)
calculated child sick days from last month as start balance that are unconfirmed
end_csdnumber (float)
calculated child sick days of the year up to this month
unconfirmed_end_csdnumber (float)
calculated child sick days of the year up to this month that are unconfirmed
correction_csdnumber (float)
manual correction for child sick days for this month
real_csdnumber (float)
real child sick days for this month - counted apart from the own sick days
unconfirmed_real_csdnumber (float)
real child sick days for this month that are unconfirmed
dirtyboolean
mark for recalculation
search_stringstring
Text that the entity can be searched by.
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/processed/employment_contract_month/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "correction_wts": 1,
    "correction_last_year_vd": 1.5,
    "correction_vd": 1.5,
    "correction_sd": 1.5,
    "correction_csd": 1.5
  }
}
'

const options = {
  method: 'PUT',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({
    data: {
      correction_wts: 1,
      correction_last_year_vd: 1.5,
      correction_vd: 1.5,
      correction_sd: 1.5,
      correction_csd: 1.5
    }
  })
};

fetch('https://your-instance.iw-erp.de/api/time/processed/employment_contract_month/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/processed/employment_contract_month/42"

payload = { "data": {
    "correction_wts": 1,
    "correction_last_year_vd": 1.5,
    "correction_vd": 1.5,
    "correction_sd": 1.5,
    "correction_csd": 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/processed/employment_contract_month/42', [
  'body' => '{"data":{"correction_wts":1,"correction_last_year_vd":1.5,"correction_vd":1.5,"correction_sd":1.5,"correction_csd":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/processed/employment_contract_month/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"correction_wts\":1,\"correction_last_year_vd\":1.5,\"correction_vd\":1.5,\"correction_sd\":1.5,\"correction_csd\":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\":{\"correction_wts\":1,\"correction_last_year_vd\":1.5,\"correction_vd\":1.5,\"correction_sd\":1.5,\"correction_csd\":1.5}}");
Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/time/processed/employment_contract_month/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/processed/employment_contract_month/42"

	payload := strings.NewReader("{\"data\":{\"correction_wts\":1,\"correction_last_year_vd\":1.5,\"correction_vd\":1.5,\"correction_sd\":1.5,\"correction_csd\":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/time_tracking_processed_employment_contract_month_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/time_tracking_processed_employment_contract_month.dart';

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

final result = await TimeTrackingProcessedEmploymentContractMonthController.put(TimeTrackingProcessedEmploymentContractMonth.fromJson({
  "correction_wts": 1,
  "correction_last_year_vd": 1.5,
  "correction_vd": 1.5,
  "correction_sd": 1.5,
  "correction_csd": 1.5
}));
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "id": 42,
  "user": {
    "id": 42,
    "name": "Beispiel",
    "username": "lena.hartmann@example.org",
    "email": "lena.hartmann@example.org",
    "profile_picture_url": "https://vynst.de",
    "positioningeneral": "string",
    "crm_person": {
      "id": 42,
      "first_name": "Lena",
      "last_name": "Hartmann",
      "title": "Beispiel",
      "language": "de",
      "support_description": "Text",
      "profile_picture_url": "https://vynst.de",
      "address_street": "Jakobistr. 39",
      "address_city": "Hannover",
      "address_zip": "30163"
    },
    "archived": true,
    "require2fa": true,
    "search_string": "string"
  },
  "contract": {
    "id": 42,
    "description": "Text",
    "staged_absence_approval": true,
    "token": "string",
    "user": {
      "id": 42,
      "name": "Beispiel",
      "username": "lena.hartmann@example.org",
      "email": "lena.hartmann@example.org",
      "profile_picture_url": "https://vynst.de",
      "positioningeneral": "string",
      "archived": true,
      "require2fa": true,
      "search_string": "string"
    },
    "week_total_hours": 1.5,
    "week_total_days": 1.5,
    "reserved_hours_preparation": 1.5,
    "reserved_hours_follow_up": 1.5,
    "reserved_hours_travel": 1.5
  },
  "start_month": 1,
  "start_year": 1,
  "start_wts": 1,
  "overtime_last_year_wts": 1,
  "end_wts": 1,
  "correction_wts": 1,
  "real_wts": 1
}

Update a single ProcessedEmploymentContractMonth

PATCH/api/time/processed/employment_contract_month/{id}

Path parameters

idrequiredstring

Request body application/json

dataProcessedEmploymentContractMonth2
Show fields (5)
- correction_wtsinteger
  manual correction for worked seconds for this month
- correction_last_year_vdnumber (float)
  manual correction for vacation days from last year
- correction_vdnumber (float)
  manual correction for vacation days for this month
- correction_sdnumber (float)
  manual correction for sick days for this month
- correction_csdnumber (float)
  manual correction for child sick days for this month

Responses

200Update a single ProcessedEmploymentContractMonthProcessedEmploymentContractMonth

Show fields (53)

idinteger
Primary key of the processed month. Internal ID.
userUser14
User the processed month belongs to.
Show fields (10)
- idinteger
  Primary key of the user. Internal ID of the login user.
- namestring
  Display name of the user. Shown in the UI and in audit entries.
- usernamestring
  Login name of the user. Must be unique across all users.
- emailstring
  E-mail address of the user. Used for login notifications, password resets and as a login alias.
- positioningeneralstring
  Free text describing the position or role of the user.
- crm_personCRMPerson10
  CRM person linked to this login user. Connects the login account with the person record.
- profile_picture_urlstring
  URL of the profile picture of the user.
- archivedboolean
  Marks the user as archived. Archived users are kept for history and are not active.
- require2faboolean
  Two-factor authentication is required for this user.
- search_stringstring
  Text that the entity can be searched by.
contractEmploymentContract6
Employment contract the processed month belongs to.
Show fields (43)
- staged_absence_approvalboolean
  null inherits group then organization policy; existing installations stay off.
- idinteger
  Primary key of the employment contract. Internal ID.
- tokenstring
  Public token of the contract. Used instead of the ID.
- userUser14
  Login user of the employee.
- week_total_hoursnumber (float)
  Total working hours per week.
- week_total_daysnumber (float)
  Total working days 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.
- week_full_time_total_daysnumber (float)
  Total working days per week for a full-time contract.
- 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.
- startstring (date-time)
  Start date of the contract.
- endstring (date-time)
  End date of the contract.
- fixed_term_statusstring
  Befristung: PERMANENT (unbefristet, default), FIXED_TERM or EXTENDED (FIXED_TERM_STATUS_*).
- fixed_term_endstring (date-time)
  Befristet bis (erster Zeitraum).
- fixed_term_extension_endstring (date-time)
  Befristet bis nach Verlängerung.
- probation_endstring (date-time)
  Probezeit bis; filled from the template's probationMonths when a contract is created without it.
- numberstring
  Contract number.
- descriptionstring
  Description of the contract.
- archivedboolean
  The contract is archived.
- allow_app_time_trackingboolean
  The employee may track time in the app.
- allow_scanner_time_trackingboolean
  The employee may track time with the scanner.
- allow_app_non_work_time_managementboolean
  The employee may manage absences in the app.
- force_no_auto_breakboolean
  Automatic breaks are not added for this contract.
- work_time_modestring
  How the target working time is defined - null behaves as WEEKDAY_HOURS so existing contracts keep their previous behaviour unchanged.
- holiday_credit_modestring
  Holiday credit for WEEK_TOTAL contracts - null behaves as WEEKDAY_TARGET (previous behaviour, only meaningful for WEEKDAY_HOURS contracts).
- holiday_credit_fixed_secondsinteger
  Fixed holiday credit in seconds.
- planning_weekdays_bitmaskinteger
  ISO weekday bitmask (Mo=1 ... So=64) of the days this WEEK_TOTAL contract can be planned / takes vacation on - null behaves as Mo-Fr.
- request_lead_time_daysinteger
  Days an absence request has to be handed in ahead of its first day ("Bearbeitungs- frist"). null falls back to the contract group and from there to the installation wide setting, so an existing contract keeps behaving exactly as before.
- shift_booking_syncboolean
  L35: shifts as availabilities / appointments in the booking area; null inherits the group (which inherits the organisation).
- search_stringstring
  Text that the entity can be searched by.
start_monthinteger
Month the processed period starts.
start_yearinteger
Year the processed period starts.
start_wtsinteger
calculated seconds from last month as start balance
overtime_last_year_wtsinteger
calculated overtime seconds from last year as start balance
end_wtsinteger
calculated result of worked seconds for this month
correction_wtsinteger
manual correction for worked seconds for this month
real_wtsinteger
real worked seconds for this month
planned_wtsinteger
planned worked seconds for this month
live_end_wtsinteger
calculated result of worked seconds for this month until today
live_real_wtsinteger
real worked seconds for this month until today
live_planned_wtsinteger
planned worked seconds for this month until today
live_wts_statusstring
status of the live wts
start_vdnumber (float)
calculated vacation days from last month as start balance
unconfirmed_start_vdnumber (float)
calculated vacation days from last month as start balance that are unconfirmed
start_sum_vdnumber (float)
calculated vacation days for year until last month
start_last_year_vdnumber (float)
calculated open vacation days from last year as start balance
end_last_year_vdnumber (float)
calculated open vacation days from last year as end balance
correction_last_year_vdnumber (float)
manual correction for vacation days from last year
real_last_year_vdnumber (float)
real used vacation days for this month from last year
start_real_last_year_vdnumber (float)
real used vacation days summed up until start of current month
end_real_last_year_vdnumber (float)
real used vacation days summed up until end of current month
expired_last_year_vdnumber (float)
calculated expired vacation days from last year
start_expired_last_year_vdnumber (float)
sum of expired vacation days at start of month
end_expired_last_year_vdnumber (float)
sum of expired vacation days at end of month
end_vdnumber (float)
calculated result of vacation days for this month
unconfirmed_end_vdnumber (float)
calculated result of vacation days for this month that are unconfirmed
end_sum_vdnumber (float)
calculated result of vacation days for year until this month
new_vdnumber (float)
new vacation days for this month from contract
correction_vdnumber (float)
manual correction for vacation days for this month
real_vdnumber (float)
real used vacation days for this month
unconfirmed_real_vdnumber (float)
real used vacation days for this month that are unconfirmed
real_wdnumber (float)
real work days for this month
start_sdnumber (float)
calculated sick days from last month as start balance
unconfirmed_start_sdnumber (float)
calculated sick days from last month as start balance that are unconfirmed
end_sdnumber (float)
calculated result of sick days for this month
unconfirmed_end_sdnumber (float)
calculated result of sick days for this month that are unconfirmed
correction_sdnumber (float)
manual correction for sick days for this month
real_sdnumber (float)
real sick days for this month
unconfirmed_real_sdnumber (float)
real sick days for this month that are unconfirmed
start_csdnumber (float)
calculated child sick days (Kind krank, § 45 SGB V) of the year up to last month as start balance
unconfirmed_start_csdnumber (float)
calculated child sick days from last month as start balance that are unconfirmed
end_csdnumber (float)
calculated child sick days of the year up to this month
unconfirmed_end_csdnumber (float)
calculated child sick days of the year up to this month that are unconfirmed
correction_csdnumber (float)
manual correction for child sick days for this month
real_csdnumber (float)
real child sick days for this month - counted apart from the own sick days
unconfirmed_real_csdnumber (float)
real child sick days for this month that are unconfirmed
dirtyboolean
mark for recalculation
search_stringstring
Text that the entity can be searched by.
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/processed/employment_contract_month/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "correction_wts": 1,
    "correction_last_year_vd": 1.5,
    "correction_vd": 1.5,
    "correction_sd": 1.5,
    "correction_csd": 1.5
  }
}
'

const options = {
  method: 'PATCH',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({
    data: {
      correction_wts: 1,
      correction_last_year_vd: 1.5,
      correction_vd: 1.5,
      correction_sd: 1.5,
      correction_csd: 1.5
    }
  })
};

fetch('https://your-instance.iw-erp.de/api/time/processed/employment_contract_month/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/processed/employment_contract_month/42"

payload = { "data": {
    "correction_wts": 1,
    "correction_last_year_vd": 1.5,
    "correction_vd": 1.5,
    "correction_sd": 1.5,
    "correction_csd": 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/processed/employment_contract_month/42', [
  'body' => '{"data":{"correction_wts":1,"correction_last_year_vd":1.5,"correction_vd":1.5,"correction_sd":1.5,"correction_csd":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/processed/employment_contract_month/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"correction_wts\":1,\"correction_last_year_vd\":1.5,\"correction_vd\":1.5,\"correction_sd\":1.5,\"correction_csd\":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\":{\"correction_wts\":1,\"correction_last_year_vd\":1.5,\"correction_vd\":1.5,\"correction_sd\":1.5,\"correction_csd\":1.5}}");
Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/time/processed/employment_contract_month/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/processed/employment_contract_month/42"

	payload := strings.NewReader("{\"data\":{\"correction_wts\":1,\"correction_last_year_vd\":1.5,\"correction_vd\":1.5,\"correction_sd\":1.5,\"correction_csd\":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 the iw_erp_api package

import 'package:iw_erp_api/clients/time_tracking_processed_employment_contract_month_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/time_tracking_processed_employment_contract_month.dart';

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

final result = await TimeTrackingProcessedEmploymentContractMonthController.patch(TimeTrackingProcessedEmploymentContractMonth.fromJson({
  "correction_wts": 1,
  "correction_last_year_vd": 1.5,
  "correction_vd": 1.5,
  "correction_sd": 1.5,
  "correction_csd": 1.5
}), 'correction_wts');
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "id": 42,
  "user": {
    "id": 42,
    "name": "Beispiel",
    "username": "lena.hartmann@example.org",
    "email": "lena.hartmann@example.org",
    "profile_picture_url": "https://vynst.de",
    "positioningeneral": "string",
    "crm_person": {
      "id": 42,
      "first_name": "Lena",
      "last_name": "Hartmann",
      "title": "Beispiel",
      "language": "de",
      "support_description": "Text",
      "profile_picture_url": "https://vynst.de",
      "address_street": "Jakobistr. 39",
      "address_city": "Hannover",
      "address_zip": "30163"
    },
    "archived": true,
    "require2fa": true,
    "search_string": "string"
  },
  "contract": {
    "id": 42,
    "description": "Text",
    "staged_absence_approval": true,
    "token": "string",
    "user": {
      "id": 42,
      "name": "Beispiel",
      "username": "lena.hartmann@example.org",
      "email": "lena.hartmann@example.org",
      "profile_picture_url": "https://vynst.de",
      "positioningeneral": "string",
      "archived": true,
      "require2fa": true,
      "search_string": "string"
    },
    "week_total_hours": 1.5,
    "week_total_days": 1.5,
    "reserved_hours_preparation": 1.5,
    "reserved_hours_follow_up": 1.5,
    "reserved_hours_travel": 1.5
  },
  "start_month": 1,
  "start_year": 1,
  "start_wts": 1,
  "overtime_last_year_wts": 1,
  "end_wts": 1,
  "correction_wts": 1,
  "real_wts": 1
}

Get all ProcessedEmploymentContractMonth

GET/api/time/processed/employment_contract_month

Query parameters

`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

200Get all ProcessedEmploymentContractMontharray<ProcessedEmploymentContractMonth>

Show fields (53)

idinteger
Primary key of the processed month. Internal ID.
userUser14
User the processed month belongs to.
Show fields (10)
- idinteger
  Primary key of the user. Internal ID of the login user.
- namestring
  Display name of the user. Shown in the UI and in audit entries.
- usernamestring
  Login name of the user. Must be unique across all users.
- emailstring
  E-mail address of the user. Used for login notifications, password resets and as a login alias.
- positioningeneralstring
  Free text describing the position or role of the user.
- crm_personCRMPerson10
  CRM person linked to this login user. Connects the login account with the person record.
- profile_picture_urlstring
  URL of the profile picture of the user.
- archivedboolean
  Marks the user as archived. Archived users are kept for history and are not active.
- require2faboolean
  Two-factor authentication is required for this user.
- search_stringstring
  Text that the entity can be searched by.
contractEmploymentContract6
Employment contract the processed month belongs to.
Show fields (43)
- staged_absence_approvalboolean
  null inherits group then organization policy; existing installations stay off.
- idinteger
  Primary key of the employment contract. Internal ID.
- tokenstring
  Public token of the contract. Used instead of the ID.
- userUser14
  Login user of the employee.
- week_total_hoursnumber (float)
  Total working hours per week.
- week_total_daysnumber (float)
  Total working days 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.
- week_full_time_total_daysnumber (float)
  Total working days per week for a full-time contract.
- 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.
- startstring (date-time)
  Start date of the contract.
- endstring (date-time)
  End date of the contract.
- fixed_term_statusstring
  Befristung: PERMANENT (unbefristet, default), FIXED_TERM or EXTENDED (FIXED_TERM_STATUS_*).
- fixed_term_endstring (date-time)
  Befristet bis (erster Zeitraum).
- fixed_term_extension_endstring (date-time)
  Befristet bis nach Verlängerung.
- probation_endstring (date-time)
  Probezeit bis; filled from the template's probationMonths when a contract is created without it.
- numberstring
  Contract number.
- descriptionstring
  Description of the contract.
- archivedboolean
  The contract is archived.
- allow_app_time_trackingboolean
  The employee may track time in the app.
- allow_scanner_time_trackingboolean
  The employee may track time with the scanner.
- allow_app_non_work_time_managementboolean
  The employee may manage absences in the app.
- force_no_auto_breakboolean
  Automatic breaks are not added for this contract.
- work_time_modestring
  How the target working time is defined - null behaves as WEEKDAY_HOURS so existing contracts keep their previous behaviour unchanged.
- holiday_credit_modestring
  Holiday credit for WEEK_TOTAL contracts - null behaves as WEEKDAY_TARGET (previous behaviour, only meaningful for WEEKDAY_HOURS contracts).
- holiday_credit_fixed_secondsinteger
  Fixed holiday credit in seconds.
- planning_weekdays_bitmaskinteger
  ISO weekday bitmask (Mo=1 ... So=64) of the days this WEEK_TOTAL contract can be planned / takes vacation on - null behaves as Mo-Fr.
- request_lead_time_daysinteger
  Days an absence request has to be handed in ahead of its first day ("Bearbeitungs- frist"). null falls back to the contract group and from there to the installation wide setting, so an existing contract keeps behaving exactly as before.
- shift_booking_syncboolean
  L35: shifts as availabilities / appointments in the booking area; null inherits the group (which inherits the organisation).
- search_stringstring
  Text that the entity can be searched by.
start_monthinteger
Month the processed period starts.
start_yearinteger
Year the processed period starts.
start_wtsinteger
calculated seconds from last month as start balance
overtime_last_year_wtsinteger
calculated overtime seconds from last year as start balance
end_wtsinteger
calculated result of worked seconds for this month
correction_wtsinteger
manual correction for worked seconds for this month
real_wtsinteger
real worked seconds for this month
planned_wtsinteger
planned worked seconds for this month
live_end_wtsinteger
calculated result of worked seconds for this month until today
live_real_wtsinteger
real worked seconds for this month until today
live_planned_wtsinteger
planned worked seconds for this month until today
live_wts_statusstring
status of the live wts
start_vdnumber (float)
calculated vacation days from last month as start balance
unconfirmed_start_vdnumber (float)
calculated vacation days from last month as start balance that are unconfirmed
start_sum_vdnumber (float)
calculated vacation days for year until last month
start_last_year_vdnumber (float)
calculated open vacation days from last year as start balance
end_last_year_vdnumber (float)
calculated open vacation days from last year as end balance
correction_last_year_vdnumber (float)
manual correction for vacation days from last year
real_last_year_vdnumber (float)
real used vacation days for this month from last year
start_real_last_year_vdnumber (float)
real used vacation days summed up until start of current month
end_real_last_year_vdnumber (float)
real used vacation days summed up until end of current month
expired_last_year_vdnumber (float)
calculated expired vacation days from last year
start_expired_last_year_vdnumber (float)
sum of expired vacation days at start of month
end_expired_last_year_vdnumber (float)
sum of expired vacation days at end of month
end_vdnumber (float)
calculated result of vacation days for this month
unconfirmed_end_vdnumber (float)
calculated result of vacation days for this month that are unconfirmed
end_sum_vdnumber (float)
calculated result of vacation days for year until this month
new_vdnumber (float)
new vacation days for this month from contract
correction_vdnumber (float)
manual correction for vacation days for this month
real_vdnumber (float)
real used vacation days for this month
unconfirmed_real_vdnumber (float)
real used vacation days for this month that are unconfirmed
real_wdnumber (float)
real work days for this month
start_sdnumber (float)
calculated sick days from last month as start balance
unconfirmed_start_sdnumber (float)
calculated sick days from last month as start balance that are unconfirmed
end_sdnumber (float)
calculated result of sick days for this month
unconfirmed_end_sdnumber (float)
calculated result of sick days for this month that are unconfirmed
correction_sdnumber (float)
manual correction for sick days for this month
real_sdnumber (float)
real sick days for this month
unconfirmed_real_sdnumber (float)
real sick days for this month that are unconfirmed
start_csdnumber (float)
calculated child sick days (Kind krank, § 45 SGB V) of the year up to last month as start balance
unconfirmed_start_csdnumber (float)
calculated child sick days from last month as start balance that are unconfirmed
end_csdnumber (float)
calculated child sick days of the year up to this month
unconfirmed_end_csdnumber (float)
calculated child sick days of the year up to this month that are unconfirmed
correction_csdnumber (float)
manual correction for child sick days for this month
real_csdnumber (float)
real child sick days for this month - counted apart from the own sick days
unconfirmed_real_csdnumber (float)
real child sick days for this month that are unconfirmed
dirtyboolean
mark for recalculation
search_stringstring
Text that the entity can be searched by.
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/processed/employment_contract_month \
  --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/processed/employment_contract_month', 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/processed/employment_contract_month"

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/processed/employment_contract_month', [
  '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/processed/employment_contract_month"),
  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/processed/employment_contract_month")
  .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/processed/employment_contract_month"

	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/time_tracking_processed_employment_contract_month_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 TimeTrackingProcessedEmploymentContractMonthController.getAll();
if (result.success) {
  print(result.data);
}

Response 200 application/json

[
  {
    "id": 42,
    "user": {
      "id": 42,
      "name": "Beispiel",
      "username": "lena.hartmann@example.org",
      "email": "lena.hartmann@example.org",
      "profile_picture_url": "https://vynst.de",
      "positioningeneral": "string",
      "archived": true,
      "require2fa": true,
      "search_string": "string"
    },
    "contract": {
      "id": 42,
      "description": "Text",
      "staged_absence_approval": true,
      "token": "string",
      "week_total_hours": 1.5,
      "week_total_days": 1.5,
      "reserved_hours_preparation": 1.5,
      "reserved_hours_follow_up": 1.5,
      "reserved_hours_travel": 1.5,
      "reserved_hours_flexible": 1.5
    },
    "start_month": 1,
    "start_year": 1,
    "start_wts": 1,
    "overtime_last_year_wts": 1,
    "end_wts": 1,
    "correction_wts": 1,
    "real_wts": 1
  }
]