Versions Compared

Key

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

...

Panel
titlePwsEngagementDetail
  • PwsEngagementDetail
    • EngagementCode: String
    • EngagementId: Int32
    • EngagementUid: 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


Inherit Address from the client. Please see Inheritancefor more information.Inherit Billing Cycle from the client. Please see Inheritancefor more information.Inherit Billing Instructions from the client. Please see Inheritancefor more information.Inherit Client Message from the client. Please see Inheritancefor more information. Inherit Invoice Content from the client. Please see Inheritancefor more information.Inherit Invoice Scope from the client. Please see Inheritancefor more information.Inherit Invoice Template from the client. Please see Inheritancefor more information.Inherit Payment Term from the client. Please see Inheritancefor more information.Inherit Purchase Order Number from the client. Please see Inheritancefor more information.Inherit Time Billing Type from the client. Please see Inheritancefor more information.Inherit Invoice Email settings from the client. Please see Inheritancefor more information.Inherit Render Receipts flag from the client. Please see Inheritancefor more information.Inherit Auto Apply Available Balance flag from the Client. Please see Inheritancefor more information.Inherit Tax Types flag from the Client. Please see Inheritancefor more information.

Element

Data Type

Description

Sample Data

ClientId

Int32

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

ClientNumber

String

The Client Number is a unique identifier for a Client.

Projector PSA

ClientUid

Int64

The Client Uid is a unique and immutable identifier for a Client.

1152921504606961482

ClientIdentity

PwsClientRef

EngagementName

String

The Engagement Name

Web Services Engagement

Address

PwsAddress

BillingAdjustedRevenueTimeBudgetAmount

Double

The Billing Adjusted Revenue Time Budget Amount

10000

BillingCultureIdentity

PwsCultureRef

BillingCycleIdentity

PwsBillingCycleRef

BillingInstructions

String

Billing Instructions for the client

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

ClientAmountCostBudgetAmount

Double

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

5000

CostAlertsBasisType

String

Cost Alerts Basis Type

"A" for actuals to date

"E" for estimate at completion

E

CostBudgetMetric

String

 Cost Budget Metric

"C" for client amount

"D" for disbursed amount

"E" for expense amount

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

DisbursedAmountCostBudgetAmount

Double

Cost Budget for the Disbursed Amount

10000

EngagementStageIdentity

PwsEngagementStageRef

EngagementTypeIdentity

PwsEngagementTypeRef

ExpenseAmountCostBudgetAmount

Double

Cost Budget for an Expense Amount

2500

HoldbackAmount

Double

Holdback amount. Applies only when holdback type is A; null otherwise.

2000

HoldbackPercent

Double

Holdback percent. Applies only when holdback type is P; null otherwise.

.20

HoldbackType

String

Holdback Type:

"N" for none

"A" for Amount

"P" for Percent

A

InheritAddressFlag

Boolean

true/false

InheritBillingCycleFlag

Boolean

true/false

InheritBillingInstructionsFlag

Boolean

true/false

InheritClientMessageFlag

Boolean

true/false

InheritInvoiceContentFlag

Boolean

true/false

InheritInvoiceScopeFlag

Boolean

true/false

InheritInvoiceTemplateFlag

Boolean

true/false

InheritPaymentTermFlag

Boolean

true/false

InheritPurchaseOrderNumberFlag

Boolean

true/false

InheritTimeBillingTypeFlag

Boolean

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

E

InvoiceTemplateIdentity

PwsInvoiceTemplateRef

ManagerIdentity

PwsUserRef

MaxCostContractAmount

Double

Maximum Cost Contract Amount

Must be specified for cost contract terms F or C, and null otherwise.

10000

MaxTimeContractAmount

Double

Maximum Time Contract Amount

Must be specified for time contract terms F or C, and null otherwise.

50000

MinCostContractAmount

Double

Minimum Cost Contract Amount

Must be specified for cost contract terms F, and null otherwise.

2500

MinTimeContractAmount

Double

Minimum Time Contract Amount

