Add Absence Report timeman.timecontrol.report.add

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Scope: timeman

Who can execute the method: any user

The method timeman.timecontrol.report.add sends an absence report and adds it to the calendar.

By default, a user can only send a report for themselves. A portal administrator can send a report for anyone—this requires specifying the user ID in the USER_ID parameter.

Method Parameters

Required parameters are marked with *

Name
type

Description

REPORT_ID* | ID*
integer

Identifier of the absence record.

You can obtain record identifiers using the timeman.timecontrol.reports.get method

USER_ID
integer

User identifier. Can only be specified by an administrator.

You can obtain the user identifier using the user.get method

TEXT*
string

Report text

TYPE
string

Report type:

  • WORK — work-related
  • PRIVATE — personal

Default value is PRIVATE

CALENDAR
string

Add event to calendar:

  • Y — yes
  • N — no

Default value is Y

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"REPORT_ID":123,"TEXT":"Worked on the project","TYPE":"WORK","CALENDAR":"Y"}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/timeman.timecontrol.report.add
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"REPORT_ID":123,"TEXT":"Worked on the project","TYPE":"WORK","CALENDAR":"Y","auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/timeman.timecontrol.report.add
        
try
        {
        	const response = await $b24.callMethod(
        		'timeman.timecontrol.report.add',
        		{
        			'REPORT_ID': 123,
        			'TEXT': 'Worked on the project',
        			'TYPE': 'WORK',
        			'CALENDAR': 'Y'
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'timeman.timecontrol.report.add',
                    [
                        'REPORT_ID' => 123,
                        'TEXT'      => 'Worked on the project',
                        'TYPE'      => 'WORK',
                        'CALENDAR'  => 'Y',
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Your logic for processing data
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding time control report: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'timeman.timecontrol.report.add',
            {
                'REPORT_ID': 123,
                'TEXT': 'Worked on the project',
                'TYPE': 'WORK',
                'CALENDAR': 'Y'
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'timeman.timecontrol.report.add',
            [
                'REPORT_ID' => 123,
                'TEXT' => 'Worked on the project',
                'TYPE' => 'WORK',
                'CALENDAR' => 'Y'
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result": true,
            "time": {
                "start": 1743056587.6559751,
                "finish": 1743056587.8529301,
                "duration": 0.19695496559143066,
                "processing": 0.16714906692504883,
                "date_start": "2025-03-27T09:23:07+02:00",
                "date_finish": "2025-03-27T09:23:07+02:00",
                "operating_reset_at": 1743057187,
                "operating": 0.1671299934387207
            }
        }

Returned Data

Name
type

Description

result
boolean

Execution result. Returns true if the report was added successfully

time
time

Information about the request execution time

Error Handling

HTTP status: 400

{
            "error": "TEXT_EMPTY",
            "error_description": "Text can't be empty"
        }

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

ACCESS_ERROR

You don't have access for this report

You do not have access to this report

TEXT_EMPTY

Text can't be empty

The report text cannot be empty

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 permitted for calls 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 HTTPS protocol is required for method calls

503

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it

403

ACCESS_DENIED
REST API is available only on commercial plans

The REST API is only available on commercial plans

403

INVALID_CREDENTIALS
Invalid request credentials

The user associated with the access token or webhook used to call the method lacks the necessary 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 portal administrator has restricted access to this application to specific users only

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 "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Previous
Overview of Methods
Next
Get Absence Reports