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	Nullable
Description	The description of the timeregistration.	string	-
ClientAbsent	Determines whether the client is absent.	boolean	-
ClientSigned	Determines whether the client has signed.	boolean	-
CostTypeId	The id of the costType.	integer	Nullable
TravelMethodId	The id of the travelMethod.	integer	Nullable
Cost	Amount of the cost.	decimal number	Nullable
TravelDistance	The travel distances in km.	integer	Nullable
TravelDuration	The travel duration in minutes.	integer	Nullable
Location	The address.	Location	-
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	-

Response Formats

application/json, text/json

Sample:

{
  "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-26T22:09:45.3552681+02:00",
  "End": "2026-05-26T22:09:45.3552681+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"
  }
}

application/xml, text/xml

Sample:

<TimesheetComplete xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.TimeSheet">
  <Acts xmlns:d2p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface">
    <d2p1:ProductAct>
      <d2p1:ActDescription>sample string 4</d2p1:ActDescription>
      <d2p1:ActId>2</d2p1:ActId>
      <d2p1:ActName>sample string 3</d2p1:ActName>
      <d2p1:ProductId>1</d2p1:ProductId>
    </d2p1:ProductAct>
    <d2p1:ProductAct>
      <d2p1:ActDescription>sample string 4</d2p1:ActDescription>
      <d2p1:ActId>2</d2p1:ActId>
      <d2p1:ActName>sample string 3</d2p1:ActName>
      <d2p1:ProductId>1</d2p1:ProductId>
    </d2p1:ProductAct>
  </Acts>
  <Client xmlns:d2p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
    <d2p1:Identifier>sample string 1</d2p1:Identifier>
    <d2p1:Type>ExternalId</d2p1:Type>
  </Client>
  <ClientAbsent>true</ClientAbsent>
  <ClientSigned>true</ClientSigned>
  <ContractId>8</ContractId>
  <Cost>1</Cost>
  <CostTypeId>1</CostTypeId>
  <Description>sample string 5</Description>
  <Employee xmlns:d2p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
    <d2p1:Identifier>sample string 1</d2p1:Identifier>
    <d2p1:Type>ExternalId</d2p1:Type>
  </Employee>
  <EmploymentId>4</EmploymentId>
  <End>2026-05-26T22:09:45.3552681+02:00</End>
  <Identifier xmlns:d2p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
    <d2p1:Identifier>sample string 1</d2p1:Identifier>
    <d2p1:Type>ExternalId</d2p1:Type>
  </Identifier>
  <Location xmlns:d2p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.RealizedWorktime">
    <d2p1:HouseNumber>1</d2p1:HouseNumber>
    <d2p1:HouseNumberAddition>sample string 2</d2p1:HouseNumberAddition>
    <d2p1:ZipCode>sample string 1</d2p1:ZipCode>
  </Location>
  <LocationId>9</LocationId>
  <OrganizationEntityId xmlns:d2p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
    <d2p1:Identifier>sample string 1</d2p1:Identifier>
    <d2p1:Type>ExternalId</d2p1:Type>
  </OrganizationEntityId>
  <Product>
    <Identifier>sample string 1</Identifier>
    <Type>ExternalId</Type>
  </Product>
  <ProductId>1</ProductId>
  <Start>2026-05-26T22:09:45.3552681+02:00</Start>
  <TravelDistance>1</TravelDistance>
  <TravelDuration>1</TravelDuration>
  <TravelMethodId>1</TravelMethodId>
  <WorkTypeId>1</WorkTypeId>
</TimesheetComplete>