Versions Compared

Key

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

...

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

Required?

Default

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

Inherit Address from the client. Please see Inheritancefor more information.

true/false

InheritBillingCycleFlag

Boolean

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

true/false

InheritBillingInstructionsFlag

Boolean

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

true/false

InheritClientMessageFlag

Boolean

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

true/false

InheritInvoiceContentFlag

Boolean

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

true/false

InheritInvoiceScopeFlag

Boolean

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

true/false

InheritInvoiceTemplateFlag

Boolean

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

true/false

InheritPaymentTermFlag

Boolean

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

true/false

InheritPurchaseOrderNumberFlag

Boolean

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

true/false

InheritTimeBillingTypeFlag

Boolean

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

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

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

true/false

InvoiceEmailSettings

PwsInvoiceEmailSettings



InheritRenderReceiptsFlag

Boolean

Inherit Render Receipts flag from the client. Please see Inheritancefor more information.

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

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

true/false

InheritTaxTypesFlag

Boolean

Inherit Tax Types flag from the Client. Please see Inheritancefor more information.

true/false

TaxType1Identity

PwsTaxTypeRef



TaxType2Identity

PwsTaxTypeRef



TaxType3Identity

PwsTaxTypeRef



...