Show/hide List Operations Expand Operations

Workdones

A Workdone is work actually performed: who worked, on what, from when to when, and with which materials. It is the busiest entity in the API and the one most other records eventually point at. These endpoints start and stop work, create and edit records, attach material usage, approve work and read it back by period. Work can arrive from the mobile app, from a plan item marked done, from a card reader or from telemetry. A Workdone is either approved or not: approving one records who approved it, when, and any comment they left, and a customer can approve their own work separately through a token link. For consolidated figures or worked hours over a period, prefer the endpoints under Reports: raw Workdone rows overlap, run past midnight and include unapproved and corrected records, so summing them yourself will not match what the reports show. Deleting is soft, except that a refuelling Workdone cannot be deleted here at all.

DELETE /api/materialusages/{usageid}

Deletes a material usage of a Workdone

Documentation
Sandbox

Documentation

Deletes a material usage of a Workdone. Returns the parent Workdone, not the removed usage

Requirements

Name	Requirement	Type	Description
usageid		integer\|string	MaterialUsage id
wdid		integer\|string	Workdone id

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Return

Parameter	Type	Versions	Description
200
is_transport_work	boolean	*
is_silage_transport_work	boolean	*
location_history	array	*
pause_minutes	integer	*
roster_type	array	*
duration_seconds	integer	*
paused_from_timestamp	integer	*
duration_as_text	string	*
from_time	DateTime	*
to_time	DateTime	*
silage_transports	custom handler result for (Doctrine\Common\Collections\Collection)	*	Get silageTransports.
transport_cases	custom handler result for (Doctrine\Common\Collections\Collection)	*	Get transportCases.
id	integer	*
description	string	*
start_time	DateTime	*
stop_time	DateTime	*
worker	object (Worker)	*
worktype	object (Worktype)	*
main_facility	object (Facility)	*
main_facility_start_hour	float	*
main_facility_stop_hour	float	*
secondary_facility	object (Facility)	*
agrifield	object (Agrifield)	*
kilometer_start	integer	*
kilometer_stop	integer	*
fuel_consumption	integer	*
is_approved	boolean	*
approver	object (Worker)	*
approving_time	DateTime	*
pria_sync_time	DateTime	*
hectares_served	float	*
is_mobile_initiated	boolean	*
start_latitude	float	*
start_longitude	float	*
stop_latitude	float	*
stop_longitude	float	*
material_usages[]	array of objects (MaterialUsage)	*
cost_account	object (CostAccount)	*
pause_total_duration	integer	*
is_paused	boolean	*
planitem	object (Planitem)	*
rosteritem	object (Rosteritem)	*
fuel_filling	object (FuelFilling)	*
faultitem	object (Faultitem)	*
inspection_case	object (InspectionCase)	*
is_forbidden_for_fieldbook	boolean	*
is_forbidden_for_customer	boolean	*
customer	object (Customer)	*
description_extended	string	*
is_agrifield_finished	boolean	*
hectares_displayed	float	*
yield_measured	float	*
department	object (Department)	*
crop_period	object (CropPeriod)	*
project	object (Project)	*
device_uuid	string	*
foreman_info	object (WorkdoneForemanInfo)	*	@ORM\OneToOne(targetEntity="WorkdoneForemanInfo", mappedBy="workdone" )
workdone_telemetry	object (WorkdoneTelemetry)	*	@ORM\OneToOne(targetEntity="WorkdoneTelemetry", mappedBy="workdone" )
workplace	object (Workplace)	*
workdone_geo_track[]	array of objects (WorkdoneGeoTrack)	*
workdone_pictures[]	array of objects (WorkdonePicture)	*
workdone_device_location	object (WorkdoneDeviceLocation)	*	@ORM\OneToOne(targetEntity="WorkdoneDeviceLocation", mappedBy="workdone" )
is_unfinished	boolean	*
is_invoiced	boolean	*
is_manual_entry	boolean	*
is_auto_created	boolean	*
is_auto_stopped	boolean	*
is_signed	boolean	*
workdone_approval	object (WorkdoneApproval)	*
workdone_budget	object (WorkdoneBudget)	*
is_deleted	boolean	*
is_archived	boolean	*
maintenance_unit	object (Facility)	*

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/office-hours

Office hours in period

Documentation
Sandbox

Documentation

Office hours in period. Returns the number of office hours in the period

Parameters

Parameter	Type	Required?	Format	Description
from	datetime	false	YYYY-MM-DD HH:MM:SS	Start of the period. The time part may be omitted and defaults to 00:00:00.
to	datetime	false	YYYY-MM-DD HH:MM:SS	End of the period. The time part may be omitted and defaults to 00:00:00, so a bare date excludes that day itself - send the next day or add a time.

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/startwork

Starts work - creates an open Workdone for the calling worker

Documentation
Sandbox

Documentation

Starts work - creates an open Workdone for the calling worker

Parameters

Parameter	Type	Required?	Description
description	string	false	Truncated to 1000 characters.
worker	object	false	Reference to Worker. Send { "id": <id> }, or null to clear.
worktype	object	false	Reference to Worktype. Send { "id": <id> }, or null to clear.
main_facility	object	false	Reference to Facility. Send { "id": <id> }, or null to clear.
secondary_facility	object	false	Reference to Facility. Send { "id": <id> }, or null to clear.
workobject	object	false	Reference to Agrifield. Send { "id": <id> }, or null to clear.
cost_account	object	false	Reference to CostAccount. Send { "id": <id> }, or null to clear.
project	object	false	Reference to Project. Send { "id": <id> }, or null to clear.
customer	object	false	Reference to Customer. Send { "id": <id> }, or null to clear.
maintenance_unit	object	false	Reference to Facility. Send { "id": <id> }, or null to clear.

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Return

Parameter	Type	Versions	Description
200
location_history	array	*
pause_minutes	integer	*
roster_type	array	*
duration_seconds	integer	*
paused_from_timestamp	integer	*
duration_as_text	string	*
from_time	DateTime	*
to_time	DateTime	*
id	integer	*
description	string	*
start_time	DateTime	*
stop_time	DateTime	*
worker	object (Worker)	*
worktype	object (Worktype)	*
main_facility	object (Facility)	*
main_facility_start_hour	float	*
main_facility_stop_hour	float	*
secondary_facility	object (Facility)	*
agrifield	object (Agrifield)	*
kilometer_start	integer	*
kilometer_stop	integer	*
fuel_consumption	integer	*
is_approved	boolean	*
approver	object (Worker)	*
approving_time	DateTime	*
pria_sync_time	DateTime	*
hectares_served	float	*
is_mobile_initiated	boolean	*
start_latitude	float	*
start_longitude	float	*
stop_latitude	float	*
stop_longitude	float	*
material_usages[]	array of objects (MaterialUsage)	*
cost_account	object (CostAccount)	*
pause_total_duration	integer	*
is_paused	boolean	*
planitem	object (Planitem)	*
rosteritem	object (Rosteritem)	*
fuel_filling	object (FuelFilling)	*
faultitem	object (Faultitem)	*
inspection_case	object (InspectionCase)	*
is_forbidden_for_fieldbook	boolean	*
is_forbidden_for_customer	boolean	*
customer	object (Customer)	*
description_extended	string	*
is_agrifield_finished	boolean	*
hectares_displayed	float	*
yield_measured	float	*
department	object (Department)	*
crop_period	object (CropPeriod)	*
project	object (Project)	*
device_uuid	string	*
foreman_info	object (WorkdoneForemanInfo)	*	@ORM\OneToOne(targetEntity="WorkdoneForemanInfo", mappedBy="workdone" )
workdone_telemetry	object (WorkdoneTelemetry)	*	@ORM\OneToOne(targetEntity="WorkdoneTelemetry", mappedBy="workdone" )
workplace	object (Workplace)	*
workdone_pictures[]	array of objects (WorkdonePicture)	*
workdone_device_location	object (WorkdoneDeviceLocation)	*	@ORM\OneToOne(targetEntity="WorkdoneDeviceLocation", mappedBy="workdone" )
is_unfinished	boolean	*
is_invoiced	boolean	*
is_manual_entry	boolean	*
is_auto_created	boolean	*
is_auto_stopped	boolean	*
is_signed	boolean	*
workdone_approval	object (WorkdoneApproval)	*
workdone_budget	object (WorkdoneBudget)	*
is_deleted	boolean	*
is_archived	boolean	*
maintenance_unit	object (Facility)	*

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/stopwork/{id}

Stops Workdone

Documentation
Sandbox

Documentation

Stops Workdone. Does not have a request body.

Requirements

Name	Requirement	Type	Description
id		integer\|string	Workdone id or uuid

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Return

