Timesheet Entries
The Timesheet Entry
object is used to track coverage for Hours Worked by an Employee.Properties
id
StringRequired
remote_id
StringOptional
The third-party API ID of the matching object.
employee
StringOptional
The employee the timesheet entry is for.
hours_worked
NumberOptional
The number of hours logged by the employee.
start_time
StringOptional
The time at which the employee started work.
end_time
StringOptional
The time at which the employee ended work.
created_at
StringRequired
modified_at
StringRequired
This is the datetime that this object was last updated by Merge
The TimesheetEntry object
JSON
{"id": "91b2b905-e866-40c8-8be2-efe53827a0aa","remote_id": "19202938","employee": "d2f972d0-2526-434b-9409-4c3b468e08f0","hours_worked": 10,"start_time": "2020-11-10T00:00:00Z","end_time": "2020-11-10T00:10:00Z","created_at": "2021-09-15T00:00:00Z","modified_at": "2021-10-16T00:00:00Z"}
GET
/timesheet-entries
https://api.merge.dev/api/hris/v1/timesheet-entries
US
EU
Returns a list of TimesheetEntry
objects.
Header Parameters
Authorization
StringRequired
Token-based authentication with required prefix "Bearer"
X-Account-Token
StringRequired
Token identifying the end user.
Query & Path Parameters
created_after
StringOptional
If provided, will only return objects created after this datetime.
created_before
StringOptional
If provided, will only return objects created before this datetime.
cursor
StringOptional
The pagination cursor value.
employee_id
StringOptional
If provided, will only return employee payroll runs for this employee.
ended_after
StringOptional
If provided, will only return employee payroll runs ended after this datetime.
ended_before
StringOptional
If provided, will only return employee payroll runs ended before this datetime.
include_deleted_data
BooleanOptional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_data
BooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
modified_after
StringOptional
If provided, only objects synced by Merge after this date time will be returned.
modified_before
StringOptional
If provided, only objects synced by Merge before this date time will be returned.
order_by
StringOptional
Overrides the default ordering for this endpoint. Possible values include: start_time, -start_time.
page_size
IntegerOptional
Number of results to return per page.
remote_id
StringOptional
The API provider's ID for the given object.
started_after
StringOptional
If provided, will only return employee payroll runs started after this datetime.
started_before
StringOptional
If provided, will only return employee payroll runs started before this datetime.
Response
JSON
{"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results": [{"id": "91b2b905-e866-40c8-8be2-efe53827a0aa","remote_id": "19202938","employee": "d2f972d0-2526-434b-9409-4c3b468e08f0","hours_worked": 10,"start_time": "2020-11-10T00:00:00Z","end_time": "2020-11-10T00:10:00Z","created_at": "2021-09-15T00:00:00Z","modified_at": "2021-10-16T00:00:00Z"}]}
POST
/timesheet-entries
https://api.merge.dev/api/hris/v1/timesheet-entries
US
EU
Creates a TimesheetEntry
object with the given values.
Header Parameters
Authorization
StringRequired
Token-based authentication with required prefix "Bearer"
X-Account-Token
StringRequired
Token identifying the end user.
Query & Path Parameters
is_debug_mode
BooleanOptional
Whether to include debug fields (such as log file links) in the response.
run_async
BooleanOptional
Whether or not third-party updates should be run asynchronously.
Body Parameters
model
ObjectRequired
Find available fields below under “Model Parameters”.
Model Parameters
View app-specific writable fields under “Field support by platform” in this section.employee
StringThe employee the timesheet entry is for. Must pass in a valid Merge ID, which can be obtained from the
id
field in the Employee object.hours_worked
NumberThe number of hours logged by the employee.
start_time
StringThe time at which the employee started work.
end_time
StringThe time at which the employee ended work.
integration_params
Objectlinked_account_params
ObjectPOST v1/timesheet-entries
JSON
{"model": {"employee": "d2f972d0-2526-434b-9409-4c3b468e08f0","hours_worked": 10,"start_time": "2020-11-10T00:00:00Z","end_time": "2020-11-10T00:10:00Z"}}
Response
JSON
{"model": {"id": "91b2b905-e866-40c8-8be2-efe53827a0aa","remote_id": "19202938","employee": "d2f972d0-2526-434b-9409-4c3b468e08f0","hours_worked": 10,"start_time": "2020-11-10T00:00:00Z","end_time": "2020-11-10T00:10:00Z","created_at": "2021-09-15T00:00:00Z","modified_at": "2021-10-16T00:00:00Z"},"warnings": [{"source": {"pointer": "/age"},"title": "Unrecognized Field","detail": "An unrecognized field, age, was passed in with request data.","problem_type": "UNRECOGNIZED_FIELD"}],"errors": [{"source": {},"title": "Missing Required Field","problem_type": "MISSING_REQUIRED_FIELD"}],"logs": [{"log_id": "99433219-8017-4acd-bb3c-ceb23d663832","dashboard_view": "https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832","log_summary": {"url": "https://harvest.greenhouse.io/v1/candidates/","method": "POST","status_code": 200}}]}
GET
/timesheet-entries/{id}
https://api.merge.dev/api/hris/v1/timesheet-entries/{id}
US
EU
Returns a TimesheetEntry
object with the given id
.
Header Parameters
Authorization
StringRequired
Token-based authentication with required prefix "Bearer"
X-Account-Token
StringRequired
Token identifying the end user.
Query & Path Parameters
id
StringRequired
include_remote_data
BooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
Response
JSON
{"id": "91b2b905-e866-40c8-8be2-efe53827a0aa","remote_id": "19202938","employee": "d2f972d0-2526-434b-9409-4c3b468e08f0","hours_worked": 10,"start_time": "2020-11-10T00:00:00Z","end_time": "2020-11-10T00:10:00Z","created_at": "2021-09-15T00:00:00Z","modified_at": "2021-10-16T00:00:00Z"}
GET
/timesheet-entries/meta/post
https://api.merge.dev/api/hris/v1/timesheet-entries/meta/post
US
EU
Returns metadata for TimesheetEntry
POSTs.
Header Parameters
Authorization
StringRequired
Token-based authentication with required prefix "Bearer"
X-Account-Token
StringRequired
Token identifying the end user.
Response
JSON
{"request_schema": {},"remote_field_classes": {},"status": {"linked_account_status": "COMPLETE","can_make_request": true},"has_conditional_params": true,"has_required_linked_account_params": true}