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 5 Current »

Overview


This structure represents the fields associated with a payment voucher. Payment Vouchers are the vehicle by which Projector reimburses resources or pays vendors. 

Format


PwsPaymentVoucher
  • PwsPaymentVoucher

Elements


Element

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

On Insert: No

On Update: One of PaymentVoucherNumber or PaymentVoucherUid is required


The payment voucher number is a unique identifier for a payment voucher. If not specified, this field will be auto generated.

PVER00722

PaymentVoucherUid

Int64

See PaymentVoucherNumber


The payment voucher Uid is a unique and immutable identifier for a payment voucher

1152921504607609481

ApprovedToPayByUser

PwsUserSummary

No 


The user who set to the payment voucher to approved to pay


ApprovedToPayTimestamp

DateTime

No 


The date and time the payment voucher was set to approved to pay

2018-03-20T15:20:51.503Z

CashAdvanceAmount

Double

No 


The cash advance amount on the payment voucher

0

PaidByUser

PwsUserSummary

No 


The user who set to the payment voucher to paid


PaidTimestamp

DateTime

No 


The date and time the payment voucher was set to paid

2018-03-20T15:20:55.103Z

PayeeVendor

PwsVendorSummary

No 


The payee vendor on the payment voucher


PaymentWorkflowStatus

String

No 

false

The payment voucher's payment workflow status:

'N' for Not Approved to Pay

'F' for Approved to Pay

'T' for Transmitted

'P' for Paid

'C' for Payment Received

P

ReceivedByUser

PwsUserSummary

No


The user who set to the payment voucher to received


ReceivedTimestamp

DateTime

No 


The date and time the payment voucher was set to received


TransmittedByUser

PwsUserSummary

No 


The user who set to the payment voucher to transmitted


TransmittedTimestamp

DateTime

No 

false

The date and time the payment voucher was set to transmitted

2018-03-20T15:20:55.103Z

CanMarkReceivedFlag

Boolean

No 


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

true

ApPaymentInformation

String

No


Information associated with the accounts payable payment information

Pay to Jack

ApVoucherNumber

String

No


The accounts payable voucher number

P123

DisbursedAmount

Double

On Insert: Yes

On Update: No  


The total disbursed amount

5

DisbursedCurrency

PwsCurrencyRef

On Insert: Yes

On Update: No  


The disbursed currency. This is the currency associated with the resource's location at the time the cost card was created.


DisbursingCostCenterIdentity

PwsCostCenterRef

On Insert: Yes

On Update: No  


The disbursing cost center identity


ReconciliationCompleteFlag

Boolean

No

false

If set to 'true', reconciliation is complete for this payment voucher

false

ExpenseDocuments

PwsPaymentVoucherExpenseDocument [???]

On Insert: Yes

On Update: No 


The expense document(s) associated with the payment voucher


Usage Example(s)


Example 01 
               <a:PwsPaymentVoucher>
                  <PaymentVoucherId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                  <PaymentVoucherNumber xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">PVER00722</PaymentVoucherNumber>
                  <PaymentVoucherUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607609481</PaymentVoucherUid>
                  <a:ApprovedToPayByUser xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:UserDisplayName>Beth Brown</b:UserDisplayName>
                     <b:UserId i:nil="true"/>
                     <b:UserReferenceSystemId>Partner - 01</b:UserReferenceSystemId>
                     <b:UserUid>1152921504607011056</b:UserUid>
                     <b:EmailAddress>beth@projectorpsa.com</b:EmailAddress>
                     <b:FirstName>Beth</b:FirstName>
                     <b:LastName>Brown</b:LastName>
                     <b:MiddleName i:nil="true"/>
                  </a:ApprovedToPayByUser>
                  <a:ApprovedToPayTimestamp>2018-03-20T15:20:51.503Z</a:ApprovedToPayTimestamp>
                  <a:CashAdvanceAmount>0</a:CashAdvanceAmount>
                  <a:PaidByUser xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:UserDisplayName>Beth Brown</b:UserDisplayName>
                     <b:UserId i:nil="true"/>
                     <b:UserReferenceSystemId>Partner - 01</b:UserReferenceSystemId>
                     <b:UserUid>1152921504607011056</b:UserUid>
                     <b:EmailAddress>beth@projectorpsa.com</b:EmailAddress>
                     <b:FirstName>Beth</b:FirstName>
                     <b:LastName>Brown</b:LastName>
                     <b:MiddleName i:nil="true"/>
                  </a:PaidByUser>
                  <a:PaidTimestamp>2018-03-20T15:20:55.103Z</a:PaidTimestamp>
                  <a:PayeeVendor xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:VendorId i:nil="true"/>
                     <b:VendorName>Jack Spratt</b:VendorName>
                     <b:VendorUid>1152921504607055599</b:VendorUid>
                     <b:VendorNumber>Jack Spratt</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>P</a:PaymentWorkflowStatus>
                  <a:ReceivedByUser i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
                  <a:ReceivedTimestamp i:nil="true"/>
                  <a:TransmittedByUser xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:UserDisplayName>Beth Brown</b:UserDisplayName>
                     <b:UserId i:nil="true"/>
                     <b:UserReferenceSystemId>Partner - 01</b:UserReferenceSystemId>
                     <b:UserUid>1152921504607011056</b:UserUid>
                     <b:EmailAddress>beth@projectorpsa.com</b:EmailAddress>
                     <b:FirstName>Beth</b:FirstName>
                     <b:LastName>Brown</b:LastName>
                     <b:MiddleName i:nil="true"/>
                  </a:TransmittedByUser>
                  <a:TransmittedTimestamp>2018-03-20T15:20:55.103Z</a:TransmittedTimestamp>
                  <a:CanMarkReceivedFlag>true</a:CanMarkReceivedFlag>
                  <a:ApPaymentInformation>Pay to Jack</a:ApPaymentInformation>
                  <a:ApVoucherNumber>P123</a:ApVoucherNumber>
                  <a:DisbursedAmount>5</a:DisbursedAmount>
                  <a:DisbursedCurrency xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:CurrencyCode>USD</b:CurrencyCode>
                     <b:CurrencyId i:nil="true"/>
                     <b:CurrencyUid>1152921504606851838</b:CurrencyUid>
                  </a:DisbursedCurrency>
                  <a:DisbursingCostCenterIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                     <b:CostCenterId i:nil="true"/>
                     <b:CostCenterName>Executive Team (USA)</b:CostCenterName>
                     <b:CostCenterNumber>Executive Team (USA)</b:CostCenterNumber>
                     <b:CostCenterUid>1152921504606867363</b:CostCenterUid>
                  </a:DisbursingCostCenterIdentity>
                  <a:ReconciliationCompleteFlag>false</a:ReconciliationCompleteFlag>
                  <a:ExpenseDocuments>
                     <a:PwsPaymentVoucherExpenseDocument>
                        <a:DocumentType>E</a:DocumentType>
                        <a:ExpenseDocumentIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
                           <b:DocumentNumber>ER00722</b:DocumentNumber>
                           <b:ExpenseDocumentId i:nil="true"/>
                           <b:ExpenseDocumentUid>1152921504607683576</b:ExpenseDocumentUid>
                        </a:ExpenseDocumentIdentity>
                        <a:ExpenseDocumentName>Expense report created 27 Feb 2018 - B</a:ExpenseDocumentName>
                     </a:PwsPaymentVoucherExpenseDocument>
                  </a:ExpenseDocuments>
               </a:PwsPaymentVoucher>
  • No labels