Must be specified for time contract terms F, and null otherwise.

20000

NewEngagementCode

String

New Engagement Code

Web Services Engagement - New

PaymentTermIdentity

PwsPaymentTermRef

PurchaseOrderNumber

String

Purchase Order Number 

PO-1234E

ResourceDirectCostTimeBudgetAmount

Double

Time Budget Amount for the Resource Direct Cost

12500

RevenueEarnedByDate

DateTime

Revenue Earn By Date

2018-03-31T00:00:00Z

RevenueRecognitionMethod

String

Revenue Recognition Method

"P" for percent complete

"R" for revenue schedule

Leave blank for non-billable engagements.

P

TimeAlertsBasisType

String

Time Alerts Basis Type

"A" for Actuals to Date

"E" for Estimate at Completion

A

TimeBillingType

String

Time Billing Type

"D" for Daily

"H" for Hourly

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

TimeContractTerms

String

Time Contract Terms

"T" for Time & Materials

"F" for Fixed Price

"C" for Not to Exceed

T

Timestamp

String

Base64 encoded timestamp 

AAAAAA61gVA=

UserDefinedFields

PwsUserDefinedFieldDetail

WorkMinutesTimeBudgetAmount

Int32

Time Budget Amount for Work Minutes (applicable only when time budget metric is H, null otherwise).

3660

CalculateEngagementBudgetFlag

Boolean

Calculate Engagement Budget Flag

true/false

ChargeableMinutesTimeBudgetAmount

Int32

Time Budget Amount for Chargeable Minutes

InheritInvoiceEmailSettingsFlag

Boolean

true/false

InvoiceEmailSettings

PwsInvoiceEmailSettings

InheritRenderReceiptsFlag

Boolean

true/false

RenderReceiptsFlag

Boolean

If set to true, Render Receipts on the invoice.

true/false

AutoApplyAvailableBalanceFlag

Boolean

If set to true, for engagements with a pre-payment balance, automatically apply the balance to new invoices. 

true/false

InheritAutoApplyAvailableBalanceFlag

Boolean

true/false

InheritTaxTypesFlag

Boolean

true/false

TaxType1Identity

PwsTaxTypeRef

TaxType2Identity

PwsTaxTypeRef

TaxType3Identity

PwsTaxTypeRef

Element

Data Type

Required?

Default

Description

Sample Data

EngagementCode

String



The engagement is a unique identifier for an engagement


EngagementId

Int32



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

Projector PSA 

EngagementUid

Int64



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

1152921504606961482 

ClientIdentity

PwsClientRef



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


EngagementName

String



The engagement name

Web Services Engagement 

Address

PwsAddress



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


BillingAdjustedRevenueTimeBudgetAmount

Double



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

 10000

BillingCultureIdentity

PwsCultureRef



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


BillingCycleIdentity

PwsBillingCycleRef



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


BillingInstructions

String



The billing instructions associated with the engagement

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

ClientAmountCostBudgetAmount

Double



The client amount cost budget amount associated with the engagement

10000

ClientMessage

String



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



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

Thank you for your business!

ContractRevenueTimeBudgetAmount

Double



The contract revenue time budget amount associated with the engagement

5000

CostAlertsBasisType

String



The cost alerts basis type associated with the engagement

"A" for actuals to date

"E" for estimate at completion

 A

CostBudgetMetric

String



The cost budget metric associated with the engagement

"C" for client amount

"D" for disbursed amount

"E" for expense amount

 E

CostCenterIdentity

PwsCostCenterRef



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


CostContractTerms

String



The 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



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


DisbursedAmountCostBudgetAmount

Double



The disbursed amount cost buget amount

 10000

EngagementStageIdentity

PwsEngagementStageRef



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


EngagementTypeIdentity

PwsEngagementTypeRef



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


ExpenseAmountCostBudgetAmount

Double



The expense amount cost budget amount

2500 

HoldbackAmount

Double



The holdback amount. Applies only when the holdback type is A; null otherwise. 


