Create a fee group
post
/fscmRestApi/resources/11.13.18.05/feeGroups
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
BusinessUnitId(required): integer
(int64)
Unique identifier of the business unit.
-
BusinessUnitName: string
Name of the business unit.
-
EndDate: string
(date)
Date when the fee group's validity ends.
-
feeDetails: array
Fee Details
Title:
Fee Details
The fee details resource is used to associate the fees with the fee group. -
FeeGroupCode(required): string
Maximum Length:
30
Unique user-defined code of the fee group. -
FeeGroupName(required): string
Maximum Length:
50
Unique user-defined name of the fee group. -
FeeGroupTypeCode: string
Maximum Length:
30
Default Value:ORA_HES_TUITION_CALCULATION
Unique code for the fee group type. A list of accepted values is defined in the lookup type ORA_HES_FEE_GROUP_TYPE. Review and update the list of values in the Setup and Maintenance work area, Manage Student Management Lookups task. -
Notes: string
Maximum Length:
240
User-defined notes about the fee group. -
Priority: integer
(int32)
Default Value:
9999
Priority of the fee group. -
StartDate(required): string
(date)
Date from when the fee group is active.
Nested Schema : Fee Details
Type:
array
Title:
Fee Details
The fee details resource is used to associate the fees with the fee group.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
FeeCode: string
Maximum Length:
30
Unique user-defined fee code. -
FeeId: integer
(int64)
Unique identifier of the fee associated with the fee group.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : feeGroups-item-response
Type:
Show Source
object
-
BusinessUnitId: integer
(int64)
Unique identifier of the business unit.
-
BusinessUnitName: string
Name of the business unit.
-
EndDate: string
(date)
Date when the fee group's validity ends.
-
feeDetails: array
Fee Details
Title:
Fee Details
The fee details resource is used to associate the fees with the fee group. -
FeeGroupCode: string
Maximum Length:
30
Unique user-defined code of the fee group. -
FeeGroupId: integer
(int64)
Read Only:
true
Unique identifier of the fee group. -
FeeGroupName: string
Maximum Length:
50
Unique user-defined name of the fee group. -
FeeGroupTypeCode: string
Maximum Length:
30
Default Value:ORA_HES_TUITION_CALCULATION
Unique code for the fee group type. A list of accepted values is defined in the lookup type ORA_HES_FEE_GROUP_TYPE. Review and update the list of values in the Setup and Maintenance work area, Manage Student Management Lookups task. -
FeeGroupTypeMeaning: string
Read Only:
true
Maximum Length:80
Name of the fee group type. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Notes: string
Maximum Length:
240
User-defined notes about the fee group. -
Priority: integer
(int32)
Default Value:
9999
Priority of the fee group. -
StartDate: string
(date)
Date from when the fee group is active.
Nested Schema : Fee Details
Type:
array
Title:
Fee Details
The fee details resource is used to associate the fees with the fee group.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : feeGroups-feeDetails-item-response
Type:
Show Source
object
-
FeeCode: string
Maximum Length:
30
Unique user-defined fee code. -
FeeDescription: string
Read Only:
true
Maximum Length:240
Description of the fee. -
FeeDetailId: integer
(int64)
Read Only:
true
Unique identifier of the fee detail. -
FeeId: integer
(int64)
Unique identifier of the fee associated with the fee group.
-
FeeName: string
Read Only:
true
Maximum Length:50
Name of the fee. -
FeeTypeCode: string
Title:
Fee Type Code
Read Only:true
Maximum Length:30
Unique code of the fee attribute type. A list of accepted values is defined in the lookup type ORA_HES_FEE_ATTRIBUTE_TYPE. Review and update the list of values in the Setup and Maintenance work area, Manage Student Management Lookups task. -
FeeTypeName: string
Title:
Fee Type Name
Read Only:true
Maximum Length:50
Name of the fee type. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
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.
Links
- feeDetails
-
Parameters:
- FeeGroupId:
$request.path.FeeGroupId
The fee details resource is used to associate the fees with the fee group. - FeeGroupId:
- feeGroupTypesLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HES_FEE_GROUP_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: FeeGroupTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- studentFinancialSystemConfigurationsLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: BusinessUnitName; Target Attribute: Name
- Display Attribute: Name