Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 13 Next »

Overview


This structure contains the complete set of information about a contract line item milestone. 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 updated.


Format


PwsContractLineItemMilestoneElement

Elements


Element

Data Type

Required?

Default

Description

Sample Data

CreatedByUserIdentity

PwsUserRef

On Insert: No

On Update: No


The identity of the user who created this milestone. Click here for more information.


CreatedTimestamp

DateTime

On Insert: No

On Update: No


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

2018-01-06T16:53:15.527Z

InvoiceIdentity

PwsInvoiceRef

On Insert: No

On Update: No


The invoice (if any) that contains this milestone. Click here for more information.


LastUpdatedByUserIdentity

PwsUserRef

On Insert: No

On Update: No


The user who last modified the milestone. Click here for more information.


LastUpdatedTimestamp

DateTime

On Insert: No

On Update: No


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

2018-01-06T18:12:48.527Z

MilestoneDetail

PwsContractLineItemMilestoneDetail

On Insert: Yes

On Update: Yes


The complete set of information about the milestone. Click here for more information.


MilestoneStatus

String (1)

On Insert: No

On Insert: No

 P

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


The purchase order number associated with the milestone

PO-1234

Usage Example(s)


Example 01 
                         <PwsContractLineItemMilestoneElement>
                              <CreatedByUserIdentity>
                                 <UserDisplayName>Bob Smith</UserDisplayName>
                                 <UserId i:nil="true"/>
                                 <UserReferenceSystemId>Partner - 01</UserReferenceSystemId>
                                 <UserUid>1152921504607011056</UserUid>
                              </CreatedByUserIdentity>
                              <CreatedTimestamp>2018-01-06T16:53:25.15Z</CreatedTimestamp>
                              <InvoiceIdentity i:nil="true"/>
                              <LastUpdatedByUserIdentity>
                                 <UserDisplayName>Bob Smith</UserDisplayName>
                                 <UserId i:nil="true"/>
                                 <UserReferenceSystemId>Partner - 01</UserReferenceSystemId>
                                 <UserUid>1152921504607011056</UserUid>
                              </LastUpdatedByUserIdentity>
                              <LastUpdatedTimestamp>2018-01-06T18:12:48.527Z</LastUpdatedTimestamp>
                              <MilestoneDetail>
                                 <ContractLineItemMilestoneId i:nil="true"/>
                                 <ContractLineItemMilestoneUid>1152921504607104692</ContractLineItemMilestoneUid>
                                 <AchievedDate i:nil="true"/>
                                 <ContractLineItemIdentity>
                                    <ContractLineItemCode>P001396-CL1</ContractLineItemCode>
                                    <ContractLineItemId i:nil="true"/>
                                    <ContractLineItemUid>1152921504607083378</ContractLineItemUid>
                                 </ContractLineItemIdentity>
                                 <ContractLineItemMilestoneName>Milestone for period starting 01-Jan-2018</ContractLineItemMilestoneName>
                                 <MilestoneAmount>10000</MilestoneAmount>
                                 <PlannedDate i:nil="true"/>
                                 <Description>Milestone for start of project</Description>
                                 <ForegoneFlag>false</ForegoneFlag>
                                 <ProjectIdentity>
                                    <ProjectCode>P001396-001</ProjectCode>
                                    <ProjectId i:nil="true"/>
                                    <ProjectUid>1152921504607412210</ProjectUid>
                                 </ProjectIdentity>
                                 <ProjectTaskIdentity>
                                    <ExternalSystemIdentifier i:nil="true"/>
                                    <ProjectTaskId i:nil="true"/>
                                    <ProjectTaskUid>1152921504608637343</ProjectTaskUid>
                                 </ProjectTaskIdentity>
                              </MilestoneDetail>
                              <MilestoneStatus>P</MilestoneStatus>
                              <PurchaseOrderNumber>PO-1234</PurchaseOrderNumber>
                           </PwsContractLineItemMilestoneElement>
  • No labels