Versions Compared

Key

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

...

Panel
titlePwsContractLineItemDetail
  • PwsContractLineItemDetail
    • ContractLineItemCode: String
    • ContractLineItemId: Int32
    • ContractLineItemUid: Int64
    • ContractLineItemName: String
    • 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

ContractLineItemCode

String

 

On Insert: No

On Update: Yes (if ContractLineItemUid is not supplied)


The contract line item code is a unique identifier for a contract line item

 

 


ContractLineItemId

Int32

 

On Insert: No

On Update: No


The contract line item id. For internal use only

 

 


ContractLineItemUid

Int64

 

On Insert: No

On Update: Yes (if ContractLineItemCode is not supplied)


A unique and immutable Id for a contract line item

 

 


ContractLineItemName

String

 

On Insert: Yes

On Update: No


The contract line item name 

 


EngagementIdentity

PwsEngagementRef

 

 

 

  

On Insert: No

On Update: No


The engagement associated with the contract line item


CostContractTerms

String

 

On Insert: No

On Update: No


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 

 

 


DeferredRevenueOpeningBalanceEngCurrency

Double

 

On Insert: No

On Update: No


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

 

 


DeferredRevenueOpeningBalanceEngGLCurrency

Double

 

On Insert: No

On Update: No


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

 

 


HoldbackAmount

Double

 

On Insert: No

On Update: No


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

  

 


HoldbackPercent

Double

 

On Insert: No

On Update: No


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

  


HoldbackType

String

 

On Insert: No

On Update: No


The holdback type associated with the contract line item

"N" for none

"A" for Amount

"P" for Percent 

  


MaxCostContractAmount

Double

 

On Insert: No

On Update: No


The maximum cost contract amount associated with the contract line item

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

 

 


MaxTimeContractAmount

Double

 

On Insert: No

On Update: No


The maximum time contract amount associated with the contract line item

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

 

 


MinCostContractAmount

Double

 

On Insert: No

On Update: No


The minimum cost contract amount associated with the contract line item

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

 

 


MinTimeContractAmount

Double

 

On Insert: No

On Update: No


The minimum time contract amount associated with the contract line item

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

 

 


RevenueEarnedByDate

DateTime

 

On Insert: No

On Update: No


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

 

 


RevenueRecognitionMethod

String

 

On Insert: No

On Update: No


The revenue recognition method associated with the contract line item

"P" for percent complete

"R" for revenue schedule

Leave blank for non-billable engagements

 


RevenueSchedule

PwsRevenueScheduleItem

[]

 

 

On Insert: No

On Update: No


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

 

 


TimeContractTerms

String

 

On Insert: Yes (if ContractTypeIdentity is not supplied)

On Update: No


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

 

On Insert: Yes (if TimeContractTerms is not supplied)

On Update: No


The contract type identity with the contract line item

 

 


InheritPurchaseOrderNumberFlag

Boolean

 

On Insert: No

On Update: No

true

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

 

true/false

ModelContractedHoursAndOveragesFlag

Boolean

 

 

On Insert: No

On Update: No

Dependent on ContractTypeIdentity, if a ContractTypeIdentity is not supplied the default is false

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. 

 

 


OverageProjectIdentity

PwsProjectRef

 

On Insert: No

On Update: N


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 

 

 


PurchaseOrderNumber

String

 

On Insert: No

On Update: N


Purchase Order Number associated with the Contract Line Item

 


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>5000</HoldbackAmount>
                     <HoldbackPercent i:nil="true"/>
                     <HoldbackType>A</HoldbackType>
                     <MaxCostContractAmount i:nil="true"/>
                     <MaxTimeContractAmount>100000</MaxTimeContractAmount>
                     <MinCostContractAmount i:nil="true"/>
                     <MinTimeContractAmount>100000</MinTimeContractAmount>
                     <RevenueEarnedByDate>2018-06-30T00:00:00Z</RevenueEarnedByDate>
                     <RevenueRecognitionMethod>P</RevenueRecognitionMethod>
                     <RevenueSchedule/>
                     <TimeContractTerms>F</TimeContractTerms>
                     <ContractTypeIdentity i:nil="true"/>
                     <InheritPurchaseOrderNumberFlag>true</InheritPurchaseOrderNumberFlag>
                     <ModelContractedHoursAndOveragesFlag>false</ModelContractedHoursAndOveragesFlag>
                     <OverageProjectIdentity i:nil="true"/>
                     <PurchaseOrderNumber>PR-PSA01</PurchaseOrderNumber>
                     <Timestamp>AAAAAA61kS0=</Timestamp>
                  </ContractLineItemDetail>