Add Absence Report timeman.timecontrol.report.add
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
timemanWho can execute the method: any user
The method timeman.timecontrol.report.add sends an absence report. If you pass CALENDAR: Y, the method also adds an event to the employee's calendar.
By default, a user can only send a report for themselves. An administrator can send a report on behalf of another employee: pass their identifier in USER_ID. In cloud Bitrix24, an integrator can do this too.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
REPORT_ID* | ID* |
Identifier of the absence record. You can obtain record identifiers using the timeman.timecontrol.reports.get method |
|
USER_ID |
User identifier. The method takes the parameter into account only if it is called by an administrator, and in cloud Bitrix24 also by an integrator. For other users, the method sends the report on their own behalf. You can obtain the user identifier using the user.get method |
|
TEXT* |
Report text |
|
TYPE |
Absence type:
Default value is |
|
CALENDAR |
Add event to calendar:
Default value is |
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
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
try {
const response = await $b24.actions.v2.call.make<boolean>({
method: 'timeman.timecontrol.report.add',
params: {
REPORT_ID: 123,
TEXT: 'Worked on the project',
TYPE: 'WORK',
CALENDAR: 'Y',
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Report added:', result)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function addTimecontrolReport() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'timeman.timecontrol.report.add',
params: {
REPORT_ID: 123,
TEXT: 'Worked on the project',
TYPE: 'WORK',
CALENDAR: 'Y',
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Report added:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addTimecontrolReport)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.timeman.timecontrol.report.add(
report_id=123,
text="Worked on the project",
type="WORK",
calendar="Y",
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Bitrix API error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected 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>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "timeman.timecontrol.report.add", b24.Params{
"REPORT_ID": 123,
"TEXT": "Worked on the project",
"TYPE": "WORK",
"CALENDAR": "Y",
})
if err != nil {
return fmt.Errorf("timeman.timecontrol.report.add: %w", err)
}
var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println("done:", ok)
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 |
Description |
|
result |
Execution result. Returns |
|
time |
Information about the request execution time |
If USER_ID is not passed, the method returns true but does not store the report when:
- there is no record with the passed
REPORT_ID - the record belongs to another employee
To make sure the report was added, check the report_text field of the record using timeman.timecontrol.reports.get. This requires access to reports. See Access Permissions for details.
Error Handling
HTTP status: 400
{
"error": "TEXT_EMPTY",
"error_description": "Text can't be empty"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
Value |
|
|
Time management is disabled. |
The time tracking tool is disabled |
|
|
You don't have access for this report |
The administrator passed |
|
|
Text can't be empty |
The report text cannot be empty |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it 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 |