Parameter	Type	Versions	Description
200
location_history	array	*
pause_minutes	integer	*
roster_type	array	*
duration_seconds	integer	*
paused_from_timestamp	integer	*
duration_as_text	string	*
from_time	DateTime	*
to_time	DateTime	*
id	integer	*
description	string	*
start_time	DateTime	*
stop_time	DateTime	*
worker	object (Worker)	*
worktype	object (Worktype)	*
main_facility	object (Facility)	*
main_facility_start_hour	float	*
main_facility_stop_hour	float	*
secondary_facility	object (Facility)	*
agrifield	object (Agrifield)	*
kilometer_start	integer	*
kilometer_stop	integer	*
fuel_consumption	integer	*
is_approved	boolean	*
approver	object (Worker)	*
approving_time	DateTime	*
pria_sync_time	DateTime	*
hectares_served	float	*
is_mobile_initiated	boolean	*
start_latitude	float	*
start_longitude	float	*
stop_latitude	float	*
stop_longitude	float	*
material_usages[]	array of objects (MaterialUsage)	*
cost_account	object (CostAccount)	*
pause_total_duration	integer	*
is_paused	boolean	*
planitem	object (Planitem)	*
rosteritem	object (Rosteritem)	*
fuel_filling	object (FuelFilling)	*
faultitem	object (Faultitem)	*
inspection_case	object (InspectionCase)	*
is_forbidden_for_fieldbook	boolean	*
is_forbidden_for_customer	boolean	*
customer	object (Customer)	*
description_extended	string	*
is_agrifield_finished	boolean	*
hectares_displayed	float	*
yield_measured	float	*
department	object (Department)	*
crop_period	object (CropPeriod)	*
project	object (Project)	*
device_uuid	string	*
foreman_info	object (WorkdoneForemanInfo)	*	@ORM\OneToOne(targetEntity="WorkdoneForemanInfo", mappedBy="workdone" )
workdone_telemetry	object (WorkdoneTelemetry)	*	@ORM\OneToOne(targetEntity="WorkdoneTelemetry", mappedBy="workdone" )
workplace	object (Workplace)	*
workdone_pictures[]	array of objects (WorkdonePicture)	*
workdone_device_location	object (WorkdoneDeviceLocation)	*	@ORM\OneToOne(targetEntity="WorkdoneDeviceLocation", mappedBy="workdone" )
is_unfinished	boolean	*
is_invoiced	boolean	*
is_manual_entry	boolean	*
is_auto_created	boolean	*
is_auto_stopped	boolean	*
is_signed	boolean	*
workdone_approval	object (WorkdoneApproval)	*
workdone_budget	object (WorkdoneBudget)	*
is_deleted	boolean	*
is_archived	boolean	*
maintenance_unit	object (Facility)	*

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/workdone/approve/{id}

Approves the Workdone

Documentation
Sandbox

Documentation

Approves the Workdone. Does not have a request body.

Requirements

Name	Requirement	Type	Description
id		integer\|string	Workdone id or uuid

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Return

Parameter	Type	Versions	Description
200
is_transport_work	boolean	*
is_silage_transport_work	boolean	*
location_history	array	*
pause_minutes	integer	*
roster_type	array	*
duration_seconds	integer	*
paused_from_timestamp	integer	*
duration_as_text	string	*
from_time	DateTime	*
to_time	DateTime	*
silage_transports	custom handler result for (Doctrine\Common\Collections\Collection)	*	Get silageTransports.
transport_cases	custom handler result for (Doctrine\Common\Collections\Collection)	*	Get transportCases.
id	integer	*
description	string	*
start_time	DateTime	*
stop_time	DateTime	*
worker	object (Worker)	*
worktype	object (Worktype)	*
main_facility	object (Facility)	*
main_facility_start_hour	float	*
main_facility_stop_hour	float	*
secondary_facility	object (Facility)	*
agrifield	object (Agrifield)	*
kilometer_start	integer	*
kilometer_stop	integer	*
fuel_consumption	integer	*
is_approved	boolean	*
approver	object (Worker)	*
approving_time	DateTime	*
pria_sync_time	DateTime	*
hectares_served	float	*
is_mobile_initiated	boolean	*
start_latitude	float	*
start_longitude	float	*
stop_latitude	float	*
stop_longitude	float	*
material_usages[]	array of objects (MaterialUsage)	*
cost_account	object (CostAccount)	*
pause_total_duration	integer	*
is_paused	boolean	*
planitem	object (Planitem)	*
rosteritem	object (Rosteritem)	*
fuel_filling	object (FuelFilling)	*
faultitem	object (Faultitem)	*
inspection_case	object (InspectionCase)	*
is_forbidden_for_fieldbook	boolean	*
is_forbidden_for_customer	boolean	*
customer	object (Customer)	*
description_extended	string	*
is_agrifield_finished	boolean	*
hectares_displayed	float	*
yield_measured	float	*
department	object (Department)	*
crop_period	object (CropPeriod)	*
project	object (Project)	*
device_uuid	string	*
foreman_info	object (WorkdoneForemanInfo)	*	@ORM\OneToOne(targetEntity="WorkdoneForemanInfo", mappedBy="workdone" )
workdone_telemetry	object (WorkdoneTelemetry)	*	@ORM\OneToOne(targetEntity="WorkdoneTelemetry", mappedBy="workdone" )
workplace	object (Workplace)	*
workdone_pictures[]	array of objects (WorkdonePicture)	*
workdone_device_location	object (WorkdoneDeviceLocation)	*	@ORM\OneToOne(targetEntity="WorkdoneDeviceLocation", mappedBy="workdone" )
is_unfinished	boolean	*
is_invoiced	boolean	*
is_manual_entry	boolean	*
is_auto_created	boolean	*
is_auto_stopped	boolean	*
is_signed	boolean	*
workdone_approval	object (WorkdoneApproval)	*
workdone_budget	object (WorkdoneBudget)	*
maintenance_unit	object (Facility)	*

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/workdone/approve_client

Lets a customer approve or reject a Workdone through the token link sent to them

Documentation
Sandbox

Documentation

Handles lets a customer approve or reject a Workdone through the token link sent to them

Parameters

Parameter	Type	Required?	Format	Description
is_client_approved	boolean	false		Whether the customer approves the work
comment	string	false		Customer comment stored with the approval

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Return

Parameter	Type	Versions	Description
200
is_transport_work	boolean	*
is_silage_transport_work	boolean	*
location_history	array	*
pause_minutes	integer	*
roster_type	array	*
duration_seconds	integer	*
paused_from_timestamp	integer	*
duration_as_text	string	*
from_time	DateTime	*
to_time	DateTime	*
silage_transports	custom handler result for (Doctrine\Common\Collections\Collection)	*	Get silageTransports.
transport_cases	custom handler result for (Doctrine\Common\Collections\Collection)	*	Get transportCases.
id	integer	*
description	string	*
start_time	DateTime	*
stop_time	DateTime	*
worker	object (Worker)	*
worktype	object (Worktype)	*
main_facility	object (Facility)	*
main_facility_start_hour	float	*
main_facility_stop_hour	float	*
secondary_facility	object (Facility)	*
agrifield	object (Agrifield)	*
kilometer_start	integer	*
kilometer_stop	integer	*
fuel_consumption	integer	*
is_approved	boolean	*
approver	object (Worker)	*
approving_time	DateTime	*
pria_sync_time	DateTime	*
hectares_served	float	*
is_mobile_initiated	boolean	*
start_latitude	float	*
start_longitude	float	*
stop_latitude	float	*
stop_longitude	float	*
material_usages[]	array of objects (MaterialUsage)	*
cost_account	object (CostAccount)	*
pause_total_duration	integer	*
is_paused	boolean	*
planitem	object (Planitem)	*
rosteritem	object (Rosteritem)	*
fuel_filling	object (FuelFilling)	*
faultitem	object (Faultitem)	*
inspection_case	object (InspectionCase)	*
is_forbidden_for_fieldbook	boolean	*
is_forbidden_for_customer	boolean	*
customer	object (Customer)	*
description_extended	string	*
is_agrifield_finished	boolean	*
hectares_displayed	float	*
yield_measured	float	*
department	object (Department)	*
crop_period	object (CropPeriod)	*
project	object (Project)	*
device_uuid	string	*
foreman_info	object (WorkdoneForemanInfo)	*	@ORM\OneToOne(targetEntity="WorkdoneForemanInfo", mappedBy="workdone" )
workdone_telemetry	object (WorkdoneTelemetry)	*	@ORM\OneToOne(targetEntity="WorkdoneTelemetry", mappedBy="workdone" )
workplace	object (Workplace)	*
workdone_pictures[]	array of objects (WorkdonePicture)	*
is_unfinished	boolean	*
is_invoiced	boolean	*
is_manual_entry	boolean	*
is_auto_created	boolean	*
is_auto_stopped	boolean	*
is_signed	boolean	*
workdone_approval	object (WorkdoneApproval)	*
workdone_budget	object (WorkdoneBudget)	*
maintenance_unit	object (Facility)	*

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT DEPRECATED /api/workdone/multisetcostaccount/{cost_account_id}

