Versions Compared

Key

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

Overview

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

Format

Panel
titlePwsEngagementDetail
  • PwsEngagementDetail
    • EngagementCode: String (20)
    • EngagementId: Int32
    • EngagementUid: Int64
    • ClientIdentity: PwsClientRef
    • EngagementName: String (255)
    • Address: PwsAddress
    • BillingAdjustedRevenueTimeBudgetAmount: Double
    • BillingCultureIdentity: PwsCultureRef
    • BillingCycleIdentity: PwsBillingCycleRef
    • BillingInstructions: String (1000)
    • ClientAmountCostBudgetAmount: Double
    • ClientMessage: String (4000)
    • ClientMessagePlain: String (4000)
    • ContractRevenueTimeBudgetAmount: Double
    • CostAlertsBasisType: String (1)
    • CostBudgetMetric: String (1)
    • CostCenterIdentity: PwsCostCenterRef
    • CostContractTerms: String (1)
    • CurrencyIdentity: PwsCurrencyRef
    • DisbursedAmountCostBudgetAmount: Double
    • EngagementStageIdentity: PwsEngagementStageRef
    • EngagementTypeIdentity: PwsEngagementTypeRef
    • ExpenseAmountCostBudgetAmount: Double
    • HoldbackAmount: Double *** deprecated ***
    • HoldbackPercent: Double *** deprecated ***
    • HoldbackType: String (1) *** deprecated ***
    • InheritAddressFlag: Boolean
    • InheritBillingCycleFlag: Boolean
    • InheritBillingInstructionsFlag: Boolean
    • InheritClientMessageFlag: Boolean
    • InheritInvoiceContentFlag: Boolean
    • InheritInvoiceScopeFlag: Boolean
    • InheritInvoiceTemplateFlag: Boolean
    • InheritPaymentTermFlag: Boolean
    • InheritPurchaseOrderNumberFlag: Boolean
    • InheritTimeBillingTypeFlag: Boolean
    • InvoiceContent: String (1)
    • InvoiceScope: String (1)
    • InvoiceTemplateIdentity: PwsInvoiceTemplateRef
    • ManagerIdentity: PwsUserRef
    • MaxCostContractAmount: Double *** deprecated ***
    • MaxTimeContractAmount: Double *** deprecated ***
    • MinCostContractAmount: Double *** deprecated ***
    • MinTimeContractAmount: Double *** deprecated ***
    • NewEngagementCode: String
    • PaymentTermIdentity: PwsPaymentTermRef
    • PurchaseOrderNumber: String (50)
    • ResourceDirectCostTimeBudgetAmount: Double
    • RevenueEarnedByDate: DateTime
    • RevenueRecognitionMethod: String (1)
    • TimeAlertsBasisType: String (1)
    • TimeBillingType: String (1)
    • TimeBudgetMetric: String (1)
    • TimeContractTerms: String (1)
    • Timestamp: String
    • UserDefinedFields: PwsUserDefinedFieldDetail
    • WorkMinutesTimeBudgetAmount: Int32
    • CalculateEngagementBudgetFlag: Boolean
    • ChargeableMinutesTimeBudgetAmount: Int32
    • InheritInvoiceEmailSettingsFlag: Boolean
    • InvoiceEmailSettings: PwsInvoiceEmailSettings
    • InheritRenderReceiptsFlag: Boolean
    • RenderReceiptsFlag: Boolean
    • AutoApplyAvailableBalanceFlag: Boolean
    • InheritAutoApplyAvailableBalanceFlag: Boolean
    • InheritTaxTypesFlag: Boolean
    • TaxType1Identity: PwsTaxTypeRef
    • TaxType2Identity: PwsTaxTypeRef
    • TaxType3Identity: PwsTaxTypeRef

Element

...

Element

...

Data Type

...

Required?

...

Default

...

Description

...

Sample Data

...

EngagementCode

...

String (20)

...

On Insert: Yes

On Update: Yes (if the EngagementUid is not supplied)

...

The engagement is a unique identifier for an engagement. See "NewEngagementCode" for guidance on how to change the engagement code of an existing engagement.

...

EngagementId

...

Int32

...

On Insert: No

On Update: No

...

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

...

Projector PSA 

...

EngagementUid

...

Int64

...

On Insert: No

On Update: Yes (if the EngagementCode is not supplied)

...

The engagement Uid is a unique and immutable identifier for an engagement

...

1152921504606961482 

...

ClientIdentity

...

PwsClientRef

...

On Insert: Yes

On Update: No

...

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

...

EngagementName

...

String (255)

...

On Insert: Yes

On Update: No

...

The engagement name

...

Web Services Engagement 

...

Address

...

PwsAddress

...

On Insert: No

On Update: No

...

The billing address associated with the engagement. Click here for more information.

...

BillingAdjustedRevenueTimeBudgetAmount

...

Overview


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

Format


