Get all fee instances
get
/fscmRestApi/resources/11.13.18.05/hedFeeInstances
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- FindByClosestInstance Finds the fee instance that matches the closest instance criteria specified.
Finder Variables - FindByCriteria Finds the fee instance that matches the criteria specified.
Finder Variables- FeeCriteriaId; integer; The unique identifier of the fee criteria.
- FeeCriteriaQuery; string; The unique query parameters of the fee criteria.
- ShowClosestInstance; boolean; The most recent instance of a fee.
- FindByCurrentInstance Finds the fee instance that matches the current instance criteria specified.
Finder Variables- BindSystemDate; string; The unique identifier of the fee instance.
- PrimaryKey Finds the fee instances that match the primary key criteria specified.
Finder Variables- FeeInstanceId; integer; The unique identifier of the fee instance.
- FindByClosestInstance Finds the fee instance that matches the closest instance 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:- ActiveFlag; boolean; Flag to indicate if the fee is active or inactive. If yes, the fee is active, else it's inactive.
- AllowDiscountFlag; boolean; Flag to indicate if discount is allowed for the fee or not. If set to yes, discount is allowed.
- BatchSourceSequenceId; integer; Unique identifier of the batch transaction source setup on the fee instance.
- BatchSourceSequenceName; string; Name of the batch transaction source setup on the fee instance.
- BusinessUnitActiveFlag; boolean; Flag to indicate if the business unit is active.
- BusinessUnitDescription; string; Description of the business unit.
- BusinessUnitId; integer; Unique identifier of the business unit.
- BusinessUnitName; string; Name of the business unit.
- CreditTransactionTypeId; integer; Unique identifier of the credit transaction type setup on the fee instance.
- CreditTransactionTypeName; string; Name of the credit transaction type setup on the fee instance.
- CurrencyCode; string; The currency code associated with the fees.
- CurrencySymbol; string; The currency symbol associated with the fees.
- EndDate; string; End date of the fee instance.
- FeeAtrrStatusCode; string; Fee instance status code.
- FeeAtrrStatusMeaning; string; Fee instance status meaning.
- FeeCode; string; Description of the fee.
- FeeDescription; string; Unique identifier of the fee.
- FeeId; integer; Code of fee instance.
- FeeInstanceCode; string; Lock flag to indicate if the instance code can be updated or not. If set to yes, it can't be updated by the user.
- FeeInstanceCodeLockFlag; boolean; Code of the fees.
- FeeInstanceId; integer; Unique identifier of the fee instance.
- FeeName; string; Name of the fee.
- FeeTypeCode; string; Code of the fee type.
- FeeTypeId; integer; Unique identifier of the fee type.
- FeeTypeName; string; Name of the fee type.
- FlatAmount; number; The amount setup for the fee instance.
- InheritOptionFlag; boolean; Unique identifier of the transaction source setup on the fee instance.
- InheritedBatchSourceSequenceId; integer; Name of the transaction source setup on the fee instance.
- InheritedBatchSourceSequenceName; string; Unique identifier of the credit transaction type setup on the business unit from which the fee instance is inheriting the values.
- InheritedCreditTransactionTypeId; integer; Name of the credit transaction type setup on the business unit from which the fee instance is inheriting the values.
- InheritedCreditTransactionTypeName; string; Unique identifier of the memo line setup on the business unit from which the fee instance is inheriting the values.
- InheritedMemoLineId; integer; Name of the memo line setup on the business unit from which the fee instance is inheriting the values.
- InheritedMemoLineName; string; Unique identifier of the transaction source setup on the business unit from which the fee instance is inheriting the values.
- InheritedTransactionTypeId; integer; Name of the transaction type setup on the business unit from which the fee instance is inheriting the values.
- InheritedTransactionTypeName; string; Flag to indicate if the accounts receivable attributes for the fees should be inherited from the business unit setup or not.
- LastUpdateDate; string; Last updated date of the fee record.
- MemoLineId; integer; Unique identifier of the memo line setup on the fee instance.
- MemoLineName; string; Name of the memo line setup on the fee instance.
- StartDate; string; Start date of the fee instance.
- TransactionTypeId; integer; Unique identifier of the transaction type setup on the fee instance.
- TransactionTypeName; string; Name of the transaction type setup on the fee instance.
-
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 : hedFeeInstances
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 : hedFeeInstances-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Maximum Length:
1
Flag to indicate if the fee is active or inactive. If yes, the fee is active, else it's inactive. -
AllowDiscountFlag: boolean
Maximum Length:
1
Flag to indicate if discount is allowed for the fee or not. If set to yes, discount is allowed. -
BatchSourceSequenceId: integer
(int64)
Unique identifier of the batch transaction source setup on the fee instance.
-
BatchSourceSequenceName: string
Read Only:
true
Maximum Length:255
Name of the batch transaction source setup on the fee instance. -
BusinessUnitActiveFlag: boolean
Read Only:
true
Maximum Length:1
Flag to indicate if the business unit is active. -
BusinessUnitDescription: string
Read Only:
true
Maximum Length:255
Description of the business unit. -
BusinessUnitId: integer
Unique identifier of the business unit.
-
BusinessUnitName: string
Read Only:
true
Maximum Length:255
Name of the business unit. -
CreditTransactionTypeId: integer
(int64)
Unique identifier of the credit transaction type setup on the fee instance.
-
CreditTransactionTypeName: string
Title:
Transaction Type Name
Maximum Length:20
Name of the credit transaction type setup on the fee instance. -
CurrencyCode: string
Maximum Length:
15
The currency code associated with the fees. -
CurrencySymbol: string
Read Only:
true
Maximum Length:255
The currency symbol associated with the fees. -
DeletableFlag: boolean
Read Only:
true
Maximum Length:1
Flag to indicate if the fee instance can be deleted. If set to yes, delete is allowed, else it's not allowed. -
EndDate: string
(date)
End date of the fee instance.
-
FeeAtrrStatusCode: string
Read Only:
true
Maximum Length:255
Fee instance status code. -
FeeAtrrStatusMeaning: string
Read Only:
true
Maximum Length:255
Fee instance status meaning. -
FeeCode: string
Maximum Length:
30
Description of the fee. -
FeeDescription: string
Maximum Length:
240
Unique identifier of the fee. -
FeeId: integer
(int64)
Code of fee instance.
-
FeeInstanceCode: string
Maximum Length:
150
Lock flag to indicate if the instance code can be updated or not. If set to yes, it can't be updated by the user. -
FeeInstanceCodeLockFlag: boolean
Read Only:
true
Maximum Length:1
Default Value:false
Code of the fees. -
FeeInstanceId: integer
(int64)
Read Only:
true
Unique identifier of the fee instance. -
FeeName: string
Maximum Length:
50
Name of the fee. -
FeeTypeCode: string
Maximum Length:
255
Code of the fee type. -
FeeTypeId: integer
Unique identifier of the fee type.
-
FeeTypeName: string
Read Only:
true
Maximum Length:255
Name of the fee type. -
FlatAmount: number
Default Value:
0
The amount setup for the fee instance. -
InheritedBatchSourceSequenceId: integer
Read Only:
true
Name of the transaction source setup on the fee instance. -
InheritedBatchSourceSequenceName: string
Read Only:
true
Maximum Length:255
Unique identifier of the credit transaction type setup on the business unit from which the fee instance is inheriting the values. -
InheritedCreditTransactionTypeId: integer
Read Only:
true
Name of the credit transaction type setup on the business unit from which the fee instance is inheriting the values. -
InheritedCreditTransactionTypeName: string
Read Only:
true
Maximum Length:255
Unique identifier of the memo line setup on the business unit from which the fee instance is inheriting the values. -
InheritedMemoLineId: integer
Read Only:
true
Name of the memo line setup on the business unit from which the fee instance is inheriting the values. -
InheritedMemoLineName: string
Read Only:
true
Maximum Length:255
Unique identifier of the transaction source setup on the business unit from which the fee instance is inheriting the values. -
InheritedTransactionTypeId: integer
Read Only:
true
Name of the transaction type setup on the business unit from which the fee instance is inheriting the values. -
InheritedTransactionTypeName: string
Read Only:
true
Maximum Length:255
Flag to indicate if the accounts receivable attributes for the fees should be inherited from the business unit setup or not. -
InheritOptionFlag: boolean
Maximum Length:
1
Default Value:false
Unique identifier of the transaction source setup on the fee instance. -
LastUpdateDate: string
(date-time)
Read Only:
true
Last updated date of the fee record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MemoLineId: integer
(int64)
Unique identifier of the memo line setup on the fee instance.
-
MemoLineName: string
Title:
Memo Line Name
Maximum Length:50
Name of the memo line setup on the fee instance. -
StartDate: string
(date)
Start date of the fee instance.
-
tagAssignments: array
Tag Assignments
Title:
Tag Assignments
Tags provide a way to classify, group, or process fees as well as report on fee transactions. -
TransactionTypeId: integer
(int64)
Unique identifier of the transaction type setup on the fee instance.
-
TransactionTypeName: string
Title:
Transaction Type Name
Maximum Length:20
Name of the transaction type setup on the fee instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Tag Assignments
Type:
array
Title:
Tag Assignments
Tags provide a way to classify, group, or process fees as well as report on fee transactions.
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.
Nested Schema : hedFeeInstances-tagAssignments-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TagAssignmentId: integer
(int64)
Title:
Tag Assignment ID
Unique identifier of the assignment of a tag to the fee. -
TagCode: string
Title:
Tag Code
Maximum Length:30
Code of a tag assigned to a fee. -
TagId: integer
(int64)
Title:
Tag ID
Unique identifier of a tag assigned to the fee. -
TagName: string
Title:
Tag Name
Read Only:true
Maximum Length:64
Name of a tag assigned to a fee.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source