Applies cost account to multiple workdones

Documentation
Sandbox

Documentation

Applies cost account to multiple workdones. Returns the ids of the Workdones whose cost account was set

Requirements

Name	Requirement	Type	Description
cost_account_id		integer\|string	CostAccount id

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/workdones

Workdones detailed list by period

Documentation
Sandbox

Documentation

Workdones detailed list by period. Returns { pagination, collection } for the requested page of Workdones

The response has a fixed structure and may not include every field these records carry elsewhere in the API.

Parameters

Parameter	Type	Required?	Format	Description
from	date	false	YYYY-MM-DD	Date as Y-m-d, for example 2026-08-28. Defaults to the first day of the current month when omitted. Workers without ROLE_ADMIN or ROLE_OBSERVER, and any request with myworks set, never see work that started before the first day of the month 3 months ago, whatever from says.
to	date	false	YYYY-MM-DD	Date as Y-m-d, for example 2026-08-28. The whole of that day is included. When omitted the period runs to the end of the current month.
worker_id	integer	false		Filter by one Worker
worktype_id	integer	false		Filter by one Worktype
main_facility_id	integer	false		Filter by one Main Facility
cost_account_id	integer	false		Filter by one Cost Account
workobject_id	integer	false		Filter by one Workobject
only_notapproved	boolean	false		if set, show only not approved works
myworks	boolean	false		If set, show only requesting person own workdones
current_page	integer	false		Page number, 1-based. Defaults to 1.
department_ids	string	false		Comma-separated department ids to restrict the result to.
dimension	array\|comma separated string	false		Sent either as dimension[]=record&dimension[]=worker or as a comma separated list, dimension=record,worker - the two are equivalent. Not a grouping parameter on this endpoint: only two flags are read, 'only_notapproved' limits the result to work that has not been approved, and 'incl_zero_works' keeps work whose start and stop time are equal.
facility_id	integer	false		Filter by facility id.
ids	string	false		JSON array of workdone ids. Capped at the first 100.
no_dates	boolean	false		Truthy ignores the from/to range and returns records regardless of date. Workers without ROLE_ADMIN, ROLE_OBSERVER, ROLE_DISPATCHER, ROLE_VEHICLE_SERVICE or ROLE_STORAGE still never see work that started before the first day of the month 3 months ago.
output_type	integer	false		Response format: 0 JSON, 1 xls, 2 pdf.
per_page	integer	false		Page size. Defaults to 500.
project_id	integer	false		Filter by project id.

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/workdones

Create new Workdone

Documentation
Sandbox

Documentation

Creates new Workdone

Parameters

Parameter	Type	Required?	Format	Description
id	integer	false		Updates this record instead of creating one, when given.
import_type	string	false		Set to "file" to match an existing record on outer_id, id or uuid before creating - used by the import endpoints.
description	string	false		Truncated to 1000 characters.
description_extended	string	false		Truncated to 1000 characters.
start_time	datetime	false	Y-m-d H:i:s	Date and time as Y-m-d H:i:s, for example 2026-08-28 14:30:00. An empty value clears the field. Read in the company time zone. Any string PHP can parse is accepted, but a slash-separated date is read US-first, so send Y-m-d H:i:s.
stop_time	datetime	false	Y-m-d H:i:s	Date and time as Y-m-d H:i:s, for example 2026-08-28 14:30:00. An empty value clears the field. Read in the company time zone. Any string PHP can parse is accepted, but a slash-separated date is read US-first, so send Y-m-d H:i:s.
is_approved	boolean	false
is_forbidden_for_fieldbook	boolean	false
is_forbidden_for_customer	boolean	false
is_unfinished	boolean	false
is_invoiced	boolean	false
pause_total_duration	integer	false
adblue	integer	false
kilometer_start	integer	false
kilometer_stop	integer	false
fuel_consumption	integer	false
hectares_served	float	false		Decimal comma is accepted. Stored with 2 decimal places.
main_facility_start_hour	float	false		Decimal comma is accepted. Stored with 2 decimal places.
main_facility_stop_hour	float	false		Decimal comma is accepted. Stored with 2 decimal places.
worker	object	false		Reference to Worker. Send { "id": <id> }, or null to clear.
worktype	object	false		Reference to Worktype. Send { "id": <id> }, or null to clear.
main_facility	object	false		Reference to Facility. Send { "id": <id> }, or null to clear.
secondary_facility	object	false		Reference to Facility. Send { "id": <id> }, or null to clear.
agrifield	object	false		Reference to Agrifield. Send { "id": <id> }, or null to clear.
cost_account	object	false		Reference to CostAccount. Send { "id": <id> }, or null to clear.
maintenance_unit	object	false		Reference to Facility. Send { "id": <id> }, or null to clear.
customer	object	false		Reference to Customer. Send { "id": <id> }, or null to clear.
project	object	false		Reference to Project. Send { "id": <id> }, or null to clear.
department	object	false		Reference to Department. Send { "id": <id> }, or null to clear.
rosteritem	object	false		Reference to Rosteritem. Send { "id": <id> }, or null to clear.
based_on_entity_id	integer	false		Existing work the new one is copied from.
is_anonymous	boolean	false		Records the work against the anonymous worker of the company instead of the one in worker.
pause_minutes	string	false		Pause as HH:MM, or as a whole number of minutes below 1440. Converted into pause_total_duration seconds.

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Return

Parameter	Type	Versions	Description
200
is_transport_work	boolean	*
is_silage_transport_work	boolean	*
location_history	array	*
pause_minutes	integer	*
roster_type	array	*
duration_seconds	integer	*
paused_from_timestamp	integer	*
duration_as_text	string	*
from_time	DateTime	*
to_time	DateTime	*
silage_transports	custom handler result for (Doctrine\Common\Collections\Collection)	*	Get silageTransports.
transport_cases	custom handler result for (Doctrine\Common\Collections\Collection)	*	Get transportCases.
id	integer	*
description	string	*
start_time	DateTime	*
stop_time	DateTime	*
worker	object (Worker)	*
worktype	object (Worktype)	*
main_facility	object (Facility)	*
main_facility_start_hour	float	*
main_facility_stop_hour	float	*
secondary_facility	object (Facility)	*
agrifield	object (Agrifield)	*
kilometer_start	integer	*
kilometer_stop	integer	*
fuel_consumption	integer	*
is_approved	boolean	*
approver	object (Worker)	*
approving_time	DateTime	*
pria_sync_time	DateTime	*
hectares_served	float	*
is_mobile_initiated	boolean	*
start_latitude	float	*
start_longitude	float	*
stop_latitude	float	*
stop_longitude	float	*
material_usages[]	array of objects (MaterialUsage)	*
cost_account	object (CostAccount)	*
pause_total_duration	integer	*
is_paused	boolean	*
planitem	object (Planitem)	*
rosteritem	object (Rosteritem)	*
fuel_filling	object (FuelFilling)	*
faultitem	object (Faultitem)	*
inspection_case	object (InspectionCase)	*
is_forbidden_for_fieldbook	boolean	*
is_forbidden_for_customer	boolean	*
customer	object (Customer)	*
description_extended	string	*
is_agrifield_finished	boolean	*
hectares_displayed	float	*
yield_measured	float	*
department	object (Department)	*
crop_period	object (CropPeriod)	*
project	object (Project)	*
device_uuid	string	*
foreman_info	object (WorkdoneForemanInfo)	*	@ORM\OneToOne(targetEntity="WorkdoneForemanInfo", mappedBy="workdone" )
workdone_telemetry	object (WorkdoneTelemetry)	*	@ORM\OneToOne(targetEntity="WorkdoneTelemetry", mappedBy="workdone" )
workplace	object (Workplace)	*
workdone_geo_track[]	array of objects (WorkdoneGeoTrack)	*
workdone_pictures[]	array of objects (WorkdonePicture)	*
workdone_device_location	object (WorkdoneDeviceLocation)	*	@ORM\OneToOne(targetEntity="WorkdoneDeviceLocation", mappedBy="workdone" )
is_unfinished	boolean	*
is_invoiced	boolean	*
is_manual_entry	boolean	*
is_auto_created	boolean	*
is_auto_stopped	boolean	*
is_signed	boolean	*
workdone_approval	object (WorkdoneApproval)	*
workdone_budget	object (WorkdoneBudget)	*
is_deleted	boolean	*
is_archived	boolean	*
maintenance_unit	object (Facility)	*

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/workdones-list/{ids}

