Versions Compared

Key

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

Overview


This web service set sets the Received status on a payment voucher.  It only applies to payment vouchers with statuses "Approved to pay", "Transmitted", "Paid" and "Received". 

Request Format

...

Panel
titlePwsMarkPaymentVouchersReceivedRq

Request Elements


Element

Data Type

Required?

Default

Description

Sample Data

RequestId

Int32

No


Click here for more information.


SessionTicket

String

Yes


Click here for more information.

AZiT3IQ6HBrx52tFGD+G1A==

ExpenseDocumentIdentity

PwsExpenseDocumentRef

Either ExpenseDocumentIdentity or PaymentVoucherIdentity is requiredThe identity of the expense document that associated with payment vouchers. Both may not be specified.


If specified, all vouchers associated with the specified expense document are affected. Click here for more information.


PaymentVoucherIdentity

PwsPaymentVoucherRef

See above


The identity of the a single payment voucher whose status is being to be updated. Click here for more information.


ReceivedFlag

Boolean

No

false

Applies to payment voucher with statuses "Approved to pay", "Transmitted", "Paid" and "Received". If set to " true", then payment voucher status will be is set to "Received". If set to "false" and status is "Received", the status is set to "Approved to pay"; otherwise, the status is left unchanged at "Approved to pay", "Transmitted" or "Otherwise, payment status is set to "Paid".

false

ResourceIdentity

PwsResourceRef

**deprecated**




Request Usage Example(s)


Code Block
languagexml
titleExample 01 - payment voucher specified
collapsetrue
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:tim="http://projectorpsa.com/DataContracts/Shared/TimeAndCost/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsMarkPaymentVouchersReceived>
         <pws:serviceRequest>
            <req:SessionTicket>AZiT3IQ6HBrx52tFGD+G1A==</req:SessionTicket>
            <tim:PaymentVoucherIdentity>
               <com:PaymentVoucherNumber>PVER00161</com:PaymentVoucherNumber>
            </tim:PaymentVoucherIdentity>
            <tim:ReceivedFlag>true</tim:ReceivedFlag>
            <tim:ResourceIdentity>
               <com:ResourceDisplayName>Min Zeng</com:ResourceDisplayName>
            </tim:ResourceIdentity>
         </pws:serviceRequest>
      </pws:PwsMarkPaymentVouchersReceived>
   </soapenv:Body>
</soapenv:Envelope>

...

Element

Data Type

Description

Sample Data

Messages

PwsMessage[]

The web service response status and message. Click here for more information.


ResponseId

Int32

Click here for more information.

0

StatusRequestStatusClick here for more information

Ok

ServerTimestampUtc

DateTime

Click here for more information.

2018-03-26T17:56:47.0673082Z

Vouchers

PwsReceivedPaymentVoucher[]

The identity identities of the payment voucher/expense document combo combinations whose payment status has been updated. For example, if a payment voucher has two cost cards and they caome came from two expense reports, then there will be two PwsReceivedPaymentVoucher in the response, referring to the same payment voucher, but to each expense document respectively. Click here for more information.


...