Set the balance (available balance) of a time off type for a specific employee.

This endpoint allows you to set (adjust) the balance of a time off type for a specific employee. The balance adjustment will be recorded in the time off history with a description of the change.

The employee must be assigned to the specified time off type for the operation to succeed. Balance values can be positive or negative.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The unique identifier of the time off type (MongoDB ObjectId).

string
required

The unique identifier of the employee (MongoDB ObjectId).

Body Params
number
required

Enter the new balance (remaining days or hours) for the selected time off type. This sets how much time off the employee should have left to use. The system will automatically adjust the overall totalAllowance (total granted) so that, after subtracting time already taken, the balance matches what you set. For example, if the employee has already taken 4 days, and you set the balance to 10, the allowance will be updated to 14. Also, note that any planned (not yet taken) time off is automatically subtracted from this balance to show the true available amount. For instance, if there are 4 planned days and you set the balance to 10, the available balance will be 6.

string
length ≤ 1000

Optional description explaining the reason for the balance adjustment (max 1000 characters).

Headers
string
required

A valid bearer token.

Responses

401

UNAUTHORIZED. The Authorization header is incorrect, not provided or the token expired.

403

FORBIDDEN. Insufficient permissions to adjust time off balances.

404

NOT FOUND. Time off type not found, employee not found, or employee not assigned to the specified time off type.

500

INTERNAL SERVER ERROR. Server error during balance adjustment.

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json