Versions Compared

Key

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

...

This structure contains the complete set of information about a Contract Line Itemcontract 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.

...

Web

Element

Data Type

Description

Sample Data

ContractLineItemName

String

Contract Line Item Name

The contract line item name.

eb Services Engagement

EngagementCode

StringEngagement Code. A unique identifier for an Engagement

The engagement code associated with the contract line item.

E001395

EngagementId

Int32

Engagement Id. A unique identifier for an Engagement. The engagement id associated with the contract line item. For internal use only.


EngagementUid

Int64

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

1152921504607083377

EngagementIdentity

PwsEngagementRef



CostContractTerms

StringCost Contract Terms

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

T

DeferredRevenueOpeningBalanceEngCurrency

DoubleDeferred Revenue Opening Balance in the Engagement Currency

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

20000

DeferredRevenueOpeningBalanceEngGLCurrency

DoubleDeferred Revenue Opening Balance in the General Ledger Currency

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

15000

HoldbackAmount

Double

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

5000

HoldbackPercent

Double

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

.25

HoldbackType

StringHoldback

TypeThe holdback type associated with the contract line item.

"N" for none

"A" for Amount

"P" for Percent

N

MaxCostContractAmount

DoubleMaximum Cost Contract Amount

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

DoubleMaximum Time Contract Amount

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

DoubleMaximum Cost Contract Amount

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

DoubleMinimum Time Contract Amount

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 an engagement the contract line item is expected to finishbe complete.

2018-06-30T00:00:00Z

RevenueRecognitionMethod

StringRevenue Recognition Method

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

StringTime Contract Terms

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

...