Overview

This web service updates the disbursed amount on one or more existing cost cards.

Request Format

PwsAdjustCostDisbursedAmount Request

PwsAdjustCostDisbursedAmount
- serviceRequest: PwsAdjustCostDisbursedAmountRq
  - RequestId: Int32
  - SessionTicket: String
  - AdjustmentCodeIdentity: PwsAdjustmentCodeRef
  - CostCardIdentities: PwsVersionedCostCardRef
  - AdjustmentOrders: PwsCostDisbursedAmountAdjustmentOrder
  - Explanation: String (1024)

Request Elements

Element	Data Type	Required?	Description	Sample Data
RequestId	Int32	No	Click here for more information	1
SessionTicket	String	Yes	Click here for more information	AWuKIeUvHQC5lNzuzE3Ugg==
AdjustmentCodeIdentity	PwsAdjustmentCodeRef	No	This structure represents the unique key fields associated with identifying an adjustment code. Adjustment codes are required whenever you make some monetary adjustment to a time or cost card. This is not applicable to this service.
CostCardIdentities	PwsVersionedCostCardRef	Yes	This structure represents the unique key fields associated with identifying a cost card.
AdjustmentOrders	PwsCostDisbursedAmountAdjustmentOrder	Yes	This structure represents the fields associated with a cost card's disbursed amount adjustment.
Explanation	String (1024)	No	An explanation as to why this adjustment was applied.	made a mistake earlier

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:PwsAdjustCostDisbursedAmount>
         <!--Optional:-->
         <pws:serviceRequest>
            <req:SessionTicket>AYqurzyaruwg84zm4AOdBA==</req:SessionTicket>
            <tim:AdjustmentCodeIdentity>
               <com:AdjustmentCodeName>other</com:AdjustmentCodeName>
            </tim:AdjustmentCodeIdentity>
            <!--Optional:-->
            <tim:AdjustmentOrders>
               <!--Zero or more repetitions:-->
               <tim:PwsCostDisbursedAmountAdjustmentOrder>
                  <!--Optional:-->
                  <tim:CostCardIdentity>
                     <com:CostCardUid>1152921504614703247</com:CostCardUid>
                  </tim:CostCardIdentity>
                  <!--Optional:-->
                  <tim:NewIncurredOpsCurrencyIdentity>
                     <!--Optional:-->
                     <com:OpsCurrencyCode>USD</com:OpsCurrencyCode>
                  </tim:NewIncurredOpsCurrencyIdentity>
                  <!--Optional:-->
                  <tim:NewTotalAmountDisbursedCurrency>1122.33</tim:NewTotalAmountDisbursedCurrency>
                  <tim:NewTotalAmountIncurredCurrency>1000</tim:NewTotalAmountIncurredCurrency>
                  <tim:NewVatAmountIncurredCurrency>23</tim:NewVatAmountIncurredCurrency>
                  </tim:PwsCostDisbursedAmountAdjustmentOrder>
            </tim:AdjustmentOrders>
            <!--Optional:-->
            <tim:Explanation>Made a mistake</tim:Explanation>
         </pws:serviceRequest>
      </pws:PwsAdjustCostDisbursedAmount>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsAdjustCostDisbursedAmount Response

PwsAdjustCostDisbursedAmountResponse
- PwsAdjustCostDisbursedAmountResult: PwsAdjustCostDisbursedAmountRs
  - Messages: PwsMessage[]
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - CostCardIdentities: PwsCostCardRef

Response Elements

Element	Data Type	Description	Sample Data
Messages	PwsMessage[]	The web service response status and message. Click here for more information.
ResponseId	Int32	Click here for more information	1
Status	RequestStatus	Click here for more information	Ok
ServerTimestampUtc	DateTime	Click here for more information	2019-11-06T17:18:38.6934436Z
CostCardIdentities	PwsCostCardRef	The identities of the cost cards that were updated.

Response Usage Example(s)

Example 01

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsAdjustCostDisbursedAmountResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsAdjustCostDisbursedAmountResult 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/">2019-11-07T20:29:57.8069156Z</ServerTimestampUtc>
            <a:CostCardIdentities xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:PwsCostCardRef>
                  <b:CostCardId i:nil="true"/>
                  <b:CostCardUid>1152921504614703247</b:CostCardUid>
                  <b:ReferenceId i:nil="true"/>
               </b:PwsCostCardRef>
            </a:CostCardIdentities>
         </PwsAdjustCostDisbursedAmountResult>
      </PwsAdjustCostDisbursedAmountResponse>
   </s:Body>
</s:Envelope>

PwsAdjustCostDisbursedAmount - 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: NewIncurredOpsCurrencyIdentity.
10111	RequiredFieldMissing	A required field is missing: NewTotalAmountIncurredCurrency.
10111	RequiredFieldMissing	A required field is missing: NewVatAmountIncurredCurrency.
50024	EntityNotFound	Cost Card was not found. Another user may have deleted it.