Skip to content
Developer

EmploymentContract

Staff8 EndpointsTimeTracking / EmploymentContract

This method will get all EmploymentContract Objects

GET/api/time/employment/contracts

Query parameters

searchStringstringtext to search for in the list
orderFieldNamestringname of the order field
orderFieldSortstringsorting modeAllowed: DESCASC
pageintegerpage of the list
pageSizeintegernumber of entries for each page
withMaxPageNumberstringreturns the number of pages available as a header if this is set

Responses

default

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

Add a new EmploymentContract

POST/api/time/employment/contracts

Query parameters

keepParallelContractsbooleanKeep the earlier open contract of the person running in parallel instead of ending it the day before this contract starts (also accepted as employment_contract[keep_parallel_contracts])

Responses

default

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

This method will get a single EmploymentContract with the given id

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

Path parameters

idrequiredstring

Responses

default

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

Update a EmploymentContract

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

Path parameters

idrequiredstring

Query parameters

keepParallelContractsbooleanKeep the earlier open contract of the person running in parallel instead of ending it the day before this contract starts (also accepted as employment_contract[keep_parallel_contracts])

Responses

default

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

Update a EmploymentContract

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

Path parameters

idrequiredstring

Query parameters

keepParallelContractsbooleanKeep the earlier open contract of the person running in parallel instead of ending it the day before this contract starts (also accepted as employment_contract[keep_parallel_contracts])

Responses

default

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

R3: the vacations of the contract's person from a date on (default tomorrow) - shown before the working days of the contract change. Needs employment_contract_future_absence_hint_enabled.

GET/api/time/employment/contracts/{id}/future_absences

Path parameters

idrequiredstring

Query parameters

fromstringFirst day (Y-m-d), default tomorrow

Responses

200Not declined vacation requests from that day on: request_id, status, content_type, content_type_name, content_type_color, start, end, weekdays

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

Update a EmploymentContract as a leadership person of the contract

PUT/api/time/employment/leadership/contracts/{id}

Path parameters

idrequiredstring

Responses

default

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

This method will get all EmploymentContract Objects with your leadership + your own contracts

GET/api/time/employment/leadership/contracts

Query parameters

searchStringstringtext to search for in the list
orderFieldNamestringname of the order field
orderFieldSortstringsorting modeAllowed: DESCASC
pageintegerpage of the list
pageSizeintegernumber of entries for each page
withMaxPageNumberstringreturns the number of pages available as a header if this is set

Responses

default

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