Get all expense mileage policy line records

get

/fscmRestApi/resources/11.13.18.05/expenseMileagePolicies

Request

Query Parameters
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Finds the expense mileage policy record using a mileage policy identifier that matches the primary key criteria specified.
      Finder Variables:
      • MileagePolicyId; integer; Identifier of a mileage policy for a mileage policy record
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • AdditionalRatesListCode; string; Lookup representing the additional rate types applicable for this mileage policy. Valid values are from the lookup EXM_ADDITIONAL_RATES.
    • ApplyThresholdBy; string; Date when a threshold is applied to a trip distance to determine mileage rates, such as By trip or By cumulative mileage. Valid values are from the lookup EXM_THRESHOLD_PERIOD.
    • ApplyThresholdByCode; string; Code that is associated with a threshold date that is applied to a trip distance to determine mileage rates.
    • CalculationPassRateByDistFlag; boolean; Indicates whether passenger rate must be calculated by the distance traveled by each passenger.
    • CapturePassNamesFlag; boolean; Indicates whether passenger names must be captured in expense report.
    • CommuteDistanceRequiredFlag; boolean; Indicates whether the commute distance is required.
    • Country; string; Country where a mileage expense policy is applicable.
    • CountryCode; string; Code associated with a country.
    • CreatedBy; string; User who created the mileage policy record.
    • CreationDate; string; Date when the mileage policy record was created.
    • Currency; string; Currency of the mileage expense policy when rates are defined in a single currency.
    • CurrencyCode; string; Code that is associated with a currency.
    • CurrencyOption; string; Currency option selected for the rate definition, such as single or multiple currency. Valid values are from the lookup EXM_CURRENCY_OPTION.
    • CurrencyOptionCode; string; Code that is associated with a currency.
    • Description; string; Description for this expense policy of mileage category.
    • DisplayAllUnitsFlag; boolean; Indicates whether expense entry preparers can select any unit of measure in an expense report for a mileage expense associated with this expense policy.
    • DistanceThresholdFlag; boolean; Indicates whether mileage rates vary by distance threshold.
    • EligibilityDistance; number; Minimum trip distance to be eligible for mileage reimbursement.
    • EnabledAdditnlRatesFlag; boolean; Indicates whether mileage rates vary by additional rate types.
    • EnabledDeductCommuteFlag; boolean; Indicates whether the user can deduct the commute distance.
    • EnabledEligibilityFlag; boolean; Indicates whether there is a minimum distance requirement for mileage eligibility.
    • EnabledFuelTypeFlag; boolean; Indicates whether mileage rates vary by fuel type.
    • EnabledGenderFlag; boolean; Indicates whether mileage rates vary based on the gender of an employee.
    • EnabledLocationFlag; boolean; Indicates whether mileage rates vary by location.
    • EnabledMaximumPassFlag; boolean; Indicates whether a limit exists for number of passengers eligible to be included in mileage reimbursement calculation.
    • EnabledPassengerFlag; boolean; Indicates whether passenger rates are applicable for this policy.
    • EnabledRoleFlag; boolean; Indicates whether mileage rates vary based on the role of an employee.
    • EnabledStandardDeductionFlag; boolean; Indicates whether standard mileage deduction is applicable for this policy.
    • EnabledVehCategoryFlag; boolean; Indicates whether mileage rates vary by vehicle category.
    • EnabledVehTypeFlag; boolean; Indicates whether mileage rates vary by vehicle type.
    • FuelTypeListCode; string; Code that is associated with the fuel type list.
    • LastUpdateDate; string; Date when the expense mileage policy record was last updated.
    • LastUpdateLogin; string; Session login of the user who last updated the mileage policy record.
    • LastUpdatedBy; string; User who last updated the mileage policy record.
    • LocationType; string; Type of location that determines rates, such as Geographical Location and Zone. Valid values are from the lookup EXM_LOCATION_TYPE.
    • LocationTypeCode; string; Code that is associated with a location type.
    • MaximumPassengers; integer; Maximum number of passengers eligible for inclusion in mileage reimbursement calculation.
    • MileageDeduction; number; Distance that must be subtracted from the total distance traveled before mileage calculation.
    • MileagePolicyId; integer; Meals policy identifier.
    • PassengerRule; string; Passenger rate type, such as Single, Range, or Specific. Valid values are from the lookup EXM_PASSENGER_RULE.
    • PassengerRuleCode; string; Code that is associated with a passenger rule.
    • PolicyName; string; Name of this expense policy of mileage category.
    • PolicyRole; string; Role type that determines the policy rate, such as Job, Grade, and Position. Values are from the lookup EXM_POLICY_ROLE.
    • PolicyRoleCode; string; Code that is associated with a mileage expense policy role.
    • StandardDeductionCode; string; Indicates which type of standard mileage deduction is applicable.
    • Status; string; Status of the mileage expense policy, such as Draft or Active. Valid values are from the lookup EXM_POLICY_STATUS.
    • StatusCode; string; Code that is associated with a mileage expense policy status, such as Draft or Active. Valid values are from the lookup EXM_POLICY_STATUS.
    • UnitOfMeasure; string; Unit in which distance is measured for mileage calculation. Values are from the lookup EXM_UNIT_OF_MEASURE.
    • UnitOfMeasureCode; string; Code that is associated with a unit of measure.
    • VehicleCategoryListCode; string; Code that is associated with a vehicle category list.
    • VehicleTypeListCode; string; Code that is associated with a vehicle type list.
    • ZoneType; string; Type of zone for a mileage expense policy. Valid values are from the lookup EXM_ZONE_TYPE.
    • ZoneTypeCode; string; Code that is associated with a zone type.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : expenseMileagePolicies
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : expenseMileagePolicies-item-response
Type: object
Show Source
Nested Schema : Expense Mileage Policy Lines
Type: array
Title: Expense Mileage Policy Lines
The expense mileage policy lines resource is used to get all records related to mileage policy lines.
Show Source
Nested Schema : expenseMileagePolicies-expenseMileagePolicyLines-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to retrieve all the expense mileage policy records by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseMileagePolicies

