Versions Compared

Version Old Version 45 New Version 46
Changes made by

Bettina Borces

Bettina Borces

Saved on

Key

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

...

Overview


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

Format


Panel
titlePwsEngagementDetail
  • PwsEngagementDetail
    • ClientId: Int32
    • ClientNumber: String
    • ClientUid: Int64
    • ClientIdentity: PwsClientRef
    • EngagementName: String
    • Address: PwsAddress
    • BillingAdjustedRevenueTimeBudgetAmount: Double
    • BillingCultureIdentity: PwsCultureRef
    • BillingCycleIdentity: PwsBillingCycleRef
    • BillingInstructions: String
    • ClientAmountCostBudgetAmount: Double
    • ClientMessage: String
    • ClientMessagePlain: String
    • ContractRevenueTimeBudgetAmount: Double
    • CostAlertsBasisType: String
    • CostBudgetMetric: String
    • CostCenterIdentity: PwsCostCenterRef
    • CostContractTerms: String
    • CurrencyIdentity: PwsCurrencyRef
    • DisbursedAmountCostBudgetAmount: Double
    • EngagementStageIdentity: PwsEngagementStageRef
    • EngagementTypeIdentity: PwsEngagementTypeRef
    • ExpenseAmountCostBudgetAmount: Double
    • HoldbackAmount: Double
    • HoldbackPercent: Double
    • HoldbackType: String
    • InheritAddressFlag: Boolean
    • InheritBillingCycleFlag: Boolean
    • InheritBillingInstructionsFlag: Boolean
    • InheritClientMessageFlag: Boolean
    • InheritInvoiceContentFlag: Boolean
    • InheritInvoiceScopeFlag: Boolean
    • InheritInvoiceTemplateFlag: Boolean
    • InheritPaymentTermFlag: Boolean
    • InheritPurchaseOrderNumberFlag: Boolean
    • InheritTimeBillingTypeFlag: Boolean
    • InvoiceContent: String
    • InvoiceScope: String
    • InvoiceTemplateIdentity: PwsInvoiceTemplateRef
    • ManagerIdentity: PwsUserRef
    • MaxCostContractAmount: Double
    • MaxTimeContractAmount: Double
    • MinCostContractAmount: Double
    • MinTimeContractAmount: Double
    • NewEngagementCode: String
    • PaymentTermIdentity: PwsPaymentTermRef
    • PurchaseOrderNumber: String
    • ResourceDirectCostTimeBudgetAmount: Double
    • RevenueEarnedByDate: DateTime
    • RevenueRecognitionMethod: String
    • TimeAlertsBasisType: String
    • TimeBillingType: String
    • TimeBudgetMetric: String
    • TimeContractTerms: String
    • 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

Description

Required?

Default

(on insert/update)

Description

Sample Data
EngagementCodeEngagementIdInt32This is the engagement id

ClientId

StringThis is the engagement code, which can uniquely identify an engagement.P001396

Int32

 

 

The Client Id is a unque identifier for a Client. For internal use only.

EngagementUidInt64This is the


ClientNumber

String

 

 

The Client Number is a unique identifier for a Client.


ClientUid

Int64

 

 

The Client Uid is a unique and immutable identifier

of an engagement1152921504607324699

for a Client.


ClientIdentity

PwsClientRef

 

 

 


EngagementName

String

The engagement name.Web Services Engagement

 

 

The Engagement Name


Address

PwsAddress

 

 

The Client Address


BillingAdjustedRevenueTimeBudgetAmount

Double

 

 

The Billing Adjusted Revenue Time Budget Amount

25000


BillingCultureIdentity

PwsCultureRef

 

 

 


BillingCycleIdentity

PwsBillingCycleRef

 

 

 


BillingInstructions

String

 

 

Billing Instructions

associated with

for the client

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

ClientAmountCostBudgetAmount

Double

Client Amount

 

 

Cost Budget for the Client 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

 

 

Time Budget for the Contract Revenue

Time Budget Amount

10000

CostAlertsBasisType

String

 

 

Cost Alerts Basis Type

"A" for actuals to date

"E" for estimate at completion

E

CostBudgetMetric

A

String

CostBudgetMetric

 

String

 

Cost

 Cost Budget Metric

"C" for client amount

"D" for disbursed amount

"E" for expense amount

C

CostCenterIdentity

PwsCostCenterRef

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

CurrencyIdentity

PwsCurrencyRef

F

 

CurrencyIdentity

 

PwsCurrencyRef

 


DisbursedAmountCostBudgetAmount

Double

 

Disbursed Amount

 

Cost Budget for the Disbursed Amount

10000


EngagementStageIdentity

PwsEngagementStageRef

 

 

 


EngagementTypeIdentity

PwsEngagementTypeRef

 

 

 


ExpenseAmountCostBudgetAmount

Double

 

Expense Amount

 

Cost Budget for an Expense 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

InheritAddressFlag

A

Boolean

InheritAddressFlag

 

Boolean

 

Inherit

