Versions Compared

Key

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

...

Element

Data Type

Required?

Default

Description

Sample Data

EngagementDetail

PwsEngagementDetail

On Insert: Yes

On Update: No


The full details of the engagement. Click here for more information.


ProjectIdentities

PwsProjectRef

On Insert: No

On Update: No 


The list of projects that are part of this engagement. PwsGetProject may be used to fetch complete details about each project if necessary.


ContractLineItems

PwsContractLineItemElement

On Insert: Yes

On Update: No 


The contract line items that are associated with this engagement engagement. Click here for more information.


Client

PwsClientSummary

On Insert: Yes

On Update: No


The client associated with this engagement. Click here for more information.


EffectiveCurrencySymbol

String (7)

On Insert: No

On Update: No


The effective currency symbol for the engagement currency 

$

EffectiveCurrencySymbolPlacement

Byte

On Insert: No

On Update: No 


The effective currency symbol placement for the engagement currency. This field indicated where the currency symbol is placed (i.e. before or after the digits, 0 for before)

0

EffectiveDecimalDigits

Byte

On Insert: No

On Update: No 


The effective decimal digits, this field indicates how many decimal places should be displayed when displaying an amount in the effective engagement currency

2

EffectiveDefaultOpsCultureIdentity

PwsOpsCultureRef

On Insert: Yes

On Update: No 


The effective default culture associated with the engagement. Click here for more information.


EffectiveExcelCurrencyFormat

String (100)

On Insert: No

On Update: No 


The effective excel currency format, this field determines how amounts in the effective engagement currency will be displayed in excel (not rounded)

[$$-409]#,##0.00_);[Red]([$$-409]#,##0.00);

EffectiveExcelCurrencyFormatRounded

String (100)

On Insert: No

On Update: No 


The effective excel currency format, this field determines how amounts in the effective engagement currency will be displayed in excel (rounded)

[$$-409]#,##0_);[Red]([$$-409]#,##0);

Manager

PwsUserSummary

On Insert: Yes

On Update: No


The engagement manager associated with this engagement engagement. Click here for more information.


Usage Example(s)


