Overview

This web service updates the payment workflow status for one or more cost cards. The cost card could be in Draft, Submitted or Rejected statuses in Approval workflow. In that case, when a cost card is set to a status other than "Not Approved to Pay" in Payment workflow, the Approval workflow status is automatically set to Approved status. If the cost card is on a payment voucher, the status change will confer the same change on all the other cost cards on the same payment voucher. For example, if a payment voucher has two cost cards, one has its payment status set to "Approved to Pay", then other cost card's payment status is automatically set to "Approved to Pay".

Rate Limiting

In order to protect our servers from inadvertent service overuse or intentional attack, and to fairly distribute services to all our customers, we have implemented a rate limiting algorithm. When fully deployed, this new algorithm will cause services to either succeed with new warnings or fail with new errors when services are consumed at too high a rate. Programs that consume Projector services should be enhanced to handle rate limiting errors so that they can continue functioning properly. For more information please visit: Projector Rate Limiting Behavior.

Request Format

PwsSetCostCardPaymentWorkflowStatus Request

PwsSetCostCardPaymentWorkflowStatus
- serviceRequest: PwsSetCostCardPaymentWorkflowStatusRq
  - RequestId: Int32
  - SessionTicket: String
  - PaymentWorkflowStatus: String
  - SendApprovalEmailFlag: Boolean
  - SendApprovalToPayEmailFlag: Boolean
  - SendPaidEmailFlag: Boolean
  - StatusOrders: PwsCostPwsChangeOrder[]

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

Example 01

<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

PwsSetCostCardPaymentWorkflowStatus Response

PwsSetCostCardPaymentWorkflowStatusResponse
- PwsSetCostCardPaymentWorkflowStatusResult: PwsSetCostCardPaymentWorkflowStatusRs
  - Messages: PwsMessage[]
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - CostCardIdentities: PwsCostCardRef[]

Response Elements

Element	Data Type	Description	Sample Data
Messages	PwsMessage[]	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-08-22T17:50:23.1025831Z
CostCardIdentities	PwsCostCardRef[]	The identity of the cost cards that have been updated.

Response Usage Example(s)

Example 01

<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

For all errors and warnings please refer to the Complete List of Errors and Warnings

ErrorNumber	ErrorCode	ErrorText
10111	RequiredFieldMissing	A required field is missing: StatusOrders
19045	CostCardIdentitiesRequired	One or more cost card identities must be specified.
19052	InvalidValueForCostCardPaymentWorkflowStatus	The specified value for cost card payment workflow status is invalid. Valid values are N for Not Approved to Pay, F for Approved to Pay, T for Transmitted, P for Paid and C for Received.
65329	AP voucher number may not be specified	AP voucher number may not be specified when payment workflow status is not Transmitted
65330	AP payment information may not be specified	AP payment information may not be specified when payment workflow status is not Paid
65723	StatusChangeCannotBeCompletedCostCardsChangedOrIneligible	Status change cannot be completed because one or more cards has changed or is ineligible.

Browser not supported