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 Version History

« Previous Version 4 Next »

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
    • NotesClearFlag: Boolean
    • ReceiptCostCards: PwsReceiptCostCard[]
    • NumberPages: Byte
    • DocumentName: String
    • NumberPagesShort: Int16

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

On Insert: No

On Update: 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 PwsSaveReceipt 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

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: Yes (if the receipt is attached to a cost card)

On Update: No


The cost card the receipt is attached to


NumberPages

Byte

On Insert: No

On Update: No


The number of pages in 8-bit type format


DocumentName

String

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 in 16-bit type format


Usage Example(s)


Example 01 
                   <a:PwsReceiptDetail>
                     <ReceiptId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                     <ReceiptUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607351892</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>1152921504607571578</b:DocumentRefUid>
                     </a:DocumentIdentity>
                     <a:EntireExpenseReportFlag>false</a:EntireExpenseReportFlag>
                     <a:ExpenseDocumentIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                        <b:DocumentNumber>ER00706</b:DocumentNumber>
                        <b:ExpenseDocumentId i:nil="true"/>
                        <b:ExpenseDocumentUid>1152921504607683553</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>1152921504614515251</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>01_Scan_2.jpeg</a:DocumentName>
                     <a:NumberPagesShort i:nil="true"/>
                  </a:PwsReceiptDetail>
  • No labels