Panel
titlePwsEngagementDetail
  • PwsEngagementDetail
    • EngagementCode: String (20)
    • EngagementId: Int32
    • EngagementUid: Int64
    • ClientIdentity: PwsClientRef
    • EngagementName: String (255)
    • Address: PwsAddress
    • BillingAdjustedRevenueTimeBudgetAmount: Double
    • BillingCultureIdentity: PwsCultureRef
    • BillingCycleIdentity: PwsBillingCycleRef
    • BillingInstructions: String (1000)
    • ClientAmountCostBudgetAmount: Double
    • ClientMessage: String (4000)
    • ClientMessagePlain: String (4000)
    • ContractRevenueTimeBudgetAmount: Double
    • CostAlertsBasisType: String (1)
    • CostBudgetMetric: String (1)
    • CostCenterIdentity: PwsCostCenterRef
    • CostContractTerms: String (1) ** deprecated **
    • CurrencyIdentity: PwsCurrencyRef
    • DisbursedAmountCostBudgetAmount: Double
    • EngagementStageIdentity: PwsEngagementStageRef
    • EngagementTypeIdentity: PwsEngagementTypeRef
    • ExpenseAmountCostBudgetAmount: Double
    • HoldbackAmount: Double ** deprecated **
    • HoldbackPercent: Double ** deprecated **
    • HoldbackType: String (1) ** deprecated **
    • InheritAddressFlag: Boolean
    • InheritBillingCycleFlag: Boolean
    • InheritBillingInstructionsFlag: Boolean
    • InheritClientMessageFlag: Boolean
    • InheritInvoiceContentFlag: Boolean
    • InheritInvoiceScopeFlag: Boolean
    • InheritInvoiceTemplateFlag: Boolean
    • InheritPaymentTermFlag: Boolean
    • InheritPurchaseOrderNumberFlag: Boolean
    • InheritTimeBillingTypeFlag: Boolean
    • InvoiceContent: String (1)
    • InvoiceScope: String (1)
    • InvoiceTemplateIdentity: PwsInvoiceTemplateRef
    • ManagerIdentity: PwsUserRef
    • MaxCostContractAmount: Double ** deprecated **
    • MaxTimeContractAmount: Double ** deprecated **
    • MinCostContractAmount: Double ** deprecated **
    • MinTimeContractAmount: Double ** deprecated **
    • NewEngagementCode: String
    • PaymentTermIdentity: PwsPaymentTermRef
    • PurchaseOrderNumber: String (50)
    • ResourceDirectCostTimeBudgetAmount: Double
    • RevenueEarnedByDate: DateTime ** deprecated **
    • RevenueRecognitionMethod: String (1) ** deprecated **
    • TimeAlertsBasisType: String (1)
    • TimeBillingType: String (1)
    • TimeBudgetMetric: String (1)
    • TimeContractTerms: String (1) ** deprecated **
    • Timestamp: String
    • UserDefinedFields: PwsUserDefinedFieldDetail
    • WorkMinutesTimeBudgetAmount: Int32
    • CalculateEngagementBudgetFlag: Boolean
    • ChargeableMinutesTimeBudgetAmount: Int32
    • InheritInvoiceEmailSettingsFlag: Boolean
    • InvoiceEmailSettings: PwsInvoiceEmailSettings
    • InheritRenderReceiptsFlag: Boolean
    • RenderReceiptsFlag: Boolean
    • AutoApplyAvailableBalanceFlag: Boolean
    • InheritAutoApplyAvailableBalanceFlag: Boolean
    • InheritTaxTypesFlag: Boolean
    • TaxType1Identity: PwsTaxTypeRef
    • TaxType2Identity: PwsTaxTypeRef
    • TaxType3Identity: PwsTaxTypeRef
    • InheritRenderedInvoiceFormatFlag: Boolean
    • RenderedInvoiceFormat: String(1)
    • ManagementTeam: PwsEngagementManagementTeamMember[]

Elements


...

languagexml
titleExample 01
collapsetrue

...

** This field has been deprecated in favor of Contract Line Items. Please see PwsContractLineItemDetail for more information **

Element

Data Type

Required?

Default

Description

Sample Data

EngagementCode

String (20)

One of EngagementCode or EngagementUid is required


The engagement code is a unique identifier for an engagement. See "NewEngagementCode" for guidance on how to change the engagement code of an existing engagement.

P001320

EngagementId

Int32

On Insert: No

On Update: No


The billing adjusted time revenue time budget amount associated with the engagement

 10000

BillingCultureIdentity

PwsCultureRefengagement Id is a unique identifier for an engagement. For internal use only.


EngagementUid

Int64

See EngagementCode


A unique and immutable identifier for an engagement

1152921504607326368


ClientIdentity

PwsClientRef

On Insert: Yes

On Update: No


The billing culture client associated with the installation

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

en-US

BillingCycleIdentity

PwsBillingCycleRefengagement


EngagementName

String (255)

On Insert: Yes

On Update: No


The engagement name

Web Services Documentation


Address

PwsAddress

On Insert: No

On Update: No


The billing cycle address associated with the engagement. Click here for more information.

BillingInstructions

String (1000)


BillingAdjustedRevenueTimeBudgetAmount

Double

On Insert: No

On Update: No


The billing instructions adjusted time revenue time budget amount associated with the engagement

This client should be billed on the 15th of each month. 

ClientAmountCostBudgetAmount