Simplified Workdone list for the ids given in the URL, at most 100

Documentation
Sandbox

Documentation

Simplified Workdone list for the ids given in the URL, at most 100 of them.

Each row carries an agrifield block of { id, name, field_number }, or null, when show_agrifield is set. Rows have a fixed, reduced field set — not the full Workdone representation returned by other endpoints.

Requirements

Name	Requirement	Type	Description
ids

Parameters

Parameter	Type	Required?	Format	Description
show_agrifield	boolean	false		Truthy includes workobject data in each row.

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/workdones/realtime

Ongoing Work list

Documentation
Sandbox

Documentation

Ongoing Work list

Parameters

Parameter	Type	Required?	Format	Description
department_ids	string	false		Comma-separated department ids to restrict the result to.
oneself	boolean	false		Truthy limits the result to the authenticated worker.

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Return

Parameter	Type	Versions	Description
200
distance_reported	integer	*
is_transport_work	boolean	*
is_silage_transport_work	boolean	*
location_history	array	*
server_id	integer	*
cost	double	*
pause_minutes	integer	*
roster_type	array	*
start_timestamp	integer	*
stop_timestamp	integer	*
duration_seconds	integer	*
paused_from_timestamp	integer	*
duration_as_text	string	*
pause_seconds	integer	*
from_time	DateTime	*
to_time	DateTime	*
silage_transports	custom handler result for (Doctrine\Common\Collections\Collection)	*	Get silageTransports.
transport_cases	custom handler result for (Doctrine\Common\Collections\Collection)	*	Get transportCases.
id	integer	*
description	string	*
start_time	DateTime	*
stop_time	DateTime	*
worker	object (Worker)	*
worktype	object (Worktype)	*
main_facility	object (Facility)	*
main_facility_start_hour	float	*
main_facility_stop_hour	float	*
secondary_facility	object (Facility)	*
agrifield	object (Agrifield)	*
kilometer_start	integer	*
kilometer_stop	integer	*
fuel_consumption	integer	*
is_approved	boolean	*
approver	object (Worker)	*
approving_time	DateTime	*
pria_sync_time	DateTime	*
hectares_served	float	*
is_mobile_initiated	boolean	*
start_latitude	float	*
start_longitude	float	*
stop_latitude	float	*
stop_longitude	float	*
material_usages[]	array of objects (MaterialUsage)	*
cost_account	object (CostAccount)	*
pause_str	string	*
pause_total_duration	integer	*
is_paused	boolean	*
planitem	object (Planitem)	*
rosteritem	object (Rosteritem)	*
fuel_filling	object (FuelFilling)	*
faultitem	object (Faultitem)	*
inspection_case	object (InspectionCase)	*
is_forbidden_for_fieldbook	boolean	*
is_forbidden_for_customer	boolean	*
customer	object (Customer)	*
description_extended	string	*
is_agrifield_finished	boolean	*
hectares_displayed	float	*
yield_measured	float	*
department	object (Department)	*
crop_period	object (CropPeriod)	*
project	object (Project)	*
device_uuid	string	*
foreman_info	object (WorkdoneForemanInfo)	*	@ORM\OneToOne(targetEntity="WorkdoneForemanInfo", mappedBy="workdone" )
workdone_telemetry	object (WorkdoneTelemetry)	*	@ORM\OneToOne(targetEntity="WorkdoneTelemetry", mappedBy="workdone" )
workplace	object (Workplace)	*
workdone_geo_track[]	array of objects (WorkdoneGeoTrack)	*
workdone_pictures[]	array of objects (WorkdonePicture)	*
workdone_device_location	object (WorkdoneDeviceLocation)	*	@ORM\OneToOne(targetEntity="WorkdoneDeviceLocation", mappedBy="workdone" )
is_unfinished	boolean	*
is_invoiced	boolean	*
is_manual_entry	boolean	*
is_auto_created	boolean	*
is_auto_stopped	boolean	*
is_signed	boolean	*
workdone_approval	object (WorkdoneApproval)	*
workdone_budget	object (WorkdoneBudget)	*
updated_at_timestamp	integer	*
is_deleted	boolean	*
is_archived	boolean	*
uuid	string	*
maintenance_unit	object (Facility)	*

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/workdones/{id}

Delete Workdone by ID or UUID

Documentation
Sandbox

Documentation

Deletes Workdone by ID or UUID. Returns the deleted Workdone. Refuelling Workdones cannot be deleted here: those answer 403 with { error: { slug: message.delete_refueling_from } }

Requirements

Name	Requirement	Type	Description
id		integer\|string	Workdone id or uuid

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Return

Parameter	Type	Versions	Description
200
is_transport_work	boolean	*
is_silage_transport_work	boolean	*
location_history	array	*
pause_minutes	integer	*
roster_type	array	*
duration_seconds	integer	*
paused_from_timestamp	integer	*
duration_as_text	string	*
from_time	DateTime	*
to_time	DateTime	*
silage_transports	custom handler result for (Doctrine\Common\Collections\Collection)	*	Get silageTransports.
transport_cases	custom handler result for (Doctrine\Common\Collections\Collection)	*	Get transportCases.
id	integer	*
description	string	*
start_time	DateTime	*
stop_time	DateTime	*
worker	object (Worker)	*
worktype	object (Worktype)	*
main_facility	object (Facility)	*
main_facility_start_hour	float	*
main_facility_stop_hour	float	*
secondary_facility	object (Facility)	*
agrifield	object (Agrifield)	*
kilometer_start	integer	*
kilometer_stop	integer	*
fuel_consumption	integer	*
is_approved	boolean	*
approver	object (Worker)	*
approving_time	DateTime	*
pria_sync_time	DateTime	*
hectares_served	float	*
is_mobile_initiated	boolean	*
start_latitude	float	*
start_longitude	float	*
stop_latitude	float	*
stop_longitude	float	*
material_usages[]	array of objects (MaterialUsage)	*
cost_account	object (CostAccount)	*
pause_total_duration	integer	*
is_paused	boolean	*
planitem	object (Planitem)	*
rosteritem	object (Rosteritem)	*
fuel_filling	object (FuelFilling)	*
faultitem	object (Faultitem)	*
inspection_case	object (InspectionCase)	*
is_forbidden_for_fieldbook	boolean	*
is_forbidden_for_customer	boolean	*
customer	object (Customer)	*
description_extended	string	*
is_agrifield_finished	boolean	*
hectares_displayed	float	*
yield_measured	float	*
department	object (Department)	*
crop_period	object (CropPeriod)	*
project	object (Project)	*
device_uuid	string	*
foreman_info	object (WorkdoneForemanInfo)	*	@ORM\OneToOne(targetEntity="WorkdoneForemanInfo", mappedBy="workdone" )
workdone_telemetry	object (WorkdoneTelemetry)	*	@ORM\OneToOne(targetEntity="WorkdoneTelemetry", mappedBy="workdone" )
workplace	object (Workplace)	*
workdone_pictures[]	array of objects (WorkdonePicture)	*
is_unfinished	boolean	*
is_invoiced	boolean	*
is_manual_entry	boolean	*
is_auto_created	boolean	*
is_auto_stopped	boolean	*
is_signed	boolean	*
workdone_approval	object (WorkdoneApproval)	*
workdone_budget	object (WorkdoneBudget)	*
is_deleted	boolean	*
is_archived	boolean	*
maintenance_unit	object (Facility)	*

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/workdones/{id}

Workdone by ID or UUID

Documentation
Sandbox

Documentation

Returns Workdone by ID or UUID

Requirements

Name	Requirement	Type	Description
id		integer\|string	Workdone id or uuid

Parameters

Parameter	Type	Required?	Format	Description
groups	string	false		Comma-separated subset of the serializer groups this endpoint offers (workdone, workdone_all, owner, classificator, geo, baseattribute). Narrows the response to those groups, dropping the nested objects the others add; a group not offered here is refused with 400.

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Return

