Versions Compared

Key

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

Overview


This web service updates the payment workflow status for one or more cost cards.

Request Format

Panel
titlePwsSetCostCardPaymentWorkflowStatus Request
  • PwsSetCostCardPaymentWorkflowStatus
    • serviceRequest: PwsSetCostCardPaymentWorkflowStatusRq


Request Elements

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[]





...

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>

Response Format


Panel
titlePwsSetCostCardPaymentWorkflowStatus Response


Response Elements

Element

Data Type

Required?

Description

Sample Data

RequestId

Int32




SessionTicket

String




PaymentWorkflowStatus

String




SendApprovalEmailFlag

Boolean




SendApprovalToPayEmailFlag

Boolean




SendPaidEmailFlag

Boolean




StatusOrders

PwsCostPwsChangeOrder[]




...

Code Block
languagexml
titleExample 01
collapsetrue
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsSetCostCardPaymentWorkflowStatusResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsSetCostCardPaymentWorkflowStatusResult xmlns:a="http://projectorpsa.com/DataContracts/Shared/TimeAndCost/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <ResponseId xmlns="http://projectorpsa.com/CommonServices/">0</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-09-10T15:57:41.8861299Z</ServerTimestampUtc>
            <a:CostCardIdentities xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:PwsCostCardRef>
                  <b:CostCardId i:nil="true"/>
                  <b:CostCardUid>1152921504613926551</b:CostCardUid>
                  <b:ReferenceId i:nil="true"/>
               </b:PwsCostCardRef>
            </a:CostCardIdentities>
         </PwsSetCostCardPaymentWorkflowStatusResult>
      </PwsSetCostCardPaymentWorkflowStatusResponse>
   </s:Body>
</s:Envelope>

PwsSetCostCardInvoiceWorkflowStatus - Common Errors and Warnings

...