PwsContractLineItemMilestoneElement

Overview


This structure is returned by services such as PwsGetContractLineItem, which return the full details about contract line items, including full details of milestones associated with the contract line item. This structure contains a contract line item milestone detail structure (PwsContractLineItemMilestoneDetail). It is also where additional related information about the contract line item milestone, that is not directly an attribute of the contract line item milestone itself or is not a modifiable attribute, is found.

Format


PwsContractLineItemMilestoneElement

Elements


Element

Data Type

Required?

Description

Sample Data

CreatedByUserIdentity

PwsUserRef

n/a

The identity of the user who created this milestone.


CreatedTimestamp

DateTime

n/a

The date and time (in UTC format) this milestone was created.

2018-01-06T16:53:15.527Z

InvoiceIdentity

PwsInvoiceRef

n/a

The invoice (if any) that contains this milestone.


LastUpdatedByUserIdentity

PwsUserRef

n/a

The user who last modified the milestone.


LastUpdatedTimestamp

DateTime

n/a

The date and time (in UTC format) this milestone was last updated.

2018-01-06T18:12:48.527Z

MilestoneDetail

PwsContractLineItemMilestoneDetail

n/a


The complete set of information about the milestone. This substructure can be modified and passed to PwsSaveContractLineItemMilestone to make changes to the milestone.


MilestoneStatus

String (1)

n/a


The milestone status.

"P" for Pending - the milestone is yet to be achieved, but will in the future

"F" for Foregone - the milestone has not and will not be achieved

"A" for Achieved - set this by choosing an achieved date

"B" for Billed - set when this milestone is on an issued invoice

P

PurchaseOrderNumber

String (50)

n/a


The purchase order number associated with the milestone.

PO-1234
EffectivePlannedDateDateTimen/aIf linked to a project task, it is the task's start date. Otherwise, it is the milestone's planned date.

Usage Example(s)


Example 01
                      <b:PwsContractLineItemMilestoneElement>
                        <b:CreatedByUserIdentity>
                           <b:UserDisplayName>PPSA Support User</b:UserDisplayName>
                           <b:UserId i:nil="true"/>
                           <b:UserReferenceSystemId>000</b:UserReferenceSystemId>
                           <b:UserUid>1152921504606944261</b:UserUid>
                        </b:CreatedByUserIdentity>
                        <b:CreatedTimestamp>2018-11-12T16:57:52.23Z</b:CreatedTimestamp>
                        <b:InvoiceIdentity i:nil="true"/>
                        <b:LastUpdatedByUserIdentity>
                           <b:UserDisplayName>PPSA Support User</b:UserDisplayName>
                           <b:UserId i:nil="true"/>
                           <b:UserReferenceSystemId>000</b:UserReferenceSystemId>
                           <b:UserUid>1152921504606944261</b:UserUid>
                        </b:LastUpdatedByUserIdentity>
                        <b:LastUpdatedTimestamp>2018-11-12T16:57:52.23Z</b:LastUpdatedTimestamp>
                        <b:MilestoneDetail>
                           <b:ContractLineItemMilestoneId i:nil="true"/>
                           <b:ContractLineItemMilestoneUid>1152921504607120669</b:ContractLineItemMilestoneUid>
                           <b:AchievedDate>2018-12-23T00:00:00Z</b:AchievedDate>
                           <b:ContractLineItemIdentity>
                              <b:ContractLineItemCode>P001125-CL2-2</b:ContractLineItemCode>
                              <b:ContractLineItemId i:nil="true"/>
                              <b:ContractLineItemUid>1152921504607095669</b:ContractLineItemUid>
                           </b:ContractLineItemIdentity>
                           <b:ContractLineItemMilestoneName>2018-4Q</b:ContractLineItemMilestoneName>
                           <b:MilestoneAmount>400</b:MilestoneAmount>
                           <b:PlannedDate>2018-09-01T00:00:00Z</b:PlannedDate>
                           <b:Description i:nil="true"/>
                           <b:ForegoneFlag>false</b:ForegoneFlag>
                           <b:ProjectIdentity i:nil="true"/>
                           <b:ProjectTaskIdentity i:nil="true"/>
                        </b:MilestoneDetail>
                        <b:MilestoneStatus>A</b:MilestoneStatus>
                        <b:PurchaseOrderNumber>P001125-PO</b:PurchaseOrderNumber>
                        <b:EffectivePlannedDate>2018-09-01T00:00:00Z</b:EffectivePlannedDate>
                     </b:PwsContractLineItemMilestoneElement>