GET PlanCare2Api/Timesheets/RealizedTimesheets?dateFrom={dateFrom}&dateUntil={dateUntil}&forCurrentEmployeeOnly={forCurrentEmployeeOnly}
Fetch realized timesheets within the given time period .
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| dateFrom |
Start date for the filter. |
date |
Required |
| dateUntil |
End date for the filter. |
date |
Required |
| forCurrentEmployeeOnly |
Determine if the realized timesheet are owned by logged on employee. |
boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
Returns a list of timesheets within the given time periods.
Collection of RealizedTimesheet| Name | Description | Type | Additional information |
|---|---|---|---|
| TimesheetId |
The internal id of the realized timesheet. |
integer |
None |
| ExternalId |
The external id of the realized timesheet. |
string |
None |
| Start |
Start date and time. |
date |
None |
| End |
End date and time. |
date |
None |
| Employee |
Identifier of the employee who has performed the timesheet. |
Identity |
None |
| EmployeeName |
Employee name who realized the timesheet. |
string |
None |
| Contract |
Contracttype of the timesheet. |
ContractType |
Deprecated (unavailable from 21.01.1P): Please use 'ContractInfo' instead. |
| ContractInfo |
Contract information of the timesheet. |
ContractInfo |
None |
| Client |
Identifier of the client involved. |
Identity |
None |
| Description |
Description added to the timesheet. |
string |
None |
| ClientName |
The name of the involved client. |
string |
None |
| Product |
The identifier of the product. |
Identity |
None |
| ProductName |
The name of the product. |
string |
None |
| Project |
Project identifier if available. |
Project |
None |
| IsApproved |
The status of the timesheet approval whether it is approved by the employee. |
boolean |
None |
| Editable |
The status whether this timesheet is editable or not. |
boolean |
None |
| AccomplishedThroughCalendar |
It declares whether this timesheet is accomplished through a calendar. |
boolean |
None |
| WorkType |
Attached worktype in timesheet. |
WorkType |
None |
| CurrentLevel |
The current approval level. |
integer |
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 in euro. |
decimal number |
None |
| TravelDistance |
The travel distances in km. |
integer |
None |
| TravelDuration |
The travel duration in minutes. |
integer |
None |
| Location |
The address. |
Location |
None |
| EmploymentId |
The id of the employment. |
integer |
None |
| OrganizationEntityId |
Refers to the organization entity id. |
Identity |
None |
| DeclarationCodes |
List of declarationcodes - valid in the timesheet's period - of all the products associated with the contract of this timesheet. |
Collection of ContractProductDeclarationCode |
None |
Response Formats
application/json, text/json
[
{
"$id": "1",
"TimesheetId": 1,
"ExternalId": "sample string 2",
"Start": "2026-05-26T23:13:55.5254523+02:00",
"End": "2026-05-26T23:13:55.5254523+02:00",
"Employee": {
"$id": "2",
"Identifier": "sample string 1",
"Type": 0
},
"EmployeeName": "sample string 5",
"Contract": {
"$id": "3",
"Id": 1,
"Code": "sample string 2",
"Description": "sample string 3",
"IsActive": true,
"Source": "sample string 5"
},
"ContractInfo": {
"$id": "4",
"Id": 1,
"ContractTypeCode": "sample string 2",
"Description": "sample string 3"
},
"Client": {
"$ref": "2"
},
"Description": "sample string 6",
"ClientName": "sample string 7",
"Product": {
"$ref": "2"
},
"ProductName": "sample string 8",
"Project": {
"$id": "5",
"Id": "sample string 1",
"Name": "sample string 2"
},
"IsApproved": true,
"Editable": true,
"AccomplishedThroughCalendar": true,
"WorkType": {
"$id": "6",
"Id": 1,
"Code": "sample string 2",
"Name": "sample string 3",
"Description": "sample string 4",
"StartDate": "2026-05-26T23:13:55.5254523+02:00",
"EndDate": "2026-05-26T23:13:55.5254523+02:00",
"WorkTypeIsDirect": true,
"ExternalCode": "sample string 7",
"IsWorkTime": true,
"OrganizationEntities": [
{
"$id": "7",
"CostCenter": "sample string 1",
"Code": "sample string 2",
"Name": "sample string 3",
"Id": {
"$ref": "2"
}
},
{
"$ref": "7"
}
]
},
"CurrentLevel": 12,
"ClientAbsent": true,
"ClientSigned": true,
"CostTypeId": 1,
"TravelMethodId": 1,
"Cost": 1.0,
"TravelDistance": 1,
"TravelDuration": 1,
"Location": {
"$id": "8",
"ZipCode": "sample string 1",
"HouseNumber": 1,
"HouseNumberAddition": "sample string 2"
},
"EmploymentId": 15,
"OrganizationEntityId": {
"$ref": "2"
},
"DeclarationCodes": [
{
"$id": "9",
"Id": 1,
"Code": "sample string 2",
"Description": "sample string 3",
"Rate": 1.0,
"Factor": 4.0,
"ClientSpecificRateAllowed": true
},
{
"$ref": "9"
}
]
},
{
"$ref": "1"
}
]
application/xml, text/xml
<ArrayOfRealizedTimesheet xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.TimeSheet">
<RealizedTimesheet>
<AccomplishedThroughCalendar>true</AccomplishedThroughCalendar>
<Client xmlns:d3p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
<d3p1:Identifier>sample string 1</d3p1:Identifier>
<d3p1:Type>ExternalId</d3p1:Type>
</Client>
<ClientAbsent>true</ClientAbsent>
<ClientName>sample string 7</ClientName>
<ClientSigned>true</ClientSigned>
<Contract xmlns:d3p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface">
<d3p1:Code>sample string 2</d3p1:Code>
<d3p1:Description>sample string 3</d3p1:Description>
<d3p1:Id>1</d3p1:Id>
<d3p1:IsActive>true</d3p1:IsActive>
<d3p1:Source>sample string 5</d3p1:Source>
</Contract>
<ContractInfo xmlns:d3p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface">
<d3p1:ContractTypeCode>sample string 2</d3p1:ContractTypeCode>
<d3p1:Description>sample string 3</d3p1:Description>
<d3p1:Id>1</d3p1:Id>
</ContractInfo>
<Cost>1</Cost>
<CostTypeId>1</CostTypeId>
<CurrentLevel>12</CurrentLevel>
<DeclarationCodes xmlns:d3p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface">
<d3p1:ContractProductDeclarationCode>
<d3p1:ClientSpecificRateAllowed>true</d3p1:ClientSpecificRateAllowed>
<d3p1:Code>sample string 2</d3p1:Code>
<d3p1:Description>sample string 3</d3p1:Description>
<d3p1:Factor>4</d3p1:Factor>
<d3p1:Id>1</d3p1:Id>
<d3p1:Rate>1</d3p1:Rate>
</d3p1:ContractProductDeclarationCode>
<d3p1:ContractProductDeclarationCode>
<d3p1:ClientSpecificRateAllowed>true</d3p1:ClientSpecificRateAllowed>
<d3p1:Code>sample string 2</d3p1:Code>
<d3p1:Description>sample string 3</d3p1:Description>
<d3p1:Factor>4</d3p1:Factor>
<d3p1:Id>1</d3p1:Id>
<d3p1:Rate>1</d3p1:Rate>
</d3p1:ContractProductDeclarationCode>
</DeclarationCodes>
<Description>sample string 6</Description>
<Editable>true</Editable>
<Employee xmlns:d3p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
<d3p1:Identifier>sample string 1</d3p1:Identifier>
<d3p1:Type>ExternalId</d3p1:Type>
</Employee>
<EmployeeName>sample string 5</EmployeeName>
<EmploymentId>15</EmploymentId>
<End>2026-05-26T23:13:55.5254523+02:00</End>
<ExternalId>sample string 2</ExternalId>
<IsApproved>true</IsApproved>
<Location xmlns:d3p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.RealizedWorktime">
<d3p1:HouseNumber>1</d3p1:HouseNumber>
<d3p1:HouseNumberAddition>sample string 2</d3p1:HouseNumberAddition>
<d3p1:ZipCode>sample string 1</d3p1:ZipCode>
</Location>
<OrganizationEntityId xmlns:d3p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
<d3p1:Identifier>sample string 1</d3p1:Identifier>
<d3p1:Type>ExternalId</d3p1:Type>
</OrganizationEntityId>
<Product xmlns:d3p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
<d3p1:Identifier>sample string 1</d3p1:Identifier>
<d3p1:Type>ExternalId</d3p1:Type>
</Product>
<ProductName>sample string 8</ProductName>
<Project xmlns:d3p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface">
<d3p1:Id>sample string 1</d3p1:Id>
<d3p1:Name>sample string 2</d3p1:Name>
</Project>
<Start>2026-05-26T23:13:55.5254523+02:00</Start>
<TimesheetId>1</TimesheetId>
<TravelDistance>1</TravelDistance>
<TravelDuration>1</TravelDuration>
<TravelMethodId>1</TravelMethodId>
<WorkType xmlns:d3p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface">
<d3p1:Code>sample string 2</d3p1:Code>
<d3p1:Description>sample string 4</d3p1:Description>
<d3p1:EndDate>2026-05-26T23:13:55.5254523+02:00</d3p1:EndDate>
<d3p1:ExternalCode>sample string 7</d3p1:ExternalCode>
<d3p1:Id>1</d3p1:Id>
<d3p1:IsWorkTime>true</d3p1:IsWorkTime>
<d3p1:Name>sample string 3</d3p1:Name>
<d3p1:OrganizationEntities>
<d3p1:OrganizationEntity>
<d3p1:Code>sample string 2</d3p1:Code>
<d3p1:CostCenter>sample string 1</d3p1:CostCenter>
<d3p1:Id xmlns:d6p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
<d6p1:Identifier>sample string 1</d6p1:Identifier>
<d6p1:Type>ExternalId</d6p1:Type>
</d3p1:Id>
<d3p1:Name>sample string 3</d3p1:Name>
</d3p1:OrganizationEntity>
<d3p1:OrganizationEntity>
<d3p1:Code>sample string 2</d3p1:Code>
<d3p1:CostCenter>sample string 1</d3p1:CostCenter>
<d3p1:Id xmlns:d6p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
<d6p1:Identifier>sample string 1</d6p1:Identifier>
<d6p1:Type>ExternalId</d6p1:Type>
</d3p1:Id>
<d3p1:Name>sample string 3</d3p1:Name>
</d3p1:OrganizationEntity>
</d3p1:OrganizationEntities>
<d3p1:StartDate>2026-05-26T23:13:55.5254523+02:00</d3p1:StartDate>
<d3p1:WorkTypeIsDirect>true</d3p1:WorkTypeIsDirect>
</WorkType>
</RealizedTimesheet>
<RealizedTimesheet>
<AccomplishedThroughCalendar>true</AccomplishedThroughCalendar>
<Client xmlns:d3p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
<d3p1:Identifier>sample string 1</d3p1:Identifier>
<d3p1:Type>ExternalId</d3p1:Type>
</Client>
<ClientAbsent>true</ClientAbsent>
<ClientName>sample string 7</ClientName>
<ClientSigned>true</ClientSigned>
<Contract xmlns:d3p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface">
<d3p1:Code>sample string 2</d3p1:Code>
<d3p1:Description>sample string 3</d3p1:Description>
<d3p1:Id>1</d3p1:Id>
<d3p1:IsActive>true</d3p1:IsActive>
<d3p1:Source>sample string 5</d3p1:Source>
</Contract>
<ContractInfo xmlns:d3p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface">
<d3p1:ContractTypeCode>sample string 2</d3p1:ContractTypeCode>
<d3p1:Description>sample string 3</d3p1:Description>
<d3p1:Id>1</d3p1:Id>
</ContractInfo>
<Cost>1</Cost>
<CostTypeId>1</CostTypeId>
<CurrentLevel>12</CurrentLevel>
<DeclarationCodes xmlns:d3p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface">
<d3p1:ContractProductDeclarationCode>
<d3p1:ClientSpecificRateAllowed>true</d3p1:ClientSpecificRateAllowed>
<d3p1:Code>sample string 2</d3p1:Code>
<d3p1:Description>sample string 3</d3p1:Description>
<d3p1:Factor>4</d3p1:Factor>
<d3p1:Id>1</d3p1:Id>
<d3p1:Rate>1</d3p1:Rate>
</d3p1:ContractProductDeclarationCode>
<d3p1:ContractProductDeclarationCode>
<d3p1:ClientSpecificRateAllowed>true</d3p1:ClientSpecificRateAllowed>
<d3p1:Code>sample string 2</d3p1:Code>
<d3p1:Description>sample string 3</d3p1:Description>
<d3p1:Factor>4</d3p1:Factor>
<d3p1:Id>1</d3p1:Id>
<d3p1:Rate>1</d3p1:Rate>
</d3p1:ContractProductDeclarationCode>
</DeclarationCodes>
<Description>sample string 6</Description>
<Editable>true</Editable>
<Employee xmlns:d3p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
<d3p1:Identifier>sample string 1</d3p1:Identifier>
<d3p1:Type>ExternalId</d3p1:Type>
</Employee>
<EmployeeName>sample string 5</EmployeeName>
<EmploymentId>15</EmploymentId>
<End>2026-05-26T23:13:55.5254523+02:00</End>
<ExternalId>sample string 2</ExternalId>
<IsApproved>true</IsApproved>
<Location xmlns:d3p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.RealizedWorktime">
<d3p1:HouseNumber>1</d3p1:HouseNumber>
<d3p1:HouseNumberAddition>sample string 2</d3p1:HouseNumberAddition>
<d3p1:ZipCode>sample string 1</d3p1:ZipCode>
</Location>
<OrganizationEntityId xmlns:d3p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
<d3p1:Identifier>sample string 1</d3p1:Identifier>
<d3p1:Type>ExternalId</d3p1:Type>
</OrganizationEntityId>
<Product xmlns:d3p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
<d3p1:Identifier>sample string 1</d3p1:Identifier>
<d3p1:Type>ExternalId</d3p1:Type>
</Product>
<ProductName>sample string 8</ProductName>
<Project xmlns:d3p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface">
<d3p1:Id>sample string 1</d3p1:Id>
<d3p1:Name>sample string 2</d3p1:Name>
</Project>
<Start>2026-05-26T23:13:55.5254523+02:00</Start>
<TimesheetId>1</TimesheetId>
<TravelDistance>1</TravelDistance>
<TravelDuration>1</TravelDuration>
<TravelMethodId>1</TravelMethodId>
<WorkType xmlns:d3p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface">
<d3p1:Code>sample string 2</d3p1:Code>
<d3p1:Description>sample string 4</d3p1:Description>
<d3p1:EndDate>2026-05-26T23:13:55.5254523+02:00</d3p1:EndDate>
<d3p1:ExternalCode>sample string 7</d3p1:ExternalCode>
<d3p1:Id>1</d3p1:Id>
<d3p1:IsWorkTime>true</d3p1:IsWorkTime>
<d3p1:Name>sample string 3</d3p1:Name>
<d3p1:OrganizationEntities>
<d3p1:OrganizationEntity>
<d3p1:Code>sample string 2</d3p1:Code>
<d3p1:CostCenter>sample string 1</d3p1:CostCenter>
<d3p1:Id xmlns:d6p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
<d6p1:Identifier>sample string 1</d6p1:Identifier>
<d6p1:Type>ExternalId</d6p1:Type>
</d3p1:Id>
<d3p1:Name>sample string 3</d3p1:Name>
</d3p1:OrganizationEntity>
<d3p1:OrganizationEntity>
<d3p1:Code>sample string 2</d3p1:Code>
<d3p1:CostCenter>sample string 1</d3p1:CostCenter>
<d3p1:Id xmlns:d6p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
<d6p1:Identifier>sample string 1</d6p1:Identifier>
<d6p1:Type>ExternalId</d6p1:Type>
</d3p1:Id>
<d3p1:Name>sample string 3</d3p1:Name>
</d3p1:OrganizationEntity>
</d3p1:OrganizationEntities>
<d3p1:StartDate>2026-05-26T23:13:55.5254523+02:00</d3p1:StartDate>
<d3p1:WorkTypeIsDirect>true</d3p1:WorkTypeIsDirect>
</WorkType>
</RealizedTimesheet>
</ArrayOfRealizedTimesheet>