Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

Overview


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

Format

PwsProjectDetail
  • PwsProjectDetail
    • ProjectCode: String
    • ProjectId: Int32
    • ProjectUid: Int64
    • EngagementIdentity: PwsEngagementRef
    • ProjectName: String
    • CloseDate: DateTime
    • CostGlccOverride: String
    • CostPlccMappingType: String
    • DefaultSchedulingMode: String
    • Description: String
    • EmEmailFlag: Boolean
    • EngagementTimestamp: String
    • ExpenseApprovalUserIdentity: PwsUserRef
    • ExpenseApproverType: String
    • ExpenseEntryRestrictedToResourcesAssignedToRolesFlag: Boolean
    • LocationIdentity: PwsLocationRef
    • ManagerIdentity: PwsUserRef
    • MinutesPerDay: Int16
    • NarrativeRequiredFlag: Boolean
    • NewProjectCode: String
    • OpenDate: DateTime
    • OpenForCostFlag: Boolean
    • OpenForCostTransferFlag: Boolean
    • OpenForTimeFlag: Boolean
    • OpenForTimeTransferFlag: Boolean
    • PercentLikelihood: Double
    • PmModuleEnabledFlag: Boolean
    • ProjectStageIdentity: PwsProjectStageRef
    • ProjectWorkspaceEnabledFlag: Boolean
    • Rates: PwsProjectRate[]
    • TimeApprovalUserIdentity: PwsUserRef
    • TimeApproverType: String
    • TimeEntryRestrictedToResourcesAssignedToRolesFlag: Boolean
    • TimeEntryRestrictedToRolesAssignedToTasksFlag: Boolean
    • TimeGlccOverride: String
    • TimePlccMappingType: String
    • UserDefinedFields: PwsUserDefinedFieldDetail[]
    • WorkspaceMessages: String
    • BookExpenseResourceCostCenterIdentity: PwsCostCenterRef
    • BookExpenseResourcesAllowCode: String
    • BookTimeResourceCostCenterIdentity: PwsCostCenterRef
    • BookTimeResourcesAllowCode: String
    • PlccMappings: PwsProjectPlccMappingCostCenter[]
    • ContractLineItemIdentity: PwsContractLineItemRef
    • ManagementTeam: PwsProjectManagementTeamMember[]
    • BdDashboards: PwsProjectBdDashboard[]
    • ExpenseTypeConfigurationIdentity: PwsExpenseTypeConfigurationRef
    • InheritPurchaseOrderNumberFlag: Boolean
    • PurchaseOrderNumber: String

Element

Element

Data Type

Required?

Default

Description

Sample Data

ProjectCode

String

 

 

 

 

ProjectId

Int32

 

 

 

 

ProjectUid

Int64

 

 

 

 

EngagementIdentity

PwsEngagementRef

 

 

 

 

ProjectName

String

 

 

 

 

CloseDate

DateTime

 

 

 

 

CostGlccOverride

String

 

 

 

 

CostPlccMappingType

String

 

 

 

 

DefaultSchedulingMode

String

 

 

 

 

Description

String

 

 

 

 

EmEmailFlag

Boolean

 

 

 

 

EngagementTimestamp

String

 

 

 

 

ExpenseApprovalUserIdentity

PwsUserRef

 

 

 

 

ExpenseApproverType

String

 

 

 

 

ExpenseEntryRestrictedToResourcesAssignedToRolesFlag

Boolean

 

 

 

 

LocationIdentity

PwsLocationRef

 

 

 

 

ManagerIdentity

PwsUserRef

 

 

 

 

MinutesPerDay

Int16

 

 

 

 

NarrativeRequiredFlag

Boolean

 

 

 

 

NewProjectCode

String

 

 

 

 

OpenDate

DateTime

 

 

 

 

OpenForCostFlag

Boolean

 

 

 

 

OpenForCostTransferFlag

Boolean

 

 

 

 

OpenForTimeFlag

