Time Off Report

post

https://{dc-region}.zuperpro.com/api/reports/timesheet/timeoff

Generate a comprehensive time off report with detailed filtering options

Body Params

from_date

string

required

Start date (YYYY-MM-DD)

to_date

string

required

End date (YYYY-MM-DD)

date_type

string

Defaults to scheduled_date

skip_date_range

boolean

Defaults to false

include_uid

string

Specific timesheet UIDs to include (comma-separated)

filter_rules

string

Advanced filter rules JSON

filter.employee

string

Employee UIDs (comma-separated)

filter.team

string

Team UIDs (comma-separated)

filter.status

string

Timesheet status (approved/pending/rejected)

filter.type

string

Timesheet types (comma-separated)

filter.shift_type

string

Shift types (comma-separated)

filter.approval_status

string

Approval status (pending/approved/rejected)

filter.created_by

string

Creator user UIDs (comma-separated)

filter.created_at

string

Filter by creation date

filter.updated_at

string

Filter by update date

filter.check_in

string

Filter by check-in date

filter.check_out

string

Filter by check-out date

filter.location

string

Location UIDs (comma-separated)

filter.location_name

string

Location names (comma-separated)

filter.work_time_min

number

Minimum work time in minutes

filter.work_time_max

number

Maximum work time in minutes

filter.break_time_min

number

Minimum break time in minutes

filter.break_time_max

number

Maximum break time in minutes

filter.remarks

string

Filter by remarks content

filter.timeoff_type

string

Time-off request types (comma-separated)

filter.timeoff_status

string

Time-off request status (pending/approved/rejected)

Responses

Language

Credentials

Header

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Time Off report generated successfully

400Bad request - Invalid parameters

401Unauthorized - Missing or invalid authentication