Parameter	Type	Versions	Description
200
is_transport_work	boolean	*
is_silage_transport_work	boolean	*
location_history	array	*
pause_minutes	integer	*
roster_type	array	*
duration_seconds	integer	*
paused_from_timestamp	integer	*
duration_as_text	string	*
from_time	DateTime	*
to_time	DateTime	*
silage_transports	custom handler result for (Doctrine\Common\Collections\Collection)	*	Get silageTransports.
transport_cases	custom handler result for (Doctrine\Common\Collections\Collection)	*	Get transportCases.
id	integer	*
description	string	*
start_time	DateTime	*
stop_time	DateTime	*
worker	object (Worker)	*
worktype	object (Worktype)	*
main_facility	object (Facility)	*
main_facility_start_hour	float	*
main_facility_stop_hour	float	*
secondary_facility	object (Facility)	*
agrifield	object (Agrifield)	*
kilometer_start	integer	*
kilometer_stop	integer	*
fuel_consumption	integer	*
is_approved	boolean	*
approver	object (Worker)	*
approving_time	DateTime	*
pria_sync_time	DateTime	*
hectares_served	float	*
is_mobile_initiated	boolean	*
start_latitude	float	*
start_longitude	float	*
stop_latitude	float	*
stop_longitude	float	*
material_usages[]	array of objects (MaterialUsage)	*
cost_account	object (CostAccount)	*
pause_total_duration	integer	*
is_paused	boolean	*
planitem	object (Planitem)	*
rosteritem	object (Rosteritem)	*
fuel_filling	object (FuelFilling)	*
faultitem	object (Faultitem)	*
inspection_case	object (InspectionCase)	*
is_forbidden_for_fieldbook	boolean	*
is_forbidden_for_customer	boolean	*
customer	object (Customer)	*
description_extended	string	*
is_agrifield_finished	boolean	*
hectares_displayed	float	*
yield_measured	float	*
department	object (Department)	*
crop_period	object (CropPeriod)	*
project	object (Project)	*
device_uuid	string	*
foreman_info	object (WorkdoneForemanInfo)	*	@ORM\OneToOne(targetEntity="WorkdoneForemanInfo", mappedBy="workdone" )
workdone_telemetry	object (WorkdoneTelemetry)	*	@ORM\OneToOne(targetEntity="WorkdoneTelemetry", mappedBy="workdone" )
workplace	object (Workplace)	*
workdone_geo_track[]	array of objects (WorkdoneGeoTrack)	*
workdone_pictures[]	array of objects (WorkdonePicture)	*
workdone_device_location	object (WorkdoneDeviceLocation)	*	@ORM\OneToOne(targetEntity="WorkdoneDeviceLocation", mappedBy="workdone" )
is_unfinished	boolean	*
is_invoiced	boolean	*
is_manual_entry	boolean	*
is_auto_created	boolean	*
is_auto_stopped	boolean	*
is_signed	boolean	*
workdone_approval	object (WorkdoneApproval)	*
workdone_budget	object (WorkdoneBudget)	*
updated_at_timestamp	integer	*
is_deleted	boolean	*
is_archived	boolean	*
uuid	string	*
maintenance_unit	object (Facility)	*

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/workdones/{id}

Modify Workdone

Documentation
Sandbox

Documentation

Modify Workdone

Requirements

Name	Requirement	Type	Description
id		integer\|string	Workdone id or uuid

Parameters

Parameter	Type	Required?	Format	Description
id	integer	true		Id of the record being updated. Must match the id in the URL.
description	string	false		Truncated to 1000 characters.
description_extended	string	false		Truncated to 1000 characters.
start_time	datetime	false	Y-m-d H:i:s	Date and time as Y-m-d H:i:s, for example 2026-08-28 14:30:00. An empty value clears the field. Read in the company time zone. Any string PHP can parse is accepted, but a slash-separated date is read US-first, so send Y-m-d H:i:s.
stop_time	datetime	false	Y-m-d H:i:s	Date and time as Y-m-d H:i:s, for example 2026-08-28 14:30:00. An empty value clears the field. Read in the company time zone. Any string PHP can parse is accepted, but a slash-separated date is read US-first, so send Y-m-d H:i:s.
is_approved	boolean	false
is_forbidden_for_fieldbook	boolean	false
is_forbidden_for_customer	boolean	false
is_unfinished	boolean	false
is_invoiced	boolean	false
pause_total_duration	integer	false
adblue	integer	false
kilometer_start	integer	false
kilometer_stop	integer	false
fuel_consumption	integer	false
hectares_served	float	false		Decimal comma is accepted. Stored with 2 decimal places.
main_facility_start_hour	float	false		Decimal comma is accepted. Stored with 2 decimal places.
main_facility_stop_hour	float	false		Decimal comma is accepted. Stored with 2 decimal places.
worker	object	false		Reference to Worker. Send { "id": <id> }, or null to clear.
worktype	object	false		Reference to Worktype. Send { "id": <id> }, or null to clear.
main_facility	object	false		Reference to Facility. Send { "id": <id> }, or null to clear.
secondary_facility	object	false		Reference to Facility. Send { "id": <id> }, or null to clear.
agrifield	object	false		Reference to Agrifield. Send { "id": <id> }, or null to clear.
cost_account	object	false		Reference to CostAccount. Send { "id": <id> }, or null to clear.
maintenance_unit	object	false		Reference to Facility. Send { "id": <id> }, or null to clear.
customer	object	false		Reference to Customer. Send { "id": <id> }, or null to clear.
project	object	false		Reference to Project. Send { "id": <id> }, or null to clear.
department	object	false		Reference to Department. Send { "id": <id> }, or null to clear.
rosteritem	object	false		Reference to Rosteritem. Send { "id": <id> }, or null to clear.
pause_minutes	string	false		Pause as HH:MM, or as a whole number of minutes below 1440. Converted into pause_total_duration seconds. Ignored when the workdone follows a rosteritem.

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Return

Parameter	Type	Versions	Description
200
is_transport_work	boolean	*
is_silage_transport_work	boolean	*
location_history	array	*
pause_minutes	integer	*
roster_type	array	*
duration_seconds	integer	*
paused_from_timestamp	integer	*
duration_as_text	string	*
from_time	DateTime	*
to_time	DateTime	*
silage_transports	custom handler result for (Doctrine\Common\Collections\Collection)	*	Get silageTransports.
transport_cases	custom handler result for (Doctrine\Common\Collections\Collection)	*	Get transportCases.
id	integer	*
description	string	*
start_time	DateTime	*
stop_time	DateTime	*
worker	object (Worker)	*
worktype	object (Worktype)	*
main_facility	object (Facility)	*
main_facility_start_hour	float	*
main_facility_stop_hour	float	*
secondary_facility	object (Facility)	*
agrifield	object (Agrifield)	*
kilometer_start	integer	*
kilometer_stop	integer	*
fuel_consumption	integer	*
is_approved	boolean	*
approver	object (Worker)	*
approving_time	DateTime	*
pria_sync_time	DateTime	*
hectares_served	float	*
is_mobile_initiated	boolean	*
start_latitude	float	*
start_longitude	float	*
stop_latitude	float	*
stop_longitude	float	*
material_usages[]	array of objects (MaterialUsage)	*
cost_account	object (CostAccount)	*
pause_total_duration	integer	*
is_paused	boolean	*
planitem	object (Planitem)	*
rosteritem	object (Rosteritem)	*
fuel_filling	object (FuelFilling)	*
faultitem	object (Faultitem)	*
inspection_case	object (InspectionCase)	*
is_forbidden_for_fieldbook	boolean	*
is_forbidden_for_customer	boolean	*
customer	object (Customer)	*
description_extended	string	*
is_agrifield_finished	boolean	*
hectares_displayed	float	*
yield_measured	float	*
department	object (Department)	*
crop_period	object (CropPeriod)	*
project	object (Project)	*
device_uuid	string	*
foreman_info	object (WorkdoneForemanInfo)	*	@ORM\OneToOne(targetEntity="WorkdoneForemanInfo", mappedBy="workdone" )
workdone_telemetry	object (WorkdoneTelemetry)	*	@ORM\OneToOne(targetEntity="WorkdoneTelemetry", mappedBy="workdone" )
workplace	object (Workplace)	*
workdone_geo_track[]	array of objects (WorkdoneGeoTrack)	*
workdone_pictures[]	array of objects (WorkdonePicture)	*
workdone_device_location	object (WorkdoneDeviceLocation)	*	@ORM\OneToOne(targetEntity="WorkdoneDeviceLocation", mappedBy="workdone" )
is_unfinished	boolean	*
is_invoiced	boolean	*
is_manual_entry	boolean	*
is_auto_created	boolean	*
is_auto_stopped	boolean	*
is_signed	boolean	*
workdone_approval	object (WorkdoneApproval)	*
workdone_budget	object (WorkdoneBudget)	*
updated_at_timestamp	integer	*
is_deleted	boolean	*
is_archived	boolean	*
uuid	string	*
maintenance_unit	object (Facility)	*

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/workdones/{wdid}/materialusages

Workdone collection

Documentation
Sandbox

Documentation

Returns Workdone Material collection

Requirements

Name	Requirement	Type	Description
wdid		integer\|string	Workdone id

Parameters

