Versions Compared

Key

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

...

This web service retrieves one mileage rate using the identity of a resource (PwsResourceRef), the identity of an expense document (PwsExpenseDocumentRef), or both.  If both identities are provided, the resources must match or an error is returned in the response. 

Request Format

 


Panel
titlePwsGetMileageRate Request

...

Element

Data Type

Required?

Default

Description

Sample Data

RequestId

Int32

No


Click here for more information.


SessionTicket

String

Yes


Click here for more information.

ARNkL4C1bp7KLtsSXQW6/g==

DisbursedCurrencyIdentity

PwsCurrencyRef

Either DisbursedCurrencyIdentity or ExpenseDocumentIdentity must be provided


The disbursed currency for mileage rate. If both DisbursedCurrencyIdentity and ExpenseDocumentIdentity are provided, the currencies in both data types disbursing currency of the expense document must match the specified disbursed currency. Otherwise, an error is returned in the response. If both DisbursedCurrencyIdentity and ResourceIdentity are provided and there is a mismatch between the resource's disbursed currency and the specified currency, a null mileage rate is returned in the response. Click here for more information.


EffectiveDate

DateTime

No


The effective date of for which to retrieve the mileage rate.

2018-03-01z

ExpenseDocumentIdentity

PwsExpenseDocumentRef

See DisbursedCurrencyIdentity above


The identify of the expense document whose resource's location is what the mileage rate is based on. The document's disbursed currency must match the one in DisbursedCurrencyIdentity if provided, and the document's resource must match the one in ResourceIdentity if provided. Otherwise, an error is returned in both cases. Click here for more information.


ResourceIdentity

PwsResourceRef

No


The resource whose mileage rate is requested. If both ExpenseDocumentIdentity and ResourceIdentity are both provided, this resource must match the resource on the expense document. If neither is provided in the request, requesting user/resource is used to locate the mileage rate. If this user is not a resource, an error is returned in the response. Click here for more information.


...