Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview


This structure includes basic information about a payment voucher. The information represented in this structure is not comprehensive and only includes certain key attributes of a payment voucher deemed to be useful in a listing of payment vouchers.

Format


Panel
titlePwsPaymentVoucherSummary
  • PwsPaymentVoucherSummary
    • PaymentVoucherId: Int32
    • PaymentVoucherNumber: String (40)
    • PaymentVoucherUid: Int64
    • ApprovedToPayByUser: PwsUserSummary
    • ApprovedToPayTimestamp: DateTime
    • CashAdvanceAmount: Double
    • PaidByUser: PwsUserSummary
    • PaidTimestamp: DateTime
    • PayeeVendor: PwsVendorSummary
    • PaymentWorkflowStatus: String
    • ReceivedByUser: PwsUserSummary
    • ReceivedTimestamp: DateTime
    • TransmittedByUser: PwsUserSummary
    • TransmittedTimestamp: DateTime
    • CanMarkReceivedFlag: Boolean

Elements


Element

mnsElement

Data Type

Required?

Default

Description

Sample Data

PaymentVoucherId

Int32

 No

 

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

 


PaymentVoucherNumber

String (40)

One of PaymentVoucherNumber or PaymentVoucherUid is required

 

The payment voucher number is a unique identifier for a payment voucher.

PVER00706 

PaymentVoucherUid

Int64

See PaymentVoucherNumber 

 

A unique and immutable identifier for a payment voucher.

1152921504607609478 

ApprovedToPayByUser

PwsUserSummary

On Insert: No

On Update No 

 

The identity of the user who updated the payment voucher status to approved to pay

 

.


ApprovedToPayTimestamp

DateTime

On Insert: No

On Update No 

 

The date and time the payment voucher was

approved 

approved.

2018-02-07T19:32:26.15Z

CashAdvanceAmount

Double

On Insert: No

On Update No 

0

The cash advance amount associated with the payment

voucher 

voucher.

0

PaidByUser

PwsUserSummary

On Insert: No

On Update No 

 

The identity of the user who updated the payment voucher status to paid

 

.


PaidTimestamp

DateTime

On Insert: No

On Update No 

 

The date and time the payment voucher was paid.

 


PayeeVendor

PwsVendorSummary

On Insert: No

On Update No 

 

The user identity of the payee associated with the payment voucher.

 


PaymentWorkflowStatus

String

On Insert: Yes

On Update No 

 

The payment workflow status:

A

N - for Not Approved

F - for Approved

T - for Transmitted

P - for Paid

C - for Payment Received

F

ReceivedByUser

PwsUserSummary

On Insert: No

On Update No 

 

The identity of the user who updated the payment voucher status to received

 

.


ReceivedTimestamp

DateTime

On Insert: No

On Update No 

 

The date and time the payment voucher was received

 

.

 


TransmittedByUser

PwsUserSummary

On Insert: No

On Update No 

 

The identity of the user who updated the payment voucher status to transmitted

 

.


TransmittedTimestamp

DateTime

On Insert: No

On Update No 

 

The date and time the payment voucher was transmitted

 

.


CanMarkReceivedFlag

Boolean

On Insert: No

On Update No 

 true

If set to 'true', the payment voucher can be marked as received.

true

Usage Example(s)


Code Block
languagexml
titleExample 01
collapsetrue
                     <a:PaymentVoucher>
                        <PaymentVoucherId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                        <PaymentVoucherNumber xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">PVER00706</PaymentVoucherNumber>
                        <PaymentVoucherUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607609478</PaymentVoucherUid>
                        <a:ApprovedToPayByUser xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                           <b:UserDisplayName>Bob Smith</b:UserDisplayName>
                           <b:UserId i:nil="true"/>
                           <b:UserReferenceSystemId>Partner - 01</b:UserReferenceSystemId>
                           <b:UserUid>1152921504607011056</b:UserUid>
                           <b:EmailAddress>bob@revcorp.bb</b:EmailAddress>
                           <b:FirstName>Bob</b:FirstName>
                           <b:LastName>Smith</b:LastName>
                           <b:MiddleName i:nil="true"/>
                        </a:ApprovedToPayByUser>
                        <a:ApprovedToPayTimestamp>2018-02-07T19:32:26.15Z</a:ApprovedToPayTimestamp>
                        <a:CashAdvanceAmount>0</a:CashAdvanceAmount>
                        <a:PaidByUser i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                        <a:PaidTimestamp i:nil="true"/>
                        <a:PayeeVendor xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                           <b:VendorId i:nil="true"/>
                           <b:VendorName>Beth Brown</b:VendorName>
                           <b:VendorUid>1152921504607055834</b:VendorUid>
                           <b:VendorNumber>Beth Brown</b:VendorNumber>
                           <b:ExpenseReportPayeeFlag>true</b:ExpenseReportPayeeFlag>
                           <b:InactiveFlag>false</b:InactiveFlag>
                           <b:ResourceVendorFlag>true</b:ResourceVendorFlag>
                           <b:VendorInvoicePayeeFlag>false</b:VendorInvoicePayeeFlag>
                           <b:SubcontractorInvoicePayeeFlag>true</b:SubcontractorInvoicePayeeFlag>
                        </a:PayeeVendor>
                        <a:PaymentWorkflowStatus>F</a:PaymentWorkflowStatus>
                        <a:ReceivedByUser i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                        <a:ReceivedTimestamp i:nil="true"/>
                        <a:TransmittedByUser i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                        <a:TransmittedTimestamp i:nil="true"/>
                        <a:CanMarkReceivedFlag>true</a:CanMarkReceivedFlag>
                     </a:PaymentVoucher>