Returns an existing reviewing batch matching the given
(work_time_group_id, start_date, end_date) if one exists;
otherwise creates a new one, attaches work time entries and absences,
and generates user summaries. draft batches (= prior failed
creations) are ignored by the lookup and a new batch is created instead.
Note: no email notification is send with user summaries reports.
Access: managers and accountants.
{
"id": 42,
"company_id": 7,
"work_time_group_id": 3,
"work_time_group_name": "paid overtime WTG",
"period_start": "2026-04-01",
"period_end": "2026-04-30",
"state": "reviewing",
"created_at": "2026-05-01T08:30:00.000Z",
"updated_at": "2026-05-01T08:30:05.000Z",
"user_summaries": [
{
"id": 101,
"user_id": 55,
"user_name": "Jane Doe",
"expected_hours": 184.0,
"true_hours": 168.0,
"vacation_duration": "8:00",
"sick_leave_duration": "0:00",
"long_absence_duration": "0:00",
"missing_hours": 8.0,
"flex_balance_hours": -8.0,
"vacation_days": 24.0,
"comp_time_days": "2.0 (Overtime), 0.5 (On-call)"
}
],
"reports": []
}
| Param name | Description |
|---|---|
|
work_time_group_id
optional |
Work time group ID. Omit to create a company-wide batch. Validations:
|
|
start_date
required |
Period start date, e.g. Validations:
|
|
end_date
required |
Period end date, e.g. Validations:
|
|
date_range
optional |
Alternative to Validations:
|