Versions Compared

Key

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

...

Element

Data Type

Required?

Default

Description

Sample Data

RequestId

Int32

No


Click here for more information.

0

SessionTicket

String

Yes


Click here for more information.

AdeUxuUYUffSYpH+zHYKYQ==

PaymentWorkflowStatus

String

Yes


Cost card payment workflow status code:

'N' for Not Approved to Pay

'F' for Approved to Pay

'T' for Transmitted

'P' for Paid

'C' for Received.

F

SendApprovalEmailFlag

Boolean

No

false

If set to "true", an email will be sent informing the payment voucher resource that the cost card has been approved.

true

SendApprovalToPayEmailFlag

Boolean

No

false

If set to "true", an email will be sent informing the payment voucher resource that the cost card has been approved to pay.

true

SendPaidEmailFlag

Boolean

No

false

If set to "true", an email will be sent informing the payment voucher resource that the cost card has been paid

true

StatusOrders

PwsCostPwsChangeOrder[]



This data structure includes the identifies of the cost cards to be updated and additional information accompanying payment status change. For example, AP voucher number when status is set to transmitted.



Request Usage Example(s)


Code Block
languagexml
titleExample 01
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:PwsSetCostCardPaymentWorkflowStatus>
         <!--Optional:-->
         <pws:serviceRequest>
            <req:SessionTicket>AdeUxuUYUffSYpH+zHYKYQ==</req:SessionTicket>
            <!--Optional:-->
            <tim:PaymentWorkflowStatus>F</tim:PaymentWorkflowStatus>
            <!--Optional:-->
            <tim:SendApprovalEmailFlag>false</tim:SendApprovalEmailFlag>
            <!--Optional:-->
            <tim:SendApprovalToPayEmailFlag>false</tim:SendApprovalToPayEmailFlag>
            <!--Optional:-->
            <tim:SendPaidEmailFlag>false</tim:SendPaidEmailFlag>
            <!--Optional:-->
            <tim:StatusOrders>
               <!--Zero or more repetitions:-->
               <tim:PwsCostPwsChangeOrder>
                  <tim:ApproveToPayFlag>true</tim:ApproveToPayFlag>
                  <!--Optional:-->
                  <tim:CostCardIdentities>
                     <!--Zero or more repetitions:-->
                     <tim:PwsVersionedCostCardRef>
                        <com:CostCardUid>1152921504613926551</com:CostCardUid>
                     </tim:PwsVersionedCostCardRef>
                  </tim:CostCardIdentities>
               </tim:PwsCostPwsChangeOrder>
            </tim:StatusOrders>
         </pws:serviceRequest>
      </pws:PwsSetCostCardPaymentWorkflowStatus>
   </soapenv:Body>
</soapenv:Envelope>

...

RequestId

Element

Data Type

Description

Sample Data

Messages

PwsMessage[]

Click here for more information.


ResponseId

Int32

SessionTicket

String

PaymentWorkflowStatus

String

SendApprovalEmailFlag

Boolean

SendApprovalToPayEmailFlag

Boolean

SendPaidEmailFlag

Boolean

StatusOrders

PwsCostPwsChangeOrder[]Click here for more information.

0

Status

RequestStatus

Click here for more information.

Ok

ServerTimestampUtc

DateTime

Click here for more information.

2018-08-22T17:50:23.1025831Z

CostCardIdentities

PwsCostCardRef[]

The identity of the cost cards that have been updated.



Response Usage Example(s)

...