Start a New Workday timeman.open

Scope: timeman

Who can execute the method: any user

The method timeman.open starts a new workday or continues the workday after a break or completion.

Method Parameters

Name `type`	Description
USER_ID `integer`	User identifier. Defaults to the current user
TIME `datetime`	The start date and time of the workday in the ATOM (ISO-8601) format, for example, `2025-02-12T15:52:01+00:00`. The date must match the current calendar date. The `TIME` parameter can be passed if the workday is in the `CLOSED` status. In other cases, an error will be returned. By default, the workday opens with the current time in the employee's time zone. The system takes into account the time zone specified in the parameter and considers it the user's time zone
REPORT `string`	Reason for changing the workday. Required under the conditions: the `TIME` parameter is specified the employee does not have a flexible schedule
LAT `double`	Geographic latitude of the start of the workday
LON `double`	Geographic longitude of the start of the workday

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"USER_ID":503,"TIME":"2025-03-27T08:00:01+00:00","REPORT":"I forgot to start the workday","LAT":53.548841,"LON":9.987274}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/timeman.open

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"USER_ID":503,"TIME":"2025-03-27T08:00:01+00:00","REPORT":"I forgot to start the workday","LAT":53.548841,"LON":9.987274,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/timeman.open

try
        {
        	const response = await $b24.callMethod(
        		'timeman.open',
        		{
        			'USER_ID' : 503,
        			'TIME': '2025-03-27T08:00:01+00:00',
        			'REPORT': 'I forgot to start the workday',
        			'LAT': 53.548841, 
        			'LON': 9.987274
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }

BX24.callMethod(
            'timeman.open',
            {
                'USER_ID' : 503,
                'TIME': '2025-03-27T08:00:01+00:00',
                'REPORT': 'I forgot to start the workday',
                'LAT': 53.548841, 
                'LON': 9.987274
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'timeman.open',
            [
                'USER_ID' => 503,
                'TIME' => '2025-03-27T08:00:01+00:00',
                'REPORT' => 'I forgot to start the workday',
                'LAT' => 53.548841,
                'LON' => 9.987274
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
            "result": {
                "STATUS": "OPENED",
                "TIME_START": "2025-03-27T08:00:01+02:00",
                "TIME_FINISH": null,
                "DURATION": "00:00:00",
                "TIME_LEAKS": "00:00:00",
                "ACTIVE": false,
                "IP_OPEN": "",
                "IP_CLOSE": "",
                "LAT_OPEN": 53.548841000000003,
                "LON_OPEN": 9.9872739999999993,
                "LAT_CLOSE": 0,
                "LON_CLOSE": 0,
                "TZ_OFFSET": 7200
            },
            "time": {
                "start": 1743056587.6559751,
                "finish": 1743056587.8529301,
                "duration": 0.19695496559143066,
                "processing": 0.16714906692504883,
                "date_start": "2025-03-27T09:23:07+03:00",
                "date_finish": "2025-03-27T09:23:07+03:00",
                "operating_reset_at": 1743057187,
                "operating": 0.1671299934387207
            }
        }

Returned Data

Name `type`	Description
result `object`	Root element of the response. Contains an object with the description of the workday
STATUS `string`	Status of the current workday. Possible values: `OPENED` — opened `CLOSED` — closed `PAUSED` — paused `EXPIRED` — expired, meaning opened until the start of the current calendar day and not closed
TIME_START `datetime`	Date and time the workday started. The time zone corresponds to the time zone of the start of the workday
TIME_FINISH `datetime`	Date and time the workday was completed. Returns `null` for an unfinished workday
DURATION `string`	Duration of the workday in the `HH:MM:SS` format. Returns `00:00:00` for an unfinished workday
TIME_LEAKS `string`	Total duration of breaks during the day in the `HH:MM:SS` format
ACTIVE `boolean`	Confirmation of the workday. A value of `false` means that the change to the workday is awaiting confirmation from the supervisor
IP_OPEN `string`	IP address from which the workday was started
IP_CLOSE `string`	IP address from which the workday was completed. Returns `null` for an unfinished workday
LAT_OPEN `double`	Geographic latitude of the point where the workday started
LON_OPEN `double`	Geographic longitude of the point where the workday started
LAT_CLOSE `double`	Geographic latitude of the point where the workday was completed
LON_CLOSE `double`	Geographic longitude of the point where the workday was completed
TZ_OFFSET `integer`	Time zone offset of the employee in which the workday started. The completion time of the workday is adjusted to the time zone of the start of the day
TIME_FINISH_DEFAULT `datetime`	Recommended value for the end of the day, which can be displayed to the user as a default value. Displayed only for workdays in the expired status `EXPIRED`
time `time`	Information about the time taken to process the request

Error Handling

HTTP Status: 400

{
            "error":"WRONG_DATETIME",
            "error_description":"Day open date should correspond to the current date"
        }

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Code	Description	Value
empty string	User not found	User with the specified `USER_ID` not found
`WRONG_DATETIME`	Day open date should correspond to the current date	The date of opening the workday must match the current calendar date
`TIME`	Unable to set time, work day is paused	Cannot pass the `TIME` parameter for a paused workday

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Overview of Methods

Pause the Current Workday

Start a New Workday timeman.open

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning