Overview
Request Format
| Panel | ||
|---|---|---|
| ||
|
...
Overview
This web service set 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 | ||
|---|---|---|
| ||
|
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. | ExpenseDocumentIdentity | PaymentVoucherIdentity | ReceivedFlag | Boolean | ResourceIdentity | PwsResourceRefinformation. | AZiT3IQ6HBrx52tFGD+G1A== | |||
ExpenseDocumentIdentity | Either ExpenseDocumentIdentity or PaymentVoucherIdentity is required | The identity of the expense document that associated with payment vouchers. Click here for more information. | |||||||||||
PaymentVoucherIdentity | See above | The identity of the payment voucher whose status is being 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", payment voucher status will be 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 "Paid". | false | ||||||||
ResourceIdentity | **deprecated** |
Request Usage Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<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 | The web service response status and message. Click here for more information. | ||
ResponseId | Int32 | Click here for more information. | 0 |
| Status | RequestStatus | Click here for more information | Ok |
ServerTimestampUtc | DateTime | Click here for more information. | 2018-03-26T17:56:47.0673082Z |
Vouchers | The identity of the payment voucher whose status has been updated. Click here for more information. |
Response Usage Example(s)
...
| ErrorNumber | ErrorCode | ErrorText |
|---|---|---|
| 19010 | PaymentVouchersNotSpecifiedForMarking | No payment vouchers were specified for marking received. |
| 19011 | ExpenseDocumentAndPaymentVoucherMayNotBothBeSpecified | Must specify an expense document or a payment voucher, but not both. |