Overview
This structure contains the complete set of information about 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 (less any subordinate entitiesdetail structure (PwsContractLineItemMilestoneDetail). The structure is used both to retrieve detailed contract line item milestone information and to pass information about a contract line item milestone back to the server to get updatedIt 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
Panel | ||
---|---|---|
| ||
|
...
Element | Data Type | Required? | Description | Sample Data | |
---|---|---|---|---|---|
CreatedByUserIdentity | 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 | n/a | The invoice (if any) that contains this milestone. | |||
LastUpdatedByUserIdentity | 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 | On Insert: Yes On Update: Yes | 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) | On Insert: Yes On Update: Non/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) | On Insert: No On Update: No | n/a | The purchase order number associated with the milestone. | PO-1234 |
Usage Example(s)
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<b:PwsContractLineItemMilestoneElement> <b:CreatedByUserIdentity> <b:UserDisplayName>Betty Smith</b:UserDisplayName> <b:UserId i:nil="true"/> <b:UserReferenceSystemId>Partner - 01</b:UserReferenceSystemId> <b:UserUid>1152921504607011056</b:UserUid> </b:CreatedByUserIdentity> <b:CreatedTimestamp>2018-01-17T14:33:57.143</b:CreatedTimestamp> <b:InvoiceIdentity i:nil="true"/> <b:LastUpdatedByUserIdentity> <b:UserDisplayName>Betty Smith</b:UserDisplayName> <b:UserId i:nil="true"/> <b:UserReferenceSystemId>Partner - 01</b:UserReferenceSystemId> <b:UserUid>1152921504607011056</b:UserUid> </b:LastUpdatedByUserIdentity> <b:LastUpdatedTimestamp>2018-01-17T14:36:06.58</b:LastUpdatedTimestamp> <b:MilestoneDetail> <b:ContractLineItemMilestoneId i:nil="true"/> <b:ContractLineItemMilestoneUid>1152921504607106568</b:ContractLineItemMilestoneUid> <b:AchievedDate i:nil="true"/> <b:ContractLineItemIdentity> <b:ContractLineItemCode>P001320-CL1</b:ContractLineItemCode> <b:ContractLineItemId i:nil="true"/> <b:ContractLineItemUid>1152921504607083461</b:ContractLineItemUid> </b:ContractLineItemIdentity> <b:ContractLineItemMilestoneName>Milestone for period starting 01-Jan-2018</b:ContractLineItemMilestoneName> <b:MilestoneAmount>10000</b:MilestoneAmount> <b:PlannedDate i:nil="true"/> <b:Description>January Milestone</b:Description> <b:ForegoneFlag>false</b:ForegoneFlag> <b:ProjectIdentity> <b:ProjectCode>P001320-001</b:ProjectCode> <b:ProjectId i:nil="true"/> <b:ProjectUid>1152921504607410915</b:ProjectUid> </b:ProjectIdentity> <b:ProjectTaskIdentity> <b:ExternalSystemIdentifier i:nil="true"/> <b:ProjectTaskId i:nil="true"/> <b:ProjectTaskUid>1152921504608715269</b:ProjectTaskUid> </b:ProjectTaskIdentity> </b:MilestoneDetail> <b:MilestoneStatus>P</b:MilestoneStatus> <b:PurchaseOrderNumber i:nil="true"/> </b:PwsContractLineItemMilestoneElement> <b:PwsContractLineItemMilestoneElement> |