Square.Connect.Model.V1ListTimecardsRequest

July 10, 2019 ยท View on GitHub

Description

Properties

NameTypeDescriptionNotes
OrderstringThe order in which timecards are listed in the response, based on their created_at field. See SortOrder for possible values[optional]
EmployeeIdstringIf provided, the endpoint returns only timecards for the employee with the specified ID.[optional]
BeginClockinTimestringIf filtering results by their clockin_time field, the beginning of the requested reporting period, in ISO 8601 format.[optional]
EndClockinTimestringIf filtering results by their clockin_time field, the end of the requested reporting period, in ISO 8601 format.[optional]
BeginClockoutTimestringIf filtering results by their clockout_time field, the beginning of the requested reporting period, in ISO 8601 format.[optional]
EndClockoutTimestringIf filtering results by their clockout_time field, the end of the requested reporting period, in ISO 8601 format.[optional]
BeginUpdatedAtstringIf filtering results by their updated_at field, the beginning of the requested reporting period, in ISO 8601 format.[optional]
EndUpdatedAtstringIf filtering results by their updated_at field, the end of the requested reporting period, in ISO 8601 format.[optional]
Deletedbool?If 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]
Limitint?The maximum integer number of employee entities to return in a single response. Default 100, maximum 200.[optional]
BatchTokenstringA pagination cursor to retrieve the next set of results for your original query to the endpoint.[optional]

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