V1ListTimecardsRequest

February 26, 2020 ยท View on GitHub

Description

Note: This model is deprecated.

Properties

NameGetterSetterTypeDescriptionNotes
ordergetOrder()setOrder($value)stringThe order in which timecards are listed in the response, based on their created_at field. See SortOrder for possible values[optional]
employee_idgetEmployeeId()setEmployeeId($value)stringIf provided, the endpoint returns only timecards for the employee with the specified ID.[optional]
begin_clockin_timegetBeginClockinTime()setBeginClockinTime($value)stringIf filtering results by their clockin_time field, the beginning of the requested reporting period, in ISO 8601 format.[optional]
end_clockin_timegetEndClockinTime()setEndClockinTime($value)stringIf filtering results by their clockin_time field, the end of the requested reporting period, in ISO 8601 format.[optional]
begin_clockout_timegetBeginClockoutTime()setBeginClockoutTime($value)stringIf filtering results by their clockout_time field, the beginning of the requested reporting period, in ISO 8601 format.[optional]
end_clockout_timegetEndClockoutTime()setEndClockoutTime($value)stringIf filtering results by their clockout_time field, the end of the requested reporting period, in ISO 8601 format.[optional]
begin_updated_atgetBeginUpdatedAt()setBeginUpdatedAt($value)stringIf filtering results by their updated_at field, the beginning of the requested reporting period, in ISO 8601 format.[optional]
end_updated_atgetEndUpdatedAt()setEndUpdatedAt($value)stringIf filtering results by their updated_at field, the end of the requested reporting period, in ISO 8601 format.[optional]
deletedgetDeleted()setDeleted($value)boolIf true, only deleted timecards are returned. If false, only valid timecards are returned.If you don't provide this parameter, both valid and deleted timecards are returned.[optional]
limitgetLimit()setLimit($value)intThe maximum integer number of employee entities to return in a single response. Default 100, maximum 200.[optional]
batch_tokengetBatchToken()setBatchToken($value)stringA pagination cursor to retrieve the next set of results for your original query to the endpoint.[optional]

Note: All properties are protected and only accessed via getters and setters.

[Back to Model list] [Back to API list] [Back to README]