HoldbackPercent

Double



The holdback percent. Applies only when the holdback type is P; null otherwise. 


HoldbackType

String



The holdback type

"N" for None

"A" for Amount

"P" for Percent 

 N

InheritAddressFlag

Boolean



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

true/false 

InheritBillingCycleFlag

Boolean



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

true/false

InheritBillingInstructionsFlag

Boolean



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

true/false 

InheritClientMessageFlag

Boolean



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

true/false 

InheritInvoiceContentFlag

Boolean



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

true/false

InheritInvoiceScopeFlag

Boolean



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

true/false

InheritInvoiceTemplateFlag

Boolean



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

true/false 

InheritPaymentTermFlag

Boolean



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

true/false 

InheritPurchaseOrderNumberFlag

Boolean



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

true/false 

InheritTimeBillingTypeFlag

Boolean



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

true/false  

InvoiceContent

String



The invoice content associated with the engagement

"B" for time and cost together

"S" for time and cost separately

InvoiceScope

String



The invoice scope associated with the engagement

"C" for client

"N" for purchase order number

"E" for engagement

"P" for project 

E

InvoiceTemplateIdentity

PwsInvoiceTemplateRef



The invoice template associated with the engagement. Click here for more information. 


ManagerIdentity

PwsUserRef



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


MaxCostContractAmount

Double



The maximum cost contract amount, must be specified for cost contract terms F or C, and null otherwise.

10000

MaxTimeContractAmount

Double



The maximum time contract amount, must be specified for cost contract terms F or C, and null otherwise.


50000

MinCostContractAmount

Double



The minimum cost contract amount, must be specified for cost contract terms F, and null otherwise.

2500

MinTimeContractAmount

Double



The minimum time contract amount, must be specified for cost contract terms F, and null otherwise.

20000

NewEngagementCode

String



The new engagement code. This is used by PwsSaveEngagement to support changing 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 engagement code may only be changed if numbering for engagements is configured as Manual or Hybrid.

Web Services Engagement - New

PaymentTermIdentity

PwsPaymentTermRef



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


PurchaseOrderNumber

String



The purchase order number associated with the engagement

PO-1234E

ResourceDirectCostTimeBudgetAmount

Double



The resource direct cost time budget amount

12500

RevenueEarnedByDate

DateTime



The date that the revenue is expected to be earned by

2018-03-31T00:00:00Z

RevenueRecognitionMethod

String



The revenue recognition method

"P" for percent complete

"R" for revenue schedule

Leave blank for non-billable engagements.

P

TimeAlertsBasisType

String



The time alerts basis type

"A" for Actuals to Date

"E" for Estimate at Completion

A

TimeBillingType

String



The time billing type

"D" for Daily

"H" for Hourly

D

TimeBudgetMetric

String



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



The time contract terms

"T" for Time & Materials

"F" for Fixed Price

"C" for Not to Exceed

T

Timestamp

String



Base64 encoded timestamp 

AAAAAA61gVA=

UserDefinedFields

PwsUserDefinedFieldDetail



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


WorkMinutesTimeBudgetAmount

Int32



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

3660

CalculateEngagementBudgetFlag

Boolean



If set to true, the engagement budget flag will be calculated based on the budgets set within the projects beneath the engagement

true/false

ChargeableMinutesTimeBudgetAmount

Int32



The chargeable minutes time budget amount

3660

InheritInvoiceEmailSettingsFlag

Boolean



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

true/false

InvoiceEmailSettings

PwsInvoiceEmailSettings



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.

true/false

InheritRenderReceiptsFlag

Boolean



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

true/false

RenderReceiptsFlag

Boolean



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


AutoApplyAvailableBalanceFlag

Boolean



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


InheritAutoApplyAvailableBalanceFlag

Boolean



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


InheritTaxTypesFlag

Boolean



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


TaxType1Identity

PwsTaxTypeRef



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


TaxType2Identity

PwsTaxTypeRef



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


TaxType3Identity

PwsTaxTypeRef



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


...