Skip to main content

Get-HaloTimesheet

Generated Cmdlet Help

This page has been generated from the HaloAPI PowerShell module source. To make changes please edit the appropriate PowerShell source file.

SYNOPSIS

Gets timesheets from the Halo API.

SYNTAX

Get-HaloTimesheet [-SelectedTeam <Int32>] [-ShowHolidays] [-SelectedAgents <Int32[]>]
[-SelectedTypes <Int32[]>] [-StartDate <DateTime>] [-EndDate <DateTime>] [-ShowAllDates]
[-IncludeTimesheetFields] [-UTCOffset <Int32>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

Retrieves timesheets from the Halo API - supports a variety of filtering parameters.

EXAMPLES

PARAMETERS

-SelectedTeam

Return the timesheet for the specified team.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-ShowHolidays

Include holidays in the result.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-SelectedAgents

Return the timesheet for the selected agents.

Type: Int32[]
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SelectedTypes

Return the selected types.

Type: Int32[]
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: @(0, 1 , 2, 3)
Accept pipeline input: False
Accept wildcard characters: False

-StartDate

Timesheet start date/time.

Type: DateTime
Parameter Sets: (All)
Aliases: start_date

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-EndDate

Timesheet end date/time.

Type: DateTime
Parameter Sets: (All)
Aliases: end_date

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ShowAllDates

Include all days in the result.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-IncludeTimesheetFields

Include all timesheet fields in the result.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-UTCOffset

The UTC offset.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

A powershell object containing the response.

NOTES