Versions Compared

Key

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

...

Panel
titlePwsContractLineItemDetail
  • PwsContractLineItemDetail
    • ContractLineItemNameContractLineItemCode: StringEngagementCode
    • ContractLineItemId: StringInt32EngagementId
    • ContractLineItemUid: Int32Int64EngagementUid
    • ContractLineItemName: Int64String
    • EngagementIdentity: PwsEngagementRef
    • CostContractTerms: String
    • DeferredRevenueOpeningBalanceEngCurrency: Double
    • DeferredRevenueOpeningBalanceEngGLCurrency: Double
    • HoldbackAmount: Double
    • HoldbackPercent: Double
    • HoldbackType: String
    • MaxCostContractAmount: Double
    • MaxTimeContractAmount: Double
    • MinCostContractAmount: Double
    • MinTimeContractAmount: Double
    • RevenueEarnedByDate: DateTime
    • RevenueRecognitionMethod: String
    • RevenueSchedule: PwsRevenueScheduleItem
    • TimeContractTerms: String
    • ContractTypeIdentity: PwsContractTypeRef
    • InheritPurchaseOrderNumberFlag: Boolean
    • ModelContractedHoursAndOveragesFlag: Boolean
    • OverageProjectIdentity: PwsProjectRef
    • PurchaseOrderNumber: String

Elements



Element

Data Type

Required?

Default

Description

Sample Data

ContractLineItemName

ContractLineItemCode

String

 

 

The contract line item

name.eb Services Engagement

EngagementCode

String

The engagement code associated with the

code is a unique identifier for a contract line item

.

E001395

 

EngagementId

ContractLineItemId

Int32

The engagement id associated with the

 

 

The contract line item id. For internal use only

.

 

EngagementUid1152921504607083377

ContractLineItemUid

Int64

 

 

A unique and immutable Id for a contract line item

 

ContractLineItemName

The engagement Uid associated with the contract line item. This is a unique and immutable identifer for an engagement.

String

 

 

The contract line item name 

 

EngagementIdentity

PwsEngagementRef

 

 

 

 

CostContractTerms

String

 

 

The cost contract terms associated with the contract line item:

"F" for Fixed Price

"T" for Time and Materials

"C" for Time and Materials with a cap

Null on update means leave as

is

is 

T

 

DeferredRevenueOpeningBalanceEngCurrency

Double

 

 

The deferred revenue opening balance associated with the contract line item (in the engagement currency) 

20000

 

DeferredRevenueOpeningBalanceEngGLCurrency

Double

 

 

The deferred revenue opening balance associated with the contract line item (in the general ledger currency) 

15000

 

HoldbackAmount

Double

 

 

The holdback amount associated with the contract line item. Applies only when holdback type is A; null otherwise. 

5000

 

HoldbackPercent

Double

 

 

The holdback percent associated with the contract line item. Applies only when holdback type is P; null otherwise.

.25

 

HoldbackType

String

 

 

The holdback type associated with the contract line item

.

"N" for none

"A" for Amount

"P" for

Percent

Percent 

N

 

MaxCostContractAmount

Double

 

 

The maximum cost contract amount associated with the contract line item

.

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

.

10000

 

MaxTimeContractAmount

Double

 

 

The maximum time contract amount associated with the contract line item

.

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

.

20000

 

MinCostContractAmount

Double

 

 

The minimum cost contract amount associated with the contract line item

.

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

.

5000

 

MinTimeContractAmount

Double

 

 

The minimum time contract amount associated with the contract line item

.

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

.

15000

 

RevenueEarnedByDate

DateTime

 

 

This is a date by which the contract line item is expected to be complete

.2018-06-30T00:00:00Z

 

RevenueRecognitionMethod

String

 

 

The revenue recognition method associated with the contract line item

.

"P" for percent complete

"R" for revenue schedule

Leave blank for non-billable engagements

.

P

 

RevenueSchedule

PwsRevenueScheduleItem[]

 

 

