Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview


This structure contains the complete set of information about a project associated with a cost cardthat is relevant to expense entry and expense management.

Format


Panel
titlePwsExpenseEntryProject
  • PwsExpenseEntryProject
    • ProjectCode: String (24)
    • ProjectId: Int32
    • ProjectUid: Int64
    • BookedResourcesOnlyFlag: Boolean
    • EarliestRoleStartDate: DateTime
    • EngagementDescriptor: PwsEngagementDescriptor
    • LatestRoleEndDate: DateTime
    • LocationIdentity: PwsLocationRef
    • OpenForCostFlag: Boolean
    • ProjectCloseDate: DateTime
    • ProjectDescription: String (1000)
    • ProjectManager: PwsUserSummary
    • ProjectName: String (255)
    • ProjectOpenDate: DateTime
    • ProjectStageIdentity: PwsProjectStageRef
    • RoleCount: Int32
    • Udf1InactiveFlag: Boolean
    • Udf1Values: String
    • Udf2InactiveFlag: Boolean
    • Udf2Values: String
    • AllowBookingFlag: Boolean
    • Udf1DefaultValue: String
    • Udf2DefaultValue: String
    • ExpenseTypeIdentities: PwsExpenseTypeRef

Elements


Element

Data Type

Required?

Default

Description

Sample Data

ProjectCode

String (24)

One of the ProjectCode or ProjectUid is required

The project code is a unique identifier for a project.

P001407-001

ProjectId

Int32No

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


ProjectUid

Int64

See ProjectCode

A unique and immutable identifier for a project.

1152921504607413030

BookedResourcesOnlyFlag

Boolean

On Insert: No

On Update: No

false

If set to 'true', only resources booked to a role can enter expenses against the project.

false

EarliestRoleStartDate

DateTime

On Insert: No

On Update: No

The earliest role start date (if null, there are no roles, or no roles have a start date, this field will take on the value of the ProjectStartDate).

2018-01-01T00:00:00Z

EngagementDescriptor

PwsEngagementDescriptor

On Insert: Yes

On Update: No

The complete set of Basic information about the engagement this project resides under.


LatestRoleEndDate

DateTime

On Insert: No

On Update: No

The earliest latest role end date (if nullthere are no roles, or no roles have an end date, this field will take on the value of the ProjectCloseDate – and may be null if the project has no close date).

2018-02-28T00:00:00Z

LocationIdentity

PwsLocationRef

On Insert: Yes

On Update: No

The location associated The location associated with the project.


OpenForCostFlag

BooleanOn Insert: Yes

On Update: No

true

If set to 'true', the project is open for cost.

true

ProjectCloseDate

DateTime

On Insert: No

On Update: No

The project close date.

2018-02-28T00:00:00Z

ProjectDescription

String

On Insert: No

On Update: No

The project description.


ProjectManager

PwsUserSummaryOn Insert: Yes

On Update: No

The project manager.


ProjectName

String

On Insert: Yes

On Update: No

The project name.

Project A

ProjectOpenDate

DateTime

On Insert: Yes

On Update: No

The project open date.

2018-01-01T00:00:00Z

ProjectStageIdentity

PwsProjectStageRef

On Insert: Yes

On Update: No

The proejct stageThe project stage.


RoleCount

Int32

On Insert: No

On Update: No

The number of active project roles.

1

Udf1InactiveFlag

Boolean

On Insert: No

On Update: No

false

If set to 'true', the first cost card user defined field (UDF) associated with the expense type specified in the cost card is inactive (taking enterprise configuration into account).

false

Udf1Values

String

On Insert: No

On Update: No

A complete list of valid values for the first user defined field (UDF).


Udf2InactiveFlag

Boolean

On Insert: No

On Update: No

false

If set to 'true', the second cost card user defined field (UDF) associated with the expense type specified in the cost card is inactiveis inactive (taking enterprise configuration into account).

false

Udf2Values

String

On Insert: No

On Update: No

A complete list of valid values for the second user defined field (UDF).


AllowBookingFlag

Boolean

On Insert: No

On Update: No

true

If set to 'true', the project allows permissioned users to book hours report expenses against the project.

true

Udf1DefaultValue

String

On Insert: No

On Update: No

The default value for the first cost card user defined field (UDF).


Udf2DefaultValue

StringOn Insert: No

On Update: No

The default value for the second cost card user defined field (UDF).


ExpenseTypeIdentities

PwsExpenseTypeRef

On Insert: No

On Update: No

A list of all the valid expense types.


Usage Example(s)