Code Block
languagexml
titleExample 01
collapsetrue
               <PwsEngagementElement>
                  <EngagementDetail>
                     <EngagementCode>E001395</EngagementCode>
                     <EngagementId i:nil="true"/>
                     <EngagementUid>1152921504607324698</EngagementUid>
                     <ClientIdentity>
                        <ClientId i:nil="true"/>
                        <ClientNumber>Projector PSA</ClientNumber>
                        <ClientUid>1152921504606961482</ClientUid>
                     </ClientIdentity>
                     <EngagementName>Web Services Engagement</EngagementName>
                     <Address>
                        <AddressLine1>85 Merrimac Street</AddressLine1>
                        <AddressLine2>200</AddressLine2>
                        <Attention i:nil="true"/>
                        <City>Boston</City>
                        <CompanyName>Projector PSA</CompanyName>
                        <Country>USA</Country>
                        <StateOrProvince>MA</StateOrProvince>
                        <ZipOrPostalCode>02114</ZipOrPostalCode>
                     </Address>
                     <BillingAdjustedRevenueTimeBudgetAmount i:nil="true"/>
                     <BillingCultureIdentity>
                        <CultureId i:nil="true"/>
                        <CultureName>en-US</CultureName>
                        <CultureUid>1152921504606851419</CultureUid>
                     </BillingCultureIdentity>
                     <BillingCycleIdentity>
                        <BillingCycleId i:nil="true"/>
                        <BillingCycleName>Monthly</BillingCycleName>
                        <BillingCycleUid>1152921504606853180</BillingCycleUid>
                     </BillingCycleIdentity>
                     <BillingInstructions>This client should be billed on the 15th of each month.</BillingInstructions>
                     <ClientAmountCostBudgetAmount i:nil="true"/>
                     <ClientMessage>Thank you for using revcorp-bb. We appreciate your business.</ClientMessage>
                     <ClientMessagePlain>Thank you for using revcorp-bb. We appreciate your business.</ClientMessagePlain>
                     <ContractRevenueTimeBudgetAmount i:nil="true"/>
                     <CostAlertsBasisType>E</CostAlertsBasisType>
                     <CostBudgetMetric>C</CostBudgetMetric>
                     <CostCenterIdentity>
                        <CostCenterId i:nil="true"/>
                        <CostCenterName>Executive Team (USA)</CostCenterName>
                        <CostCenterNumber>Executive Team (USA)</CostCenterNumber>
                        <CostCenterUid>1152921504606867363</CostCenterUid>
                     </CostCenterIdentity>
                     <CostContractTerms>T</CostContractTerms>
                     <CurrencyIdentity>
                        <CurrencyCode>USD</CurrencyCode>
                        <CurrencyId i:nil="true"/>
                        <CurrencyUid>1152921504606851838</CurrencyUid>
                     </CurrencyIdentity>
                     <DisbursedAmountCostBudgetAmount i:nil="true"/>
                     <EngagementStageIdentity>
                        <EngagementStageId i:nil="true"/>
                        <EngagementStageName>Open</EngagementStageName>
                        <EngagementStageShortName>Open</EngagementStageShortName>
                        <EngagementStageUid>1152921504606849675</EngagementStageUid>
                     </EngagementStageIdentity>
                     <EngagementTypeIdentity>
                        <EngagementTypeId i:nil="true"/>
                        <EngagementTypeName>Billable - Time and Materials</EngagementTypeName>
                        <EngagementTypeShortName>T&amp;M</EngagementTypeShortName>
                        <EngagementTypeUid>1152921504606863884</EngagementTypeUid>
                     </EngagementTypeIdentity>
                     <ExpenseAmountCostBudgetAmount i:nil="true"/>
                     <HoldbackAmount i:nil="true"/>
                     <HoldbackPercent i:nil="true"/>
                     <HoldbackType>N</HoldbackType>
                     <InheritAddressFlag>true</InheritAddressFlag>
                     <InheritBillingCycleFlag>true</InheritBillingCycleFlag>
                     <InheritBillingInstructionsFlag>true</InheritBillingInstructionsFlag>
                     <InheritClientMessageFlag>true</InheritClientMessageFlag>
                     <InheritInvoiceContentFlag>true</InheritInvoiceContentFlag>
                     <InheritInvoiceScopeFlag>true</InheritInvoiceScopeFlag>
                     <InheritInvoiceTemplateFlag>true</InheritInvoiceTemplateFlag>
                     <InheritPaymentTermFlag>true</InheritPaymentTermFlag>
                     <InheritPurchaseOrderNumberFlag>true</InheritPurchaseOrderNumberFlag>
                     <InheritTimeBillingTypeFlag>true</InheritTimeBillingTypeFlag>
                     <InvoiceContent>B</InvoiceContent>
                     <InvoiceScope>E</InvoiceScope>
                     <InvoiceTemplateIdentity>
                        <InvoiceTemplateId i:nil="true"/>
                        <InvoiceTemplateName>A200</InvoiceTemplateName>
                        <InvoiceTemplateUid>1152921504606878904</InvoiceTemplateUid>
                     </InvoiceTemplateIdentity>
                     <ManagerIdentity>
                        <UserDisplayName>Jack Spratt</UserDisplayName>
                        <UserId i:nil="true"/>
                        <UserReferenceSystemId>E123</UserReferenceSystemId>
                        <UserUid>1152921504607112369</UserUid>
                     </ManagerIdentity>
                     <MaxCostContractAmount i:nil="true"/>
                     <MaxTimeContractAmount i:nil="true"/>
                     <MinCostContractAmount i:nil="true"/>
                     <MinTimeContractAmount i:nil="true"/>
                     <NewEngagementCode i:nil="true"/>
                     <PaymentTermIdentity>
                        <PaymentTermId i:nil="true"/>
                        <PaymentTermName>Net 30</PaymentTermName>
                        <PaymentTermUid>1152921504606856054</PaymentTermUid>
                     </PaymentTermIdentity>
                     <PurchaseOrderNumber>PO Projector PSA</PurchaseOrderNumber>
                     <ResourceDirectCostTimeBudgetAmount i:nil="true"/>
                     <RevenueEarnedByDate i:nil="true"/>
                     <RevenueRecognitionMethod i:nil="true"/>
                     <TimeAlertsBasisType>E</TimeAlertsBasisType>
                     <TimeBillingType>H</TimeBillingType>
                     <TimeBudgetMetric>B</TimeBudgetMetric>
                     <TimeContractTerms>T</TimeContractTerms>
                     <Timestamp>AAAAAA61frA=</Timestamp>
                     <UserDefinedFields/>
                     <WorkMinutesTimeBudgetAmount i:nil="true"/>
                     <CalculateEngagementBudgetFlag>true</CalculateEngagementBudgetFlag>
                     <ChargeableMinutesTimeBudgetAmount i:nil="true"/>
                     <InheritInvoiceEmailSettingsFlag>true</InheritInvoiceEmailSettingsFlag>
                     <InvoiceEmailSettings>
                        <EmailFromUserIdentity>
                           <UserDisplayName>Bob Smith</UserDisplayName>
                           <UserId i:nil="true"/>
                           <UserReferenceSystemId>Partner - 01</UserReferenceSystemId>
                           <UserUid>1152921504607011056</UserUid>
                        </EmailFromUserIdentity>
                        <EmailInvoiceTemplateIdentity>
                           <InvoiceTemplateId i:nil="true"/>
                           <InvoiceTemplateName>E004</InvoiceTemplateName>
                           <InvoiceTemplateUid>1152921504606878909</InvoiceTemplateUid>
                        </EmailInvoiceTemplateIdentity>
                        <InvoiceEmailEnabledFlag>true</InvoiceEmailEnabledFlag>
                        <InvoiceEmailType>H</InvoiceEmailType>
                        <Recipients>
                           <PwsInvoiceEmailRecipient>
                              <RecipientType>T</RecipientType>
                              <UserIdentity>
                                 <UserDisplayName>Jane Doe</UserDisplayName>
                                 <UserId i:nil="true"/>
                                 <UserReferenceSystemId>E124</UserReferenceSystemId>
                                 <UserUid>1152921504607112368</UserUid>
                              </UserIdentity>
                           </PwsInvoiceEmailRecipient>
                        </Recipients>
                     </InvoiceEmailSettings>
                     <InheritRenderReceiptsFlag>true</InheritRenderReceiptsFlag>
                     <RenderReceiptsFlag>true</RenderReceiptsFlag>
                     <AutoApplyAvailableBalanceFlag>true</AutoApplyAvailableBalanceFlag>
                     <InheritAutoApplyAvailableBalanceFlag>true</InheritAutoApplyAvailableBalanceFlag>
                     <InheritTaxTypesFlag>true</InheritTaxTypesFlag>
                     <TaxType1Identity>
                        <TaxTypeCode>VAT</TaxTypeCode>
                        <TaxTypeId i:nil="true"/>
                        <TaxTypeUid>1152921504606868258</TaxTypeUid>
                     </TaxType1Identity>
                     <TaxType2Identity i:nil="true"/>
                     <TaxType3Identity i:nil="true"/>
                  </EngagementDetail>
                  <ProjectIdentities>
                     <PwsProjectRef>
                        <ProjectCode>P001395-001</ProjectCode>
                        <ProjectId i:nil="true"/>
                        <ProjectUid>1152921504607412209</ProjectUid>
                     </PwsProjectRef>
                  </ProjectIdentities>
                  <ContractLineItems>
                     <PwsContractLineItemElement>
                        <ContractLineItemDetail>
                           <ContractLineItemCode>P001395-CL1</ContractLineItemCode>
                           <ContractLineItemId i:nil="true"/>
                           <ContractLineItemUid>1152921504607083377</ContractLineItemUid>
                           <ContractLineItemName>Web Services Engagement</ContractLineItemName>
                           <EngagementIdentity>
                              <EngagementCode>E001395</EngagementCode>
                              <EngagementId i:nil="true"/>
                              <EngagementUid>1152921504607324698</EngagementUid>
                           </EngagementIdentity>
                           <CostContractTerms>T</CostContractTerms>
                           <DeferredRevenueOpeningBalanceEngCurrency>0</DeferredRevenueOpeningBalanceEngCurrency>
                           <DeferredRevenueOpeningBalanceEngGLCurrency>0</DeferredRevenueOpeningBalanceEngGLCurrency>
                           <HoldbackAmount i:nil="true"/>
                           <HoldbackPercent i:nil="true"/>
                           <HoldbackType>N</HoldbackType>
                           <MaxCostContractAmount i:nil="true"/>
                           <MaxTimeContractAmount i:nil="true"/>
                           <MinCostContractAmount i:nil="true"/>
                           <MinTimeContractAmount i:nil="true"/>
                           <RevenueEarnedByDate i:nil="true"/>
                           <RevenueRecognitionMethod i:nil="true"/>
                           <RevenueSchedule/>
                           <TimeContractTerms>T</TimeContractTerms>
                           <ContractTypeIdentity i:nil="true"/>
                           <InheritPurchaseOrderNumberFlag>true</InheritPurchaseOrderNumberFlag>
                           <ModelContractedHoursAndOveragesFlag>false</ModelContractedHoursAndOveragesFlag>
                           <OverageProjectIdentity i:nil="true"/>
                           <PurchaseOrderNumber>PO Projector PSA</PurchaseOrderNumber>
                           <Timestamp>AAAAAA61fo0=</Timestamp>
                        </ContractLineItemDetail>
                        <LastFroTimeCardDate i:nil="true"/>
                        <LastRevenueRecognitionCutoffDate i:nil="true"/>
                        <Milestones/>
                        <RevenueCutoffDate>1753-01-01T00:00:00Z</RevenueCutoffDate>
                     </PwsContractLineItemElement>
                  </ContractLineItems>
                  <Client>
                     <ClientId i:nil="true"/>
                     <ClientNumber>Projector PSA</ClientNumber>
                     <ClientUid>1152921504606961482</ClientUid>
                     <ClientName>Projector PSA</ClientName>
                     <InactiveFlag>false</InactiveFlag>
                     <ParentClientIdentity i:nil="true"/>
                  </Client>
                  <EffectiveCurrencySymbol>$</EffectiveCurrencySymbol>
                  <EffectiveCurrencySymbolPlacement>0</EffectiveCurrencySymbolPlacement>
                  <EffectiveDecimalDigits>2</EffectiveDecimalDigits>
                  <EffectiveDefaultOpsCultureIdentity>
                     <OpsCultureId i:nil="true"/>
                     <OpsCultureName>en-US</OpsCultureName>
                     <OpsCultureNumber>1033</OpsCultureNumber>
                  </EffectiveDefaultOpsCultureIdentity>
                  <EffectiveExcelCurrencyFormat>[$$-409]#,##0.00_);[Red]([$$-409]#,##0.00);</EffectiveExcelCurrencyFormat>
                  <EffectiveExcelCurrencyFormatRounded>[$$-409]#,##0_);[Red]([$$-409]#,##0);</EffectiveExcelCurrencyFormatRounded>
                  <Manager>
                     <UserDisplayName>Jack Spratt</UserDisplayName>
                     <UserId i:nil="true"/>
                     <UserReferenceSystemId>E123</UserReferenceSystemId>
                     <UserUid>1152921504607112369</UserUid>
                     <EmailAddress>jack@revcorp.bb</EmailAddress>
                     <FirstName>Jack</FirstName>
                     <LastName>Spratt</LastName>
                     <MiddleName i:nil="true"/>
                  </Manager>
               </PwsEngagementElement>