GET PlanCare2Api/Timesheets/WLZ/{timesheetId}

Fetch WLZ timesheet by identifier.

Deprecated (unavailable from 21.01.1P), please use the PlanCare2Api/Timesheets/{timesheetId} endpoint

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 WLZ timesheet by identifier.

TimesheetWLZ
Name Description Type Additional information
Client

References to the client

Identity

Required

ContractId

References to the Contract

integer

Required

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

Required

Start

The start date and time.

date

Required

End

The end date and time.

date

Required

EmploymentId

References to the employment 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

-

OrganizationEntityId

Refers to the organization entity id.

Identity

-

Response Formats

application/json, text/json

Sample:
{
  "Client": {
    "$id": "2",
    "Identifier": "sample string 1",
    "Type": 0
  },
  "ContractId": 1,
  "Identifier": {
    "$ref": "2"
  },
  "Employee": {
    "$ref": "2"
  },
  "ProductId": 2,
  "Start": "2026-05-26T21:12:33.6679695+02:00",
  "End": "2026-05-26T21:12:33.6679695+02:00",
  "EmploymentId": 5,
  "WorkTypeId": 1,
  "Description": "sample string 6",
  "ClientAbsent": true,
  "ClientSigned": true,
  "CostTypeId": 1,
  "TravelMethodId": 1,
  "Cost": 1.0,
  "TravelDistance": 1,
  "TravelDuration": 1,
  "Location": {
    "$id": "3",
    "ZipCode": "sample string 1",
    "HouseNumber": 1,
    "HouseNumberAddition": "sample string 2"
  },
  "OrganizationEntityId": {
    "$ref": "2"
  }
}

application/xml, text/xml

Sample:
<TimesheetWLZ xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.TimeSheet">
  <ClientAbsent>true</ClientAbsent>
  <ClientSigned>true</ClientSigned>
  <Cost>1</Cost>
  <CostTypeId>1</CostTypeId>
  <Description>sample string 6</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>5</EmploymentId>
  <End>2026-05-26T21:12:33.6679695+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>
  <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>
  <ProductId>2</ProductId>
  <Start>2026-05-26T21:12:33.6679695+02:00</Start>
  <TravelDistance>1</TravelDistance>
  <TravelDuration>1</TravelDuration>
  <TravelMethodId>1</TravelMethodId>
  <WorkTypeId>1</WorkTypeId>
  <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>
  <ContractId>1</ContractId>
</TimesheetWLZ>