Code Block
languagexml
titleExample 01
collapsetrue
                   <a:PwsExpenseEntryProject>
                     <ProjectCode xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">P001407-001</ProjectCode>
                     <ProjectId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                     <ProjectUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607413030</ProjectUid>
                     <a:BookedResourcesOnlyFlag>false</a:BookedResourcesOnlyFlag>
                     <a:EarliestRoleStartDate>2018-01-01T00:00:00Z</a:EarliestRoleStartDate>
                     <a:EngagementDescriptor>
                        <EngagementCode xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">E001407</EngagementCode>
                        <EngagementId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                        <EngagementUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607325242</EngagementUid>
                        <a:ClientDescriptor>
                           <ClientId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                           <ClientNumber xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">PR-PSA</ClientNumber>
                           <ClientUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504606961482</ClientUid>
                           <a:ClientName>Projector PSA</a:ClientName>
                           <a:ParentClientDescriptor i:nil="true"/>
                        </a:ClientDescriptor>
                        <a:EngagementManager xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                           <b:UserDisplayName>Jack Spratt</b:UserDisplayName>
                           <b:UserId i:nil="true"/>
                           <b:UserReferenceSystemId>E123</b:UserReferenceSystemId>
                           <b:UserUid>1152921504607112369</b:UserUid>
                           <b:EmailAddress>jack@revcorp.bb</b:EmailAddress>
                           <b:FirstName>Jack</b:FirstName>
                           <b:LastName>Spratt</b:LastName>
                           <b:MiddleName i:nil="true"/>
                        </a:EngagementManager>
                        <a:EngagementName>Engagement A</a:EngagementName>
                        <a:EngagementTypeDescriptor>
                           <EngagementTypeId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                           <EngagementTypeName xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">Billable - Time and Materials</EngagementTypeName>
                           <EngagementTypeShortName xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">TandM</EngagementTypeShortName>
                           <EngagementTypeUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504606863884</EngagementTypeUid>
                           <a:BillableFlag>true</a:BillableFlag>
                        </a:EngagementTypeDescriptor>
                        <a:EngagementCurrencyDecimalDigits>2</a:EngagementCurrencyDecimalDigits>
                        <a:EngagementCurrencyIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                           <b:CurrencyCode>USD</b:CurrencyCode>
                           <b:CurrencyId i:nil="true"/>
                           <b:CurrencyUid>1152921504606851838</b:CurrencyUid>
                        </a:EngagementCurrencyIdentity>
                     </a:EngagementDescriptor>
                     <a:LatestRoleEndDate>2018-02-28T00:00:00Z</a:LatestRoleEndDate>
                     <a:LocationIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:LocationId i:nil="true"/>
                        <b:LocationName>USA</b:LocationName>
                        <b:LocationUid>1152921504606855985</b:LocationUid>
                     </a:LocationIdentity>
                     <a:OpenForCostFlag>true</a:OpenForCostFlag>
                     <a:ProjectCloseDate>2018-02-28T00:00:00Z</a:ProjectCloseDate>
                     <a:ProjectDescription i:nil="true"/>
                     <a:ProjectManager xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:UserDisplayName>Jack Spratt</b:UserDisplayName>
                        <b:UserId i:nil="true"/>
                        <b:UserReferenceSystemId>E123</b:UserReferenceSystemId>
                        <b:UserUid>1152921504607112369</b:UserUid>
                        <b:EmailAddress>jack@revcorp.bb</b:EmailAddress>
                        <b:FirstName>Jack</b:FirstName>
                        <b:LastName>Spratt</b:LastName>
                        <b:MiddleName i:nil="true"/>
                     </a:ProjectManager>
                     <a:ProjectName>Project A</a:ProjectName>
                     <a:ProjectOpenDate>2018-01-01T00:00:00Z</a:ProjectOpenDate>
                     <a:ProjectStageIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:ProjectStageId i:nil="true"/>
                        <b:ProjectStageName>Delivery</b:ProjectStageName>
                        <b:ProjectStageShortName>Delivery</b:ProjectStageShortName>
                        <b:ProjectStageUid>1152921504606853304</b:ProjectStageUid>
                     </a:ProjectStageIdentity>
                     <a:RoleCount>1</a:RoleCount>
                     <a:Udf1InactiveFlag>false</a:Udf1InactiveFlag>
                     <a:Udf1Values xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/>
                     <a:Udf2InactiveFlag>false</a:Udf2InactiveFlag>
                     <a:Udf2Values xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                        <b:string>Celebration</b:string>
                        <b:string>Team Building</b:string>
                        <b:string>Client Meeting</b:string>
                        <b:string>Other</b:string>
                     </a:Udf2Values>
                     <a:AllowBookingFlag>true</a:AllowBookingFlag>
                     <a:Udf1DefaultValue i:nil="true"/>
                     <a:Udf2DefaultValue i:nil="true"/>
                     <a:ExpenseTypeIdentities xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:PwsExpenseTypeRef>
                           <b:ExpenseTypeId i:nil="true"/>
                           <b:ExpenseTypeName>Meals</b:ExpenseTypeName>
                           <b:ExpenseTypeUid>1152921504606878415</b:ExpenseTypeUid>
                        </b:PwsExpenseTypeRef>
                        <b:PwsExpenseTypeRef>
                           <b:ExpenseTypeId i:nil="true"/>
                           <b:ExpenseTypeName>Other/Misc Billable</b:ExpenseTypeName>
                           <b:ExpenseTypeUid>1152921504606879705</b:ExpenseTypeUid>
                        </b:PwsExpenseTypeRef>
                        <b:PwsExpenseTypeRef>
                           <b:ExpenseTypeId i:nil="true"/>
                           <b:ExpenseTypeName>Meals and Entertainment</b:ExpenseTypeName>
                           <b:ExpenseTypeUid>1152921504606881279</b:ExpenseTypeUid>
                        </b:PwsExpenseTypeRef>
                        <b:PwsExpenseTypeRef>
                           <b:ExpenseTypeId i:nil="true"/>
                           <b:ExpenseTypeName>Travel</b:ExpenseTypeName>
                           <b:ExpenseTypeUid>1152921504606881280</b:ExpenseTypeUid>
                        </b:PwsExpenseTypeRef>
                     </a:ExpenseTypeIdentities>
                  </a:PwsExpenseEntryProject>