Overview
This structure contains the complete set of information about a Contract Line Item. The structure is used both to retrieve detailed contract line item information and to pass information about a contract line item back to the server to get updated.
Format
| Panel | ||
|---|---|---|
| ||
|
Elements
| Element | Data Type | Description | Default (on insert/update) | Sample Data |
|---|---|---|---|---|
| ContractLineItemCode | String | Unique Contract Line Item Code | P001395-CL1 | |
| ContractLineItemId | Int32 | Contract Line Item Id. For internal use only. | ||
| ContractLineItemUid | Int64 | The Contract Line Item Uid is a unique and immutable identifier for a contract line item. | 1152921504607083377 | |
| ContractLineItemName | String | Contract Line Item Name | Web Services Engagement | |
| EngagementIdentity | PwsEngagementRef | |||
| 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 | C | C |
| DeferredRevenueOpeningBalanceEngCurrency | Double | Deferred Revenue Opening Balance in the Engagement Currency | 20000 | |
| DeferredRevenueOpeningBalanceEngGLCurrency | Double | Deferred Revenue Opening Balance in the General Ledger Currency | 15000 | |
| HoldbackAmount | Double | Holdback Amount. Applies only when holdback type is A; null otherwise. | 5000 | |
| HoldbackPercent | Double | Holdback Percent. Applies only when holdback type is P; null otherwise. | 0.25 | |
| HoldbackType | String | Holdback Type. "N" for none "A" for Amount "P" for Percent | N | A |
| MaxCostContractAmount | Double | Maximum Cost Contract Amount Must be specified for cost contract terms F or C, and null otherwise. | 5000 | |
| MaxTimeContractAmount | Double | Maximum Time Contract Amount Must be specified for time contract terms F or C, and null otherwise. | 20000 | |
| MinCostContractAmount | Double | Minimum Cost Contract Amount Must be specified for cost contract terms F, and null otherwise. | 10000 | |
| MinTimeContractAmount | Double | Minimum Time Contract Amount Must be specified for time contract terms F, and null otherwise. | 15000 | |
| RevenueEarnedByDate | DateTime | The date that revenue should be earned by | 2018-06-30T00:00:00Z | |
| RevenueRecognitionMethod | String | Revenue Recognition Method "P" for percent complete "R" for revenue schedule Leave blank for non-billable engagements. | R | |
| RevenueSchedule | PwsRevenueScheduleItem |
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
ContractLineItemName | String |
|
| Contract Line Item Name | Web Services Engagement |
EngagementCode | String |
|
| Engagement Code. A unique identifier for an Engagement | E001395 |
EngagementId | Int32 |
|
| Engagement Id. A unique identifier for an Engagement. For internal use only. | |
EngagementUid | Int64 |
|
| Engagement Unique Id. A unique and immutable identifer for an engagement. | 1152921504607083377 |
EngagementIdentity |
|
|
| ||
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 |
DeferredRevenueOpeningBalanceEngCurrency | Double |
|
| Deferred Revenue Opening Balance in the Engagement Currency | 20000 |
DeferredRevenueOpeningBalanceEngGLCurrency | Double |
|
| Deferred Revenue Opening Balance in the General Ledger Currency | 15000 |
HoldbackAmount | Double |
|
| Holdback Amount. Applies only when holdback type is A; null otherwise. | 5000 |
HoldbackPercent | Double |
|
| Holdback Percent. Applies only when holdback type is P; null otherwise. | .25 |
HoldbackType | String |
|
| Holdback Type. "N" for none "A" for Amount "P" for Percent | N |
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. | 20000 |
MinCostContractAmount | Double |
|
| Maximum Cost Contract Amount Must be specified for cost contract terms F or C, and null otherwise. | 5000 |
MinTimeContractAmount | Double |
|
| Minimum Time Contract Amount Must be specified for time contract terms F, and null otherwise. | 15000 |
RevenueEarnedByDate | DateTime |
|
| This is a date by which an engagement is expected to finish. | 2018-06-30T00:00:00Z |
RevenueRecognitionMethod | String |
|
| Revenue Recognition Method "P" for percent complete "R" for revenue schedule Leave blank for non-billable engagements. | P |
RevenueSchedule |
|
|
| ||
TimeContractTerms | String |
|
| Time Contract Terms "T" for Time & Materials "F" for Fixed Price "C" for Not to Exceed | |
ContractTypeIdentity |
|
|
| ||
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 |
|
| 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 | ||||||
|---|---|---|---|---|---|---|
| ||||||
<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"/>
<HoldbackPercent i:nil="true"/>
<HoldbackType>N</HoldbackType>
<MaxCostContractAmount i:nil="true"/>
<MaxTimeContractAmount i:nil="true"/>
<MinCostContractAmount i:nil="true"/>
<MinTimeContractAmount i:nil="true"/>
<RevenueEarnedByDate i:nil="true"/>
<RevenueRecognitionMethod i:nil="true"/>
<RevenueSchedule/>
<TimeContractTerms>T</TimeContractTerms>
<ContractTypeIdentity i:nil="true"/>
<InheritPurchaseOrderNumberFlag>true</InheritPurchaseOrderNumberFlag>
<ModelContractedHoursAndOveragesFlag>false</ModelContractedHoursAndOveragesFlag>
<OverageProjectIdentity i:nil="true"/>
<PurchaseOrderNumber>PO Projector PSA<-1234/PurchaseOrderNumber>
<Timestamp>AAAAAA61fo0=</Timestamp>
</ContractLineItemDetail> |