...
Element | Data Type | Required? | Default | Description | Sample Data | |
---|---|---|---|---|---|---|
ContractLineItemCode | String (27) | 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 | E001395P001163-CL1 | ||
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 item1152921504607324698 | 1152921504607049238 | ||
ContractLineItemName | String (255) | On Insert: Yes On Update: No | The contract line item name Web Services Engagement | Contract 192810 | ||
EngagementIdentity | On Insert: No On Update: No | The engagement associated with the contract line item. Click here for more information. | ||||
CostContractTerms | String (1) | 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 "N" for Non-chargeable Null on update means leave as is C | T | ||
DeferredRevenueOpeningBalanceEngCurrency | Double | On Insert: No On Update: No | 0 | The deferred revenue opening balance associated with the contract line item (in the engagement currency) | 0 | |
DeferredRevenueOpeningBalanceEngGLCurrency | Double | On Insert: No On Update: No | 0 | The deferred revenue opening balance associated with the contract line item (in the general ledger currency) | 0 | |
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 | N | The holdback type associated with the contract line item "N" for none "A" for Amount "P" for Percent | N | |
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 otherwise5000 | |||
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 otherwise10000 | |||
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 (in midnight UTC) by which the contract line item is expected to be complete.2018-06-30T00:00:00Z | |||
RevenueRecognitionMethod | String (1) | On Insert: No On Update: No | P | The revenue recognition method associated with the contract line item. The RevenueRecognitionMethod will be NULL unless it is a fixed price for time contract. Otherwise will be P or R. "P" for percent complete "R" for revenue schedule | P | |
RevenueSchedule | On Insert: No On Update: No | The information associated with the revenue and/or contracted hours schedule associated with the contract line item. Applies only when the RevenueRecogntionMethod = 'R'. Click here for more information. | ||||
TimeContractTerms | String (1) | On Insert: Yes (if ContractTypeIdentity is not supplied) On Update: No | T | The time contract terms associated with the contract line item "T" for Time & Materials "F" for Fixed Price "C" for Not to ExceedC | T | |
ContractTypeIdentity | On Insert: Yes (if TimeContractTerms is not supplied) On Update: No | The contract type identity associated with the contract line item. For custom contract line items, this will be NULL. Click here for more information. | ||||
InheritPurchaseOrderNumberFlag | Boolean | On Insert: No On Update: No | true | If set to 'true', the purchase order number is inherited from the 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. | true/false | |
OverageProjectIdentity | On Insert: No On Update: No | 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. Click here for more information. | ||||
PurchaseOrderNumber | String (50) | On Insert: No On Update: No | The purchase order number associated with the contract line item | PR-PSA01 |
Usage Example(s)
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<b:ContractLineItemDetail> <b:ContractLineItemCode>P001163-CL1</b:ContractLineItemCode> <b:ContractLineItemId i:nil="true"/> <b:ContractLineItemUid>1152921504607049238</b:ContractLineItemUid> <b:ContractLineItemName>RelationshipContractLineItemName>Contract Type UDFs<192810</b:ContractLineItemName> <b:EngagementIdentity> <b:EngagementCode>P001163</b:EngagementCode> <b:EngagementId i:nil="true"/> <b:EngagementUid>1152921504607293498</b:EngagementUid> </b:EngagementIdentity> <b:CostContractTerms>T</b:CostContractTerms> <b:DeferredRevenueOpeningBalanceEngCurrency>0</b:DeferredRevenueOpeningBalanceEngCurrency> <b:DeferredRevenueOpeningBalanceEngGLCurrency>0</b:DeferredRevenueOpeningBalanceEngGLCurrency> <b:HoldbackAmount i:nil="true"/> <b:HoldbackPercent i:nil="true"/> <b:HoldbackType>N</b:HoldbackType> <b:MaxCostContractAmount i:nil="true"/> <b:MaxTimeContractAmount i:nil="true"/> <b:MinCostContractAmount i:nil="true"/> <b:MinTimeContractAmount i:nil="true"/> <b:RevenueEarnedByDate i:nil="true"/> <b:RevenueRecognitionMethod>P</b:RevenueRecognitionMethod> <b:RevenueSchedule/> <b:TimeContractTerms>T</b:TimeContractTerms> <b:ContractTypeIdentity i:nil="true"/> <b:InheritPurchaseOrderNumberFlag>true</b:InheritPurchaseOrderNumberFlag> <b:ModelContractedHoursAndOveragesFlag>false</b:ModelContractedHoursAndOveragesFlag> <b:OverageProjectIdentity i:nil="true"/> <b:PurchaseOrderNumber i:nil="true"/> </b:ContractLineItemDetail> |
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<b:ContractLineItemDetail>
<b:ContractLineItemCode>P001320-CL1</b:ContractLineItemCode>
<b:ContractLineItemId i:nil="true"/>
<b:ContractLineItemUid>1152921504607083461</b:ContractLineItemUid>
<b:ContractLineItemName>Web Services Documentation</b:ContractLineItemName>
<b:EngagementIdentity>
<b:EngagementCode>P001320</b:EngagementCode>
<b:EngagementId i:nil="true"/>
<b:EngagementUid>1152921504607326368</b:EngagementUid>
</b:EngagementIdentity>
<b:CostContractTerms>T</b:CostContractTerms>
<b:DeferredRevenueOpeningBalanceEngCurrency>0</b:DeferredRevenueOpeningBalanceEngCurrency>
<b:DeferredRevenueOpeningBalanceEngGLCurrency>0</b:DeferredRevenueOpeningBalanceEngGLCurrency>
<b:HoldbackAmount i:nil="true"/>
<b:HoldbackPercent i:nil="true"/>
<b:HoldbackType>N</b:HoldbackType>
<b:MaxCostContractAmount i:nil="true"/>
<b:MaxTimeContractAmount>30000</b:MaxTimeContractAmount>
<b:MinCostContractAmount i:nil="true"/>
<b:MinTimeContractAmount>30000</b:MinTimeContractAmount>
<b:RevenueEarnedByDate i:nil="true"/>
<b:RevenueRecognitionMethod>R</b:RevenueRecognitionMethod>
<b:RevenueSchedule>
<b:PwsRevenueScheduleItem>
<b:EndDate>2018-01-31T00:00:00Z</b:EndDate>
<b:ScheduledRevenueAmount>10000</b:ScheduledRevenueAmount>
<b:StartDate i:nil="true"/>
<b:ContractedMinutes i:nil="true"/>
<b:Notes>January Bucket</b:Notes>
</b:PwsRevenueScheduleItem>
<b:PwsRevenueScheduleItem>
<b:EndDate>2018-02-28T00:00:00Z</b:EndDate>
<b:ScheduledRevenueAmount>10000</b:ScheduledRevenueAmount>
<b:StartDate>2018-02-01T00:00:00Z</b:StartDate>
<b:ContractedMinutes i:nil="true"/>
<b:Notes>February Bucket</b:Notes>
</b:PwsRevenueScheduleItem>
<b:PwsRevenueScheduleItem>
<b:EndDate>2018-03-31T00:00:00Z</b:EndDate>
<b:ScheduledRevenueAmount>10000</b:ScheduledRevenueAmount>
<b:StartDate>2018-03-01T00:00:00Z</b:StartDate>
<b:ContractedMinutes i:nil="true"/>
<b:Notes>March Bucket</b:Notes>
</b:PwsRevenueScheduleItem>
</b:RevenueSchedule>
<b:TimeContractTerms>F</b:TimeContractTerms>
<b:ContractTypeIdentity i:nil="true"/>
<b:InheritPurchaseOrderNumberFlag>true</b:InheritPurchaseOrderNumberFlag>
<b:ModelContractedHoursAndOveragesFlag>false</b:ModelContractedHoursAndOveragesFlag>
<b:OverageProjectIdentity i:nil="true"/>
<b:PurchaseOrderNumber>P-001</b:PurchaseOrderNumber>
</b:ContractLineItemDetail> |