Get an expense per diem policy

get

/fscmRestApi/resources/11.13.18.05/expensePerDiemPolicies/{PerDiemPolicyId}

Request

Path Parameters
  • The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : expensePerDiemPolicies-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 255
    Calculation method for accommodation deductions such as Rate, Percentage, or Spreadsheet.
  • Title: Calculation Method
    Maximum Length: 30
    Code that indicates the calculation method for accommodation deductions. Values are from the lookup ORA_EXM_PERDIEM_CALCMETH.
  • Title: Accommodations deduction
    Maximum Length: 1
    Indicates whether this per diem policy deducts free accommodations from the calculated accommodation allowance. Valid values are Yes and No.
  • Title: Hours
    End hour for accommodations eligibility.
  • Title: Minutes
    End minute for accommodations eligibility.
  • Title: Hours
    Start hour for accommodations eligibility.
  • Title: Minutes
    Start minute for accommodations eligibility.
  • Title: Rate Only Applicable for Free Accommodations
    Maximum Length: 30
    Indicates whether the per diem policy permits free accommodations only allowance. Valid values are Yes and No.
  • Title: Hours
    Minimum hours duration for accommodations.
  • Title: Minutes
    Minimum minutes duration for accommodations.
  • Title: Minimum Night Hours Required for Night Rate
    Minimum number of hours of stay required to qualify for accommodations allowance.
  • Title: Minimum Trip Duration for Rate Eligibility
    Maximum Length: 1
    Indicates whether there is a minimum trip duration requirement for an employee to become eligible for an accommodations allowance. Valid values are Yes and No.
  • Read Only: true
    Maximum Length: 255
    Calculation method for accommodation rates such as Rate, Percentage, or Spreadsheet.
  • Title: Calculation Method
    Maximum Length: 30
    Code that indicates the calculation method for the accommodations rate. Values are from the lookup ORA_EXM_PERDIEM_CALCMETH.
  • Title: Requires Meals Rate Eligibility Being Met First
    Maximum Length: 1
    Indicates whether a per diem policy requires an employee to meet the meals allowance criteria before they're eligible for an accommodations allowance. Valid values are Yes and No.
  • Title: Allow actual expenses instead of per diem
    Maximum Length: 1
    Indicates if actual expenses are allowed instead of per diem.Valid values are Yes and No.
  • Title: Allow Rate Conversion
    Maximum Length: 1
    Indicates whether a per diem policy allows the single currency rates defined in a policy to be converted to a different reimbursement currency. Valid values are Yes and No.
  • Title: Hours
    Ending time hour for breakfast to qualify for a breakfast allowance.
  • Title: Minutes
    Ending time minute for breakfast to qualify for a breakfast allowance.
  • Title: Hours
    Starting time hour for breakfast to qualify for a breakfast allowance.
  • Title: Minutes
    Starting time minutes for breakfast to qualify for a breakfast allowance.
  • Read Only: true
    Maximum Length: 64
    User who created the row.
  • Read Only: true
    Date and time when the row was last updated.
  • Read Only: true
    Maximum Length: 255
    Currency name for per diem expense policies.
  • Title: Currency
    Maximum Length: 15
    Three-letter ISO currency code for the single currency in which rates for the policy are defined.
  • Read Only: true
    Maximum Length: 255
    Rate currency option such as Single or Location.
  • Title: Rate Currency
    Maximum Length: 30
    Code that indicates whether per diem policy rates in a policy are defined in a single currency or in a currency specific to locations. Values are from the lookup ORA_EXM_PD_CURRENCY_OPTION.
  • Title: Day Travel Eligibility
    Indicates the minimum hours of travel required to be eligible for same day travel.
  • Title: Description
    Maximum Length: 240
    Description of a per diem policy.
  • Title: Hours
    Ending time hour for dinner to qualify for a dinner allowance.
  • Title: Minutes
    Ending time minute for dinner to qualify for a dinner allowance.
  • Title: Hours
    Starting time hour for dinner to qualify for a dinner allowance.
  • Title: Minutes
    Starting time minutes for dinner to qualify for a dinner allowance.
  • Title: Accommodation Type
    Maximum Length: 1
    Indicates whether per diem policy rates vary by type of accommodation. Valid values are Yes and No.
  • Title: Location
    Maximum Length: 1
    Indicates whether per diem policy rates vary by location type such as geographical location or zone. Valid values are Yes and No.
  • Title: Long Term Travel
    Maximum Length: 1
    Indicates whether per diem policy has rules or rates defined for long-term travel. Valid values are Yes and No.
  • Title: Role
    Maximum Length: 1
    Indicates whether per diem allowances vary based on role types such as job management level or salary threshold. Valid values are Yes and No.
  • Title: Season
    Maximum Length: 1
    Indicates whether accommodation rates vary by season when accommodations are included in per diem. Valid values are Yes and No.
  • Title: Weekend and Holiday
    Maximum Length: 1
    Indicates whether per diem policy has rules or rates defined for weekend and holiday travel. Valid values are Yes and No.
  • Expense Per Diem Policy Lines
    Title: Expense Per Diem Policy Lines
    The expense per diem policy lines resource is used to view per diem expense policy line records.
  • Expense Per Diem Policy Values
    Title: Expense Per Diem Policy Values
    The expense per diem policy values resource is used to view records of per diem expense policy values in percentages.
  • Read Only: true
    Maximum Length: 255
    Type of deduction, by meal type and amount or by meal type and amount with percentage deductions over a specified limit.
  • Title: Free Meals Deductions
    Maximum Length: 30
    Code indicating the type of deduction, by meal type and amount or by meal type and amount with percentage deductions over a specified limit. Values are from the lookup ORA_EXM_CONUS_MEAL_DEDUCTION.
  • Read Only: true
    Maximum Length: 255
    Calculation method for weekend and holiday allowances such as Rate or Percentage.
  • Title: Calculation Method
    Maximum Length: 30
    Code indicating the calculation method for weekend and holiday allowances such as Rate or Percentage. Values are from the lookup ORA_EXM_PERDIEM_CALCMETH.
  • Read Only: true
    Date and time when the row was last updated.
  • Read Only: true
    Maximum Length: 64
    User who last updated the row.
  • Read Only: true
    Maximum Length: 32
    Session login associated with the user who last updated the row.
  • Links
  • Read Only: true
    Maximum Length: 255
    Indicates how policy rates vary by geographical locations.
  • Maximum Length: 30
    Lookup type that indicates policy rates vary by geographical locations. Values are from the lookup EXM_LOCATION_TYPE.
  • Read Only: true
    Maximum Length: 255
    Calculation method for long-term travel allowances.
  • Title: Calculation Method
    Maximum Length: 30
    Code indicating the calculation method for long-term travel allowances. Values are from the lookup ORA_EXM_PERDIEM_CALCMETH.
  • Title: Hours
    Ending time hours for lunch to qualify for a lunch allowance.
  • Title: Minutes
    Ending time minutes for lunch to qualify for a lunch allowance.
  • Title: Hours
    Starting time hours for lunch to qualify for a lunch allowance.
  • Title: Minutes
    Starting time minutes for lunch to qualify for a lunch allowance.
  • Title: Meals deduction
    Maximum Length: 1
    Indicates whether the per diem policy deducts free meals from the calculated meals allowance. Valid values are Yes and No.
  • Title: Meals Rate Includes Incidentals
    Maximum Length: 1
    Indicates whether the meals allowance also includes incidental expense charges. Valid values are Yes and No.
  • Read Only: true
    Maximum Length: 255
    Indicates the meal allowance type for a policy such as Daily Rate, Rates By Meal Type, or Rates by Number of Meals.
  • Maximum Length: 30
    Code that indicates meal allowance type for a policy. Values are from the lookup ORA_EXM_PERDIEM_MEAL_RATE.
  • Title: Amount Limit
    Amount limit to determine deduction for free meal.
  • Read Only: true
    Maximum Length: 255
    Calculation method for per diem meals allowances, such as Rate, Percentage, or Spreadsheet.
  • Title: Calculation Method
    Maximum Length: 30
    Code that indicates the calculation method for per diem or meals allowances. Values are from the lookup ORA_EXM_PERDIEM_CALCMETH.
  • Read Only: true
    Maximum Length: 255
    Calculation method for meals deductions such as Rate, Percentage, or Spreadsheet.
  • Title: Calculation Method
    Maximum Length: 30
    Code that indicates the calculation method for meals deductions such as Rate, Percentage, or Spreadsheet. Values are from the lookup ORA_EXM_PERDIEM_CALCMETH.
  • Read Only: true
    Maximum Length: 255
    Indicates the meals deduction type for a per diem policy such as Daily Meals Deduction, Deduction by Meal Type, or Deductions by Number of Meals.
  • Maximum Length: 30
    Code that indicates meals deduction type for a per diem policy. Values are from the lookup ORA_EXM_PERDIEM_MEAL_DEDUCTION.
  • Read Only: true
    Maximum Length: 255
    Indicates whether the meal rates are based on local rates or proportional rates.
  • Maximum Length: 30
    Code that indicates whether the meal rates are based on local rates or proportional rates. Values are from the lookup ORA_EXM_MEAL_SOURCE_CODE.
  • Title: Minimum Travel Distance from Home
    Minimum travel distance from home to qualify for per diem rate.
  • Title: Minimum Travel Distance from Office
    Minimum travel distance from office to qualify for per diem rate.
  • Title: Hours
    Minimum travel time hours to qualify for per diem or meals rate.
  • Title: Minutes
    Minimum travel time minutes to qualify for per diem or meals rate.
  • Title: Minimum Reimbursement
    Minimum reimbursement amount.
  • Title: Minimum Trip Duration for Rate Eligibility
    Maximum Length: 1
    Indicates whether this policy has a minimum trip duration for per diem eligibility.
  • Number used to implement optimistic locking for an expense miscellaneous policy line. The number increments every time the row is updated. The value of the object version number at the start and end of a transaction are compared to detect whether another session has updated the row since it was queried.
  • Read Only: true
    Maximum Length: 255
    Calculation method for an incidental allowance such as Rate, Percentage, or Spreadsheet.
  • Title: Calculation Method
    Maximum Length: 30
    Code that indicates the calculation method for an incidental allowance. Values are from the lookup ORA_EXM_PERDIEM_CALCMETH.
  • Read Only: true
    Maximum Length: 255
    Eligibility criteria for receiving an incidental allowance such as None, Meets Meals Eligibility, or Meets Meals and Accommodations Eligibility.
  • Title: Eligibility Criteria
    Maximum Length: 30
    Code that indicates the eligibility criteria for receiving an incidental allowance. Values are from the lookup ORA_EXM_PERDIEM_ELIG_CRITERIA.
  • Unique identifier of per diem policy.
  • Title: Policy Travel Type
    Maximum Length: 30
    Type of travel for which a per diem policy is applicable such as Generic, Domestic, or Foreign. Values are from the lookup ORA_EXM_PERDIEM_POLICY_TYPE.
  • Title: Policy Name
    Maximum Length: 60
    Name of a per diem policy.
  • Read Only: true
    Maximum Length: 255
    Role type by which per diem allowances vary, such as job management level or salary.
  • Title: Role Type
    Maximum Length: 30
    Code that indicates the role type by which per diem allowances vary, such as job management level or salary.
  • Read Only: true
    Maximum Length: 255
    Formula calculation method for per diem allowance such as Daily Rate, Sum Up Separate Rate Allowances, Daily Time Based Rate, or Sum Up Separate Rates -Time Based.
  • Title: Rate Calculation Method
    Maximum Length: 30
    Code indicating the formula calculation method for per diem allowance. Values are from the lookup ORA_EXM_RATE_FORMULA_METHOD.
  • Title: Accommodations
    Maximum Length: 1
    Indicates whether the per diem reimbursement defined for the policy includes accommodations. Valid values are Yes and No.
  • Title: Meals
    Maximum Length: 1
    Indicates whether the per diem allowance defined for the policy includes meals. Valid values are Yes and No.
  • Title: Other
    Maximum Length: 1
    Indicates whether the per diem reimbursement defined for the policy includes other expenses. Valid values are Yes and No.
  • Read Only: true
    Maximum Length: 255
    Code that indicates whether the rate multiplier is number of days or number of nights when the per diem policy calculation method is Daily Rate. Values are from the lookup ORA_EXM_PERDIEM_MULTIPLIER.
  • Title: Rate Multiplier
    Maximum Length: 30
    Code that indicates whether the rate multiplier is number of days or number of nights. Values are from the lookup ORA_EXM_PERDIEM_MULTIPLIER.
  • Read Only: true
    Maximum Length: 255
    Indicates if the policy is created based on rates entered by the user or from rates uploaded by the user.
  • Maximum Length: 30
    Code indicating if the policy is created based on rates entered by the user or from rates uploaded by the user.
  • Title: Calculation Method
    Maximum Length: 30
    Calculation method for role based allowances for a per diem policy such as Rate, Percentage, or Spreadsheet. Values are from the lookup ORA_EXM_PERDIEM_CALCMETH.
  • Title: First and Last Day
    Maximum Length: 1
    Indicates whether a per diem policy has specific rates for first day and last day. Valid values are Yes and No.
  • Title: Status
    Maximum Length: 30
    Code that indicates the status of a per diem policy. Values are from the lookup EXM_POLICY_STATUS.
  • Read Only: true
    Maximum Length: 255
    Status of a per diem policy such as Draft, Valid, Invalid, Partially Active, or Active.
  • Title: Allow Same Day Travel
    Maximum Length: 1
    Indicates whether this per diem policy will allow same day trip. Valid values are Yes and No.
  • Maximum Length: 1
    This attribute is reserved for future use. Indicates whether per diem policy rates vary based on travel time for each rate time period.
  • Read Only: true
    Maximum Length: 255
    Calculation method for time threshold allowances such as Rate, Percentage, or Spreadsheet.
  • Title: Calculation Method
    Maximum Length: 30
    Calculation method for time threshold allowances. Values are from the lookup ORA_EXM_PERDIEM_CALCMETH.
  • Read Only: true
    Maximum Length: 255
    Code that indicates time period boundaries per diem such as Midnight to Midnight or Start Time Plus 24 Hours.
  • Title: Per Diem Time Period
    Maximum Length: 30
    Code that indicates time period boundaries for per diem. Values are from the lookup ORA_EXM_PERDIEM_TIME_PERIOD.
  • Read Only: true
    Maximum Length: 255
    Calculation method for same day travel time threshold allowances such as Rate, Percentage, or Spreadsheet. Values are from the lookup ORA_EXM_PERDIEM_CALCMETH.
  • Title: Calculation Method
    Maximum Length: 30
    Calculation method for same day travel time threshold allowances. Values are from the lookup ORA_EXM_PERDIEM_CALCMETH.
  • Read Only: true
    Maximum Length: 255
    Indicates whether specific same day travel rates are applicable to trips less than 24 hours or to trips without an overnight stay.
  • Maximum Length: 30
    Code that indicates when specific same day travel rates are applicable. Values are from the lookup ORA_EXM_PERDIEM_SAME_DAY_RULE.
  • Maximum Length: 30
    Code that indicates the first weekend day for a specific geographic region. For example, the first weekend day for a specific geographic region may not be Saturday as it's in the United States.
  • Maximum Length: 30
    Code that indicates the second weekend day for a specific geographic region. For example, the second weekend day for a specific geographic region may not be Sunday as it's in the United States.
  • Title: Travel Can't Be Within Employees Home City
    Maximum Length: 1
    Indicates whether a policy allows travel within the employee's home city to qualify for per diem or meals allowance. Valid values are Yes and No.
  • Read Only: true
    Maximum Length: 255
    Indicates that the policy rates vary by zones.
  • Title: Zone Type
    Maximum Length: 30
    Code that indicates whether policy rates vary by zone.
Nested Schema : Expense Per Diem Policy Lines
Type: array
Title: Expense Per Diem Policy Lines
The expense per diem policy lines resource is used to view per diem expense policy line records.
Show Source
Nested Schema : Expense Per Diem Policy Values
Type: array
Title: Expense Per Diem Policy Values
The expense per diem policy values resource is used to view records of per diem expense policy values in percentages.
Show Source
Nested Schema : expensePerDiemPolicies-expensePerDiemPolLines-item-response
Type: object
Show Source
Nested Schema : expensePerDiemPolicies-expensePerDiemPolValues-item-response
Type: object
Show Source
Back to Top