Overview

This web service retrieves one default Vat percentage based on the expense type and location provided in the request.

Request Format

PwsGetDefaultVatPercentage Request

PwsGetDefaultVatPercentage
- serviceRequest: PwsGetDefaultVatPercentageRq
  - RequestId: Int32
  - SessionTicket: String
  - ExpenseTypeIdentity: PwsExpenseTypeRef
  - LocationIdentity: PwsLocationRef

Request Elements

Element	Data Type	Required?	Description	Sample Data
RequestId	Int32	No	Click here for more information.
SessionTicket	String	Yes	Click here for more information.	ATtU220EvBSE2+GCN9U58g==
ExpenseTypeIdentity	PwsExpenseTypeRef	Yes	The expense type that associated with this Vat percentage. Click here for more information.
LocationIdentity	PwsLocationRef	Yes	The location to look up an expense type's Vat percentage. Click here for more information.

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:PwsGetDefaultVatPercentage>
         <pws:serviceRequest>
            <req:SessionTicket>ATtU220EvBSE2+GCN9U58g==</req:SessionTicket>
            <tim:ExpenseTypeIdentity>
               <com:ExpenseTypeName>Travel</com:ExpenseTypeName>
            </tim:ExpenseTypeIdentity>
            <tim:LocationIdentity>
               <com:LocationName>London</com:LocationName>
            </tim:LocationIdentity>
         </pws:serviceRequest>
      </pws:PwsGetDefaultVatPercentage>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsGetDefaultVatPercentage Response

PwsGetDefaultVatPercentageResponse
- PwsGetDefaultVatPercentageResult: PwsGetDefaultVatPercentageRs
  - Messages: PwsMessage
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - VatPercentage: Double

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.
Status	RequestStatus	Click here for more information	Ok
ServerTimestampUtc	DateTime	Click here for more information.	2018-03-13T15:24:27.1225758Z
VatPercentage	Double	The default Vat precentage of an expense type at a specified location	0.175

Response Usage Example(s)

Example 01

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsGetDefaultVatPercentageResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsGetDefaultVatPercentageResult 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-13T15:24:27.1225758Z</ServerTimestampUtc>
            <a:VatPercentage>0.175</a:VatPercentage>
         </PwsGetDefaultVatPercentageResult>
      </PwsGetDefaultVatPercentageResponse>
   </s:Body>
</s:Envelope>

Common Errors and Warnings

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

ErrorNumber	ErrorCode	ErrorText
19013	ExpenseTypeRequiredForGetDefaultVatPercentage	No expense type was specified.
19014	LocationRequiredForGetDefaultVatPercentage	No location was specified.
57541	LocationNotFound	Specified location does not exist.
59912	ExpenseTypeNotFound	Cost code (i.e. Expense Type) not found.