Parameter	Type	Required?	Format	Description
groups	string	false		Comma-separated subset of the serializer groups this endpoint offers (workdone, workdone_all, owner, classificator, geo). Narrows the response to those groups, dropping the nested objects the others add; a group not offered here is refused with 400.

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Return

Parameter	Type	Versions	Description
200
harvest	object (Harvest)	*
id	integer	*
material	object (Material)	*
storage	object (Agrifield)	*	Storage id Undefined storage has id = 1
amount	float	*
ratio_per_hectare	float	*
is_forbidden_for_fieldbook	boolean	*
is_forbidden_for_material_report	boolean	*
is_inbound	boolean	*	Inbound = production/buy, Outbound = cost/sell
is_deleted	boolean	*
is_archived	boolean	*

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/workdones/{wdid}/materialusages

Creates new MaterialUsage for workdone

Documentation
Sandbox

Documentation

Creates new MaterialUsage for workdone

Requirements

Name	Requirement	Type	Description
wdid		integer\|string	Workdone id

Parameters

Parameter	Type	Required?	Description
crop_layer_type	object	false	Reference to CropLayerType. Send { "id": <id> }, or null to clear.
harvest_type	object	false	Reference to HarvestType. Send { "id": <id> }, or null to clear.
harvest	object	false	Harvest record written alongside the material usage.
wdid	integer	true	Bounded Workdone ID

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Return

Parameter	Type	Versions	Description
200
is_transport_work	boolean	*
is_silage_transport_work	boolean	*
location_history	array	*
pause_minutes	integer	*
roster_type	array	*
duration_seconds	integer	*
paused_from_timestamp	integer	*
duration_as_text	string	*
from_time	DateTime	*
to_time	DateTime	*
silage_transports	custom handler result for (Doctrine\Common\Collections\Collection)	*	Get silageTransports.
transport_cases	custom handler result for (Doctrine\Common\Collections\Collection)	*	Get transportCases.
id	integer	*
description	string	*
start_time	DateTime	*
stop_time	DateTime	*
worker	object (Worker)	*
worktype	object (Worktype)	*
main_facility	object (Facility)	*
main_facility_start_hour	float	*
main_facility_stop_hour	float	*
secondary_facility	object (Facility)	*
agrifield	object (Agrifield)	*
kilometer_start	integer	*
kilometer_stop	integer	*
fuel_consumption	integer	*
is_approved	boolean	*
approver	object (Worker)	*
approving_time	DateTime	*
pria_sync_time	DateTime	*
hectares_served	float	*
is_mobile_initiated	boolean	*
start_latitude	float	*
start_longitude	float	*
stop_latitude	float	*
stop_longitude	float	*
material_usages[]	array of objects (MaterialUsage)	*
cost_account	object (CostAccount)	*
pause_total_duration	integer	*
is_paused	boolean	*
planitem	object (Planitem)	*
rosteritem	object (Rosteritem)	*
fuel_filling	object (FuelFilling)	*
faultitem	object (Faultitem)	*
inspection_case	object (InspectionCase)	*
is_forbidden_for_fieldbook	boolean	*
is_forbidden_for_customer	boolean	*
customer	object (Customer)	*
description_extended	string	*
is_agrifield_finished	boolean	*
hectares_displayed	float	*
yield_measured	float	*
department	object (Department)	*
crop_period	object (CropPeriod)	*
project	object (Project)	*
device_uuid	string	*
foreman_info	object (WorkdoneForemanInfo)	*	@ORM\OneToOne(targetEntity="WorkdoneForemanInfo", mappedBy="workdone" )
workdone_telemetry	object (WorkdoneTelemetry)	*	@ORM\OneToOne(targetEntity="WorkdoneTelemetry", mappedBy="workdone" )
workplace	object (Workplace)	*
workdone_geo_track[]	array of objects (WorkdoneGeoTrack)	*
workdone_pictures[]	array of objects (WorkdonePicture)	*
workdone_device_location	object (WorkdoneDeviceLocation)	*	@ORM\OneToOne(targetEntity="WorkdoneDeviceLocation", mappedBy="workdone" )
is_unfinished	boolean	*
is_invoiced	boolean	*
is_manual_entry	boolean	*
is_auto_created	boolean	*
is_auto_stopped	boolean	*
is_signed	boolean	*
workdone_approval	object (WorkdoneApproval)	*
workdone_budget	object (WorkdoneBudget)	*
is_deleted	boolean	*
is_archived	boolean	*
maintenance_unit	object (Facility)	*

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/workdones/{wdid}/materialusages/{usageid}

Deletes a material usage of a Workdone

Documentation
Sandbox

Documentation

Deletes a material usage of a Workdone. Returns the parent Workdone, not the removed usage

Requirements

Name	Requirement	Type	Description
usageid		integer\|string	MaterialUsage id
wdid		integer\|string	Workdone id

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Return

Parameter	Type	Versions	Description
200
is_transport_work	boolean	*
is_silage_transport_work	boolean	*
location_history	array	*
pause_minutes	integer	*
roster_type	array	*
duration_seconds	integer	*
paused_from_timestamp	integer	*
duration_as_text	string	*
from_time	DateTime	*
to_time	DateTime	*
silage_transports	custom handler result for (Doctrine\Common\Collections\Collection)	*	Get silageTransports.
transport_cases	custom handler result for (Doctrine\Common\Collections\Collection)	*	Get transportCases.
id	integer	*
description	string	*
start_time	DateTime	*
stop_time	DateTime	*
worker	object (Worker)	*
worktype	object (Worktype)	*
main_facility	object (Facility)	*
main_facility_start_hour	float	*
main_facility_stop_hour	float	*
secondary_facility	object (Facility)	*
agrifield	object (Agrifield)	*
kilometer_start	integer	*
kilometer_stop	integer	*
fuel_consumption	integer	*
is_approved	boolean	*
approver	object (Worker)	*
approving_time	DateTime	*
pria_sync_time	DateTime	*
hectares_served	float	*
is_mobile_initiated	boolean	*
start_latitude	float	*
start_longitude	float	*
stop_latitude	float	*
stop_longitude	float	*
material_usages[]	array of objects (MaterialUsage)	*
cost_account	object (CostAccount)	*
pause_total_duration	integer	*
is_paused	boolean	*
planitem	object (Planitem)	*
rosteritem	object (Rosteritem)	*
fuel_filling	object (FuelFilling)	*
faultitem	object (Faultitem)	*
inspection_case	object (InspectionCase)	*
is_forbidden_for_fieldbook	boolean	*
is_forbidden_for_customer	boolean	*
customer	object (Customer)	*
description_extended	string	*
is_agrifield_finished	boolean	*
hectares_displayed	float	*
yield_measured	float	*
department	object (Department)	*
crop_period	object (CropPeriod)	*
project	object (Project)	*
device_uuid	string	*
foreman_info	object (WorkdoneForemanInfo)	*	@ORM\OneToOne(targetEntity="WorkdoneForemanInfo", mappedBy="workdone" )
workdone_telemetry	object (WorkdoneTelemetry)	*	@ORM\OneToOne(targetEntity="WorkdoneTelemetry", mappedBy="workdone" )
workplace	object (Workplace)	*
workdone_geo_track[]	array of objects (WorkdoneGeoTrack)	*
workdone_pictures[]	array of objects (WorkdonePicture)	*
workdone_device_location	object (WorkdoneDeviceLocation)	*	@ORM\OneToOne(targetEntity="WorkdoneDeviceLocation", mappedBy="workdone" )
is_unfinished	boolean	*
is_invoiced	boolean	*
is_manual_entry	boolean	*
is_auto_created	boolean	*
is_auto_stopped	boolean	*
is_signed	boolean	*
workdone_approval	object (WorkdoneApproval)	*
workdone_budget	object (WorkdoneBudget)	*
is_deleted	boolean	*
is_archived	boolean	*
maintenance_unit	object (Facility)	*

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/workdones/{wdid}/recalcmaterialusages

Recalc material usage for workdone

Documentation
Sandbox

Documentation

recalc MaterialUsage for workdone

Requirements

Name	Requirement	Type	Description
wdid		integer\|string	Workdone id

Parameters

Parameter	Type	Required?	Format	Description
recalc	object	true		Recalculation instructions, keyed by material usage id.
wdid	integer	true		Bounded Workdone ID

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Return

