Machinery and what it consumes: facilities, parts, fuel, fuel balances, transport, faults, identificators.
Dates and times
Send a date as Y-m-d and a date with a time as Y-m-d H:i:s, for
example 2026-08-28 and 2026-08-28 14:30:00. Values are read in the
company time zone. Other spellings PHP can parse are usually accepted, but a slash-separated
date is read month-first, so send Y-m-d and avoid the ambiguity. A duration is
HH:MM or HH:MM:SS, or a plain number of seconds.
Responses return dates and times in ISO 8601 with the offset, for example
2026-08-28T14:30:00+0300. The Return table below lists the fields of the response
and their types; it has no description column for them, so the format above is the one to
assume for every DateTime field it shows.
A Facility is a machine: a tractor, a trailer, an implement or a vehicle. It carries its
registration, its type, its telemetry identifiers and the parts fitted to it. These
endpoints create and edit facilities, archive them, record engine hours and read the
telemetry the integration server reports. Facility parts have their own lifecycle -
measured, replaced and inspected on their own schedule. Facilities can be shared with
partner companies and with customers.
GET
/api/facilities
All Facilities list
Documentation
Sandbox
Documentation
List of Facilities
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
is_archived
boolean
false
true or 1
If is_archived=1 then return also archived records
archived
boolean
false
Alias of is_archived; either being truthy has the same effect.
from_updated_at
string
false
Unix timestamp
Return only records updated on or after Unix timestamp
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
rowclass
string
*
id
integer
*
Facility Id in Terake
name
string
*
Facility name, Utf8 string 255 chars
fullname
string
*
Facility fullname, Utf8 string 255 chars
slug
string
*
reg_number
string
*
Vehicle registration number (licence plate number), string
vin
string
*
Vehicle Identification Number (VIN), string up to 20 chars
show_in_map
boolean
*
True if facility must be visible in map
facility_type
object (FacilityType)
*
Facility Type
is_main_facility
boolean
*
True if Facility is main facility
is_secondary_facility
boolean
*
True if Facility is secondary facility (implement, trailer)
is_replaceable
boolean
*
True if facility is easily replacable (has big stock)
is_maintainable
boolean
*
True if facility is maintaineable unit
outer_id
string
*
ID in external system like code in accounting system, tech. passport number, etc
serial_number
string
*
maintenance_worker
object (Worker)
*
Person responsible for maintenance
storage_worker
object (Worker)
*
Person responsible for storage
fault_severity
integer
*
agrifield
object (Agrifield)
*
Main Location (Address) of Maintenance unit
customer
object (Customer)
*
customer_person
object (CustomerPerson)
*
Customer contact person
nfc
string
*
Facility NFC code
qr
string
*
Facility QR code
This is copy of QrImage->QrText parameter for fast querying in lists
Facility engine hours and kilometers history from manual entry
Documentation
Sandbox
Documentation
Facility engine hours and kilometers history from manual entry. Returns an array of objects
with: id, measuring_time, worker_fullname, enginehours, kilometers, worker_id
Requirements
Name
Requirement
Type
Description
id
integer|string
Facility id or uuid
Parameters
Parameter
Type
Required?
Format
Description
uuid
string
false
Look the record up by uuid instead of the id in the path.
from_updated_at
integer
false
Records updated from Unix timestamp
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.
Comma-separated subset of the serializer groups this endpoint offers (owner, facility, classificator, calendarevent, baseattribute, archive, sharing, 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.
Return
Parameter
Type
Versions
Description
200
classificator
string
*
color
string
*
rowclass
string
*
partner_ids
array
*
id
integer
*
Facility Id in Terake
name
string
*
Facility name, Utf8 string 255 chars
fullname
string
*
Facility fullname, Utf8 string 255 chars
slug
string
*
reg_number
string
*
Vehicle registration number (licence plate number), string
vin
string
*
Vehicle Identification Number (VIN), string up to 20 chars
show_in_map
boolean
*
True if facility must be visible in map
linkable_reg_number
string
*
Vehicle registration number for integration tools
facility_type
object (FacilityType)
*
Facility Type
is_main_facility
boolean
*
True if Facility is main facility
is_secondary_facility
boolean
*
True if Facility is secondary facility (implement, trailer)
worktypes[]
array of objects (Worktype)
*
Worktypes
is_replaceable
boolean
*
True if facility is easily replacable (has big stock)
is_maintainable
boolean
*
True if facility is maintaineable unit
outer_id
string
*
ID in external system like code in accounting system, tech. passport number, etc
serial_number
string
*
hourly_rate
float
*
enginehours_last_value
float
*
enginehours_timestamp
integer
*
Registration year, number
odometer_last_value
float
*
Odometer last value
odometer_timestamp
integer
*
Odometer last value timestamp
auto_workdone_duration
integer
*
If > 0, then Facility movement more than in duration of autoWorkdoneDuration seconds creates automatically workdone(s)
maintenance_worker
object (Worker)
*
Person responsible for maintenance
storage_worker
object (Worker)
*
Person responsible for storage
inspection_schedule
object (InspectionMasterTemplate)
*
Inspection schedule
facility_params
object (FacilityParams)
*
fault_severity
integer
*
calendar_events[]
array of objects (CalendarEvent)
*
agrifield
object (Agrifield)
*
Main Location (Address) of Maintenance unit
customer
object (Customer)
*
customer_person
object (CustomerPerson)
*
Customer contact person
last_inventory_log
object (InventoryFacilityLog)
*
Last (in force) entry in Inventory Log
nfc
string
*
Facility NFC code
qr
string
*
Facility QR code
This is copy of QrImage->QrText parameter for fast querying in lists
Comma-separated subset of the serializer groups this endpoint offers (facility_part, 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.
Comma-separated subset of the serializer groups this endpoint offers (facility_part, baseattribute, lifespan-log). 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.
Comma-separated subset of the serializer groups this endpoint offers (facility_part, baseattribute, search). 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.
GET
/api/facilities/{parent_id}/part/{id}/measure_history
Measure Facility Part (Renew lifecycle parameters)
Documentation
Sandbox
Documentation
Get Facility Part Check history
Requirements
Name
Requirement
Type
Description
parent_id
integer|string
Facility ID or UUID
id
integer|string
Facility Part ID or UUID
Parameters
Parameter
Type
Required?
Format
Description
groups
string
false
Comma-separated subset of the serializer groups this endpoint offers (lifespan-log). 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.
Comma-separated subset of the serializer groups this endpoint offers (facility_part_replace, 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.
Comma-separated subset of the serializer groups this endpoint offers (facility_part_replace, 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.
A facility type groups machines that are alike - tractors, trailers, sprayers. Facilities
reference a type, and inspection templates hang off types so that every machine of a kind
is inspected the same way. These endpoints create, edit, archive and delete types. The
list is shared with partner companies and archived in two levels, by the owner and by each
consumer. Deleting is soft so existing machines keep a readable type.
GET
/api/facilitytypes
FacilityType collection
Documentation
Sandbox
Documentation
Returns FacilityType collection
Parameters
Parameter
Type
Required?
Format
Description
is_archived
boolean
false
Truthy returns archived records instead of active ones.
archived
boolean
false
Alias of is_archived; either being truthy has the same effect.
from_updated_at
integer
false
Records updated from Unix timestamp
groups
string
false
Comma-separated subset of the serializer groups this endpoint offers (facility_type_all, owner, baseattribute, archive). 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.
Look the record up by uuid instead of the id in the path.
groups
string
false
Comma-separated subset of the serializer groups this endpoint offers (facility_type_all, owner, baseattribute, archive). 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.
A fault is a problem reported against a machine or a workobject: what is wrong, who
reported it, how severe it is, and pictures of the problem. A fault can be planned into
repair work, which links it to a plan item and eventually to an inspection case. These
endpoints create and edit faults and list them, for the whole fleet or per facility or
workobject. Fault severity also colours the faulty item in the fleet and fieldbook
views, so an open critical fault stays visible wherever the machine or field appears.
GET
/api/faultitems
Faultitem collection
Documentation
Sandbox
Documentation
Faultitem collection. Returns { pagination, collection }; pagination is null when the result
fits one page, otherwise { total, per_page, current_page, from, to }. collection is an array of
faultitems with their worker, worktype, faultitem_consumer and maintenance_worker
Requirements
Name
Requirement
Type
Description
faultitem_consumer_id
integer|string
Id of the Facility or Workobject the fault item belongs to
Parameters
Parameter
Type
Required?
Format
Description
from
string
false
Fault time from (Y-m-d), ignored when from_updated_at is set
to
string
false
Fault time to (Y-m-d), ignored when from_updated_at is set
worker_id
integer
false
Filter by worker or maintenance worker id
from_updated_at
integer
false
Records updated from Unix timestamp
current_page
integer
false
Page number, 1-based. Defaults to 1.
department_ids
string
false
Comma-separated department ids to restrict the result to.
facility_id
integer
false
Filter by the facility the fault was recorded against.
faultitem_consumer_id
integer
false
Filter by the faulty item (facility or workobject).
main_facility_id
integer
false
Filter by the facility the fault was recorded against. Alias of facility_id.
per_page
integer
false
Page size. Defaults to 500.
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.
Updates this record instead of creating one, when given.
uuid
string
false
Updates the record with this uuid instead of creating one, when given. Clients that create records offline supply their own.
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.
outer_id
string
false
Identifier in the source system. Matched against first when import_type is "file".
fault_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 stores the current time. 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.
fault_description
string
false
severity
integer
false
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.
resolved_at_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.
resolved_description
string
false
planned_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 stores the current time. 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.
planned_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 stores the current time. 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.
maintenance_worker
object
false
Reference to Worker. Send { "id": <id> }, or null to clear.
fault_reporting_location
object
false
Reference to DeviceLocation. Send { "id": <id> }, or null to clear.
additional_json
object
false
Free-form JSON object, or null to clear.
faultitem_pictures
array of objects
false
Pictures to relate to the fault item.
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.
Comma-separated subset of the serializer groups this endpoint offers (transports, faultitems, planitem, faultitem, baseattribute, classificator, 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.
Date and time as Y-m-d H:i:s, for example 2026-08-28 14:30:00. An empty value stores the current time. 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.
fault_description
string
false
severity
integer
false
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.
resolved_at_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.
resolved_description
string
false
planned_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 stores the current time. 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.
planned_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 stores the current time. 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.
maintenance_worker
object
false
Reference to Worker. Send { "id": <id> }, or null to clear.
fault_reporting_location
object
false
Reference to DeviceLocation. Send { "id": <id> }, or null to clear.
additional_json
object
false
Free-form JSON object, or null to clear.
faultitem_pictures
array of objects
false
Pictures to relate to the fault item.
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.
Faultitem collection. Returns { pagination, collection }; pagination is null when the result
fits one page, otherwise { total, per_page, current_page, from, to }. collection is an array of
faultitems with their worker, worktype, faultitem_consumer and maintenance_worker
Requirements
Name
Requirement
Type
Description
faultitem_consumer_id
integer|string
Id of the Facility or Workobject the fault item belongs to
Parameters
Parameter
Type
Required?
Format
Description
from
string
false
Fault time from (Y-m-d), ignored when from_updated_at is set
to
string
false
Fault time to (Y-m-d), ignored when from_updated_at is set
worker_id
integer
false
Filter by worker or maintenance worker id
from_updated_at
integer
false
Records updated from Unix timestamp
current_page
integer
false
Page number, 1-based. Defaults to 1.
department_ids
string
false
Comma-separated department ids to restrict the result to.
facility_id
integer
false
Filter by the facility the fault was recorded against.
faultitem_consumer_id
integer
false
Filter by the faulty item (facility or workobject).
main_facility_id
integer
false
Filter by the facility the fault was recorded against. Alias of facility_id.
per_page
integer
false
Page size. Defaults to 500.
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.
Faultitem collection. Returns { pagination, collection }; pagination is null when the result
fits one page, otherwise { total, per_page, current_page, from, to }. collection is an array of
faultitems with their worker, worktype, faultitem_consumer and maintenance_worker
Requirements
Name
Requirement
Type
Description
faultitem_consumer_id
integer|string
Id of the Facility or Workobject the fault item belongs to
Parameters
Parameter
Type
Required?
Format
Description
from
string
false
Fault time from (Y-m-d), ignored when from_updated_at is set
to
string
false
Fault time to (Y-m-d), ignored when from_updated_at is set
worker_id
integer
false
Filter by worker or maintenance worker id
from_updated_at
integer
false
Records updated from Unix timestamp
current_page
integer
false
Page number, 1-based. Defaults to 1.
department_ids
string
false
Comma-separated department ids to restrict the result to.
facility_id
integer
false
Filter by the facility the fault was recorded against.
faultitem_consumer_id
integer
false
Filter by the faulty item (facility or workobject).
main_facility_id
integer
false
Filter by the facility the fault was recorded against. Alias of facility_id.
per_page
integer
false
Page size. Defaults to 500.
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.
Faultitem collection. Returns { pagination, collection }; pagination is null when the result
fits one page, otherwise { total, per_page, current_page, from, to }. collection is an array of
faultitems with their worker, worktype, faultitem_consumer and maintenance_worker
Requirements
Name
Requirement
Type
Description
faultitem_consumer_id
integer|string
Id of the Facility or Workobject the fault item belongs to
Parameters
Parameter
Type
Required?
Format
Description
from
string
false
Fault time from (Y-m-d), ignored when from_updated_at is set
to
string
false
Fault time to (Y-m-d), ignored when from_updated_at is set
worker_id
integer
false
Filter by worker or maintenance worker id
from_updated_at
integer
false
Records updated from Unix timestamp
current_page
integer
false
Page number, 1-based. Defaults to 1.
department_ids
string
false
Comma-separated department ids to restrict the result to.
facility_id
integer
false
Filter by the facility the fault was recorded against.
faultitem_consumer_id
integer
false
Filter by the faulty item (facility or workobject).
main_facility_id
integer
false
Filter by the facility the fault was recorded against. Alias of facility_id.
per_page
integer
false
Page size. Defaults to 500.
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.
GET
/api/faults/workobject/{faultitem_consumer_id}
Faultitem collection
Documentation
Sandbox
Documentation
Faultitem collection. Returns { pagination, collection }; pagination is null when the result
fits one page, otherwise { total, per_page, current_page, from, to }. collection is an array of
faultitems with their worker, worktype, faultitem_consumer and maintenance_worker
Requirements
Name
Requirement
Type
Description
faultitem_consumer_id
integer|string
Id of the Facility or Workobject the fault item belongs to
Parameters
Parameter
Type
Required?
Format
Description
from
string
false
Fault time from (Y-m-d), ignored when from_updated_at is set
to
string
false
Fault time to (Y-m-d), ignored when from_updated_at is set
worker_id
integer
false
Filter by worker or maintenance worker id
from_updated_at
integer
false
Records updated from Unix timestamp
current_page
integer
false
Page number, 1-based. Defaults to 1.
department_ids
string
false
Comma-separated department ids to restrict the result to.
facility_id
integer
false
Filter by the facility the fault was recorded against.
faultitem_consumer_id
integer
false
Filter by the faulty item (facility or workobject).
main_facility_id
integer
false
Filter by the facility the fault was recorded against. Alias of facility_id.
per_page
integer
false
Page size. Defaults to 500.
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.
A fuel balance is a measured reading of how much fuel a machine or tank holds at a
moment in time. Readings are chained, so consumption between two readings can be
calculated rather than estimated. These endpoints record a reading, read the balances for a
period and recalculate consumption. Recording a reading in the middle of an existing chain
re-links the readings around it. Consumption figures feed the fuel reports and the cost
allocation.
GET
/api/fuelbalances
FuelBalance collection
Documentation
Sandbox
Documentation
Returns FuelBalance collection
Parameters
Parameter
Type
Required?
Format
Description
groups
string
false
Comma-separated subset of the serializer groups this endpoint offers (fuel_balance, 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
id
integer
*
facility
object (Facility)
*
validate_begin_date
DateTime
*
fuel
object (Fuel)
*
consumption_amount
float
*
Fuel consumption from previousBalance
if no previousBalance then from all times
balance_amount
float
*
enginehours
float
*
kilometers
float
*
fuel_consumption_calc_timestamp
integer
*
Time when fuel consumption was last calculated
To discover need of recalculation
Records a measured fuel balance for a Facility at a date, creating the reading or updating the
one already stored for that date. Returns the balance rows for the period
Requirements
Name
Requirement
Type
Description
query_id
integer|string
Facility id, start date and end date joined by a pipe, as facility|from|to. Only when modifying an existing record; leave it out to create a new one.
Parameters
Parameter
Type
Required?
Format
Description
query_id
integer
false
Existing balance record to update instead of creating one. Only when modifying an existing record; leave it out to create a new one.
facility
object
true
Facility the balance belongs to, as an object with an id field.
to_time
datetime
true
YYYY-MM-DD HH:MM:SS
End of the period the balance is measured at. Date and time as Y-m-d H:i:s, for example 2026-08-28 14:30:00.
balance_end
float
true
Fuel remaining at to_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.
GET
/api/fuelbalances-generate/{company_id}/{date}
Generate FuelBalance for every main facility of a company as of given date
Documentation
Sandbox
Documentation
Generate FuelBalance for every main facility of a company as of given date. Returns a summary of
the balances generated, carrying the company id and the number created
Requirements
Name
Requirement
Type
Description
company_id
integer
Company ID
date
date
Balance validate begin date. Date as Y-m-d exactly. It is parsed with a strict format, so any other spelling is rejected rather than guessed.
Parameters
Parameter
Type
Required?
Format
Description
amount
float
false
Balance amount for generated records, default 0
groups
string
false
Comma-separated subset of the serializer groups this endpoint offers (fuel_balance, 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.
FuelBalance collection. Returns an array of objects with: id, from_time, to_time, facility,
name, balance_start, balance_end, filling_amount, consumption_amount
Requirements
Name
Requirement
Type
Description
facility_id
integer|string
Facility id
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.
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.
from_updated_at
integer
false
Records updated from Unix timestamp
facility_id
integer
false
Filter by facility id.
groups
string
false
Comma-separated subset of the serializer groups this endpoint offers (fuel_balance, 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.
FuelBalance collection. Returns an array of objects with: id, from_time, to_time, facility,
name, balance_start, balance_end, filling_amount, consumption_amount
Requirements
Name
Requirement
Type
Description
facility_id
integer|string
Facility id
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.
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.
from_updated_at
integer
false
Records updated from Unix timestamp
facility_id
integer
false
Filter by facility id.
groups
string
false
Comma-separated subset of the serializer groups this endpoint offers (fuel_balance, 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.
Facility id, start date and end date joined by a pipe, as facility|from|to
id
integer|string
FuelBalance id or uuid
Parameters
Parameter
Type
Required?
Format
Description
groups
string
false
Comma-separated subset of the serializer groups this endpoint offers (fuel_balance, 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
id
integer
*
facility
object (Facility)
*
validate_begin_date
DateTime
*
fuel
object (Fuel)
*
consumption_amount
float
*
Fuel consumption from previousBalance
if no previousBalance then from all times
balance_amount
float
*
enginehours
float
*
kilometers
float
*
fuel_consumption_calc_timestamp
integer
*
Time when fuel consumption was last calculated
To discover need of recalculation
Records a measured fuel balance for a Facility at a date, creating the reading or updating the
one already stored for that date. Returns the balance rows for the period
Requirements
Name
Requirement
Type
Description
query_id
integer|string
Facility id, start date and end date joined by a pipe, as facility|from|to. Only when modifying an existing record; leave it out to create a new one.
Parameters
Parameter
Type
Required?
Format
Description
query_id
integer
false
Existing balance record to update instead of creating one. Only when modifying an existing record; leave it out to create a new one.
facility
object
true
Facility the balance belongs to, as an object with an id field.
to_time
datetime
true
YYYY-MM-DD HH:MM:SS
End of the period the balance is measured at. Date and time as Y-m-d H:i:s, for example 2026-08-28 14:30:00.
balance_end
float
true
Fuel remaining at to_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.
A fuel filling records fuel put into a machine: when, how much, by whom and from which
tank. Fillings can be entered by hand or arrive from a fuel system through the integration
server. These endpoints create, edit, list and delete fillings, and list them for one
facility. A filling can generate a Workdone automatically so refuelling shows up as
recorded work. That link is why a refuelling Workdone cannot be deleted through the
ordinary Workdone route.
GET
/api/fuelfillings
Fuel fillings (e.g
Documentation
Sandbox
Documentation
Fuel fillings (e.g. refuelings) list. Max 1000 results. Default period is current month
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.
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.
from_updated_at
integer
false
Records updated from Unix timestamp
worker_id
integer
false
Filter records by worker id
main_facility_id
integer
false
Filter records by facility id
fuel_id
integer
false
Filter records by fuel id
groups
string
false
Comma-separated subset of the serializer groups this endpoint offers (fuelfilling, baseattribute, 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.
Return
Parameter
Type
Versions
Description
200
id
integer
*
Facility Id in Terake
name
string
*
Facility name, Utf8 string 255 chars
fullname
string
*
Facility fullname, Utf8 string 255 chars
slug
string
*
reg_number
string
*
Vehicle registration number (licence plate number), string
FuelFilling id or uuid. Only when modifying an existing record; leave it out to create a new one.
Parameters
Parameter
Type
Required?
Format
Description
outer_id
string
false
Identifier in the source system.
filling_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 stores the current time. 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.
motohours
float
false
Decimal comma is accepted.
kilometers
float
false
Decimal comma is accepted.
amount
float
false
Decimal comma is accepted.
balance_amount
float
false
Decimal comma is accepted.
worker
object
false
Reference to Worker. Send { "id": <id> }, or null to clear.
fuel
object
false
Reference to Fuel. Send { "id": <id> }, or null to clear.
facility
object
false
Reference to Facility. Send { "id": <id> }, or null to clear.
identificator
object
false
Reference to Identificator. Send { "id": <id> }, or null to clear.
price_net
float
false
Decimal comma is accepted.
price_tax
float
false
Decimal comma is accepted.
price_total
float
false
Decimal comma is accepted.
description
string
false
company_id
integer
false
Company the filling is recorded against. Read only for the integration-server account; ignored for every other caller.
provider_id
integer
false
IntegrationPartner id of the fuel provider. Read only for the integration-server account; ignored for every other caller.
fuel_card_id
string
false
Outer id of the fuel card. A card is created for the company when the id is unknown. Read only for the integration-server account; ignored for every other caller.
driver_name
string
false
Driver full name, at least 3 characters. The worker is matched on the name and created when missing. Read only for the integration-server account; ignored for every other caller.
reg_number
string
false
Vehicle registration number, at least 3 characters. The facility is matched on it and created when missing. Read only for the integration-server account; ignored for every other caller.
facility_model
string
false
Model of a facility created from reg_number. Used to build its name. Read only for the integration-server account; ignored for every other caller.
facility_description
string
false
Description of a facility created from reg_number. First 20 characters are used to build its name. Read only for the integration-server account; ignored for every other caller.
fuel_name
string
false
Name of the fuel. Defaults to unknown. Read only for the integration-server account; ignored for every other caller.
fuel_outer_id
string
false
Outer id of the fuel at the provider. Defaults to a per-company placeholder. Read only for the integration-server account; ignored for every other caller.
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.
Comma-separated subset of the serializer groups this endpoint offers (fuelfilling). 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.
Comma-separated subset of the serializer groups this endpoint offers (classificator, fuels, baseattribute, 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.
FuelFilling id or uuid. Only when modifying an existing record; leave it out to create a new one.
Parameters
Parameter
Type
Required?
Format
Description
filling_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 stores the current time. 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.
motohours
float
false
Decimal comma is accepted.
kilometers
float
false
Decimal comma is accepted.
amount
float
false
Decimal comma is accepted.
balance_amount
float
false
Decimal comma is accepted.
worker
object
false
Reference to Worker. Send { "id": <id> }, or null to clear.
fuel
object
false
Reference to Fuel. Send { "id": <id> }, or null to clear.
facility
object
false
Reference to Facility. Send { "id": <id> }, or null to clear.
identificator
object
false
Reference to Identificator. Send { "id": <id> }, or null to clear.
outer_id
string
false
Identifier in the source system.
price_net
float
false
Decimal comma is accepted.
price_tax
float
false
Decimal comma is accepted.
price_total
float
false
Decimal comma is accepted.
description
string
false
company_id
integer
false
Company the filling is recorded against. Read only for the integration-server account; ignored for every other caller.
provider_id
integer
false
IntegrationPartner id of the fuel provider. Read only for the integration-server account; ignored for every other caller.
fuel_card_id
string
false
Outer id of the fuel card. A card is created for the company when the id is unknown. Read only for the integration-server account; ignored for every other caller.
driver_name
string
false
Driver full name, at least 3 characters. The worker is matched on the name and created when missing. Read only for the integration-server account; ignored for every other caller.
reg_number
string
false
Vehicle registration number, at least 3 characters. The facility is matched on it and created when missing. Read only for the integration-server account; ignored for every other caller.
facility_model
string
false
Model of a facility created from reg_number. Used to build its name. Read only for the integration-server account; ignored for every other caller.
facility_description
string
false
Description of a facility created from reg_number. First 20 characters are used to build its name. Read only for the integration-server account; ignored for every other caller.
fuel_name
string
false
Name of the fuel. Defaults to unknown. Read only for the integration-server account; ignored for every other caller.
fuel_outer_id
string
false
Outer id of the fuel at the provider. Defaults to a per-company placeholder. Read only for the integration-server account; ignored for every other caller.
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.
A Fuel is a fuel type - diesel, petrol, AdBlue - not a quantity. Fillings, balances and
machines reference one. These endpoints create, edit, archive and delete fuel types. The
list is shared with partner companies and archived in two levels. Deleting is soft so
historic fillings keep a readable type.
GET
/api/fuels
Fuel collection
Documentation
Sandbox
Documentation
Returns Fuel collection
Parameters
Parameter
Type
Required?
Format
Description
is_archived
boolean
false
Truthy returns archived records instead of active ones.
archived
boolean
false
Alias of is_archived; either being truthy has the same effect.
from_updated_at
integer
false
Records updated from Unix timestamp
groups
string
false
Comma-separated subset of the serializer groups this endpoint offers (fuels, archive, classificator). 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.
Look the record up by uuid instead of the id in the path.
groups
string
false
Comma-separated subset of the serializer groups this endpoint offers (fuels, archive, classificator, 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.
Toggles Archive/Un-archive Fuel. Does not have a request body. The same action answers on GET
and PUT.
Requirements
Name
Requirement
Type
Description
id
integer|string
Fuel id or uuid
Parameters
Parameter
Type
Required?
Format
Description
uuid
string
false
Look the record up by uuid instead of the id in the path.
groups
string
false
Comma-separated subset of the serializer groups this endpoint offers (fuels, archive, classificator, 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.
An Identificator is a physical token that identifies a worker or a machine - an RFID tag,
an NFC card or a fuel key. Scanning one at a terminal or a fuel pump attaches the resulting
record to the right worker or facility. These endpoints create, edit, list and delete
identificators. One worker or machine can hold several, from different systems. They are
how work gets recorded without anyone logging in.
GET
/api/identificators
Identificator collection
Documentation
Sandbox
Documentation
Returns Identificator collection
Parameters
Parameter
Type
Required?
Format
Description
is_archived
boolean
false
Truthy returns archived records instead of active ones.
archived
boolean
false
Alias of is_archived; either being truthy has the same effect.
from_updated_at
integer
false
Unix timestamp. Returns records changed since then, including deleted and archived ones, so a client can reconcile.
groups
string
false
Comma-separated subset of the serializer groups this endpoint offers (identificator, classificator). 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
*
name
string
*
Nick name of card, like "John's white door card"
worker
object (Worker)
*
facility
object (Facility)
*
identificator_type
object (IdentificatorType)
*
outer_id
string
*
Id in external system, for example code in Accounting or Human Resources system.
Identificators (cards, tags, PINs) registered for one worker, by worker id or uuid
Documentation
Sandbox
Documentation
Identificators (cards, tags, PINs) registered for one worker, by worker id or uuid. Returns the
worker identificators, each carrying a created_by block with fullname
The response has a fixed structure and may not include every field these records carry elsewhere in the API.
Requirements
Name
Requirement
Type
Description
id
integer|string
Identificator 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.
Look the record up by uuid instead of the id in the path.
groups
string
false
Comma-separated subset of the serializer groups this endpoint offers (identificator, classificator). 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
*
name
string
*
Nick name of card, like "John's white door card"
worker
object (Worker)
*
facility
object (Facility)
*
identificator_type
object (IdentificatorType)
*
outer_id
string
*
Id in external system, for example code in Accounting or Human Resources system.
Id of the record being updated. Must match the id in the URL.
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 stores the current time. 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 stores the current time. 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_deleted
boolean
false
worker
object
false
Reference to Worker. Send { "id": <id> }, or null to clear.
facility
object
false
Reference to Facility. Send { "id": <id> }, or null to clear.
identificator_type
object
false
Reference to IdentificatorType. Send { "id": <id> }, or null to clear.
outer_id
string
false
Identifier in the source system.
apply_all_worker_facility
boolean
false
Applies the change to every identificator of the same worker and facility, not only this one
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
*
name
string
*
Nick name of card, like "John's white door card"
worker
object (Worker)
*
facility
object (Facility)
*
identificator_type
object (IdentificatorType)
*
outer_id
string
*
Id in external system, for example code in Accounting or Human Resources system.
These endpoints cover moving things rather than working a field: charter jobs, trip
routes and journey forms. A journey form records the legs of a trip, with times, mileage
and the worktype for each. These endpoints create and edit all of them and add legs to a
form. Journey forms are what transport work is billed and reported from. Note: this
functionality is abandoned and no longer maintained - use it with caution.
GET
/api/charter_jobs
CharterJob collection for the caller's company.
Documentation
Sandbox
Documentation
Returns CharterJob collection for the caller's company.
Parameters
Parameter
Type
Required?
Format
Description
is_archived
boolean
false
Truthy returns archived records instead of active ones.
archived
boolean
false
Alias of is_archived; either being truthy has the same effect.
from_updated_at
integer
false
Records updated from Unix timestamp
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.
groups
string
false
Comma-separated subset of the serializer groups this endpoint offers (default, transports). 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.
Updates this record instead of creating one, when given.
uuid
string
false
Updates the record with this uuid instead of creating one, when given. Clients that create records offline supply their own.
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.
outer_id
string
false
Identifier in the source system. Matched against first when import_type is "file".
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 stores the current time. 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 stores the current time. 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.
from_place_info
string
false
to_place_info
string
false
route_description
string
false
additional
string
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.
Look the record up by uuid instead of the id in the path.
groups
string
false
Comma-separated subset of the serializer groups this endpoint offers (default, transports). 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.
Id of the record being updated. Must match the id in the URL.
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 stores the current time. 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 stores the current time. 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.
from_place_info
string
false
to_place_info
string
false
route_description
string
false
additional
string
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.
Truthy returns archived records instead of active ones.
archived
boolean
false
Alias of is_archived; either being truthy has the same effect.
from_updated_at
integer
false
Records updated from Unix timestamp
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.
groups
string
false
Comma-separated subset of the serializer groups this endpoint offers (default, transports). 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.
Look the record up by uuid instead of the id in the path.
groups
string
false
Comma-separated subset of the serializer groups this endpoint offers (default, transports). 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.
GET
/api/journey_forms/{id}/classificator/charter_jobs
Charter jobs selectable on one journey form.
Documentation
Sandbox
Documentation
Returns charter jobs selectable on one journey form.
Requirements
Name
Requirement
Type
Description
id
integer|string
JourneyForm id or uuid
Parameters
Parameter
Type
Required?
Format
Description
is_archived
boolean
false
Truthy returns archived records instead of active ones.
archived
boolean
false
Alias of is_archived; either being truthy has the same effect.
from_updated_at
integer
false
Records updated from Unix timestamp
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.
groups
string
false
Comma-separated subset of the serializer groups this endpoint offers (default, transports). 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.
Truthy returns archived records instead of active ones.
archived
boolean
false
Alias of is_archived; either being truthy has the same effect.
from_updated_at
integer
false
Records updated from Unix timestamp
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.
groups
string
false
Comma-separated subset of the serializer groups this endpoint offers (default, transports). 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.
Returns TripRoute collection for the caller's company.
Parameters
Parameter
Type
Required?
Format
Description
is_archived
boolean
false
Truthy returns archived records instead of active ones.
archived
boolean
false
Alias of is_archived; either being truthy has the same effect.
from_updated_at
integer
false
Records updated from Unix timestamp
groups
string
false
Comma-separated subset of the serializer groups this endpoint offers (default, transports). 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.
Look the record up by uuid instead of the id in the path.
groups
string
false
Comma-separated subset of the serializer groups this endpoint offers (default, transports). 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.
A transport case records one load moved: what, from where, to where and by whom. Cases
are used where the material itself matters, such as harvest or manure. These endpoints
create, edit, list and delete cases and read a simplified list for several at once.
Modifying a case also updates the related material inventory. The case links the load to
the machines and the storages at each end.
GET
/api/silagetransports
TransportCase collection
Documentation
Sandbox
Documentation
Returns TransportCase collection
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.
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.
from_updated_at
integer
false
Records updated from Unix timestamp
groups
string
false
Comma-separated subset of the serializer groups this endpoint offers (transports). 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.
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.
from_updated_at
integer
false
Records updated from Unix timestamp
groups
string
false
Comma-separated subset of the serializer groups this endpoint offers (transports). 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.
Updates this record instead of creating one, when given.
transport_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 stores the current time. 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.
cargo_count
integer
false
weight_amount
float
false
Decimal comma is accepted.
weight_amount_empty
float
false
Decimal comma is accepted.
weight_amount_full
float
false
Decimal comma is accepted.
waybill_number
string
false
odometer_start
integer
false
odometer_stop
integer
false
worker
object
false
Reference to Worker. Send { "id": <id> }, or null to clear.
material
object
false
Reference to Material. Send { "id": <id> }, or null to clear.
from_point
object
false
Reference to Agrifield. Send { "id": <id> }, or null to clear.
to_point
object
false
Reference to Agrifield. Send { "id": <id> }, or null to clear.
transport_type
object
false
Reference to TransportType. Send { "id": <id> }, or null to clear.
worktype
object
false
Worktype of the transport. Object with an id field. Falls back to the generic worktype when omitted.
main_facility
object
false
Main facility of the transport. Object with an id field.
secondary_facility
object
false
Secondary facility of the transport. Object with an id field.
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.
Comma-separated subset of the serializer groups this endpoint offers (transports, classificator). 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.
Modifies TransportCase and updates the related material inventory
Documentation
Sandbox
Documentation
Modifies TransportCase
Requirements
Name
Requirement
Type
Description
id
integer|string
TransportCase 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.
transport_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 stores the current time. 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.
cargo_count
integer
false
weight_amount
float
false
Decimal comma is accepted.
weight_amount_empty
float
false
Decimal comma is accepted.
weight_amount_full
float
false
Decimal comma is accepted.
waybill_number
string
false
odometer_start
integer
false
odometer_stop
integer
false
worker
object
false
Reference to Worker. Send { "id": <id> }, or null to clear.
material
object
false
Reference to Material. Send { "id": <id> }, or null to clear.
from_point
object
false
Reference to Agrifield. Send { "id": <id> }, or null to clear.
to_point
object
false
Reference to Agrifield. Send { "id": <id> }, or null to clear.
transport_type
object
false
Reference to TransportType. 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.