BreakStart

[POST] .../v1/workattendance/breakstart

Starts a break in the active work session Use this method when the current employee starts a break inside an already opened work session. The method validates break_type, checks break management permission 698, requires an active session without another active break, creates a WorkSessionBreak, writes an action log entry, fires the break-start webhook, recalculates availability and returns new_id. The request body is required, break_type must be Lunch, Short or Other and comment is optional. Missing body, invalid break_type, denied permission, missing active session, already active break and database errors are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
break_type String Required Break type: Lunch, Short or Other. Allowed values: Default, Lunch, Short, Other.
comment String Optional Break comment. Stored in a database field with a 500 character limit.

Request Example

{
  "break_type": "Lunch",
  "comment": "Lunch break"
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Insert Created record result.

Response Example

{
  "ok": true,
  "result": {
    "new_id": 12
  }
}