Boolean

 

 

 

 

OpenForTimeTransferFlag

Boolean

 

 

 

 

PercentLikelihood

Double

 

 

 

 

PmModuleEnabledFlag

Boolean

 

 

 

 

ProjectStageIdentity

PwsProjectStageRef

 

 

 

 

ProjectWorkspaceEnabledFlag

Boolean

 

 

 

 

Rates

PwsProjectRate[]

 

 

 

 

TimeApprovalUserIdentity

PwsUserRef

 

 

 

 

TimeApproverType

String

 

 

 

 

TimeEntryRestrictedToResourcesAssignedToRolesFlag

Boolean

 

 

 

 

TimeEntryRestrictedToRolesAssignedToTasksFlag

Boolean

 

 

 

 

TimeGlccOverride

String

 

 

 

 

TimePlccMappingType

String

 

 

 

 

UserDefinedFields

PwsUserDefinedFieldDetail[]

 

 

 

 

WorkspaceMessages

String

 

 

 

 

BookExpenseResourceCostCenterIdentity

PwsCostCenterRef

 

 

 

 

BookExpenseResourcesAllowCode

String

 

 

 

 

BookTimeResourceCostCenterIdentity

PwsCostCenterRef

 

 

 

 

BookTimeResourcesAllowCode

String

 

 

 

 

PlccMappings

PwsProjectPlccMappingCostCenter[]

 

 

 

 

ContractLineItemIdentity

PwsContractLineItemRef

 

 

 

 

ManagementTeam

PwsProjectManagementTeamMember[]

 

 

 

 

BdDashboards

PwsProjectBdDashboard[]

 

 

 

 

ExpenseTypeConfigurationIdentity

PwsExpenseTypeConfigurationRef

 

 

 

 

InheritPurchaseOrderNumberFlag

Boolean

 

 

 

 

PurchaseOrderNumber

String

 

 

 

 

Usage Example(s)


