GET PlanCare2Api/Timesheets/{timesheetId}
Fetch Client/Organization timesheet by identifier.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| timesheetId |
Identifier of the timesheet. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Returns a Client/Organization timesheet by identifier.
TimesheetComplete| Name | Description | Type | Additional information |
|---|---|---|---|
| Identifier |
The Identifier of the timeregistration. Remarks: When using PlanCare2 identification: for new instance the Identifier should be 0 and Type should be PlanCare2Id. When using External identification: the Identifier should always be your own identifier and Type should be ExternalId. |
Identity |
Required |
| Employee |
References to the employee. |
Identity |
Required |
| ProductId |
References to the Product. |
integer |
Conditional Required: Use either this property or the Product property |
| Product |
References to the Product. |
ProductIdentity |
Conditional Required: Use either this property or the ProductId property |
| Start |
The start date and time. |
date |
Required |
| End |
The end date and time. |
date |
Required |
| EmploymentId |
References to the employement of the employee. |
integer |
Required |
| WorkTypeId |
References to an optional WorkType. |
integer |
None |
| Description |
The description of the timeregistration. |
string |
None |
| ClientAbsent |
Determines whether the client is absent. |
boolean |
None |
| ClientSigned |
Determines whether the client has signed. |
boolean |
None |
| CostTypeId |
The id of the costType. |
integer |
None |
| TravelMethodId |
The id of the travelMethod. |
integer |
None |
| Cost |
Amount of the cost. |
decimal number |
None |
| TravelDistance |
The travel distances in km. |
integer |
None |
| TravelDuration |
The travel duration in minutes. |
integer |
None |
| Location |
The address. |
Location |
None |
| Client |
References to the client. |
Identity |
Conditional Required: Required for all client timesheets |
| ContractId |
References to the Contract. |
integer |
Conditional Required: Required for all client timesheets |
| LocationId |
Refers to the Location. |
integer |
Conditional Required: Only required for GRZ timesheets |
| Acts |
The list of acts for timesheet. The list can be empty but must be initialized. |
Collection of ProductAct |
Conditional Required: Only required for GRZ timesheets |
| OrganizationEntityId |
Refers to the organization entity id. |
Identity |
None |
Response Formats
application/json, text/json
{
"Identifier": {
"$id": "2",
"Identifier": "sample string 1",
"Type": 0
},
"Employee": {
"$ref": "2"
},
"ProductId": 1,
"Product": {
"$id": "3",
"Identifier": "sample string 1",
"Type": 0
},
"Start": "2026-05-26T21:06:31.2744258+02:00",
"End": "2026-05-26T21:06:31.2744258+02:00",
"EmploymentId": 4,
"WorkTypeId": 1,
"Description": "sample string 5",
"ClientAbsent": true,
"ClientSigned": true,
"CostTypeId": 1,
"TravelMethodId": 1,
"Cost": 1.0,
"TravelDistance": 1,
"TravelDuration": 1,
"Location": {
"$id": "4",
"ZipCode": "sample string 1",
"HouseNumber": 1,
"HouseNumberAddition": "sample string 2"
},
"Client": {
"$ref": "2"
},
"ContractId": 8,
"LocationId": 9,
"Acts": [
{
"$id": "5",
"ProductId": 1,
"ActId": 2,
"ActName": "sample string 3",
"ActDescription": "sample string 4"
},
{
"$ref": "5"
}
],
"OrganizationEntityId": {
"$ref": "2"
}
}