Example Response Body

The following example shows the contents of the response body in JSON format:

{
  "items": [
    {
      "AdditionalRatesListCode": null,
      "ApplyThresholdByCode": null,
      "ApplyThresholdBy": null,
      "CalculationPassRateByDistFlag": false,
      "CapturePassNamesFlag": false,
      "CommuteDistanceRequiredFlag": null,
      "CountryCode": null,
      "Country": null,
      "CreatedBy": "EXPENSE_MANAGER",
      "CreationDate": "2013-12-19T16:08:44.752+00:00",
      "CurrencyCode": "JPY",
      "Currency": "Japanese yen",
      "CurrencyOptionCode": "SINGLE",
      "CurrencyOption": "Single currency",
      "Description": "MP5: Single Currency other than functional",
      "DisplayAllUnitsFlag": false,
      "DistanceThresholdFlag": false,
      "EligibilityDistance": null,
      "EnabledAdditnlRatesFlag": false,
      "EnabledDeductCommuteFlag": null,
      "EnabledEligibilityFlag": false,
      "EnabledFuelTypeFlag": false,
      "EnabledGenderFlag": false,
      "EnabledLocationFlag": false,
      "EnabledMaximumPassFlag": null,
      "EnabledPassengerFlag": false,
      "EnabledRoleFlag": false,
      "EnabledStandardDeductionFlag": false,
      "EnabledVehCategoryFlag": false,
      "EnabledVehTypeFlag": false,
      "FuelTypeListCode": null,
      "LastUpdateDate": "2013-12-19T16:10:48.195+00:00",
      "LastUpdateLogin": "EDECAC6A2DB33DAAE0432620F00AE079",
      "LastUpdatedBy": "EXPENSE_MANAGER",
      "LocationTypeCode": null,
      "LocationType": null,
      "MaximumPassengers": null,
      "MileageDeduction": null,
      "MileagePolicyId": 300100031584792,
      "PassengerRuleCode": null,
      "PassengerRule": null,
      "PolicyName": "MP5: Single Currency JPY",
      "PolicyRoleCode": null,
      "PolicyRole": null,
      "StatusCode": "ACTIVE",
      "Status": "Active",
      "StandardDeductionCode": null,
      "UnitOfMeasureCode": "KILOMETER",
      "UnitOfMeasure": "Kilometer",
      "VehicleCategoryListCode": null,
      "VehicleTypeListCode": null,
      "ZoneTypeCode": null,
      "ZoneType": null,
      "links": [
        {
          "rel": "self",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseMileagePolicies/300100031584792",
          "name": "expenseMileagePolicies",
          "kind": "item",
          "properties": {
            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
          }
        },
        {
          "rel": "canonical",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseMileagePolicies/300100031584792",
          "name": "expenseMileagePolicies",
          "kind": "item"
        },
        {
          "rel": "child",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseMileagePolicies/300100031584792/child/expenseMileagePolicyLines",
          "name": "expenseMileagePolicyLines",
          "kind": "collection"
        }
      ]
    },
	...
  ],
  "count": 17,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseMileagePolicies",
      "name": "expenseMileagePolicies",
      "kind": "collection"
    }
  ]
}
Back to Top