> ## Documentation Index
> Fetch the complete documentation index at: https://developer.rollfi.xyz/llms.txt
> Use this file to discover all available pages before exploring further.

# startBreak

> The `startBreak` API starts a break for an employee who is currently clocked in.

### What it does:
- Opens a break segment that is excluded from worked-hour totals.

### Notes:
- Use `getEmployeeTimeTrackingStatus` to verify break eligibility.



## OpenAPI

````yaml post /userPortal/startBreak
openapi: 3.1.0
info:
  title: Default module
  description: |
    Webhook events emitted when a company's KYB status is created or changes.

    Rollfi sends these requests to the webhook URL configured for the client.
    Consumers should return a successful 2xx response after accepting the event.
  version: 1.0.0
servers: []
security: []
tags:
  - name: Admin Portal
  - name: TimeOff Admin
  - name: TimeTracking Admin
  - name: TimeOff User
  - name: TimeTracking User
  - name: TimeTracking Reports
  - name: TimeOff Reports
  - name: Pay Schedule Webhooks
  - name: Pay Period Webhooks
  - name: Employee Bank Account Webhooks
  - name: Employee KYC Webhooks
  - name: Company Bank Account Webhooks
  - name: Company Webhooks
  - name: Employee Status Webhooks
paths:
  /userPortal/startBreak:
    post:
      tags:
        - TimeTracking User
      summary: startBreak
      description: >-
        The `startBreak` API starts a break for an employee who is currently
        clocked in.


        ### What it does:

        - Opens a break segment that is excluded from worked-hour totals.


        ### Notes:

        - Use `getEmployeeTimeTrackingStatus` to verify break eligibility.
      operationId: startBreak
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                method:
                  type: string
                userId:
                  type: string
                companyId:
                  type: string
              required:
                - method
                - userId
                - companyId
            example:
              method: startBreak
              userId: C4CA148F-F2C6-4E70-8349-57CC6DFC1C2B
              companyId: 5221FFCF-E84B-4690-B7DC-DE29D549096B
      responses:
        '200':
          description: Break started
          content:
            application/json:
              schema:
                type: object
                properties:
                  timeEntryBreak:
                    type: object
                    properties:
                      breakId:
                        type: string
                      success:
                        type: boolean
                      message:
                        type: string
                    required:
                      - breakId
                      - success
                      - message
                required:
                  - timeEntryBreak
              example:
                timeEntryBreak:
                  breakId: 3B6F5367-9AB1-4BCB-997D-CBCE29DC6EBE
                  success: true
                  message: Break started successfully.
          headers: {}
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: integer
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
              example:
                error:
                  code: 400
                  message: Employee is already on a break.
          headers: {}
      deprecated: false
      security: []

````