Overview
Request Format
Panel | ||
---|---|---|
| ||
|
Request Elements
...
Element
...
Data Type
...
Required?
...
Default
...
Description
...
Sample Data
...
RequestId
...
Int32
...
Click here for more information.
...
SessionTicket
...
String
...
Click here for more information.
...
ExpenseDocumentIdentity
...
...
PaymentVoucherIdentity
...
...
ReceivedFlag
...
Boolean
...
ResourceIdentity
...
Request Usage Example(s)
...
language | xml |
---|---|
title | Example 01 |
collapse | true |
...
Overview
This web service sets the Received status on a payment voucher. It only applies to payment vouchers with statuses "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. | AZiT3IQ6HBrx52tFGD+G1A== | |
ExpenseDocumentIdentity | Either ExpenseDocumentIdentity or PaymentVoucherIdentity is required. Both may not be specified. | If specified, all vouchers associated with the specified expense document are affected. Click here for more information. | |||
PaymentVoucherIdentity | See above | The identity of a single payment voucher whose status is to be updated. Click here for more information. | |||
ReceivedFlag | Boolean | No | false | If true, then payment status is set to "Received". Otherwise, payment status is set to "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> <com:PaymentVoucherNumber>PVER00161</com:PaymentVoucherNumber><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> |
Code Block |
---|
...
|
...
ServerTimestampUtc
...
DateTime
...
Click here for more information.
...
Vouchers
...
Response Usage Example(s)
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
| ||||||
|
Response Elements
...
Element
...
Data Type
...
Description
...
Sample Data
...
Messages
...
...
ResponseId
...
Int32
...
Click here for more information.
...
| |||
<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:ExpenseDocumentIdentity>
<com:DocumentNumber>ER00164</com:DocumentNumber>
</tim:ExpenseDocumentIdentity>
<tim:ReceivedFlag>false</tim:ReceivedFlag>
<tim:ResourceIdentity>
<com:ResourceDisplayName>Min Zeng</com:ResourceDisplayName>
</tim:ResourceIdentity>
</pws:serviceRequest>
</pws:PwsMarkPaymentVouchersReceived>
</soapenv:Body>
</soapenv:Envelope>
|
Response Format
Panel | ||
---|---|---|
| ||
|
Response Elements
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 identities of the payment voucher/expense document combinations whose payment status has been updated. For example, if a payment voucher has two cost cards and they 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. |
Response Usage Example(s)
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<PwsMarkPaymentVouchersReceivedResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
<PwsMarkPaymentVouchersReceivedResult xmlns:a="http://projectorpsa.com/DataContracts/Shared/TimeAndCost/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Messages xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
<ResponseId xmlns="http://projectorpsa.com/CommonServices/">0</ResponseId>
<Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
<ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-03-26T17:56:47.0673082Z</ServerTimestampUtc>
<a:Vouchers>
<a:PwsReceivedPaymentVoucher>
<a:Amount>13</a:Amount>
<a:EffectiveStatus>C</a:EffectiveStatus>
<a:ItemCount>1</a:ItemCount>
<a:PaymentVoucher>
<PaymentVoucherId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/>
<PaymentVoucherNumber xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">PVER00161</PaymentVoucherNumber>
<PaymentVoucherUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607398897</PaymentVoucherUid>
<a:ApprovedToPayByUser xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:UserDisplayName>PPSA Support User</b:UserDisplayName>
<b:UserId i:nil="true"/>
<b:UserReferenceSystemId>000</b:UserReferenceSystemId>
<b:UserUid>1152921504606944261</b:UserUid>
<b:EmailAddress>support@projectorpsa.com</b:EmailAddress>
<b:FirstName>PPSA Support User</b:FirstName>
<b:LastName>PPSA Support User</b:LastName>
<b:MiddleName>PPSA Support User</b:MiddleName>
</a:ApprovedToPayByUser>
<a:ApprovedToPayTimestamp>2014-12-23T18:08:09.36Z</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>Min Zeng</b:VendorName>
<b:VendorUid>1152921504606886624</b:VendorUid>
<b:VendorNumber>Min Zeng</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>C</a:PaymentWorkflowStatus>
<a:ReceivedByUser xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:UserDisplayName>Bruce Wayne</b:UserDisplayName>
<b:UserId i:nil="true"/>
<b:UserReferenceSystemId>BW-01</b:UserReferenceSystemId>
<b:UserUid>1152921504606950320</b:UserUid>
<b:EmailAddress>bruce@revcorp.doc</b:EmailAddress>
<b:FirstName>Bruce</b:FirstName>
<b:LastName>Wayne</b:LastName>
<b:MiddleName i:nil="true"/>
</a:ReceivedByUser>
<a:ReceivedTimestamp>2018-03-26T17:56:47.13Z</a:ReceivedTimestamp>
<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>
<a:ProjectSummary i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
<a:ExpenseDocumentIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:DocumentNumber>ER00161</b:DocumentNumber>
<b:ExpenseDocumentId i:nil="true"/>
<b:ExpenseDocumentUid>1152921504607449694</b:ExpenseDocumentUid>
</a:ExpenseDocumentIdentity>
</a:PwsReceivedPaymentVoucher>
</a:Vouchers>
</PwsMarkPaymentVouchersReceivedResult>
</PwsMarkPaymentVouchersReceivedResponse>
</s:Body>
</s:Envelope> |
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <PwsMarkPaymentVouchersReceivedResponse xmlns="http://projectorpsa.com/PwsProjectorServices/"> <PwsMarkPaymentVouchersReceivedResult xmlns:a="http://projectorpsa.com/DataContracts/Shared/TimeAndCost/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Messages xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/> <ResponseId xmlns="http://projectorpsa.com/CommonServices/">0</ResponseId> <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status> <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-03-26T17:59:54.6335978Z</ServerTimestampUtc> <a:Vouchers> <a:PwsReceivedPaymentVoucher> <a:Amount>132</a:Amount> <a:EffectiveStatus>F</a:EffectiveStatus> <a:ItemCount>2</a:ItemCount> <a:PaymentVoucher> <PaymentVoucherId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/> <PaymentVoucherNumber xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">PVER00164.1</PaymentVoucherNumber> <PaymentVoucherUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607567675</PaymentVoucherUid> <a:ApprovedToPayByUser xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:UserDisplayName>PPSA Support User</b:UserDisplayName> <b:UserId i:nil="true"/> <b:UserReferenceSystemId>000</b:UserReferenceSystemId> <b:UserUid>1152921504606944261</b:UserUid> <b:EmailAddress>support@projectorpsa.com</b:EmailAddress> <b:FirstName>PPSA Support User</b:FirstName> <b:LastName>PPSA Support User</b:LastName> <b:MiddleName>PPSA Support User</b:MiddleName> </a:ApprovedToPayByUser> <a:ApprovedToPayTimestamp>2018-03-26T17:59:06.94Z</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>Bruce Wayne</b:VendorName> <b:VendorUid>1152921504606888248</b:VendorUid> <b:VendorNumber>Bruce Wayne</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> <PwsMarkPaymentVouchersReceivedResult xmlns<a:PaymentWorkflowStatus>F</a="http://projectorpsa.com/DataContracts/Shared/TimeAndCost/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">:PaymentWorkflowStatus> <Messages xmlns="http://projectorpsa.com/CommonServices/<a:ReceivedByUser i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/> <ResponseId xmlns="http://projectorpsa.com/CommonServices/">0</ResponseId> <a:ReceivedTimestamp i:nil="true"/> <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status> <ServerTimestampUtc<a:TransmittedByUser i:nil="true" xmlns:b="http://projectorpsa.com/CommonServicesDataContracts/Shared/Common/">2018-03-26T17:56:47.0673082Z</ServerTimestampUtc>/> <a:Vouchers>TransmittedTimestamp i:nil="true"/> <a:CanMarkReceivedFlag>true</a:PwsReceivedPaymentVoucher>CanMarkReceivedFlag> <a:Amount>13<</a:Amount>PaymentVoucher> <a:EffectiveStatus>C</a:EffectiveStatus>:ProjectSummary i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/> <a:ExpenseDocumentIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <a:ItemCount>1</a:ItemCount> <a:PaymentVoucher><b:DocumentNumber>ER00164</b:DocumentNumber> <PaymentVoucherId<b:ExpenseDocumentId i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/> <PaymentVoucherNumber xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">PVER00161</PaymentVoucherNumber><b:ExpenseDocumentUid>1152921504607636703</b:ExpenseDocumentUid> </a:ExpenseDocumentIdentity> <PaymentVoucherUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607398897</PaymentVoucherUid> </a:PwsReceivedPaymentVoucher> <a:ApprovedToPayByUser xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">PwsReceivedPaymentVoucher> <a:Amount>2</a:Amount> <b:UserDisplayName>PPSA Support User</b:UserDisplayName> <a:EffectiveStatus>F</a:EffectiveStatus> <b:UserId i:nil="true"/><a:ItemCount>1</a:ItemCount> <b:UserReferenceSystemId>000</b:UserReferenceSystemId><a:PaymentVoucher> <PaymentVoucherId <b:UserUid>1152921504606944261</b:UserUid>i:nil="true" xmlns="http://projectorpsa.com/DataContracts/Shared/Common/"/> <b:EmailAddress>support@projectorpsa.com</b:EmailAddress><PaymentVoucherNumber xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">PVER00164.2</PaymentVoucherNumber> <b:FirstName>PPSA Support User</b:FirstName> <PaymentVoucherUid xmlns="http://projectorpsa.com/DataContracts/Shared/Common/">1152921504607567677</PaymentVoucherUid> <a:ApprovedToPayByUser <b:LastName>PPSA Support User</b:LastName>xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:MiddleName>PPSAUserDisplayName>PPSA Support User</b:MiddleName>UserDisplayName> </a:ApprovedToPayByUser> <a:ApprovedToPayTimestamp>2014-12-23T18:08:09.36Z</a:ApprovedToPayTimestamp><b:UserId i:nil="true"/> <a<b:CashAdvanceAmount>0<UserReferenceSystemId>000</ab:CashAdvanceAmount>UserReferenceSystemId> <a:PaidByUser i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/> <b:UserUid>1152921504606944261</b:UserUid> <a:PaidTimestamp i:nil="true"/><b:EmailAddress>support@projectorpsa.com</b:EmailAddress> <a<b:PayeeVendor xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">FirstName>PPSA Support User</b:FirstName> <b:VendorId i:nil="true"/>LastName>PPSA Support User</b:LastName> <b:VendorName>MinMiddleName>PPSA Support Zeng<User</b:VendorName>MiddleName> <b:VendorUid>1152921504606886624</b:VendorUid> </a:ApprovedToPayByUser> <b:VendorNumber>Min Zeng</b:VendorNumber><a:ApprovedToPayTimestamp>2018-03-26T17:59:41.583Z</a:ApprovedToPayTimestamp> <b:ExpenseReportPayeeFlag>true</b:ExpenseReportPayeeFlag><a:CashAdvanceAmount>0</a:CashAdvanceAmount> <a:PaidByUser <b:InactiveFlag>false</b:InactiveFlag> i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/> <a:PaidTimestamp <b:ResourceVendorFlag>true</b:ResourceVendorFlag>i:nil="true"/> <b:VendorInvoicePayeeFlag>false</b:VendorInvoicePayeeFlag><a:PayeeVendor xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:SubcontractorInvoicePayeeFlag>true</b:SubcontractorInvoicePayeeFlag> VendorId i:nil="true"/> </a:PayeeVendor> <a:PaymentWorkflowStatus>C</a:PaymentWorkflowStatus><b:VendorName>Bruce Wayne</b:VendorName> <a:ReceivedByUser xmlns<b:VendorUid>1152921504606888248</b="http://projectorpsa.com/DataContracts/Shared/Common/">:VendorUid> <b:UserDisplayName>BruceVendorNumber>Bruce Wayne</b:UserDisplayName>VendorNumber> <b:UserId i:nil="true"/>ExpenseReportPayeeFlag>true</b:ExpenseReportPayeeFlag> <b:UserReferenceSystemId>BW-01<InactiveFlag>false</b:UserReferenceSystemId>InactiveFlag> <b:UserUid>1152921504606950320<ResourceVendorFlag>true</b:UserUid>ResourceVendorFlag> <b:EmailAddress>bruce@revcorp.doc<VendorInvoicePayeeFlag>false</b:EmailAddress>VendorInvoicePayeeFlag> <b:FirstName>Bruce<SubcontractorInvoicePayeeFlag>true</b:FirstName>SubcontractorInvoicePayeeFlag> <b:LastName>Wayne</b:LastName></a:PayeeVendor> <a:PaymentWorkflowStatus>F</a:PaymentWorkflowStatus> <b:MiddleName i:nil="true"/> <a:ReceivedByUser </a:ReceivedByUser>i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/> <a:ReceivedTimestamp>2018-03-26T17:56:47.13Z</a:ReceivedTimestamp>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> <a:ProjectSummary i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/> <a:ExpenseDocumentIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:DocumentNumber>ER00161<DocumentNumber>ER00164</b:DocumentNumber> <b:ExpenseDocumentId i:nil="true"/> <b:ExpenseDocumentUid>1152921504607449694<ExpenseDocumentUid>1152921504607636703</b:ExpenseDocumentUid> </a:ExpenseDocumentIdentity> </a:PwsReceivedPaymentVoucher> </a:Vouchers> </PwsMarkPaymentVouchersReceivedResult> </PwsMarkPaymentVouchersReceivedResponse> </s:Body> </s:Envelope> |
PwsMarkPaymentVoucherReceived - Common Errors and Warnings
- For all errors and warnings please refer to the Complete List of Errors and Warnings
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. |
65759 | OneOrMoreVouchersCannotBeMarkedReceived | One or more payment vouchers cannot be marked received or unreceived. |