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.
| Element | Data Type | Description | Default (on insert/update) | Sample Data |
|---|---|---|---|---|
| EngagementCode | String | This is the engagement code, which can uniquely identify an engagement. | P001396 | |
| EngagementId | Int32 | This is the engagement id. For internal use only. | ||
| EngagementUid | Int64 | This is the unique and immutable identifier of an engagement | 1152921504607324699 | |
| ClientIdentity | PwsClientRef | |||
| EngagementName | String | The engagement name. | Web Services Engagement | |
| Address | PwsAddress | |||
| BillingAdjustedRevenueTimeBudgetAmount | Double | Billing Adjusted Revenue Time Budget Amount | 25000 | |
| BillingCultureIdentity | PwsCultureRef | |||
| BillingCycleIdentity | PwsBillingCycleRef | |||
| BillingInstructions | String | Billing Instructions associated with the client | This client should be billed on the 15th of each month. | |
| ClientAmountCostBudgetAmount | Double | Client Amount Cost Budget Amount | 10000 | |
| ClientMessage | String | A per-invoice client message to appear on the invoice. | Thank you for using revcorp-bb. We appreciate your business. | |
| ClientMessagePlain | String | A per-invoice client message to appear on the invoice, in plain text. | Thank you for using revcorp-bb. We appreciate your business. | |
| ContractRevenueTimeBudgetAmount | Double | Contract Revenue Time Budget Amount | 10000 | |
| CostAlertsBasisType | String | Cost Alerts Basis Type "A" for actuals to date "E" for estimate at completion | E | A |
| CostBudgetMetric | String | Cost Metric "C" for client amount "D" for disbursed amount "E" for expense amount | C | C |
| CostCenterIdentity | PwsCostCenterRef | |||
| CostContractTerms | String | Cost Contract Terms "F" for Fixed Price "T" for Time and Materials "C" for Time and Materials with a cap Null on update means leave as is | T | F |
| CurrencyIdentity | PwsCurrencyRef | |||
| DisbursedAmountCostBudgetAmount | Double | Disbursed Amount Cost Budget Amount | 10000 | |
| EngagementStageIdentity | PwsEngagementStageRef | |||
| EngagementTypeIdentity | PwsEngagementTypeRef | |||
| ExpenseAmountCostBudgetAmount | Double | Expense Amount Cost Budget Amount | 6700 | |
| HoldbackAmount | Double | Holdback amount. Applies only when holdback type is A; null otherwise. | 5000 | |
| HoldbackPercent | Double | Holdback percent. Applies only when holdback type is P; null otherwise. | .10 | |
| HoldbackType | String | Holdback Type: "N" for none "A" for Amount "P" for Percent | N | A |
| InheritAddressFlag | Boolean | Inherit address from the client. Please see Inheritance for more information. | true | "true" or "false" |
| InheritBillingCycleFlag | Boolean | Inherit billing cycle from the client. Please see Inheritance for more information. | true | "true" or "false" |
| InheritBillingInstructionsFlag | Boolean | Inherit billing instructions from the client. Please see Inheritance for more information. | true | "true" or "false" |
| InheritClientMessageFlag | Boolean | Inherit client message from the client. Please see Inheritance for more information. | true | "true" or "false" |
| InheritInvoiceContentFlag | Boolean | Inherit invoice content from the client. Please see Inheritance for more information. | true | "true" or "false" |
| InheritInvoiceScopeFlag | Boolean | Inherit invoice scope from the client. Please see Inheritance for more information. | true | "true" or "false" |
| InheritInvoiceTemplateFlag | Boolean | Inherit invoice template from the client. Please see Inheritance for more information. | true | "true" or "false" |
| InheritPaymentTermFlag | Boolean | Inherit payment term from the client. Please see Inheritance for more information. | true | "true" or "false" |
| InheritPurchaseOrderNumberFlag | Boolean | Inherit purchase order number from the client. Please see Inheritance for more information. | true | "true" or "false" |
| InheritTimeBillingTypeFlag | Boolean | Inherit tme billing type from the client. Please see Inheritance for more information. | true | "true" or "false" |
| InvoiceContent | String | Invoice Content "B" for time and cost together "S" for time and cost separately | B | |
| InvoiceScope | String | Invoice Scope "C" for client "N" for purchase order number "E" for engagement "P" for project | P | |
| InvoiceTemplateIdentity | PwsInvoiceTemplateRef | |||
| ManagerIdentity | PwsUserRef | |||
| MaxCostContractAmount | Double | Maximum Cost Contract Amount Must be specified for cost contract terms F or C, and null otherwise. | 5000 | |
| MaxTimeContractAmount | Double | Maximum Time Contract Amount Must be specified for time contract terms F or C, and null otherwise. | 25000 | |
| MinCostContractAmount | Double | Minimum Cost Contract Amount Must be specified for cost contract terms F, and null otherwise. | 1000 | |
| MinTimeContractAmount | Double | Minimum Time Contract Amount Must be specified for time contract terms F, and null otherwise. | 10000 | |
| NewEngagementCode | String | New Engagement Code | Web Services Engagement (New) | |
| PaymentTermIdentity | PwsPaymentTermRef | |||
| PurchaseOrderNumber | String | Purchase Order Number | PO-1234 | |
| ResourceDirectCostTimeBudgetAmount | Double | Resource Direct Cost Time Budget Amount | 11899.99 | |
| RevenueEarnedByDate | DateTime | Revenue Earn By Date | 2018-04-30T00:00:00Z | |
| RevenueRecognitionMethod | String | Revenue Recognition Method "P" for percent complete "R" for revenue schedule Leave blank for non-billable engagements. | P | R |
| TimeAlertsBasisType | String | Time Alerts Basis Type "A" for Actuals to Date "E" for Estimate at Completion | E | A |
| TimeBillingType | String | Time Billing Type "D" for Daily "H" for Hourly | H | D |
| TimeBudgetMetric | String | Time Budget Metric "B" for Billing Adjusted Revenue "C" for Contract Revenue "R" for Resource Direct Cost "H" for Working Hours | B | D |
| TimeContractTerms | String | Time Contract Terms "T" for Time & Materials "F" for Fixed Price "C" for Not to Exceed | T | F |
| Timestamp | String | Base64 encoded timestamp | AAAAAA61fwg= | |
| UserDefinedFields | PwsUserDefinedFieldDetail | |||
| WorkMinutesTimeBudgetAmount | Int32 | Work Minutes Time budget amount (applicable only when time budget metric is H, null otherwise). | 3360 | |
| CalculateEngagementBudgetFlag | Boolean | Calculate Engagement Budget Flag | "true" or "false" | |
| ChargeableMinutesTimeBudgetAmount | Int32 | Chargeable Minutes Time Budget Amount | 2400 | |
| InheritInvoiceEmailSettingsFlag | Boolean | Inherit invoice email settings from the client. Please see Inheritance for more information. | false | "true" or "false" |
| InvoiceEmailSettings | PwsInvoiceEmailSettings | |||
| InheritRenderReceiptsFlag | Boolean | Inherit render receipts flag setting from the client. Please see Inheritance for more information. | true | "true" or "false" |
| RenderReceiptsFlag | Boolean | If set to true, render receipts on the invoice. | false | "true" or "false" |
| AutoApplyAvailableBalanceFlag | Boolean | If set to true, for engagements with a pre-payment balance, automatically apply the balance to new invoices. | true | "true" or "false" |
| InheritAutoApplyAvailableBalanceFlag | Boolean | Inherit auto apply available balance flag setting from the client. Please see Inheritance for more information. | false | "true" or "false" |
| InheritTaxTypesFlag | Boolean | Inherit tax types from the client. Please see Inheritance for more information. | true | "true" or "false" |
| TaxType1Identity | PwsTaxTypeRef | |||
| TaxType2Identity | PwsTaxTypeRef | |||
| TaxType3Identity | PwsTaxTypeRef | |||
| ProjectIdentities | PwsProjectRef | |||
| ContractLineItems | PwsContractLineItemElement | |||
| Client | PwsClientSummary | |||
| EffectiveCurrencySymbol | String | Effective Currency Symbol for the engagement currency | $ | |
| EffectiveCurrencySymboPlacement | Int32 | Effective Currency Symbol placement for the engagement currency. This field indicated where the currency symbol is placed (i.e. before or after the digits, (i.e. 0 for before) | 0 | |
| EffectiveDecimalDigits | Int32 | Effective Decimal Digits, this field indicates how many decimal places should be displayed when displaying an amount in the effective engagement currency. | 2 | |
| EffectiveDefaultOpsCultureIdentity | OpsCultureIdentityRef | |||
| EffectiveExcelCurrencyFormat | String | Effective Excel Currency Format, this field determines how amounts in the effective engagement currency will be displayed in Excel when not rounded. | [$$-409]#,##0.00_);[Red]([$$-409]#,##0.00); | |
| EffectiveExcelCurrencyFormatRounded | String | Effective Excel Currency Format, this field determines how amounts in the effective engagement currency will be displayed in Excel when rounded. | [$$-409]#,##0_);[Red]([$$-409]#,##0); | |
| Manager | PwsUserRef | The Engagement Manager |