...
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.
...
Panel | ||
---|---|---|
| ||
|
...
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 | |||
EngagementName | String | The Engagement Name | Web Services Engagement |
Address | |||
BillingAdjustedRevenueTimeBudgetAmount | Double | The Billing Adjusted Revenue Time Budget Amount | 10000 |
BillingCultureIdentity | |||
BillingCycleIdentity | |||
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 | |||
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 | |||
DisbursedAmountCostBudgetAmount | Double | Cost Budget for the Disbursed Amount | 10000 |
EngagementStageIdentity | |||
EngagementTypeIdentity | |||
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 | |||
ManagerIdentity | |||
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 | |||
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 | |||
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 | |||
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 | |||
TaxType2Identity | |||
TaxType3Identity |
Usage Example(s)
...
language | xml |
---|---|
title | Example 01 |
collapse | true |
...
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 |
|
| The client associated with the engagement. Click here for more information. |
| |
EngagementName | String |
|
| The engagement name | Web Services Engagement |
Address |
|
| 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 |
|
| The billing culture associated with the engagement. Click here for more information. |
| |
BillingCycleIdentity |
|
| 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;}} |
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 |
|
| 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 |
|
| The currency associated with the engagement. Click here for more information. |
| |
DisbursedAmountCostBudgetAmount | Double |
|
| The disbursed amount cost buget amount | 10000 |
EngagementStageIdentity |
|
| The engagement stage associated with the engagement. Click here for more information. |
| |
EngagementTypeIdentity |
|
| 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 | B |
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 |
|
| The invoice template associated with the engagement. Click here for more information. |
| |
ManagerIdentity |
|
| The engagement manager associated with the engagement. Click here for more information. |
| |
MaxCostContractAmount | Double |
|
|
|
|
MaxTimeContractAmount | Double |
|
|
|
|
MinCostContractAmount | Double |
|
|
|
|
MinTimeContractAmount | Double |
|
|
|
|
NewEngagementCode | String |
|
|
|
|
PaymentTermIdentity |
|
|
|
| |
PurchaseOrderNumber | String |
|
|
|
|
ResourceDirectCostTimeBudgetAmount | Double |
|
|
|
|
RevenueEarnedByDate | DateTime |
|
|
|
|
RevenueRecognitionMethod | String |
|
|
|
|
TimeAlertsBasisType | String |
|
|
|
|
TimeBillingType | String |
|
|
|
|
TimeBudgetMetric | String |
|
|
|
|
TimeContractTerms | String |
|
|
|
|
Timestamp | String |
|
|
|
|
UserDefinedFields |
|
|
|
| |
WorkMinutesTimeBudgetAmount | Int32 |
|
|
|
|
CalculateEngagementBudgetFlag | Boolean |
|
|
|
|
ChargeableMinutesTimeBudgetAmount | Int32 |
|
|
|
|
InheritInvoiceEmailSettingsFlag | Boolean |
|
|
|
|
InvoiceEmailSettings |
|
|
|
| |
InheritRenderReceiptsFlag | Boolean |
|
|
|
|
RenderReceiptsFlag | Boolean |
|
|
|
|
AutoApplyAvailableBalanceFlag | Boolean |
|
|
|
|
InheritAutoApplyAvailableBalanceFlag | Boolean |
|
|
|
|
InheritTaxTypesFlag | Boolean |
|
|
|
|
TaxType1Identity |
|
|
|
| |
TaxType2Identity |
|
|
|
| |
TaxType3Identity |
|
|
|
|
Usage Example(s)
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<EngagementDetail> <EngagementCode>E001395</EngagementCode> <EngagementId i:nil="true"/> <EngagementUid>1152921504607324698</EngagementUid> <ClientIdentity> <ClientId i:nil="true"/> <ClientNumber>Projector PSA</ClientNumber> <ClientUid>1152921504606961482</ClientUid> </ClientIdentity> <EngagementName>Web Services Engagement</EngagementName> <Address> <AddressLine1>85 Merrimac Street</AddressLine1> <AddressLine2>200</AddressLine2> <Attention i:nil="true"/> <City>Boston</City> <CompanyName>Projector PSA</CompanyName> <Country>USA</Country> <StateOrProvince>MA</StateOrProvince> <ZipOrPostalCode>02114</ZipOrPostalCode> </Address> <BillingAdjustedRevenueTimeBudgetAmount i:nil="true"/> <BillingCultureIdentity> <CultureId i:nil="true"/> <CultureName>en-US</CultureName> <CultureUid>1152921504606851419</CultureUid> </BillingCultureIdentity> <BillingCycleIdentity> <BillingCycleId i:nil="true"/> <BillingCycleName>Monthly</BillingCycleName> <BillingCycleUid>1152921504606853180</BillingCycleUid> </BillingCycleIdentity> <BillingInstructions>This client should be billed on the 15th of each month.</BillingInstructions> <ClientAmountCostBudgetAmount i:nil="true"/> <ClientMessage>Thank you for using revcorp-bb. We appreciate your business. <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> <ClientMessagePlain>Thank you for using revcorp-bb. We appreciate your business.!</ClientMessagePlain> <ContractRevenueTimeBudgetAmount i:nil="true"/> <CostAlertsBasisType>E</CostAlertsBasisType> <CostBudgetMetric>C</CostBudgetMetric> <CostCenterIdentity> <CostCenterId i:nil="true"/> <CostCenterName>Executive Team (USA)</CostCenterName> <CostCenterNumber>Executive Team (USA)</CostCenterNumber> <CostCenterUid>1152921504606867363</CostCenterUid> </CostCenterIdentity> <CostContractTerms>T</CostContractTerms> <CurrencyIdentity> <CurrencyCode>USD</CurrencyCode> <CurrencyId i:nil="true"/> <CurrencyUid>1152921504606851838</CurrencyUid> </CurrencyIdentity> <DisbursedAmountCostBudgetAmount i:nil="true"/> <EngagementStageIdentity> <EngagementStageId i:nil="true"/> <EngagementStageName>Open</EngagementStageName> <EngagementStageShortName>Open</EngagementStageShortName> <EngagementStageUid>1152921504606849675</EngagementStageUid> </EngagementStageIdentity> <EngagementTypeIdentity> <EngagementTypeId i:nil="true"/> <EngagementTypeName>Billable - Time and Materials</EngagementTypeName> <EngagementTypeShortName>T&M</EngagementTypeShortName> <EngagementTypeUid>1152921504606863884</EngagementTypeUid> </EngagementTypeIdentity> <ExpenseAmountCostBudgetAmount i:nil="true"/> <HoldbackAmount i:nil="true"/> <HoldbackPercent i:nil="true"/> <HoldbackType>N</HoldbackType> <InheritAddressFlag>true</InheritAddressFlag> <InheritBillingCycleFlag>true</InheritBillingCycleFlag> <InheritBillingInstructionsFlag>true</InheritBillingInstructionsFlag> <InheritClientMessageFlag>true</InheritClientMessageFlag> <InheritInvoiceContentFlag>true</InheritInvoiceContentFlag> <InheritInvoiceScopeFlag>true</InheritInvoiceScopeFlag> <InheritInvoiceTemplateFlag>true</InheritInvoiceTemplateFlag> <InheritPaymentTermFlag>true</InheritPaymentTermFlag> <InheritPurchaseOrderNumberFlag>true</InheritPurchaseOrderNumberFlag> <InheritTimeBillingTypeFlag>true</InheritTimeBillingTypeFlag> <InvoiceContent>B</InvoiceContent> <InvoiceScope>E</InvoiceScope> <InvoiceTemplateIdentity> <InvoiceTemplateId i:nil="true"/> <InvoiceTemplateName>A200</InvoiceTemplateName> <InvoiceTemplateUid>1152921504606878904</InvoiceTemplateUid> </InvoiceTemplateIdentity> <ManagerIdentity> <UserDisplayName>Jack Spratt</UserDisplayName> <UserId i:nil="true"/> <UserReferenceSystemId>E123</UserReferenceSystemId> <UserUid>1152921504607112369</UserUid> </ManagerIdentity> <MaxCostContractAmount i:nil="true"/> <MaxTimeContractAmount i:nil="true"/> <MinCostContractAmount i:nil="true"/> <MinTimeContractAmount i:nil="true"/> <NewEngagementCode i:nil="true"/> <PaymentTermIdentity> <PaymentTermId i:nil="true"/> <PaymentTermName>Net 30</PaymentTermName> <PaymentTermUid>1152921504606856054</PaymentTermUid> </PaymentTermIdentity> <PurchaseOrderNumber>PO Projector PSA</PurchaseOrderNumber> <ResourceDirectCostTimeBudgetAmount i:nil="true"/> <RevenueEarnedByDate i:nil="true"/> <RevenueRecognitionMethod i:nil="true"/> <TimeAlertsBasisType>E</TimeAlertsBasisType> <TimeBillingType>H</TimeBillingType> <TimeBudgetMetric>B</TimeBudgetMetric> <TimeContractTerms>T</TimeContractTerms> <Timestamp>AAAAAA61frA=</Timestamp> <UserDefinedFields/> <WorkMinutesTimeBudgetAmount i:nil="true"/> <CalculateEngagementBudgetFlag>true</CalculateEngagementBudgetFlag> <ChargeableMinutesTimeBudgetAmount i:nil="true"/> <InheritInvoiceEmailSettingsFlag>true</InheritInvoiceEmailSettingsFlag> <InvoiceEmailSettings> <EmailFromUserIdentity> <UserDisplayName>Bob Smith</UserDisplayName> <UserId i:nil="true"/> <UserReferenceSystemId>Partner - 01</UserReferenceSystemId> <UserUid>1152921504607011056</UserUid> </EmailFromUserIdentity> <EmailInvoiceTemplateIdentity> <InvoiceTemplateId i:nil="true"/> <InvoiceTemplateName>E004</InvoiceTemplateName> <InvoiceTemplateUid>1152921504606878909</InvoiceTemplateUid> </EmailInvoiceTemplateIdentity> <InvoiceEmailEnabledFlag>true</InvoiceEmailEnabledFlag> <InvoiceEmailType>H</InvoiceEmailType> <Recipients> <PwsInvoiceEmailRecipient> <RecipientType>T</RecipientType> <UserIdentity> <UserDisplayName>Jane Doe</UserDisplayName> <UserId i:nil="true"/> <UserReferenceSystemId>E124</UserReferenceSystemId> <UserUid>1152921504607112368</UserUid> </UserIdentity> </PwsInvoiceEmailRecipient> </Recipients> </InvoiceEmailSettings> <InheritRenderReceiptsFlag>true</InheritRenderReceiptsFlag> <RenderReceiptsFlag>true</RenderReceiptsFlag> <AutoApplyAvailableBalanceFlag>true</AutoApplyAvailableBalanceFlag> <InheritAutoApplyAvailableBalanceFlag>true</InheritAutoApplyAvailableBalanceFlag> <InheritTaxTypesFlag>true</InheritTaxTypesFlag> <TaxType1Identity> <TaxTypeCode>VAT</TaxTypeCode> <TaxTypeId i:nil="true"/> <TaxTypeUid>1152921504606868258</TaxTypeUid> </TaxType1Identity> <TaxType2Identity i:nil="true"/> <TaxType3Identity i:nil="true"/> </EngagementDetail> |