Skip to content

Employees

Employees are Custom Link’s other master-data entity, covering operator and driver records. For clients, see Clients.

SituationCommand
Look up employee/operator recordsRequestEmployees
Create or update an employeeStoreEmployees

RequestEmployees follows the same filter shape as clients — retrieve by Id, number, or search.

FieldTypeDescription
EmployeeIdkeyInternal database Id.
NumberstringUser-assigned employee number (not the database key).
NamestringEmployee’s name.
AddressHomeaddressHome address.
ConnectivityHome / ConnectivityWorkconnectivityHome: fax, mobile, phone, email. Work: mobile, phone.
IsActivebooleanTrue = visible, False = invisible.
DeletedbooleanTrue = in the trash bin, False = not deleted.
DrivingLicensestringDriving license number.
PlanningbooleanTrue if this employee is a planner.
ManagementbooleanTrue if part of management.
VehicleNointDefault vehicle number for this employee.
ContractStart / ContractEnddateTimeEmployment contract dates.
PermissionspermissionsThis employee’s Custom Link/TMS permissions.

StoreEmployees follows the same convention as clients: an EmployeeId/Id that is zero or negative creates a new record; positive updates the existing one.

Response uses the shared EoStoreResultList shape.

  • A Custom Link token’s access to Employees is all-or-nothing — if the token’s section is denied (DenyAll), every RequestEmployees/StoreEmployees call fails with a Security: no permission for request <ClassName> error, the same as clients. Administration-level scoping still applies independently and can narrow results without an error.
  • StoreEmployees is not rejected for skipping a prior retrieve — the server updates the DB row directly, the same as StoreClients. But unlike clients, there is no server-side fetch of the existing row before storing — the payload you send is written as-is, so omitted fields can overwrite existing data. This makes retrieve-before-update more important for StoreEmployees than for StoreClients.