Parameter	Type	Versions	Description
200
is_transport_work	boolean	*
is_silage_transport_work	boolean	*
location_history	array	*
pause_minutes	integer	*
roster_type	array	*
duration_seconds	integer	*
paused_from_timestamp	integer	*
duration_as_text	string	*
from_time	DateTime	*
to_time	DateTime	*
silage_transports	custom handler result for (Doctrine\Common\Collections\Collection)	*	Get silageTransports.
transport_cases	custom handler result for (Doctrine\Common\Collections\Collection)	*	Get transportCases.
id	integer	*
description	string	*
start_time	DateTime	*
stop_time	DateTime	*
worker	object (Worker)	*
worktype	object (Worktype)	*
main_facility	object (Facility)	*
main_facility_start_hour	float	*
main_facility_stop_hour	float	*
secondary_facility	object (Facility)	*
agrifield	object (Agrifield)	*
kilometer_start	integer	*
kilometer_stop	integer	*
fuel_consumption	integer	*
is_approved	boolean	*
approver	object (Worker)	*
approving_time	DateTime	*
pria_sync_time	DateTime	*
hectares_served	float	*
is_mobile_initiated	boolean	*
start_latitude	float	*
start_longitude	float	*
stop_latitude	float	*
stop_longitude	float	*
material_usages[]	array of objects (MaterialUsage)	*
cost_account	object (CostAccount)	*
pause_total_duration	integer	*
is_paused	boolean	*
planitem	object (Planitem)	*
rosteritem	object (Rosteritem)	*
fuel_filling	object (FuelFilling)	*
faultitem	object (Faultitem)	*
inspection_case	object (InspectionCase)	*
is_forbidden_for_fieldbook	boolean	*
is_forbidden_for_customer	boolean	*
customer	object (Customer)	*
description_extended	string	*
is_agrifield_finished	boolean	*
hectares_displayed	float	*
yield_measured	float	*
department	object (Department)	*
crop_period	object (CropPeriod)	*
project	object (Project)	*
device_uuid	string	*
foreman_info	object (WorkdoneForemanInfo)	*	@ORM\OneToOne(targetEntity="WorkdoneForemanInfo", mappedBy="workdone" )
workdone_telemetry	object (WorkdoneTelemetry)	*	@ORM\OneToOne(targetEntity="WorkdoneTelemetry", mappedBy="workdone" )
workplace	object (Workplace)	*
workdone_geo_track[]	array of objects (WorkdoneGeoTrack)	*
workdone_pictures[]	array of objects (WorkdonePicture)	*
workdone_device_location	object (WorkdoneDeviceLocation)	*	@ORM\OneToOne(targetEntity="WorkdoneDeviceLocation", mappedBy="workdone" )
is_unfinished	boolean	*
is_invoiced	boolean	*
is_manual_entry	boolean	*
is_auto_created	boolean	*
is_auto_stopped	boolean	*
is_signed	boolean	*
workdone_approval	object (WorkdoneApproval)	*
workdone_budget	object (WorkdoneBudget)	*
is_deleted	boolean	*
is_archived	boolean	*
maintenance_unit	object (Facility)	*

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/workdonesbyperiod

Worked hours per worker per day over a period

Documentation
Sandbox

Documentation

Worked hours per worker per day over a period.

Returns an array of objects with: dates, data, workers, period_cutted.

dates lists the days of the period plus a trailing SUM column, data is keyed by worker id, and workers holds the workers the caller is allowed to see. period_cutted is true when the requested range is longer than 31 days - the response then covers only the first 31 days.

Parameters

Parameter	Type	Required?	Format	Description
only_notapproved	boolean	false
from	date	false	YYYY-MM-DD	Date as Y-m-d, for example 2026-08-28. Defaults to the first day of the current month when omitted.
to	date	false	YYYY-MM-DD	Date as Y-m-d, for example 2026-08-28. The whole of that day is included. When omitted the period runs to the end of the current month.
worker_id	integer	false		Worker id
worktype_id	integer	false		Worktype id
main_facility_id	integer	false		Facility id used as the main facility
cost_account_id	integer	false		CostAccount id
myworks	integer	false
project_id	integer	false		Filter by project id.

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/works/{token}/{firstId}/{lastId}/{ids}

Detailed work rows with their material usage, shared through a link

Documentation
Sandbox

Documentation

Detailed work rows with their material usage, shared through a link instead of an API key.

Returns an array of objects with: workdone_telemetry, details, id, material, material_id, material_name, amount, ratio_per_hectare.

The link authenticates the request on its own, so no api key is needed. It works only in the exact {token}/{firstId}/{lastId}/ form it was issued in; anything else returns HTTP 200 with { error_slug: alert.incorrect_url }.

Requirements

Name	Type	Description
firstId	integer\|string	Lowest Workdone id of the range
lastId	integer\|string	Highest Workdone id of the range
token
ids

Parameters

Parameter	Type	Required?	Format	Description
only_notapproved	boolean	false
from	date	false	YYYY-MM-DD	Date as Y-m-d, for example 2026-08-28.
to	date	false	YYYY-MM-DD	Date as Y-m-d, for example 2026-08-28.
worker_id	integer	false		Worker id
worktype_id	integer	false		Worktype id
main_facility_id	integer	false		Facility id used as the main facility
cost_account_id	integer	false		CostAccount id
myworks	integer	false
department_ids	string	false		Comma-separated department ids to restrict the result to.
output_type	integer	false		Response format: 0 JSON, 1 xls, 2 pdf.
project_id	integer	false		Filter by project id.
groups	string	false		Comma-separated subset of the serializer groups this endpoint offers (default, workdone, owner). Narrows the response to those groups, dropping the nested objects the others add; a group not offered here is refused with 400.

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST DEPRECATED /api/worksms
- Creates new Workdone from SMS
- Documentation
- Sandbox
Documentation

Creates new Workdone from SMS. Returns { workdone, action }
Input

Headers
= -

Content
= Replaces header if set
Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/worktimereports/calendaritem

Calendar items currently in progress

Documentation
Sandbox

Documentation

Calendar items currently in progress. Pass oneself=1 to limit the result to the authenticated worker.

Parameters

Parameter	Type	Required?	Format	Description
oneself	boolean	false		Truthy limits the result to the authenticated worker.
groups	string	false		Comma-separated subset of the serializer groups this endpoint offers (calendaritem). Narrows the response to those groups, dropping the nested objects the others add; a group not offered here is refused with 400.

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Return

Parameter	Type	Versions	Description
200
id	integer	*
from_time	DateTime	*
to_time	DateTime	*
name	string	*	Rosteritem name, Utf8 string 255 chars. Auto generated based on shift, fromTime, toTime
fullname	string	*	Rosteritem fullname, Utf8 string 255 chars. Auto generated based on shift, fromTime, toTime, and related Entities names
worker	object (Worker)	*
worktype	object (Worktype)	*
shift	object (Shift)	*
description	string	*
pause_seconds	integer	*
workdone	object (Workdone)	*
agrifield	object (Agrifield)	*
foreman	object (Worker)	*
main_facility	object (Facility)	*
secondary_facility	object (Facility)	*
customer	object (Customer)	*
customer_person	object (CustomerPerson)	*	Customer contact person
provider	object (Customer)	*
cost_account	object (CostAccount)	*
project	object (Project)	*
roster_type	object (RosterType)	*	Classificator about calendar item type work, - usual type, wide green color unavailable, - (translate to "vacation" if rosteritem has worker set) - slim red color emergency, - (translate to "sickness" if rosteritem has worker set) - slim red color
roster_status	object (RosterStatus)	*	Classificator about (Worker) assignment status open, - Worker not assigned - orange color taken, - Worker has created or assigned herself Open or Reopen status item: to be accepted by Boss - red color, assigned, - Worker assignment is accepted by Boss - green color, reopen, - assigned Worker has refused to do it - orange color,
outer_id	string	*	Event subject
rosteritem_recurrence	object (RosteritemRecurrence)	*
company	object (Company)	*	Object owner
maintenance_unit	object (Facility)	*

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/worktimereports/realtime

Work currently in progress, with worker, facility and worktype

Documentation
Sandbox

Documentation

Work currently in progress, with worker, facility and worktype. Pass oneself=1 to limit the result to the authenticated worker.

Parameters

Parameter	Type	Required?	Format	Description
oneself	boolean	false		Truthy limits the result to the authenticated worker.
groups	string	false		Comma-separated subset of the serializer groups this endpoint offers (workdone). Narrows the response to those groups, dropping the nested objects the others add; a group not offered here is refused with 400.

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Return