Example 01
                  <b:EngagementDetail>
                     <b:EngagementCode>P001320</b:EngagementCode>
                     <b:EngagementId i:nil="true"/>
                     <b:EngagementUid>1152921504607326368</b:EngagementUid>
                     <b:ClientIdentity>
                        <b:ClientId i:nil="true"/>
                        <b:ClientNumber>C000121</b:ClientNumber>
                        <b:ClientUid>1152921504606998462</b:ClientUid>
                     </b:ClientIdentity>
                     <b:EngagementName>Web Services Documentation</b:EngagementName>
                     <b:Address>
                        <b:AddressLine1>100 Main Street</b:AddressLine1>
                        <b:AddressLine2 i:nil="true"/>
                        <b:Attention>Finance</b:Attention>
                        <b:City>Boston</b:City>
                        <b:CompanyName>Acme 1000</b:CompanyName>
                        <b:Country>USA</b:Country>
                        <b:StateOrProvince>MA</b:StateOrProvince>
                        <b:ZipOrPostalCode>02114</b:ZipOrPostalCode>
                     </b:Address>
                     <b:BillingAdjustedRevenueTimeBudgetAmount i:nil="true"/>
                     <b:BillingCultureIdentity>
                        <b:CultureId i:nil="true"/>
                        <b:CultureName>en-US</b:CultureName>
                        <b:CultureUid>1152921504606851419</b:CultureUid>
                     </b:BillingCultureIdentity>
                     <b:BillingCycleIdentity>
                        <b:BillingCycleId i:nil="true"/>
                        <b:BillingCycleName>Monthly</b:BillingCycleName>
                        <b:BillingCycleUid>1152921504606853180</b:BillingCycleUid>
                     </b:BillingCycleIdentity>
                     <b:BillingInstructions>Please bill this client at the end of each month.</b:BillingInstructions>
                     <b:ClientAmountCostBudgetAmount i:nil="true"/>
                     <b:ClientMessage>{\rtf1\ansi\ansicpg1252\deff0{\fonttbl{\f0\fnil\fcharset0 Microsoft Sans Serif;}}
\viewkind4\uc1\pard\lang1033\f0\fs17We appreciate your business!\par}</b:ClientMessage>
                     <b:ClientMessagePlain>We appreciate your business!</b:ClientMessagePlain>
                     <b:ContractRevenueTimeBudgetAmount i:nil="true"/>
                     <b:CostAlertsBasisType>E</b:CostAlertsBasisType>
                     <b:CostBudgetMetric>C</b:CostBudgetMetric>
                     <b:CostCenterIdentity>
                        <b:CostCenterId i:nil="true"/>
                        <b:CostCenterName>Executive Team (USA)</b:CostCenterName>
                        <b:CostCenterNumber>Executive Team (USA)</b:CostCenterNumber>
                        <b:CostCenterUid>1152921504606867363</b:CostCenterUid>
                     </b:CostCenterIdentity>
                     <b:CostContractTerms>T</b:CostContractTerms>
                     <b:CurrencyIdentity>
                        <b:CurrencyCode>USD</b:CurrencyCode>
                        <b:CurrencyId i:nil="true"/>
                        <b:CurrencyUid>1152921504606851838</b:CurrencyUid>
                     </b:CurrencyIdentity>
                     <b:DisbursedAmountCostBudgetAmount i:nil="true"/>
                     <b:EngagementStageIdentity>
                        <b:EngagementStageId i:nil="true"/>
                        <b:EngagementStageName>Open</b:EngagementStageName>
                        <b:EngagementStageShortName>Open</b:EngagementStageShortName>
                        <b:EngagementStageUid>1152921504606849675</b:EngagementStageUid>
                     </b:EngagementStageIdentity>
                     <b:EngagementTypeIdentity>
                        <b:EngagementTypeId i:nil="true"/>
                        <b:EngagementTypeName>Executive - Contract Type</b:EngagementTypeName>
                        <b:EngagementTypeShortName>ECT</b:EngagementTypeShortName>
                        <b:EngagementTypeUid>1152921504606873528</b:EngagementTypeUid>
                     </b:EngagementTypeIdentity>
                     <b:ExpenseAmountCostBudgetAmount i:nil="true"/>
                     <b:HoldbackAmount i:nil="true"/>
                     <b:HoldbackPercent i:nil="true"/>
                     <b:HoldbackType>N</b:HoldbackType>
                     <b:InheritAddressFlag>true</b:InheritAddressFlag>
                     <b:InheritBillingCycleFlag>true</b:InheritBillingCycleFlag>
                     <b:InheritBillingInstructionsFlag>true</b:InheritBillingInstructionsFlag>
                     <b:InheritClientMessageFlag>true</b:InheritClientMessageFlag>
                     <b:InheritInvoiceContentFlag>true</b:InheritInvoiceContentFlag>
                     <b:InheritInvoiceScopeFlag>true</b:InheritInvoiceScopeFlag>
                     <b:InheritInvoiceTemplateFlag>true</b:InheritInvoiceTemplateFlag>
                     <b:InheritPaymentTermFlag>true</b:InheritPaymentTermFlag>
                     <b:InheritPurchaseOrderNumberFlag>true</b:InheritPurchaseOrderNumberFlag>
                     <b:InheritTimeBillingTypeFlag>true</b:InheritTimeBillingTypeFlag>
                     <b:InvoiceContent>B</b:InvoiceContent>
                     <b:InvoiceScope>E</b:InvoiceScope>
                     <b:InvoiceTemplateIdentity>
                        <b:InvoiceTemplateId i:nil="true"/>
                        <b:InvoiceTemplateName>A100</b:InvoiceTemplateName>
                        <b:InvoiceTemplateUid>1152921504606878901</b:InvoiceTemplateUid>
                     </b:InvoiceTemplateIdentity>
                     <b:ManagerIdentity>
                        <b:UserDisplayName>Betty Smith</b:UserDisplayName>
                        <b:UserId i:nil="true"/>
                        <b:UserReferenceSystemId>Partner - 01</b:UserReferenceSystemId>
                        <b:UserUid>1152921504607011056</b:UserUid>
                     </b:ManagerIdentity>
                     <b:MaxCostContractAmount i:nil="true"/>
                     <b:MaxTimeContractAmount>30000</b:MaxTimeContractAmount>
                     <b:MinCostContractAmount i:nil="true"/>
                     <b:MinTimeContractAmount>30000</b:MinTimeContractAmount>
                     <b:NewEngagementCode i:nil="true"/>
                     <b:PaymentTermIdentity>
                        <b:PaymentTermId i:nil="true"/>
                        <b:PaymentTermName>Net 30</b:PaymentTermName>
                        <b:PaymentTermUid>1152921504606856054</b:PaymentTermUid>
                     </b:PaymentTermIdentity>
                     <b:PurchaseOrderNumber>P-001</b:PurchaseOrderNumber>
                     <b:ResourceDirectCostTimeBudgetAmount i:nil="true"/>
                     <b:RevenueEarnedByDate i:nil="true"/>
                     <b:RevenueRecognitionMethod>R</b:RevenueRecognitionMethod>
                     <b:TimeAlertsBasisType>E</b:TimeAlertsBasisType>
                     <b:TimeBillingType>H</b:TimeBillingType>
                     <b:TimeBudgetMetric>B</b:TimeBudgetMetric>
                     <b:TimeContractTerms>F</b:TimeContractTerms>
                     <b:Timestamp>AAAAAA971aM=</b:Timestamp>
                     <b:UserDefinedFields>
                        <b:PwsUserDefinedFieldDetail>
                           <b:UdfId i:nil="true"/>
                           <b:UdfName>EN-Date</b:UdfName>
                           <b:UdfUid>1152921504606856799</b:UdfUid>
                           <b:BooleanValue i:nil="true"/>
                           <b:DataType>D</b:DataType>
                           <b:DateValue>2018-01-17T00:00:00Z</b:DateValue>
                           <b:IntegerValue i:nil="true"/>
                           <b:ResourceIdentityValue i:nil="true"/>
                           <b:TextValue i:nil="true"/>
                           <b:UdfTreatment>A</b:UdfTreatment>
                           <b:StoplightValues/>
                           <b:NumericValue i:nil="true"/>
                           <b:RelationValue i:nil="true"/>
                        </b:PwsUserDefinedFieldDetail>
                        <b:PwsUserDefinedFieldDetail>
                           <b:UdfId i:nil="true"/>
                           <b:UdfName>EN-Numeric</b:UdfName>
                           <b:UdfUid>1152921504606856800</b:UdfUid>
                           <b:BooleanValue i:nil="true"/>
                           <b:DataType>I</b:DataType>
                           <b:DateValue i:nil="true"/>
                           <b:IntegerValue>1</b:IntegerValue>
                           <b:ResourceIdentityValue i:nil="true"/>
                           <b:TextValue i:nil="true"/>
                           <b:UdfTreatment>A</b:UdfTreatment>
                           <b:StoplightValues/>
                           <b:NumericValue>1</b:NumericValue>
                           <b:RelationValue i:nil="true"/>
                        </b:PwsUserDefinedFieldDetail>
                        <b:PwsUserDefinedFieldDetail>
                           <b:UdfId i:nil="true"/>
                           <b:UdfName>EN-Resource</b:UdfName>
                           <b:UdfUid>1152921504606856801</b:UdfUid>
                           <b:BooleanValue i:nil="true"/>
                           <b:DataType>R</b:DataType>
                           <b:DateValue i:nil="true"/>
                           <b:IntegerValue i:nil="true"/>
                           <b:ResourceIdentityValue>
                              <b:ResourceDisplayName>John Doe</b:ResourceDisplayName>
                              <b:ResourceId i:nil="true"/>
                              <b:ResourceReferenceSystemId>E123</b:ResourceReferenceSystemId>
                              <b:ResourceUid>1152921504607062225</b:ResourceUid>
                           </b:ResourceIdentityValue>
                           <b:TextValue i:nil="true"/>
                           <b:UdfTreatment>A</b:UdfTreatment>
                           <b:StoplightValues/>
                           <b:NumericValue i:nil="true"/>
                           <b:RelationValue i:nil="true"/>
                        </b:PwsUserDefinedFieldDetail>
                        <b:PwsUserDefinedFieldDetail>
                           <b:UdfId i:nil="true"/>
                           <b:UdfName>EN-Text</b:UdfName>
                           <b:UdfUid>1152921504606856802</b:UdfUid>
                           <b:BooleanValue i:nil="true"/>
                           <b:DataType>T</b:DataType>
                           <b:DateValue i:nil="true"/>
                           <b:IntegerValue i:nil="true"/>
                           <b:ResourceIdentityValue i:nil="true"/>
                           <b:TextValue>Web Services Documentation</b:TextValue>
                           <b:UdfTreatment>A</b:UdfTreatment>
                           <b:StoplightValues/>
                           <b:NumericValue i:nil="true"/>
                           <b:RelationValue i:nil="true"/>
                        </b:PwsUserDefinedFieldDetail>
                        <b:PwsUserDefinedFieldDetail>
                           <b:UdfId i:nil="true"/>
                           <b:UdfName>EN-Text List</b:UdfName>
                           <b:UdfUid>1152921504606856803</b:UdfUid>
                           <b:BooleanValue i:nil="true"/>
                           <b:DataType>L</b:DataType>
                           <b:DateValue i:nil="true"/>
                           <b:IntegerValue i:nil="true"/>
                           <b:ResourceIdentityValue i:nil="true"/>
                           <b:TextValue>EN-1A</b:TextValue>
                           <b:UdfTreatment>A</b:UdfTreatment>
                           <b:StoplightValues/>
                           <b:NumericValue i:nil="true"/>
                           <b:RelationValue i:nil="true"/>
                        </b:PwsUserDefinedFieldDetail>
                        <b:PwsUserDefinedFieldDetail>
                           <b:UdfId i:nil="true"/>
                           <b:UdfName>EN-Boolean</b:UdfName>
                           <b:UdfUid>1152921504606856804</b:UdfUid>
                           <b:BooleanValue>true</b:BooleanValue>
                           <b:DataType>Y</b:DataType>
                           <b:DateValue i:nil="true"/>
                           <b:IntegerValue i:nil="true"/>
                           <b:ResourceIdentityValue i:nil="true"/>
                           <b:TextValue i:nil="true"/>
                           <b:UdfTreatment>A</b:UdfTreatment>
                           <b:StoplightValues/>
                           <b:NumericValue i:nil="true"/>
                           <b:RelationValue i:nil="true"/>
                        </b:PwsUserDefinedFieldDetail>
                        <b:PwsUserDefinedFieldDetail>
                           <b:UdfId i:nil="true"/>
                           <b:UdfName>EN-Stoplight</b:UdfName>
                           <b:UdfUid>1152921504606856813</b:UdfUid>
                           <b:BooleanValue i:nil="true"/>
                           <b:DataType>S</b:DataType>
                           <b:DateValue i:nil="true"/>
                           <b:IntegerValue i:nil="true"/>
                           <b:ResourceIdentityValue i:nil="true"/>
                           <b:TextValue i:nil="true"/>
                           <b:UdfTreatment>A</b:UdfTreatment>
                           <b:StoplightValues>
                              <b:PwsStoplightValue>
                                 <b:AsOfDate>2018-01-17T00:00:00Z</b:AsOfDate>
                                 <b:SortOrder>3</b:SortOrder>
                              </b:PwsStoplightValue>
                           </b:StoplightValues>
                           <b:NumericValue i:nil="true"/>
                           <b:RelationValue i:nil="true"/>
                        </b:PwsUserDefinedFieldDetail>
                        <b:PwsUserDefinedFieldDetail>
                           <b:UdfId i:nil="true"/>
                           <b:UdfName>EN-Multiline</b:UdfName>
                           <b:UdfUid>1152921504606858520</b:UdfUid>
                           <b:BooleanValue i:nil="true"/>
                           <b:DataType>T</b:DataType>
                           <b:DateValue i:nil="true"/>
                           <b:IntegerValue i:nil="true"/>
                           <b:ResourceIdentityValue i:nil="true"/>
                           <b:TextValue>Web Services Documentation</b:TextValue>
                           <b:UdfTreatment>A</b:UdfTreatment>
                           <b:StoplightValues/>
                           <b:NumericValue i:nil="true"/>
                           <b:RelationValue i:nil="true"/>
                        </b:PwsUserDefinedFieldDetail>
                     </b:UserDefinedFields>
                     <b:WorkMinutesTimeBudgetAmount i:nil="true"/>
                     <b:CalculateEngagementBudgetFlag>true</b:CalculateEngagementBudgetFlag>
                     <b:ChargeableMinutesTimeBudgetAmount i:nil="true"/>
                     <b:InheritInvoiceEmailSettingsFlag>true</b:InheritInvoiceEmailSettingsFlag>
                     <b:InvoiceEmailSettings>
                        <b:EmailFromUserIdentity>
                           <b:UserDisplayName>Betty Smith</b:UserDisplayName>
                           <b:UserId i:nil="true"/>
                           <b:UserReferenceSystemId>Partner - 01</b:UserReferenceSystemId>
                           <b:UserUid>1152921504607011056</b:UserUid>
                        </b:EmailFromUserIdentity>
                        <b:EmailInvoiceTemplateIdentity>
                           <b:InvoiceTemplateId i:nil="true"/>
                           <b:InvoiceTemplateName>E001</b:InvoiceTemplateName>
                           <b:InvoiceTemplateUid>1152921504606878906</b:InvoiceTemplateUid>
                        </b:EmailInvoiceTemplateIdentity>
                        <b:InvoiceEmailEnabledFlag>true</b:InvoiceEmailEnabledFlag>
                        <b:InvoiceEmailType>P</b:InvoiceEmailType>
                        <b:Recipients>
                           <b:PwsInvoiceEmailRecipient>
                              <b:RecipientType>T</b:RecipientType>
                              <b:UserIdentity>
                                 <b:UserDisplayName>Abby Whelan</b:UserDisplayName>
                                 <b:UserId i:nil="true"/>
                                 <b:UserReferenceSystemId>OPA02</b:UserReferenceSystemId>
                                 <b:UserUid>1152921504607062210</b:UserUid>
                              </b:UserIdentity>
                           </b:PwsInvoiceEmailRecipient>
                        </b:Recipients>
                     </b:InvoiceEmailSettings>
                     <b:InheritRenderReceiptsFlag>true</b:InheritRenderReceiptsFlag>
                     <b:RenderReceiptsFlag>false</b:RenderReceiptsFlag>
                     <b:AutoApplyAvailableBalanceFlag>false</b:AutoApplyAvailableBalanceFlag>
                     <b:InheritAutoApplyAvailableBalanceFlag>true</b:InheritAutoApplyAvailableBalanceFlag>
                     <b:InheritTaxTypesFlag>true</b:InheritTaxTypesFlag>
                     <b:TaxType1Identity>
                        <b:TaxTypeCode>VAT</b:TaxTypeCode>
                        <b:TaxTypeId i:nil="true"/>
                        <b:TaxTypeUid>1152921504606868258</b:TaxTypeUid>
                     </b:TaxType1Identity>
                     <b:TaxType2Identity i:nil="true"/>
                     <b:TaxType3Identity i:nil="true"/>
                  </b:EngagementDetail>



  • No labels