Get all expense miscellaneous policies
get
/fscmRestApi/resources/11.13.18.05/expenseMiscPolicies
Request
Query Parameters
-
expand: string
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).
-
fields: string
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 -
finder: string
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 miscellaneous policy record that matches the primary key criteria specified.
Finder Variables- MiscPolicyId; integer; The unique identifier of the expense miscellaneous policy record.
- PrimaryKey Finds the expense miscellaneous policy record that matches the primary key criteria specified.
-
limit: integer
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.
-
links: string
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 -
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
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
-
q: string
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:- CreatedBy; string; User who created the row.
- CreationDate; string; Date and time when the row was created.
- Currency; string; Currency of a miscellaneous expense policy when rates are defined in a single currency.
- CurrencyCode; string; Currency code for miscellaneous expense policy.
- CurrencyOption; string; Miscellaneous expense policy defined for a single currency or for multiple currencies.
- CurrencyOptionCode; string; Miscellaneous expense policy defined for a single currency or for multiple currencies. Values are from the lookup EXM_CURRENCY_OPTION.
- DailyLimitFlag; boolean; Indicates whether the daily amount limit of miscellaneous expenses is enforced. Valid values are Yes and No.
- DaysBasedItemParentFlag; boolean; Indicates whether eligibility for miscellaneous expense reimbursement is based on number of days specified in parent line during itemization in expense entry.
- Description; string; Description of miscellaneous expense policy.
- DispWarningToUserFlag; boolean; Indicates whether miscellaneous expense policy warning is displayed to user.
- EligibilityDays; integer; Minimum number of days before miscellaneous expense is eligible for reimbursement.
- EnabledEligibilityFlag; boolean; Indicates whether a minimum number of days are required for the miscellaneous expense to be eligible for expense reimbursement.
- EnabledGenderFlag; boolean; Indicates whether miscellaneous expense policy rates vary based on the gender of an employee.
- EnabledLocationFlag; boolean; Indicates whether miscellaneous expense policy rates vary by location.
- EnabledRoleFlag; boolean; Indicates whether miscellaneous expense policy rates vary based on employee role.
- ErrorTolerance; number; Percentage added to the miscellaneous expense policy amount limit to obtain the maximum allowable limit for expense report submission.
- LastUpdateDate; string; Date and time when the row was last updated
- LastUpdateLogin; string; Session login of user who last updated the row.
- LastUpdatedBy; string; User who last updated the row.
- LocationType; string; The type of location that determines miscellaneous expense policy rates, such as Geographical Location or Zone.
- LocationTypeCode; string; Indicates the location type that determines miscellaneous expense policy rates. Valid values are from the lookup EXM_LOCATION_TYPE.
- MiscPolicyId; integer; The unique identifier of the miscellaneous expense policy.
- PeriodDay; integer; Start date from which miscellaneous expense policy annual rate limit is counted. Values are from the lookup DAY.
- PeriodMonth; string; Starting month from which miscellaneous expense policy annual rate limit is counted. Values are from the lookup MONTH.
- PolicyEnforcement; string; Type of miscellaneous expense policy enforcement applied.
- PolicyEnforcementCode; string; Indicates the type of miscellaneous expense policy enforcement applied. Values are from the lookup EXM_POLICY_ENFORCEMENT.
- PolicyName; string; Name of the miscellaneous expense policy.
- PolicyRole; string; Role type that determines the miscellaneous expense policy rate, such as Job, Grade, or Position.
- PolicyRoleCode; string; Indicates the role type that determines the miscellaneous expense policy rate, such as Job, Grade, or Position. Values are from the lookup EXM_POLICY_ROLE.
- PolicyViolationFlag; boolean; Indicates whether employees are warned when they submit expenses that exceed the defined miscellaneous expense policy rate limit.
- PreventSubmissionFlag; boolean; Indicates whether expense report submission is prevented if a miscellaneous expense policy violation occurs.
- RateType; string; Policy rate type of the miscellaneous expense policy, such as rate limit, percentage reimbursement, or percentage reimbursement with upper limit.
- RateTypeCode; string; Indicates the policy rate type of the miscellaneous expense policy, such as rate limit, percentage reimbursement, or percentage reimbursement with upper limit. Values are from the lookup EXM_RATE_TYPE.
- SingleInstanceLimitFlag; boolean; Indicates whether miscellaneous expense policy limits are enforced by each submitted instance of the miscellaneous expense item.
- Status; string; Status of the miscellaneous expense policy, Valid values are Draft, Valid, Invalid, and Active.
- StatusCode; string; Indicates the status of the miscellaneous expense policy. Values are from the lookup EXM_POLICY_STATUS.
- WarningTolerance; number; Percentage added to miscellaneous expense policy amount limit to obtain the maximum allowable limit for a policy warning violation.
- YearlyLimitFlag; boolean; Indicates whether miscellaneous expense policy limits are enforced by maximum permitted annual amount. Valid values are Yes and No.
- ZoneType; string; Lookup that defines zone types for the miscellaneous expense policy.
- ZoneTypeCode; string; Indicates the lookup that defines zone types for the miscellaneous expense policy. Values are from the lookup EXM_ZONE_TYPE.
-
totalResults: boolean
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
-
Metadata-Context:
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".
-
REST-Framework-Version:
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 TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
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".
-
REST-Framework-Version:
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.
Root Schema : expenseMiscPolicies
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : expenseMiscPolicies-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the row. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the row was created. -
Currency: string
Title:
Description
Read Only:true
Maximum Length:240
Currency of a miscellaneous expense policy when rates are defined in a single currency. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
Currency code for miscellaneous expense policy. -
CurrencyOption: string
Title:
Meaning
Read Only:true
Maximum Length:80
Miscellaneous expense policy defined for a single currency or for multiple currencies. -
CurrencyOptionCode: string
Title:
Rate Currency
Maximum Length:30
Miscellaneous expense policy defined for a single currency or for multiple currencies. Values are from the lookup EXM_CURRENCY_OPTION. -
DailyLimitFlag: boolean
Title:
Daily sum limit
Maximum Length:1
Indicates whether the daily amount limit of miscellaneous expenses is enforced. Valid values are Yes and No. -
DaysBasedItemParentFlag: boolean
Title:
Based on Number of Days in Parent Line During Itemization
Maximum Length:1
Indicates whether eligibility for miscellaneous expense reimbursement is based on number of days specified in parent line during itemization in expense entry. -
Description: string
Title:
Description
Maximum Length:240
Description of miscellaneous expense policy. -
DispWarningToUserFlag: boolean
Title:
Display Warning to User
Maximum Length:1
Indicates whether miscellaneous expense policy warning is displayed to user. -
EligibilityDays: integer
(int32)
Title:
Days
Minimum number of days before miscellaneous expense is eligible for reimbursement. -
EnabledEligibilityFlag: boolean
Title:
Minimum Number of Days for Miscellaneous Expense Reimbursement
Maximum Length:1
Indicates whether a minimum number of days are required for the miscellaneous expense to be eligible for expense reimbursement. -
EnabledGenderFlag: boolean
Title:
Gender
Maximum Length:1
Indicates whether miscellaneous expense policy rates vary based on the gender of an employee. -
EnabledLocationFlag: boolean
Title:
Location
Maximum Length:1
Indicates whether miscellaneous expense policy rates vary by location. -
EnabledRoleFlag: boolean
Title:
Role
Maximum Length:1
Indicates whether miscellaneous expense policy rates vary based on employee role. -
ErrorTolerance: number
Title:
Error Tolerance Percentage
Percentage added to the miscellaneous expense policy amount limit to obtain the maximum allowable limit for expense report submission. -
expenseMiscPolicyLines: array
Expense Miscellaneous Policy Lines
Title:
Expense Miscellaneous Policy Lines
The expense miscellaneous policy lines resource is used to view miscellaneous expense policy line records. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the row was last updated -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the row. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Session login of user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationType: string
Title:
Meaning
Read Only:true
Maximum Length:80
The type of location that determines miscellaneous expense policy rates, such as Geographical Location or Zone. -
LocationTypeCode: string
Maximum Length:
30
Indicates the location type that determines miscellaneous expense policy rates. Valid values are from the lookup EXM_LOCATION_TYPE. -
MiscPolicyId: integer
(int64)
The unique identifier of the miscellaneous expense policy.
-
PeriodDay: integer
(int32)
Title:
Period Start Day
Start date from which miscellaneous expense policy annual rate limit is counted. Values are from the lookup DAY. -
PeriodMonth: string
Title:
Period Start Month
Maximum Length:30
Starting month from which miscellaneous expense policy annual rate limit is counted. Values are from the lookup MONTH. -
PolicyEnforcement: string
Title:
Meaning
Read Only:true
Maximum Length:80
Type of miscellaneous expense policy enforcement applied. -
PolicyEnforcementCode: string
Maximum Length:
30
Indicates the type of miscellaneous expense policy enforcement applied. Values are from the lookup EXM_POLICY_ENFORCEMENT. -
PolicyName: string
Title:
Policy Name
Maximum Length:60
Name of the miscellaneous expense policy. -
PolicyRole: string
Title:
Meaning
Read Only:true
Maximum Length:80
Role type that determines the miscellaneous expense policy rate, such as Job, Grade, or Position. -
PolicyRoleCode: string
Title:
Role Type
Maximum Length:30
Indicates the role type that determines the miscellaneous expense policy rate, such as Job, Grade, or Position. Values are from the lookup EXM_POLICY_ROLE. -
PolicyViolationFlag: boolean
Title:
Policy violation warning
Maximum Length:1
Indicates whether employees are warned when they submit expenses that exceed the defined miscellaneous expense policy rate limit. -
PreventSubmissionFlag: boolean
Title:
Prevent report submission
Maximum Length:1
Indicates whether expense report submission is prevented if a miscellaneous expense policy violation occurs. -
RateType: string
Title:
Meaning
Read Only:true
Maximum Length:80
Policy rate type of the miscellaneous expense policy, such as rate limit, percentage reimbursement, or percentage reimbursement with upper limit. -
RateTypeCode: string
Title:
Rate Type
Maximum Length:30
Indicates the policy rate type of the miscellaneous expense policy, such as rate limit, percentage reimbursement, or percentage reimbursement with upper limit. Values are from the lookup EXM_RATE_TYPE. -
SingleInstanceLimitFlag: boolean
Title:
Single instance limit
Maximum Length:1
Indicates whether miscellaneous expense policy limits are enforced by each submitted instance of the miscellaneous expense item. -
Status: string
Title:
Meaning
Read Only:true
Maximum Length:80
Status of the miscellaneous expense policy, Valid values are Draft, Valid, Invalid, and Active. -
StatusCode: string
Title:
Status
Maximum Length:30
Indicates the status of the miscellaneous expense policy. Values are from the lookup EXM_POLICY_STATUS. -
WarningTolerance: number
Title:
Warning Tolerance Percentage
Percentage added to miscellaneous expense policy amount limit to obtain the maximum allowable limit for a policy warning violation. -
YearlyLimitFlag: boolean
Title:
Yearly limit
Maximum Length:1
Indicates whether miscellaneous expense policy limits are enforced by maximum permitted annual amount. Valid values are Yes and No. -
ZoneType: string
Title:
Meaning
Read Only:true
Maximum Length:80
Lookup that defines zone types for the miscellaneous expense policy. -
ZoneTypeCode: string
Title:
Zone Type
Maximum Length:30
Indicates the lookup that defines zone types for the miscellaneous expense policy. Values are from the lookup EXM_ZONE_TYPE.
Nested Schema : Expense Miscellaneous Policy Lines
Type:
array
Title:
Expense Miscellaneous Policy Lines
The expense miscellaneous policy lines resource is used to view miscellaneous expense policy line records.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : expenseMiscPolicies-expenseMiscPolicyLines-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the row. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the row was created. -
Currency: string
Title:
Description
Read Only:true
Maximum Length:240
Currency of a miscellaneous expense policy line. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
Currency code of a miscellaneous expense policy line. -
DailyLimit: number
Title:
Daily sum limit
Daily reimbursement limit for miscellaneous expenses. -
EndDate: string
(date)
Title:
End Date
Date from which the miscellaneous expense policy rate is no longer applicable. -
GenderCode: string
Title:
Gender
Maximum Length:30
Gender code for the miscellaneous expense policy. -
GeographyId: integer
(int64)
The unique identifier of the geography for which the miscellaneous expense policy rate is applicable.
-
GeolocName: string
Title:
Geographical Location
Maximum Length:240
Geographical location for which the miscellaneous expense policy rate is applicable. -
InvalidCode: string
Maximum Length:
30
Indicates why the miscellaneous expense policy line has the invalid status. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the row was last updated -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the row. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Session login of user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MiscPolicyId: integer
(int64)
The unique identifier of the miscellaneous expense policy.
-
PolicyLineId: integer
(int64)
The unique identifier of the miscellaneous expense policy line.
-
RawCity: string
Title:
City
Maximum Length:80
City for which the miscellaneous expense policy rate is applicable. -
RawCountry: string
Title:
Country
Maximum Length:80
Country for which the miscellaneous expense policy rate is applicable. -
RawCounty: string
Title:
County
Maximum Length:80
County for which the miscellaneous expense policy rate is applicable. -
RawState: string
Title:
State
Maximum Length:80
State for which the miscellaneous expense policy rate is applicable. -
ReimbursementPercentage: number
Title:
Percentage Reimbursement
Percentage of the expense amount that's reimbursed when the submitted expense amount exceeds the limit and the rate type is percentage reimbursement or percentage reimbursement with upper limit. -
RoleId: integer
(int64)
The unique identifier of the role for which the miscellaneous expense policy rate is applicable.
-
RoleName: string
Title:
Role
Maximum Length:80
Role name for which the miscellaneous expense policy rate is applicable, such as Director or Engineer. -
SingleInstanceLimit: number
Title:
Single instance limit
Indicates whether miscellaneous expense policy limits are enforced by each submitted instance of a miscellaneous expense item. -
StartDate: string
(date)
Title:
Start Date
Date from which the miscellaneous expense policy rate is applicable. -
Status: string
Title:
Meaning
Read Only:true
Maximum Length:80
Status of the miscellaneous expense policy line. Valid values are Draft, Valid, Invalid, and Active. -
StatusCode: string
Title:
Status
Maximum Length:30
Indicates the status of the miscellaneous expense policy line. Values are from the lookup EXM_POLICY_STATUS. -
TypeOfRateCode: string
Maximum Length:
30
Type of rate line, such as base miscellaneous rate or catch all. -
YearlyLimit: number
Title:
Yearly limit
Annual reimbursement limit for miscellaneous expenses. -
ZoneCode: string
Title:
Zone
Maximum Length:30
Zone code for which the miscellaneous expense policy rate is applicable, such as geographical locations or zones.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.