PwsDocumentData

Overview

This data structure captures the information associated with a document.  The associated item identity depends on the type of document.  For example, when the document is a receipt and attached to the whole expense document, the associated item is an expense document (ED). If the receipt is attached to a cost card, the associated item is the cost card's expense report and cost card identity is included in the item's associations. 

Format

PwsDocumentData

Elements

Element

Data Type

Description

Sample Data

AssociatedItemIdentity

PwsFlexItemRef

The entity associated with a document. For example, in the case of receipt on an expense report, this item is an expense report. Click here for more information.


Associations

PwsDocumentAssociation

The association between a document and an entity if applicable. For example, if the document is a receipt on a cost card, the associated item is the expense report and the associations are the cost cards on the expense report that the receipt is associated with. If the document is a receipt associated with the entire expense report, then the expense report itself is the item and no additional associations exist. Click here for more information.


Notes

String

Applies only to the receipt document type. This is the note on a receipt.


AssociatedItemDescriptionString

If document is of type

  • Expense Report: document number
  • Payment Voucher: payment voucher number
  • Project Workspace Document: project code
  • Resource Resume: display name
  • Invoice: invoice number/draft invoice number
  • Project Issue Document: issue number)
  • User Receipt Pool Document: display name
  • User Issue Attachment Pool Document: display name

Usage Example(s)


Example 01 - Receipt on a cost card
                   <a:DocumentDataDetail>
                     <a:AssociatedItemIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:ItemId i:nil="true"/>
                        <b:ItemType>ED</b:ItemType>
                        <b:ItemUid>1152921504607636703</b:ItemUid>
                        <b:ReferenceType i:nil="true"/>
                     </a:AssociatedItemIdentity>
                     <a:Associations>
                        <a:PwsDocumentAssociation>
                           <a:AssociatedItemIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                              <b:ItemId i:nil="true"/>
                              <b:ItemType>CCD</b:ItemType>
                              <b:ItemUid>1152921504614018558</b:ItemUid>
                              <b:ReferenceType i:nil="true"/>
                           </a:AssociatedItemIdentity>
                           <a:ReferenceNumber i:nil="true"/>
                           <a:ReferenceNumberClearFlag>false</a:ReferenceNumberClearFlag>
                        </a:PwsDocumentAssociation>
                     </a:Associations>
                     <a:Notes>Use the receipt on the left.</a:Notes>
                  </a:DocumentDataDetail>
               </a:DocumentData>
Example 02 - Receipt on an expense report
                  <a:DocumentDataDetail>
                     <a:AssociatedItemIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:ItemId i:nil="true"/>
                        <b:ItemType>ED</b:ItemType>
                        <b:ItemUid>1152921504607636703</b:ItemUid>
                        <b:ReferenceType i:nil="true"/>
                     </a:AssociatedItemIdentity>
                     <a:Associations/>
                     <a:Notes i:nil="true"/>
                  </a:DocumentDataDetail>
Example 03 - Resume
                  <a:DocumentDataDetail>
                     <a:AssociatedItemIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:ItemId i:nil="true"/>
                        <b:ItemType>R</b:ItemType>
                        <b:ItemUid>1152921504606962993</b:ItemUid>
                        <b:ReferenceType i:nil="true"/>
                     </a:AssociatedItemIdentity>
                     <a:Associations/>
                     <a:Notes i:nil="true"/>
                     <a:AssociatedItemDescription>Barry Franklin</a:AssociatedItemDescription>
                  </a:DocumentDataDetail>