Double


BillingCultureIdentity

PwsCultureRef

On Insert: NoYes

On Update: No

The billing culture associated with the installation

The client amount cost budget amount billing culture associated with the engagement


10000BillingCycleIdentity

ClientMessagePwsBillingCycleRef

String (4000)

On Insert: No

On Update: No

A per-invoice message to appear on the invoice. This may include RTF markup.

{\rtf1\ansi\ansicpg1252\deff0{\fonttbl{\f0\fnil\fcharset0 Microsoft Sans Serif;}}
\viewkind4\uc1\pard\lang1033\f0\fs17 Thank you for your business!\par
}


ClientMessagePlain

String (4000The billing cycle associated with the engagement


BillingInstructions

String (1000)

On Insert: No

On Update: No

A per-invoice message to appear on the invoice. This is in plain text format.

Thank you for your business!


ContractRevenueTimeBudgetAmountThe billing instructions associated with the engagement

Please bill this client at the end of each month.


ClientAmountCostBudgetAmount

Double

On Insert: No

On Update: No


The contract revenue time client amount cost budget amount associated with the engagement

5000

CostAlertsBasisType

String (1)

On Insert: No

On Update: No

The cost alerts basis type associated with the engagement

"A" for actuals to date

"E" for estimate at completion

 A

CostBudgetMetric

String (1(applicable only when TimeBudgetMetric is "C", null otherwise)

10000

ClientMessage

String (4000)

On Insert: No

On Update: No

The cost budget metric associated with the engagement

"C" for client amount

"D" for disbursed amount

"E" for expense amount

 E


CostCenterIdentity

PwsCostCenterRef

On Insert: YesA per-invoice message to appear on the invoice. This may include RTF markup.

{\rtf1\ansi\ansicpg1252\deff0{\fonttbl{\f0\fnil\fcharset0 Microsoft Sans Serif;}}
\viewkind4\uc1\pard\lang1033\f0\fs17We appreciate your business!\par}

ClientMessagePlain

String (4000)

On Insert: No

On Update: No

The cost center associated with the engagement. Click here for more information.

CostContractTerms

String (1)

deprecated


CurrencyIdentity

PwsCurrencyRef

On Insert: YesA per-invoice message to appear on the invoice. This is in plain text format.

We appreciate your business!


ContractRevenueTimeBudgetAmount

Double

On Insert: No

On Update: No


The currency contract revenue time budget amount associated with the engagement. Click here for more information.

DisbursedAmountCostBudgetAmount

Double


CostAlertsBasisType

String (1)

On Insert: No

On Update: No


The disbursed amount cost buget amount

 10000

EngagementStageIdentity

PwsEngagementStageRefcost alerts basis type associated with the engagement

"A" for actuals to date

"E" for estimate at completion

E

CostBudgetMetric

String (1)

On Insert: YesNo

On Update: No


The engagement stage cost budget metric associated with the engagement. Click here for more information.

EngagementTypeIdentity

PwsEngagementTypeRef

On Insert: Yes

On Update: No

The engagement type associated wtih the engagement. Click here for more information.

ExpenseAmountCostBudgetAmount

Double

"C" for client amount

"D" for disbursed amount

"E" for expense amount

C

CostCenterIdentity

PwsCostCenterRef

On Insert: Yes

On Update: No


The expense amount cost budget amount

2500 

HoldbackAmount

Doublecost center associated with the engagement


CostContractTerms

String (1)

deprecated


** This field has been deprecated in favor of Contract Line Items. Please see PwsContractLineItemDetail for more information **


HoldbackPercentCurrencyIdentity

Double

deprecated

** This field has been deprecated in favor of Contract Line Items. Please see PwsContractLineItemDetail for more information **

HoldbackType

String (1)

deprecated

** This field has been deprecated in favor of Contract Line Items. Please see PwsContractLineItemDetail for more information **

InheritAddressFlag

Boolean

On Insert: No

On Update: No

true

If set to 'true', the engagement address is inherited from the client. Please Inheritance for more information.

true/false 

InheritBillingCycleFlag

Boolean

On Insert: No

On Update: No

true

If set to 'true', the engagement billing cycle is inherited from the client. Please Inheritance for more information.

true/false

InheritBillingInstructionsFlag

Boolean

On Insert: No

On Update: No

true

If set to 'true', the engagement billing instructions is inherited from the client. Please see Inheritance for more information.

true/false 

InheritClientMessageFlag

Boolean

On Insert: No

On Update: No

true

If set to 'true', the engagement client message is inherited from the client. Please see Inheritance for more information.

true/false 

InheritInvoiceContentFlagPwsCurrencyRef

On Insert: Yes

On Update: No


The currency associated with the engagement


DisbursedAmountCostBudgetAmount

Double

On Insert: No

On Update: No


The disbursed amount cost buget amount (applicable only when TimeBudgetMetric is "D", null otherwise)


EngagementStageIdentity

PwsEngagementStageRef

On Insert: Yes

On Update: No


The engagement stage associated with the engagement


EngagementTypeIdentity

PwsEngagementTypeRef

On Insert: Yes

On Update: No


The engagement type associated wtih the engagement


ExpenseAmountCostBudgetAmount

Double

On Insert: Yes

On Update: No


The expense amount cost budget amount (applicable only when TimeBudgetMetric is "E", null otherwise)


HoldbackAmount

Double

deprecated


** This field has been deprecated in favor of Contract Line Items. Please see PwsContractLineItemDetail for more information **


HoldbackPercent

Double

deprecated


** This field has been deprecated in favor of Contract Line Items. Please see PwsContractLineItemDetail for more information **


HoldbackType

String (1)

deprecated


** This field has been deprecated in favor of Contract Line Items. Please see PwsContractLineItemDetail for more information **


InheritAddressFlag

Boolean

On Insert: No

On Update: No

true

If set to 'true', the engagement invoice content address is inherited from the client. Please see Inheritance for more information.

true
/false

InheritInvoiceScopeFlagInheritBillingCycleFlag

Boolean

On Insert: No

On Update: No

true

If set to 'true', the engagement invoice scope billing cycle is inherited from the from the client. Please see Inheritance for more information.

true
/false

InheritInvoiceTemplateFlagInheritBillingInstructionsFlag

Boolean

On Insert: No

On Update: No

true

If set to 'true', the engagement invoice template billing instructions is inherited from the from the client. Please see Inheritance for more information.

true
/false 

InheritPaymentTermFlagInheritClientMessageFlag

Boolean

On Insert: No

On Update: No

true

If set to 'true', the engagement payment terms client message is inherited from the from the client. Please see Inheritance for more information. 

true
/false 

InheritPurchaseOrderNumberFlagInheritInvoiceContentFlag

Boolean

On Insert: No

On Update: No

true

If set to 'true', the engagement purchase order invoice content is inherited from the from the client. Please see Inheritance for more information.  

true
/false 

InheritTimeBillingTypeFlagInheritInvoiceScopeFlag

Boolean

On Insert: No

On Update: No

true

If set to 'true', the engagement time billing type invoice scope is inherited from the client. Please see Inheritance for more information.   

true
/false  


InvoiceContent

String (1)InheritInvoiceTemplateFlag

Boolean

On Insert: No

On Update: No

B

The invoice content associated with the engagement

"B" for time and cost together

"S" for time and cost separately

B 

InvoiceScope

String (1)

true

If set to 'true', the engagement invoice template is inherited from the client. Please see Inheritance for more information.

true

InheritPaymentTermFlag

Boolean

On Insert: No

On Update: No

E

The invoice scope associated with the engagement

"C" for client

"N" for purchase order number

"E" for engagement

"P" for project 

E

InvoiceTemplateIdentity

PwsInvoiceTemplateRef

true

If set to 'true', the engagement payment terms is inherited from the client. Please see Inheritance for more information. 

true

InheritPurchaseOrderNumberFlag

Boolean

On Insert: No

On Update: No

The invoice template associated with the engagement. Click here true

If set to 'true', the engagement purchase order is inherited from the client. Please see Inheritance for more information.  ManagerIdentity

true

InheritTimeBillingTypeFlag

PwsUserRefBoolean

On Insert: YesNo

On Update: NoThe engagement manager associated with the engagement. Click here

true

If set to 'true', the engagement time billing type is inherited from the client. Please see Inheritance for more information.   

true

MaxCostContractAmount

Double

deprecated

** This field has been deprecated in favor of Contract Line Items. Please see PwsContractLineItemDetail for more information **

MaxTimeContractAmount

Double

deprecated

** This field has been deprecated in favor of Contract Line Items. Please see PwsContractLineItemDetail for more information **

MinCostContractAmount

Double

deprecated

** This field has been deprecated in favor of Contract Line Items. Please see PwsContractLineItemDetail for more information **

MinTimeContractAmount

InvoiceContent

String (1)

On Insert: No

On Update: No

B

The invoice content associated with the engagement

"B" for time and cost together

"S" for time and cost separately

B


InvoiceScope

String (1)

On Insert: No

On Update: No

E

The invoice scope associated with the engagement

"C" for client

"N" for purchase order number

"E" for engagement

"P" for project 

E

InvoiceTemplateIdentity

PwsInvoiceTemplateRef

On Insert: No

On Update: No


The invoice template associated with the engagement


ManagerIdentity

PwsUserRef

On Insert: Yes

On Update: No


The engagement manager associated with the engagement 


MaxCostContractAmount

Double

deprecated


** This field has been deprecated in favor of Contract Line Items. Please see PwsContractLineItemDetail for more information **


NewEngagementCode

String (20)

On Insert: No

On Update: No

The new engagement code. This is MaxTimeContractAmount

Double

deprecated


** This field has been deprecated in favor of Contract Line Items. Please see PwsContractLineItemDetail for more information **


MinCostContractAmount

Double

deprecated


** This field has been deprecated in favor of Contract Line Items. Please see PwsContractLineItemDetail for more information **


MinTimeContractAmount

Double

deprecated


** This field has been deprecated in favor of Contract Line Items. Please see PwsContractLineItemDetail for more information **


NewEngagementCode

String (20)

On Insert: No

On Update: No


The new engagement code. This is used by PwsSaveEngagement to support changing an existing engagement code. You can both identify an engagement by engagement code and modify the engagement code by specifying the original code in EngagementCode and the new value in NewEngagementCode. NewEngagementCode will always be null in responses from PwsGetEngagement. Note that the

On Insert, if both the EngagementCode and NewEngagementCode are specified, the NewEngagementCode will take precedence.

Note: The engagement code may only be changed if numbering for engagements is configured as Manual or Hybrid.Web Services Engagement - New


PaymentTermIdentity

PwsPaymentTermRef

On Insert: No

On Update: No


The payment term associated with the engagement. Click PwsPaymentTermRef for more information.


PurchaseOrderNumber

String (50)

On Insert: No

On Update: No


The purchase order number associated with the engagementPO

P-
1234E
001


ResourceDirectCostTimeBudgetAmount

Double

On Insert: No

On Update: No


The resource direct cost time budget amount12500 (applicable only when TimeBudgetMetric is "R", null otherwise)


RevenueEarnedByDate

DateTime

deprecated


** This field has been deprecated in favor of Contract Line Items. Please see PwsContractLineItemDetail for more information **


RevenueRecognitionMethod

String (50)

deprecated


** This field has been deprecated in favor of Contract Line Items. Please see PwsContractLineItemDetail for more information **


TimeAlertsBasisType

String (1)

On Insert: No

On Update: No


The time alerts basis type

"A" for Actuals to Date

"E" for Estimate at CompletionA

E

TimeBillingType

String (1)

On Insert: No

On Update: No

H

The time billing type

"D" for Daily

"H" for HourlyD

H

TimeBudgetMetric

String (1)

On Insert: No

On Update: No

B

The time budget metric

"B" for Billing Adjusted Revenue

"C" for Contract Revenue

"R" for Resource Direct Cost

"H" for Working Hours

B

TimeContractTerms

String (1)

deprecated


** This field has been deprecated in favor of Contract Line Items. Please see PwsContractLineItemDetail for more information **


Timestamp

String

On Insert: No

On Update: No


Base64 encoded timestamp AAAAAA61gVA

AAAAAA971aM=
UserDefinedFields

PwsUserDefinedFieldDetail

On Insert: No

On Update: No


The user defined fields associated with the engagement. Click here for more information.


WorkMinutesTimeBudgetAmount

Int32

On Insert: No

On Update: No


The time budget amount for work minutes (applicable only when time budget metric TimeBudgetMetric is "H", null otherwise)

3660


CalculateEngagementBudgetFlag

Boolean

On Insert: No

On Update: No

true

If set to 'true', the engagement budget flag will be calculated based on the sum of the project budgets associated with the engagement

true
/false

ChargeableMinutesTimeBudgetAmount

Int32

On Insert: No

On Update: No


The chargeable minutes time budget amount3660.


InheritInvoiceEmailSettingsFlag

Boolean

On Insert: No

On Update: No

false

If set to 'true', the invoice email settings will be inherited from the client. Click Please see Inheritance for more information.  

true
/false

InvoiceEmailSettings

PwsInvoiceEmailSettings

On Insert: No

On Update: No


Invoice email settings control whether email distribution of invoices is enabled for this client, and if so, who the sender and recipients of the email are, the subject line, the email template and other related settings that are in effect. Click here for more informaiton.


InheritRenderReceiptsFlag

Boolean

On Insert: No

On Update: No

true

If set to 'true', the render receipts setting for the engagement will be inherited from the client. Click Please see Inheritance for more information.   

true
/false

RenderReceiptsFlag

Boolean

On Insert: No

On Update: No

false

If set to 'true', receipts will be rendered on invoices associated with the engagement.

true
/false


AutoApplyAvailableBalanceFlag

Boolean

On Insert: No

On Update: No

false

If set to 'true', the engagement's pre-payment balance will be automatically appliled applied to the balance on new invoices

true
/false


InheritAutoApplyAvailableBalanceFlag

Boolean

On Insert: No

On Update: No

true

If set to 'true', the auto apply available balance engagement setting will be inherited from the client. Click Please see Inheritance for more information.   

true
/false


InheritTaxTypesFlag

Boolean

On Insert: No

On Update: No

true

If set to 'true', the tax type(s) associatd associated with the engagement will be inherited from the client. Click Please see Inheritance for more information.   

true
/false

TaxType1Identity

PwsTaxTypeRef

On Insert: No

On Update: No


The tax types that apply for invoices under this engagement. Click here for more information.


TaxType2Identity

PwsTaxTypeRef

On Insert: No

On Update: No


The tax types that apply for invoices under this engagement. Click here for more information.


TaxType3Identity

PwsTaxTypeRef

On Insert: No

On Update: No


The tax types that apply for invoices under this engagement. Click here


InheritRenderedInvoiceFormatFlag

Boolean

On Insert: No

On Update: No

trueIf set to 'true', the rendered invoice format setting for the engagement will be inherited from the client. Please see Inheritance for more information.

Usage Example(s)

   

RenderedInvoiceFormat

String(1)

On Insert: No

On Update: No


The configured rendered invoice format (P for PDF, X for XLS, C for CSV). Controls the format of rendered invoices. Most commonly, they are rendered as PDFs.

ManagementTeam

PwsEngagementManagementTeamMember[]

This structure represents a member of the engagement management team for an engagement.

Usage Example(s)


Code Block
languagexml
titleExample 01
collapsetrue
                  <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>
            <EngagementDetail>               <b:DateValue i:nil="true"/>
     <EngagementCode>E001395</EngagementCode>                      <EngagementId<b:IntegerValue i:nil="true"/>
                     <EngagementUid>1152921504607324698</EngagementUid>      <b:ResourceIdentityValue>
                              <b:ResourceDisplayName>John Doe</b:ResourceDisplayName>
                              <b:ResourceId i:nil="true"/>
         <ClientIdentity>                     <b:ResourceReferenceSystemId>E123</b:ResourceReferenceSystemId>
   <ClientId i:nil="true"/>                         <ClientNumber>Projector PSA</ClientNumber><b:ResourceUid>1152921504607062225</b:ResourceUid>
                        <ClientUid>1152921504606961482</ClientUid>   </b:ResourceIdentityValue>
                  </ClientIdentity>         <b:TextValue i:nil="true"/>
           <EngagementName>Web Services Engagement</EngagementName>              <b:UdfTreatment>A</b:UdfTreatment>
       <Address>                    <b:StoplightValues/>
    <AddressLine1>85 Merrimac Street</AddressLine1>                     <b:NumericValue i:nil="true"/>
  <AddressLine2>200</AddressLine2>                         <Attention<b:RelationValue i:nil="true"/>
                        <City>Boston</City>
</b:PwsUserDefinedFieldDetail>
                       <CompanyName>Projector PSA</CompanyName>      <b:PwsUserDefinedFieldDetail>
                  <Country>USA</Country>         <b:UdfId i:nil="true"/>
              <StateOrProvince>MA</StateOrProvince>             <b:UdfName>EN-Text</b:UdfName>
           <ZipOrPostalCode>02114</ZipOrPostalCode>                <b:UdfUid>1152921504606856802</b:UdfUid>
     </Address>                      <BillingAdjustedRevenueTimeBudgetAmount<b:BooleanValue i:nil="true"/>
                     <BillingCultureIdentity>      <b:DataType>T</b:DataType>
                           <CultureId<b:DateValue i:nil="true"/>
                        <CultureName>en-US</CultureName>   <b:IntegerValue i:nil="true"/>
                        <CultureUid>1152921504606851419</CultureUid>   <b:ResourceIdentityValue i:nil="true"/>
                 </BillingCultureIdentity>           <b:TextValue>Web Services Documentation</b:TextValue>
        <BillingCycleIdentity>                   <b:UdfTreatment>A</b:UdfTreatment>
     <BillingCycleId i:nil="true"/>                     <b:StoplightValues/>
   <BillingCycleName>Monthly</BillingCycleName>                         <BillingCycleUid>1152921504606853180</BillingCycleUid><b:NumericValue i:nil="true"/>
                     </BillingCycleIdentity>      <b:RelationValue i:nil="true"/>
              <BillingInstructions>This client should be billed on the 15th of each month.</BillingInstructions>b:PwsUserDefinedFieldDetail>
                     <ClientAmountCostBudgetAmount i:nil="true"/>      <b:PwsUserDefinedFieldDetail>
               <ClientMessage>{\rtf1\ansi\ansicpg1252\deff0{\fonttbl{\f0\fnil\fcharset0 Microsoft Sans Serif;}}
\viewkind4\uc1\pard\lang1033\f0\fs17 Thank you for your business!\par
}</ClientMessage>            <b:UdfId i:nil="true"/>
                        <ClientMessagePlain>Thank you for your business!</ClientMessagePlain><b:UdfName>EN-Text List</b:UdfName>
                     <ContractRevenueTimeBudgetAmount i:nil="true"/>     <b:UdfUid>1152921504606856803</b:UdfUid>
                <CostAlertsBasisType>E</CostAlertsBasisType>           <b:BooleanValue i:nil="true"/>
         <CostBudgetMetric>C</CostBudgetMetric>                  <b:DataType>L</b:DataType>
   <CostCenterIdentity>                        <b:DateValue <CostCenterId i:nil="true"/>
                          <CostCenterName>Executive Team (USA)</CostCenterName><b:IntegerValue i:nil="true"/>
                          <CostCenterNumber>Executive Team (USA)</CostCenterNumber><b:ResourceIdentityValue i:nil="true"/>
                        <CostCenterUid>1152921504606867363</CostCenterUid>   <b:TextValue>EN-1A</b:TextValue>
                  </CostCenterIdentity>         <b:UdfTreatment>A</b:UdfTreatment>
            <CostContractTerms>T</CostContractTerms>               <b:StoplightValues/>
      <CurrencyIdentity>                     <b:NumericValue i:nil="true"/>
  <CurrencyCode>USD</CurrencyCode>                         <CurrencyId<b:RelationValue i:nil="true"/>
                        <CurrencyUid>1152921504606851838</CurrencyUid></b:PwsUserDefinedFieldDetail>
                        <b:PwsUserDefinedFieldDetail>
    </CurrencyIdentity>                       <DisbursedAmountCostBudgetAmount<b:UdfId i:nil="true"/>
                          <EngagementStageIdentity>  <b:UdfName>EN-Boolean</b:UdfName>
                          <EngagementStageId i:nil="true"/><b:UdfUid>1152921504606856804</b:UdfUid>
                        <EngagementStageName>Open</EngagementStageName>   <b:BooleanValue>true</b:BooleanValue>
                     <EngagementStageShortName>Open</EngagementStageShortName>      <b:DataType>Y</b:DataType>
                  <EngagementStageUid>1152921504606849675</EngagementStageUid>         <b:DateValue i:nil="true"/>
           </EngagementStageIdentity>                <b:IntegerValue i:nil="true"/>
    <EngagementTypeIdentity>                         <EngagementTypeId<b:ResourceIdentityValue i:nil="true"/>
       >
                <EngagementTypeName>Billable - Time and Materials</EngagementTypeName>       <b:TextValue i:nil="true"/>
                <EngagementTypeShortName>T&amp;M</EngagementTypeShortName>           <b:UdfTreatment>A</b:UdfTreatment>
             <EngagementTypeUid>1152921504606863884</EngagementTypeUid>              <b:StoplightValues/>
       </EngagementTypeIdentity>                    <b:NumericValue  <ExpenseAmountCostBudgetAmount i:nil="true"/>
                       <HoldbackAmount    <b:RelationValue i:nil="true"/>
                     <HoldbackPercent i:nil="true"/>  </b:PwsUserDefinedFieldDetail>
                   <HoldbackType>N</HoldbackType>     <b:PwsUserDefinedFieldDetail>
                <InheritAddressFlag>true</InheritAddressFlag>                      <InheritBillingCycleFlag>true</InheritBillingCycleFlag>
<b:UdfId i:nil="true"/>
                    <InheritBillingInstructionsFlag>true</InheritBillingInstructionsFlag>       <b:UdfName>EN-Stoplight</b:UdfName>
              <InheritClientMessageFlag>true</InheritClientMessageFlag>             <b:UdfUid>1152921504606856813</b:UdfUid>
        <InheritInvoiceContentFlag>true</InheritInvoiceContentFlag>                   <b:BooleanValue i:nil="true"/>
 <InheritInvoiceScopeFlag>true</InheritInvoiceScopeFlag>                      <InheritInvoiceTemplateFlag>true</InheritInvoiceTemplateFlag>    <b:DataType>S</b:DataType>
                 <InheritPaymentTermFlag>true</InheritPaymentTermFlag>          <b:DateValue i:nil="true"/>
          <InheritPurchaseOrderNumberFlag>true</InheritPurchaseOrderNumberFlag>                 <b:IntegerValue i:nil="true"/>
   <InheritTimeBillingTypeFlag>true</InheritTimeBillingTypeFlag>                      <InvoiceContent>B</InvoiceContent>  <b:ResourceIdentityValue i:nil="true"/>
                  <InvoiceScope>E</InvoiceScope>         <b:TextValue i:nil="true"/>
           <InvoiceTemplateIdentity>                <b:UdfTreatment>A</b:UdfTreatment>
        <InvoiceTemplateId i:nil="true"/>                  <b:StoplightValues>
      <InvoiceTemplateName>A200</InvoiceTemplateName>                        <b:PwsStoplightValue>
<InvoiceTemplateUid>1152921504606878904</InvoiceTemplateUid>                      </InvoiceTemplateIdentity>           <b:AsOfDate>2018-01-17T00:00:00Z</b:AsOfDate>
          <ManagerIdentity>                         <UserDisplayName>Jack Spratt</UserDisplayName><b:SortOrder>3</b:SortOrder>
                        <UserId i:nil="true"/>       </b:PwsStoplightValue>
                 <UserReferenceSystemId>E123</UserReferenceSystemId>          </b:StoplightValues>
              <UserUid>1152921504607112369</UserUid>                <b:NumericValue i:nil="true"/>
     </ManagerIdentity>                      <MaxCostContractAmount<b:RelationValue i:nil="true"/>
                       <MaxTimeContractAmount i:nil="true"/></b:PwsUserDefinedFieldDetail>
                       <MinCostContractAmount i:nil="true"/><b:PwsUserDefinedFieldDetail>
                           <MinTimeContractAmount<b:UdfId i:nil="true"/>
                       <NewEngagementCode    i:nil="true"/><b:UdfName>EN-Multiline</b:UdfName>
                            <PaymentTermIdentity><b:UdfUid>1152921504606858520</b:UdfUid>
                           <PaymentTermId<b:BooleanValue i:nil="true"/>
                        <PaymentTermName>Net 30</PaymentTermName>  <b:DataType>T</b:DataType>
                      <PaymentTermUid>1152921504606856054</PaymentTermUid>        <b:DateValue i:nil="true"/>
             </PaymentTermIdentity>              <b:IntegerValue i:nil="true"/>
      <PurchaseOrderNumber>PO Projector PSA</PurchaseOrderNumber>                     <b:ResourceIdentityValue <ResourceDirectCostTimeBudgetAmount i:nil="true"/>
                          <RevenueEarnedByDate i:nil="true"/><b:TextValue>Web Services Documentation</b:TextValue>
                          <RevenueRecognitionMethod i:nil="true"/><b:UdfTreatment>A</b:UdfTreatment>
                     <TimeAlertsBasisType>E</TimeAlertsBasisType>      <b:StoplightValues/>
                 <TimeBillingType>H</TimeBillingType>          <b:NumericValue i:nil="true"/>
           <TimeBudgetMetric>B</TimeBudgetMetric>                  <b:RelationValue i:nil="true"/>
   <TimeContractTerms>T</TimeContractTerms>                      <Timestamp>AAAAAA61frA=</Timestamp>b:PwsUserDefinedFieldDetail>
                     <UserDefinedFields</>b:UserDefinedFields>
                     <WorkMinutesTimeBudgetAmount<b:WorkMinutesTimeBudgetAmount i:nil="true"/>
                     <CalculateEngagementBudgetFlag>true<<b:CalculateEngagementBudgetFlag>true</b:CalculateEngagementBudgetFlag>
                     <ChargeableMinutesTimeBudgetAmount<b:ChargeableMinutesTimeBudgetAmount i:nil="true"/>
                     <InheritInvoiceEmailSettingsFlag>true<<b:InheritInvoiceEmailSettingsFlag>true</b:InheritInvoiceEmailSettingsFlag>
                     <InvoiceEmailSettings><b:InvoiceEmailSettings>
                        <EmailFromUserIdentity><b:EmailFromUserIdentity>
                           <UserDisplayName>Bob<b:UserDisplayName>Betty Smith</b:UserDisplayName>
                           <UserId<b:UserId i:nil="true"/>
                           <UserReferenceSystemId>Partner<b:UserReferenceSystemId>Partner - 01</b:UserReferenceSystemId>
                           <UserUid>1152921504607011056<<b:UserUid>1152921504607011056</b:UserUid>
                        </b:EmailFromUserIdentity>
                        <EmailInvoiceTemplateIdentity><b:EmailInvoiceTemplateIdentity>
                           <InvoiceTemplateId<b:InvoiceTemplateId i:nil="true"/>
                           <InvoiceTemplateName>E004<<b:InvoiceTemplateName>E001</b:InvoiceTemplateName>
                           <InvoiceTemplateUid>1152921504606878909<<b:InvoiceTemplateUid>1152921504606878906</b:InvoiceTemplateUid>
                        </b:EmailInvoiceTemplateIdentity>
                        <InvoiceEmailEnabledFlag>true<<b:InvoiceEmailEnabledFlag>true</b:InvoiceEmailEnabledFlag>
                        <InvoiceEmailType>H<<b:InvoiceEmailType>P</b:InvoiceEmailType>
                        <Recipients><b:Recipients>
                           <PwsInvoiceEmailRecipient><b:PwsInvoiceEmailRecipient>
                              <RecipientType>T<<b:RecipientType>T</b:RecipientType>
                              <UserIdentity><b:UserIdentity>
                                 <UserDisplayName>Jane<b:UserDisplayName>Abby Doe<Whelan</b:UserDisplayName>
                                 <UserId<b:UserId i:nil="true"/>
                                 <UserReferenceSystemId>E124<<b:UserReferenceSystemId>OPA02</b:UserReferenceSystemId>
                                 <UserUid>1152921504607112368<<b:UserUid>1152921504607062210</b:UserUid>
                              </b:UserIdentity>
                           </b:PwsInvoiceEmailRecipient>
                        </b:Recipients>
                     </b:InvoiceEmailSettings>
                     <InheritRenderReceiptsFlag>true<<b:InheritRenderReceiptsFlag>true</b:InheritRenderReceiptsFlag>
                     <RenderReceiptsFlag>true<<b:RenderReceiptsFlag>false</b:RenderReceiptsFlag>
                     <AutoApplyAvailableBalanceFlag>true<<b:AutoApplyAvailableBalanceFlag>false</b:AutoApplyAvailableBalanceFlag>
                     <InheritAutoApplyAvailableBalanceFlag>true<<b:InheritAutoApplyAvailableBalanceFlag>true</b:InheritAutoApplyAvailableBalanceFlag>
                     <InheritTaxTypesFlag>true<<b:InheritTaxTypesFlag>true</b:InheritTaxTypesFlag>
                     <TaxType1Identity><b:TaxType1Identity>
                        <TaxTypeCode>VAT<<b:TaxTypeCode>VAT</b:TaxTypeCode>
                        <TaxTypeId<b:TaxTypeId i:nil="true"/>
                        <TaxTypeUid>1152921504606868258<<b:TaxTypeUid>1152921504606868258</b:TaxTypeUid>
                     </b:TaxType1Identity>
                     <TaxType2Identity<b:TaxType2Identity i:nil="true"/>
                     <TaxType3Identity<b:TaxType3Identity i:nil="true"/>
                  </b:EngagementDetail>