address

Address from the client. Please see Inheritancefor more information.

true
"true" or "false"
/false

InheritBillingCycleFlag

Boolean

Inherit billing cycle

 

 

Inherit Billing Cycle from the client. Please see Inheritancefor more information.

true
"true" or "false"
/false

InheritBillingInstructionsFlag

Boolean

 

 

Inherit

billing instructions

Billing Instructions from the client. Please see Inheritancefor more information.

true
"true" or "false"
/false

InheritClientMessageFlag

Boolean

 

 

Inherit

client message

Client Message from the client. Please see Inheritancefor more information. 

true
"true" or "false"
/false

InheritInvoiceContentFlag

Boolean

 

 

Inherit

invoice content

Invoice Content from the client. Please see Inheritancefor more information.

true
"true" or "false"
/false

InheritInvoiceScopeFlag

Boolean

Inherit invoice scope

 

 

Inherit Invoice Scope from the client. Please see Inheritancefor more information.

true
"true" or "false"
/false

InheritInvoiceTemplateFlag

Boolean

 

 

Inherit

invoice template

Invoice Template from the client. Please see Inheritancefor more information.

true
"true" or "false"
/false

InheritPaymentTermFlag

Boolean

 

 

Inherit

payment term

Payment Term from the client. Please see Inheritancefor more information.

true
"true" or "false"
/false

InheritPurchaseOrderNumberFlag

Boolean

 

 

Inherit

purchase order number

Purchase Order Number from the client. Please see Inheritancefor more information.

true
"true" or "false"
/false

InheritTimeBillingTypeFlag

Boolean

 

 

Inherit

tme billing type

Time Billing Type from the client. Please see Inheritancefor more information.

true
"true" or "false"
/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.


MaxTimeContractAmount

5000

Double

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

 

 

Time Budget Amount for the 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

TimeAlertsBasisType

R

String

TimeAlertsBasisType

 

String

 

Time Alerts Basis Type

"A" for Actuals to Date

"E" for Estimate at Completion

E

TimeBillingType

A

String

TimeBillingType

 

String

 

Time Billing Type

"D" for Daily

"H" for Hourly

H

TimeBudgetMetric

D

String

TimeBudgetMetric

 

String

 

Time Budget Metric

"B" for Billing Adjusted Revenue

"C" for Contract Revenue

"R" for Resource Direct Cost

"H" for Working Hours

B

TimeContractTerms

D

String

TimeContractTerms

 

String

 

Time Contract Terms

"T" for Time & Materials

"F" for Fixed Price

"C" for Not to Exceed

T

Timestamp

F

String

Timestamp

 

String

 

Base64 encoded timestamp

AAAAAA61fwg=

 


UserDefinedFields

PwsUserDefinedFieldDetail[]

 

 

 


WorkMinutesTimeBudgetAmount

Int32

 

 

Time Budget Amount for 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

 

Int32

 

Chargeable Minutes

Time Budget Amount

2400

for Chargeable Minutes


InheritInvoiceEmailSettingsFlag

Boolean

 

 

Inherit

invoice email "true" or "false"

Invoice Email settings from the client. Please see Inheritancefor more information.

false
true/false

InvoiceEmailSettings

PwsInvoiceEmailSettings

 

 

 


InheritRenderReceiptsFlag

Boolean

 

 

Inherit

render receipts

Render Receipts flag

setting

from the client. Please see Inheritancefor more information.

true
"true" or "false"
/false

RenderReceiptsFlag

Boolean

 

 

If set to true,

render receipts "true" or "false"

Render Receipts on the invoice.

false
true/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
/false

InheritAutoApplyAvailableBalanceFlag

Boolean

 

Inherit auto apply available balance flag setting from the client"true" or "false"

 

Inherit Auto Apply Available Balance flag from the Client. Please see Inheritancefor more information.

false
true/false

InheritTaxTypesFlag

Boolean

Inherit tax types

 

 

Inherit Tax Types flag from the

client

Client. Please see Inheritancefor more information.

true
"true" or "false"
/false

TaxType1Identity

PwsTaxTypeRef

 

TaxType2Identity

 

PwsTaxTypeRef

 

TaxType3Identity

TaxType2Identity

PwsTaxTypeRef

ProjectIdentities

 

PwsProjectRef

 

ContractLineItems

 

PwsContractLineItemElement

TaxType3Identity

Client

PwsTaxTypeRef

PwsClientSummaryEffectiveExcelCurrencyFormatRoundedStringEffective 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);ManagerPwsUserRefThe Engagement Manager

 

EffectiveCurrencySymbolStringEffective Currency Symbol for the engagement currency$EffectiveCurrencySymboPlacementInt32Effective 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)0EffectiveDecimalDigitsInt32Effective Decimal Digits, this field indicates how many decimal places should be displayed when displaying an amount in the effective engagement currency.2EffectiveDefaultOpsCultureIdentityPwsOpsCultureRefEffectiveExcelCurrencyFormatStringEffective 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);