Parameter	Type	Versions	Description
200
location_history	array	*
pause_minutes	integer	*
roster_type	array	*
duration_seconds	integer	*
paused_from_timestamp	integer	*
duration_as_text	string	*
from_time	DateTime	*
to_time	DateTime	*
id	integer	*
description	string	*
start_time	DateTime	*
stop_time	DateTime	*
worker	object (Worker)	*
worktype	object (Worktype)	*
main_facility	object (Facility)	*
main_facility_start_hour	float	*
main_facility_stop_hour	float	*
secondary_facility	object (Facility)	*
agrifield	object (Agrifield)	*
kilometer_start	integer	*
kilometer_stop	integer	*
fuel_consumption	integer	*
is_approved	boolean	*
approver	object (Worker)	*
approving_time	DateTime	*
pria_sync_time	DateTime	*
hectares_served	float	*
is_mobile_initiated	boolean	*
start_latitude	float	*
start_longitude	float	*
stop_latitude	float	*
stop_longitude	float	*
material_usages[]	array of objects (MaterialUsage)	*
cost_account	object (CostAccount)	*
pause_total_duration	integer	*
is_paused	boolean	*
planitem	object (Planitem)	*
rosteritem	object (Rosteritem)	*
fuel_filling	object (FuelFilling)	*
faultitem	object (Faultitem)	*
inspection_case	object (InspectionCase)	*
is_forbidden_for_fieldbook	boolean	*
is_forbidden_for_customer	boolean	*
customer	object (Customer)	*
description_extended	string	*
is_agrifield_finished	boolean	*
hectares_displayed	float	*
yield_measured	float	*
department	object (Department)	*
crop_period	object (CropPeriod)	*
project	object (Project)	*
device_uuid	string	*
foreman_info	object (WorkdoneForemanInfo)	*	@ORM\OneToOne(targetEntity="WorkdoneForemanInfo", mappedBy="workdone" )
workdone_telemetry	object (WorkdoneTelemetry)	*	@ORM\OneToOne(targetEntity="WorkdoneTelemetry", mappedBy="workdone" )
workdone_pictures[]	array of objects (WorkdonePicture)	*
is_unfinished	boolean	*
is_invoiced	boolean	*
is_manual_entry	boolean	*
is_auto_created	boolean	*
is_auto_stopped	boolean	*
is_signed	boolean	*
workdone_approval	object (WorkdoneApproval)	*
workdone_budget	object (WorkdoneBudget)	*
maintenance_unit	object (Facility)	*

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Ttki

TTKI is the Estonian construction site registry, reached over X-Road. A worker starts and stops work by presenting a card at a reader on a work area, so these routes authenticate by card number rather than by api key. These endpoints start and stop work, list the work areas available to a card, and read the works recorded against one. Employment chains, constructions and employee lists are imported from the registry. Work recorded this way becomes an ordinary Workdone in Terake.

GET /api/get-chain-details/{uuid}

Fetches the details of one construction employment chain over X-Road

Documentation
Sandbox

Documentation

Fetches the details of one construction employment chain over X-Road. Returns { response_code }

Requirements

Name	Requirement	Type	Description
uuid		integer\|string	Employment chain uuid in the TTKI registry

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/get-chain-workers-list/{uuid}

Imports the workers of one construction employment chain over X-Road

Documentation
Sandbox

Documentation

Imports the workers of one construction employment chain over X-Road. Returns { response_code } from the X-Road call

Requirements

Name	Requirement	Type	Description
uuid		integer\|string	Employment chain uuid in the TTKI registry

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/get-constructions-list

Imports Constructions using X-tee

Documentation
Sandbox

Documentation

Imports Constructions using X-tee. Returns the TTKI constructions mapped for the company

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/get-tor-employees-list

Imports TOR Employees using X-tee

Documentation
Sandbox

Documentation

Imports TOR Employees using X-tee. Not implemented. Always returns { error: Not implemented yet }

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/get-ttki-employees-list

Imports TTKI Employees using X-tee

Documentation
Sandbox

Documentation

Imports TTKI Employees using X-tee. Returns the TTKI employees of the company, or an error object when the registry returns none

The response has a fixed structure and may not include every field these records carry elsewhere in the API.

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/get-ttki-file-content/{file_id}

Shows content of sent XML file

Documentation
Sandbox

Documentation

Shows content of sent XML file. Returns the request XML of the stored X-Road file, decoded into an array

Requirements

Name	Requirement	Type	Description
file_id		integer\|string	IntegrationPartnerFile id

Parameters

Parameter	Type	Required?	Format	Description
groups	string	false		Comma-separated subset of the serializer groups this endpoint offers (integration). Narrows the response to those groups, dropping the nested objects the others add; a group not offered here is refused with 400.

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/get-ttki-workareas-list

Work areas available to the company in the TTKI registry, fetched over X-Road

Documentation
Sandbox

Documentation

Work areas available to the company in the TTKI registry, fetched over X-Road. Returns the TTKI work areas mapped for the company

Parameters

Parameter	Type	Required?	Format	Description
groups	string	false		Comma-separated subset of the serializer groups this endpoint offers (integration, auditcolumns). Narrows the response to those groups, dropping the nested objects the others add; a group not offered here is refused with 400.

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET DEPRECATED /api/get-work-area-cards-list/{uuid}

Get Work Area Cards List using X-tee

Documentation
Sandbox

Documentation

Returns Work Area Cards List using X-tee. Returns the work area card list answered by X-Road

Requirements

Name	Requirement	Type	Description
uuid		integer\|string	TTKI work area uuid

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/is-workfields-app-in-use

Whether the company has any TTKI work recorded through the Workfields app

Documentation
Sandbox

Documentation

Whether the company has any TTKI work recorded through the Workfields app. Returns true or false

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST DEPRECATED /api/relate-partner-object/agrifield

Makes relation between Xtee Töömaa and Terake Workobject

Documentation
Sandbox

Documentation

Makes relation between Xtee Töömaa and Terake Workobject. Returns the partner workobject after mapping it to the Terake object

Parameters

Parameter	Type	Required?	Format	Description
outer_id	string	false		Query parameter outer_id
workobject	string	false		Query parameter workobject

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST DEPRECATED /api/relate-partner-object/workobject

Makes relation between Xtee Töömaa and Terake Workobject

Documentation
Sandbox

Documentation

Makes relation between Xtee Töömaa and Terake Workobject. Returns the partner workobject after mapping it to the Terake object

Parameters

Parameter	Type	Required?	Format	Description
outer_id	string	false		Query parameter outer_id
workobject	string	false		Query parameter workobject

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/ttki-status

Approved and unapproved workdone counts per day for a period

Documentation
Sandbox

Documentation

Approved and unapproved workdone counts per day for a period, as reported by the TTKI registry over X-Road. Returns approved and unapproved workdone counts per day, each carrying a workarea block

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/worktimereports/ttki-ongoing

Ongoing works started by the TTKI solution

Documentation
Sandbox

Documentation

Ongoing works started by the TTKI solution. Returns the TTKI works currently in progress, each carrying worker, workarea and company blocks

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/worktimereports/ttki-works

Finished works started by the TTKI solution

Documentation
Sandbox

Documentation

Finished works started by the TTKI solution. Returns the finished TTKI works, each carrying worker, workarea and company blocks

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /ttki/start/{card_number}/{workarea_uuid}

Card number starts work on a workarea

Documentation
Sandbox

Documentation

Card number starts work on a workarea. Returns { success, time }

Requirements

Name	Requirement	Type	Description
workarea_uuid		integer\|string	TTKI work area uuid
card_number		string	Personal card number

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /ttki/stop/{card_number}

Card number stops work on a workarea

Documentation
Sandbox

Documentation

Card number stops work on a workarea. Returns { success, time }

Requirements

Name	Requirement	Type	Description
workarea_uuid		integer\|string	TTKI work area uuid
card_number		string	Personal card number

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /ttki/stop/{card_number}/{workarea_uuid}

Card number stops work on a workarea

Documentation
Sandbox

Documentation

Card number stops work on a workarea. Returns { success, time }

Requirements

Name	Requirement	Type	Description
workarea_uuid		integer\|string	TTKI work area uuid
card_number		string	Personal card number

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /ttki/workareas/{card_number}

Returns array of workareas available for Card Number.

Documentation
Sandbox

Documentation

Returns array of workareas available for Card Number.

Requirements

Name	Requirement	Type	Description
card_number		string	Personal card number

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /ttki/works/{card_number}

Works of one card number

Documentation
Sandbox

Documentation

Works of one card number. Returns the works of the card holder, each carrying a company block

Requirements

Name	Requirement	Type	Description
card_number		string	Personal card number

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Terake API

Workdones

Dates and times

Workdones

DELETE /api/materialusages/{usageid}

Documentation

Requirements

Headers

Return

200

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/office-hours

Documentation

Parameters

Headers

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/startwork

Documentation

Parameters

Headers

Return

200

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/stopwork/{id}

Documentation

Requirements

Headers

Return

200

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/workdone/approve/{id}

Documentation

Requirements

Headers

Return

200

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/workdone/approve_client

Documentation

Parameters

Headers

Return

200

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT DEPRECATED /api/workdone/multisetcostaccount/{cost_account_id}

Documentation

Requirements

Headers

Requirements

Request URL