Help Page Home - Payroll
POST Payroll/Timesheet
Insert a timesheet entry.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| WsAccessKey | The Web Service access key for this user and file which allows access to the API for the associated file (found in File - Settings). Using OAuth authentication mechanism is the preferred method to allow API access. | string |
Optional. Legacy authentication method and only required if not using OAuth. OAuth is preferred. |
| FileId | Specifies the file id of the file to perform the operation upon. | integer |
Required |
Body Parameters
Timesheet| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | The unique key/Id of the timesheet entry. | integer |
None. |
| LastUpdatedId | Identifier used for concurrency checking. Required for update. | string |
None. |
| LastModifiedDateUtc | The date and time that the timesheet was modified in UTC. | date |
None. |
| CreatedDateUtc | The date and time that the timesheet was created in UTC. | date |
None. |
| LastModifiedByUserId | The user id of the user who last modified the timesheet. | integer |
None. |
| ContactId | The employee contact id for this timesheet. Call GET Employees to get a list of employee contact id. | integer |
Required |
| StartTime | Start time. | date |
Required |
| FinishTime | Finish time. | date |
Required |
| BreakDurationInMinutes | No documentation available. | integer |
None. |
| Notes | Internal notes. | string |
None. |
| _links | Hypermedia links. Contains contextual links to possible next actions related to this resource. Only present in responses. This data is not to be sent to the server. | Collection of Link |
None. |
Request Formats
application/json, text/json
Sample:
{
"Id": 1,
"LastUpdatedId": "sample string 1",
"LastModifiedDateUtc": "2025-11-01T20:05:53.0276642+11:00",
"CreatedDateUtc": "2025-11-01T20:05:53.0276642+11:00",
"LastModifiedByUserId": 1,
"ContactId": 2,
"StartTime": "2025-11-01T20:05:53.0276642+11:00",
"FinishTime": "2025-11-01T20:05:53.0276642+11:00",
"BreakDurationInMinutes": 5,
"Notes": "sample string 6",
"_links": []
}
application/xml, text/xml
Sample:
<Timesheet xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <_links /> <Id>1</Id> <LastUpdatedId>sample string 1</LastUpdatedId> <LastModifiedDateUtc>2025-11-01T20:05:53.0276642+11:00</LastModifiedDateUtc> <CreatedDateUtc>2025-11-01T20:05:53.0276642+11:00</CreatedDateUtc> <LastModifiedByUserId>1</LastModifiedByUserId> <ContactId>2</ContactId> <StartTime>2025-11-01T20:05:53.0276642+11:00</StartTime> <FinishTime>2025-11-01T20:05:53.0276642+11:00</FinishTime> <BreakDurationInMinutes>5</BreakDurationInMinutes> <Notes>sample string 6</Notes> </Timesheet>
Response Information
Resource Description
InsertTimesheetResult| Name | Description | Type | Additional information |
|---|---|---|---|
| InsertedTimesheetId | No documentation available. | integer |
None. |
| LastUpdatedId | The unique identifier generated as part of the update. This value is required when submitting subsequent update to prevent concurrency errors. | string |
None. |
| UtcLastModified | The date and time this resource was modified in UTC. | date |
None. |
| _links | Hypermedia links. Contains contextual links to possible next actions related to this resource. Only present in responses. This data is not to be sent to the server. | Collection of Link |
None. |
Response Formats
application/json, text/json
Sample:
{
"InsertedTimesheetId": 1,
"LastUpdatedId": "sample string 2",
"UtcLastModified": "2025-11-01T20:05:53.0276642+11:00",
"_links": [
{
"rel": "sample string 1",
"href": "sample string 2",
"method": "sample string 3",
"title": "sample string 4"
},
{
"rel": "sample string 1",
"href": "sample string 2",
"method": "sample string 3",
"title": "sample string 4"
}
]
}
application/xml, text/xml
Sample:
<InsertTimesheetResult xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<_links>
<Link>
<rel>sample string 1</rel>
<href>sample string 2</href>
<method>sample string 3</method>
<title>sample string 4</title>
</Link>
<Link>
<rel>sample string 1</rel>
<href>sample string 2</href>
<method>sample string 3</method>
<title>sample string 4</title>
</Link>
</_links>
<LastUpdatedId>sample string 2</LastUpdatedId>
<UtcLastModified>2025-11-01T20:05:53.0276642+11:00</UtcLastModified>
<InsertedTimesheetId>1</InsertedTimesheetId>
</InsertTimesheetResult>