The information associated with the revenue schedule associated with the contract line item. Applies only whtn the RevenueRecogntionMethod = 'R' 

 

TimeContractTerms

String

 

 

The time contract terms associated with the contract line item

.

"T" for Time & Materials

"F" for Fixed Price

"C" for Not to Exceed

 

ContractTypeIdentity

PwsContractTypeRef

 

 

The contract type identity with the contract line item

.

 

InheritPurchaseOrderNumberFlag

Boolean

 

 

Inherit Purchase Order Number from Parent Client (if any). Please see Inheritance for more information. 

true/false

 

ModelContractedHoursAndOveragesFlag

Boolean

 

 

When set to "true", the contract will be modeled to account for contracted hours and overages. This setting is typically used when setting up service contracts where a client purchases a fixed amount of hours for a specific time period. Time that exceeds the allottment is then billed at a different rate. This overage is handled by a separate project. Only available for Fixed Price time contracts using a revenue schedule. 

true/false

 

OverageProjectIdentity

PwsProjectRef

 

 

For Contract Line Items that are defined to model Contracted Hours and Overages, this is the project to which hours that exceed a set number within a date range will be transferred

.

 

P001395-002

 

PurchaseOrderNumber

String

 

 

Purchase Order Number associated with the Contract Line Item

PO-1234

 

Usage Example(s)


Code Block
languagexml
titleExample 01 - without a revenue schedule
collapsetrue
                         <ContractLineItemDetail>
  
                        <ContractLineItemCode>P001395-CL1</ContractLineItemCode>
                           <ContractLineItemId i:nil="true"/>
     
                     <ContractLineItemUid>1152921504607083377</ContractLineItemUid>
 
                         <ContractLineItemName>Web Services Engagement</ContractLineItemName>
                           <EngagementIdentity>
     
                        <EngagementCode>E001395</EngagementCode>

                             <EngagementId i:nil="true"/>
 
                            <EngagementUid>1152921504607324698</EngagementUid>
     
                     </EngagementIdentity>
                           <CostContractTerms>T</CostContractTerms>

                          <DeferredRevenueOpeningBalanceEngCurrency>0</DeferredRevenueOpeningBalanceEngCurrency>
    
                      <DeferredRevenueOpeningBalanceEngGLCurrency>0</DeferredRevenueOpeningBalanceEngGLCurrency>
                           <HoldbackAmount i:nil="true"/><HoldbackAmount>5000</HoldbackAmount>
                           <HoldbackPercent i:nil="true"/>
                           <HoldbackType>N<<HoldbackType>A</HoldbackType>

                          <MaxCostContractAmount i:nil="true"/>
                           <MaxTimeContractAmount i:nil="true"/>
<MaxTimeContractAmount>100000</MaxTimeContractAmount>
                          <MinCostContractAmount i:nil="true"/>
                           <MinTimeContractAmount i:nil="true"/><MinTimeContractAmount>100000</MinTimeContractAmount>
                           <RevenueEarnedByDate i:nil="true"/><RevenueEarnedByDate>2018-06-30T00:00:00Z</RevenueEarnedByDate>
                           <RevenueRecognitionMethod i:nil="true"/><RevenueRecognitionMethod>P</RevenueRecognitionMethod>
                           <RevenueSchedule/>
                           <TimeContractTerms>T<<TimeContractTerms>F</TimeContractTerms>
                           <ContractTypeIdentity i:nil="true"/>
                           <InheritPurchaseOrderNumberFlag>true</InheritPurchaseOrderNumberFlag>
 
                         <ModelContractedHoursAndOveragesFlag>false</ModelContractedHoursAndOveragesFlag>
                           <OverageProjectIdentity i:nil="true"/>
                           <PurchaseOrderNumber>PO-1234<PurchaseOrderNumber>PR-PSA01</PurchaseOrderNumber>
                           <Timestamp>AAAAAA61fo0<Timestamp>AAAAAA61kS0=</Timestamp>
     
                  </ContractLineItemDetail>