PwsReceiptDetail

Overview


This structure contains the complete set of information about a receipt/note. The structure is used both to retrieve detailed receipt information and to pass information about a receipt back to the server to get updated.

Format


PwsReceiptDetail
  • PwsReceiptDetail
    • ReceiptId: Int32
    • ReceiptUid: Int64
    • ReferenceId: String
    • DocumentIdentity: PwsDocumentRef
    • EntireExpenseReportFlag: Boolean
    • ExpenseDocumentIdentity: PwsExpenseDocumentRef
    • Notes: String (4000)
    • NotesClearFlag: Boolean
    • ReceiptCostCards: PwsReceiptCostCard []
    • NumberPages: Byte
    • DocumentName: String (260)
    • NumberPagesShort: Int16
    • DocumentArchivedFlag: Boolean
    • MimeType: String

Elements


Element

Data Type

Required?

Default

Description

Sample Data

ReceiptId

Int32

On Insert: No

On Update: No


The receipt Id is a unique identifier for a receipt. For internal use only.


ReceiptUid

Int64

Yes


The receipt Uid is a unique and immutable identifier for a receipt.

1152921504607571578

ReferenceId

String

On Insert: No

On Update: No


Reference id (used to affiliate PwsSaveReceiptResult records with associated PwsReceiptDetail records).


DocumentIdentity

PwsDocumentRef

On Insert: Yes

On Update: Yes


This is the identity of the receipt document.


EntireExpenseReportFlag

Boolean

On Insert: No

On Update: No

true

If set to 'true', the receipt is attached to the entire expense report.

false

ExpenseDocumentIdentity

PwsExpenseDocumentRef

On Insert: Yes

On Update: No


The expense document the receipt is attached to.


Notes

String (4000)

On Insert: No

On Update: No


The receipt note is a free text field to be associated with the receipt.


NotesClearFlag

Boolean

On Insert: No

On Update: No

false

If set to 'true', notes will be set to null.

false

ReceiptCostCards

PwsReceiptCostCard []

On Insert: No

On Update: No


The cost cards the receipt is attached to.


NumberPages

Byte

On Insert: No

On Update: No


The number of pages.


DocumentName

String (260)

On Insert: Yes

On Update: No


The receipt document name.

01_Scan_2.jpeg

NumberPagesShort

Int16

On Insert: No

On Update: No


The number of pages as a 16-bit integer.


DocumentArchivedFlagBoolean

On Insert: No

On Update: No


If set to 'true', receipt document has been archived.false
MimeTypeString

On Insert: No

On Update: No


A Multipurpose Internet Mail Extensions (MIME) type is a standard that indicates the nature and format of a document, file, or assortment of bytes.image/jpeg

Usage Example(s)


Example 01
               <a:Receipts>
                  <a:PwsReceiptDetail>
                     <ReceiptId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                     <ReceiptUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607533870</ReceiptUid>
                     <ReferenceId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                     <a:DocumentIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:DocumentRefId i:nil="true"/>
                        <b:DocumentRefUid>1152921504607773678</b:DocumentRefUid>
                     </a:DocumentIdentity>
                     <a:EntireExpenseReportFlag>false</a:EntireExpenseReportFlag>
                     <a:ExpenseDocumentIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:DocumentNumber>ER00217</b:DocumentNumber>
                        <b:ExpenseDocumentId i:nil="true"/>
                        <b:ExpenseDocumentUid>1152921504607667441</b:ExpenseDocumentUid>
                     </a:ExpenseDocumentIdentity>
                     <a:Notes i:nil="true"/>
                     <a:NotesClearFlag>false</a:NotesClearFlag>
                     <a:ReceiptCostCards>
                        <a:PwsReceiptCostCard>
                           <a:CostCardIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                              <b:CostCardId i:nil="true"/>
                              <b:CostCardUid>1152921504614211172</b:CostCardUid>
                              <b:ReferenceId i:nil="true"/>
                           </a:CostCardIdentity>
                           <a:ReferenceNumber i:nil="true"/>
                           <a:ReferenceNumberClearFlag>false</a:ReferenceNumberClearFlag>
                        </a:PwsReceiptCostCard>
                     </a:ReceiptCostCards>
                     <a:NumberPages i:nil="true"/>
                     <a:DocumentName>receipt.jpg</a:DocumentName>
                     <a:NumberPagesShort i:nil="true"/>
                     <a:DocumentArchivedFlag>false</a:DocumentArchivedFlag>
                     <a:MimeType>image/jpeg</a:MimeType>
                  </a:PwsReceiptDetail>
               </a:Receipts>