PwsResourceTimeCard

Owned by Bettina Borces
Last updated: Jan 31, 2024
5 min read

Overview


This structure contains the complete set of information about a time card. The structure is used both to retrieve detailed time card information and to pass information about a time card back to the server to get updated.

Format


PwsResourceTimecard

Elements


Element

Data Type

Required?

Default

Description

Sample Data

ReferenceId

String

No


Reference id (used to affiliate PwsSaveTimeCardsAndRto records with associated PwsResourceTimeCard records).


TimecardId

Int32

No


The time card Id is a unique identifier for a time card. For internal use only.  


TimecardType

String

On Insert: Yes

On Update: No 


The time card type:

'T' for time card associated with a project

'R' for reported time off

In this case, the value will always be "T".


TimecardUid

Int64

On Insert: No

On Update: Yes 


A unique and immutable identifier for a time card.


Description

String

On Insert: No (unless the time card task type requires a description)

On Update: No 


The time card description.

Time Card Insert

DescriptionClearFlag

Boolean

No

false

If set to 'true', the time card description will be cleared.

false 

RejectedByUser

PwsUserRef

On Insert: No (unless the status = 'R')

On Update: No


The user who rejected the time card.

Note: This is only applicable if the status = 'R' for rejected.


RejectedReason

String

On Insert: No (unless the status = 'R')

On Update: No


The reject reason associated with the time card.

Note: This is only applicable if the status = 'R' for rejected.


RejectedTimestamp

DateTime

On Insert: No (unless the status = 'R')

On Update: No



The date and time when the time card was rejected.

Note: This is only applicable if the status = 'R' for rejected.


Status

TimeCardStatus

On Insert: No

On Update: No 


*** This field has been deprecated ***


WorkDate

DateTime

On Insert: Yes

On Update: No 


The work date associated with the time card.

2018-03-14T00:00:00.000Z

WorkMinutes

Int32

On Insert: Yes

On Update: No  


The work minutes associated with the time card.

120

Timestamp

String

No


This is a Base64 encoded timestamp optionally utilized for time card locking.


CardStatus


Note: This field is ignored when calling the web service PwsSaveTimeCardsAndRto.

String

On Insert: Yes

On Update: No  


The time card status:

'D' for draft

'R' for rejected

'S' for submitted

'A' for approved

'B' for billed

S

LocationClearFlag

Boolean

No

false

If set to 'true', the time card location is cleared.

false

LocationIdentity

PwsLocationRef

On Insert: No (unless locations are required on time cards)

On Update: No  


The location associated with the time card.


ProjectIdentity

PwsProjectRef

On Insert: Yes

On Update: No  


The project associated with the time card.


ProjectRateTypeIdentity

PwsProjectRateTypeRef

On Insert: Yes

On Update: No  


The project rate type associated with the time card.


ProjectTaskIdentity

PwsProjectTaskRef

On Insert: Yes

On Update: No  


The project task associated with the time card.


RoleClearFlag

Boolean

No

false 

If set to 'true', the time card project role is cleared.

false

RoleIdentity

PwsProjectRoleRef

On Insert: Yes

On Update: No  


The project role associated with time card.


Udf1

PwsUserDefinedFieldDetail

On Insert: No (unless the time card task type requires Udf1)

On Update: No  


The first user defined field associated with the time card.


Udf1ClearFlag

Boolean

No

false

If set to 'true', the first user defined field is cleared.

false

Udf2

PwsUserDefinedFieldDetail

On Insert: No (unless the time card task type requires Udf2)

On Update: No  


The second user defined field associated with the time card.


Udf2ClearFlag

Boolean

No

false

If set to 'true', the second user defined field is cleared.

false

ExternalGroupingIdentifier

Int32

No


This unique identifier allows users to group multiple time cards together, most commonly user for reporting purposes.


ExternalGroupingIdentifierClearFlag

Boolean

No 

false

If set to 'true', the external grouping identifier is cleared.

1

ResourceIdentity

PwsResourceRef

On Insert: Yes

On Update: No  


The resource associated with the time card.

false

Usage Example(s)


Example 01 
              <tim:PwsResourceTimecard>
                  <tim:Description>Time Card Insert</tim:Description>
                  <tim:DescriptionClearFlag>false</tim:DescriptionClearFlag>
                  <tim:Status>Submitted</tim:Status>
                  <tim:WorkDate>2018-03-14T00:00:00.000Z</tim:WorkDate>
                  <tim:WorkMinutes>120</tim:WorkMinutes>
                  <tim:CardStatus>S</tim:CardStatus>
                  <tim:LocationClearFlag>false</tim:LocationClearFlag>
                  <tim:LocationIdentity>
                     <com:LocationName>USA</com:LocationName>
                  </tim:LocationIdentity>
                  <tim:ProjectIdentity>
                     <com:ProjectCode>P001396-001</com:ProjectCode>
                  </tim:ProjectIdentity>
                  <tim:ProjectRateTypeIdentity>
                     <com:ProjectRateTypeUid>1152921504607370468</com:ProjectRateTypeUid>
                  </tim:ProjectRateTypeIdentity>
                  <tim:ProjectTaskIdentity>
                     <com:ProjectTaskUid>1152921504608637344</com:ProjectTaskUid>
                  </tim:ProjectTaskIdentity>
                  <tim:RoleClearFlag>false</tim:RoleClearFlag>
                  <tim:RoleIdentity>
                     <com:ProjectRoleUid>1152921504609525049</com:ProjectRoleUid>
                  </tim:RoleIdentity>
                  <tim:Udf1>
                     <com:UdfName>TC-Jira</com:UdfName>
                     <com:RelationValue>
                        <com:CodeValue>SD-23</com:CodeValue>
                     </com:RelationValue>
                  </tim:Udf1>
                  <tim:Udf1ClearFlag>false</tim:Udf1ClearFlag>
                  <tim:Udf2ClearFlag>false</tim:Udf2ClearFlag>
                  <tim:ExternalGroupingIdentifier>1</tim:ExternalGroupingIdentifier>
                  <tim:ExternalGroupingIdentifierClearFlag>false</tim:ExternalGroupingIdentifierClearFlag>
                  <tim:ResourceIdentity>
                     <com:ResourceReferenceSystemId>E123</com:ResourceReferenceSystemId>
                  </tim:ResourceIdentity>
               </tim:PwsResourceTimecard>