Jump to

• Request
• Response

Update a fee group

patch

/fscmRestApi/resources/11.13.18.05/feeGroups/{FeeGroupId}

Request

Path Parameters

• FeeGroupId(required): integer(int64)
  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=

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ActiveFlag: boolean
  Maximum Length: 1

  Default Value: true

  Indicates if a fee group is active or inactive. If set to Yes, the fee group is active.
• EndDate: string (date)
  Date when the fee group's validity ends.
• feeCriterias: array Fee Criteria
  Title: Fee Criteria

  Criteria that determines fee attribute values that are used to dynamically retrieve fees into a list.
• feeDetails: array Fee Details
  Title: Fee Details

  The fee details resource is used to associate the fees with the fee group.
• FeeGroupName: string
  Maximum Length: 50

  Unique user-defined name of the fee group.
• feeGroupStructures: array Grouping Structures
  Title: Grouping Structures

  Fee group structures define the method in which fees are grouped in a list.
• 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.
• feeLists: array Fee Lists
  Title: Fee Lists

  Fees added to a list.
• 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.
• tagAssignments: array Tag Assignments
  Title: Tag Assignments

  Tags assigned to a fee list.

{
    "type":"object",
    "properties":{
        "StartDate":{
            "type":"string",
            "description":"Date from when the fee group is active.",
            "format":"date",
            "nullable":true
        },
        "feeGroupStructures":{
            "title":"Grouping Structures",
            "type":"array",
            "description":"Fee group structures define the method in which fees are grouped in a list.",
            "items":{
                "$ref":"#/components/schemas/feeGroups-feeGroupStructures-item-patch-request"
            }
        },
        "tagAssignments":{
            "title":"Tag Assignments",
            "type":"array",
            "description":"Tags assigned to a fee list.",
            "items":{
                "$ref":"#/components/schemas/feeGroups-tagAssignments-item-patch-request"
            }
        },
        "FeeGroupTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "default":"ORA_HES_TUITION_CALCULATION",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "FeeGroupName":{
            "maxLength":50,
            "type":"string",
            "description":"Unique user-defined name of the fee group.",
            "nullable":false
        },
        "Priority":{
            "type":"integer",
            "description":"Priority of the fee group.",
            "format":"int32",
            "nullable":true,
            "default":9999,
            "x-hints":{
                "precision":4
            }
        },
        "feeDetails":{
            "title":"Fee Details",
            "type":"array",
            "description":"The fee details resource is used to associate the fees with the fee group.",
            "items":{
                "$ref":"#/components/schemas/feeGroups-feeDetails-item-patch-request"
            }
        },
        "feeLists":{
            "title":"Fee Lists",
            "type":"array",
            "description":"Fees added to a list.",
            "items":{
                "$ref":"#/components/schemas/feeGroups-feeLists-item-patch-request"
            }
        },
        "ActiveFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if a fee group is active or inactive. If set to Yes, the fee group is active.",
            "nullable":false,
            "default":true
        },
        "EndDate":{
            "type":"string",
            "description":"Date when the fee group's validity ends.",
            "format":"date",
            "nullable":true
        },
        "Notes":{
            "maxLength":240,
            "type":"string",
            "description":"User-defined notes about the fee group.",
            "nullable":true
        },
        "feeCriterias":{
            "title":"Fee Criteria",
            "type":"array",
            "description":"Criteria that determines fee attribute values that are used to dynamically retrieve fees into a list.",
            "items":{
                "$ref":"#/components/schemas/feeGroups-feeCriterias-item-patch-request"
            }
        }
    }
}

Nested Schema : Fee Criteria

Type: array

Title: Fee Criteria

Criteria that determines fee attribute values that are used to dynamically retrieve fees into a list.

Show Source

• Array of: object feeGroups-feeCriterias-item-patch-request

{
    "title":"Fee Criteria",
    "type":"array",
    "description":"Criteria that determines fee attribute values that are used to dynamically retrieve fees into a list.",
    "items":{
        "$ref":"#/components/schemas/feeGroups-feeCriterias-item-patch-request"
    }
}

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

• Array of: object feeGroups-feeDetails-item-patch-request

{
    "title":"Fee Details",
    "type":"array",
    "description":"The fee details resource is used to associate the fees with the fee group.",
    "items":{
        "$ref":"#/components/schemas/feeGroups-feeDetails-item-patch-request"
    }
}

Nested Schema : Grouping Structures

Type: array

Title: Grouping Structures

Fee group structures define the method in which fees are grouped in a list.

Show Source

• Array of: object feeGroups-feeGroupStructures-item-patch-request

{
    "title":"Grouping Structures",
    "type":"array",
    "description":"Fee group structures define the method in which fees are grouped in a list.",
    "items":{
        "$ref":"#/components/schemas/feeGroups-feeGroupStructures-item-patch-request"
    }
}

Nested Schema : Fee Lists

Type: array

Title: Fee Lists

Fees added to a list.

Show Source

• Array of: object feeGroups-feeLists-item-patch-request

{
    "title":"Fee Lists",
    "type":"array",
    "description":"Fees added to a list.",
    "items":{
        "$ref":"#/components/schemas/feeGroups-feeLists-item-patch-request"
    }
}

Nested Schema : Tag Assignments

Type: array

Title: Tag Assignments

Tags assigned to a fee list.

Show Source

• Array of: object feeGroups-tagAssignments-item-patch-request

{
    "title":"Tag Assignments",
    "type":"array",
    "description":"Tags assigned to a fee list.",
    "items":{
        "$ref":"#/components/schemas/feeGroups-tagAssignments-item-patch-request"
    }
}

Nested Schema : feeGroups-feeCriterias-item-patch-request

Type: object

Show Source

• FeeCriteriaCode: string
  Title: Fee Criteria Code

  Maximum Length: 30

  Name of the fee criteria.
• FeeCriteriaId: integer (int64)
  Title: Fee Criteria ID

  Unique identifier of the fee criteria.

{
    "type":"object",
    "properties":{
        "FeeCriteriaId":{
            "title":"Fee Criteria ID",
            "type":"integer",
            "description":"Unique identifier of the fee criteria.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "FeeCriteriaCode":{
            "title":"Fee Criteria Code",
            "maxLength":30,
            "type":"string",
            "description":"Name of the fee criteria.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Nested Schema : feeGroups-feeDetails-item-patch-request

Type: object

Show Source

• FeeCode: string
  Maximum Length: 30

  Unique user-defined fee code.
• FeeId: integer (int64)
  Unique identifier of the fee associated with the fee group.

{
    "type":"object",
    "properties":{
        "FeeId":{
            "type":"integer",
            "description":"Unique identifier of the fee associated with the fee group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "FeeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Unique user-defined fee code.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Nested Schema : feeGroups-feeGroupStructures-item-patch-request

Type: object

Show Source

• Description: string
  Title: Description

  Maximum Length: 1000

  Description of the fee group structure.
• Name(required): string
  Title: Name

  Maximum Length: 50

  Name of the fee group structure.
• ParentFeeGroupStructureId: integer
  Title: Parent Fee Item ID

  Parent fee of a fee in a fee group.
• Sequence(required): integer
  Title: Fee List Sequence

  Sequence number of the fee group structure.
• structureDetails: array Structure Details
  Title: Structure Details

  Details about the fee group structure, such as name and description.

{
    "required":[
        "Name",
        "Sequence"
    ],
    "type":"object",
    "properties":{
        "structureDetails":{
            "title":"Structure Details",
            "type":"array",
            "description":"Details about the fee group structure, such as name and description.",
            "items":{
                "$ref":"#/components/schemas/feeGroups-feeGroupStructures-structureDetails-item-patch-request"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"Description of the fee group structure.",
            "nullable":true
        },
        "ParentFeeGroupStructureId":{
            "title":"Parent Fee Item ID",
            "type":"integer",
            "description":"Parent fee of a fee in a fee group.",
            "nullable":true
        },
        "Sequence":{
            "title":"Fee List Sequence",
            "type":"integer",
            "description":"Sequence number of the fee group structure.",
            "nullable":false
        },
        "Name":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"Name of the fee group structure.",
            "nullable":false
        }
    }
}

Nested Schema : Structure Details

Type: array

Title: Structure Details

Details about the fee group structure, such as name and description.

Show Source

• Array of: object schema

{
    "title":"Structure Details",
    "type":"array",
    "description":"Details about the fee group structure, such as name and description.",
    "items":{
        "$ref":"#/components/schemas/feeGroups-feeGroupStructures-structureDetails-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• Sequence: integer
  Title: Structure Detail Sequence

  Sequence number of the fee item within a fee group.
• SourceObjectCode: string
  Title: Source Object Code

  Maximum Length: 30

  Code of the source object.
• SourceObjectId: integer
  Title: Source Object ID

  Unique identifier of the source object detail.

{
    "type":"object",
    "properties":{
        "SourceObjectId":{
            "title":"Source Object ID",
            "type":"integer",
            "description":"Unique identifier of the source object detail.",
            "nullable":false
        },
        "Sequence":{
            "title":"Structure Detail Sequence",
            "type":"integer",
            "description":"Sequence number of the fee item within a fee group.",
            "nullable":false
        },
        "SourceObjectCode":{
            "title":"Source Object Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of the source object.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Nested Schema : feeGroups-feeLists-item-patch-request

Type: object

Show Source

• FeeGroupCode: string
  Title: Fee List Code

  Maximum Length: 30

  Unique user-defined code of the fee group.
• FeeGroupId: integer (int64)
  Title: Fee List ID

  Unique identifier of the fee group.

{
    "type":"object",
    "properties":{
        "FeeGroupId":{
            "title":"Fee List ID",
            "type":"integer",
            "description":"Unique identifier of the fee group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "FeeGroupCode":{
            "title":"Fee List Code",
            "maxLength":30,
            "type":"string",
            "description":"Unique user-defined code of the fee group.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Nested Schema : feeGroups-tagAssignments-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Back to Top

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.

Body ()

Root Schema : feeGroups-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Maximum Length: 1

  Default Value: true

  Indicates if a fee group is active or inactive. If set to Yes, the fee group is active.
• BusinessUnitId: integer (int64)
  Default Value: 204

  Unique identifier of the business unit.
• BusinessUnitName: string
  Name of the business unit.
• EndDate: string (date)
  Date when the fee group's validity ends.
• feeCriterias: array Fee Criteria
  Title: Fee Criteria

  Criteria that determines fee attribute values that are used to dynamically retrieve fees into a list.
• 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.
• feeGroupStructures: array Grouping Structures
  Title: Grouping Structures

  Fee group structures define the method in which fees are grouped in a list.
• 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.
• feeLists: array Fee Lists
  Title: Fee Lists

  Fees added to a list.
• LastUpdateDate: string (date-time)
  Read Only: true

  Last Update Date
• 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.
• tagAssignments: array Tag Assignments
  Title: Tag Assignments

  Tags assigned to a fee list.

{
    "type":"object",
    "properties":{
        "feeGroupStructures":{
            "title":"Grouping Structures",
            "type":"array",
            "description":"Fee group structures define the method in which fees are grouped in a list.",
            "items":{
                "$ref":"#/components/schemas/feeGroups-feeGroupStructures-item-response"
            }
        },
        "tagAssignments":{
            "title":"Tag Assignments",
            "type":"array",
            "description":"Tags assigned to a fee list.",
            "items":{
                "$ref":"#/components/schemas/feeGroups-tagAssignments-item-response"
            }
        },
        "Priority":{
            "type":"integer",
            "description":"Priority of the fee group.",
            "format":"int32",
            "nullable":true,
            "default":9999,
            "x-hints":{
                "precision":4
            },
            "x-queryable":true
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"Unique identifier of the business unit.",
            "format":"int64",
            "nullable":true,
            "default":204,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "feeLists":{
            "title":"Fee Lists",
            "type":"array",
            "description":"Fees added to a list.",
            "items":{
                "$ref":"#/components/schemas/feeGroups-feeLists-item-response"
            }
        },
        "FeeGroupCode":{
            "maxLength":30,
            "type":"string",
            "description":"Unique user-defined code of the fee group.",
            "nullable":false,
            "x-queryable":true
        },
        "ActiveFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if a fee group is active or inactive. If set to Yes, the fee group is active.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"Date when the fee group's validity ends.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "FeeGroupTypeMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the fee group type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Date from when the fee group is active.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "FeeGroupTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "default":"ORA_HES_TUITION_CALCULATION",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "FeeGroupId":{
            "type":"integer",
            "description":"Unique identifier of the fee group.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "FeeGroupName":{
            "maxLength":50,
            "type":"string",
            "description":"Unique user-defined name of the fee group.",
            "nullable":false,
            "x-queryable":true
        },
        "feeDetails":{
            "title":"Fee Details",
            "type":"array",
            "description":"The fee details resource is used to associate the fees with the fee group.",
            "items":{
                "$ref":"#/components/schemas/feeGroups-feeDetails-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BusinessUnitName":{
            "type":"string",
            "description":"Name of the business unit.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Notes":{
            "maxLength":240,
            "type":"string",
            "description":"User-defined notes about the fee group.",
            "nullable":true,
            "x-queryable":true
        },
        "feeCriterias":{
            "title":"Fee Criteria",
            "type":"array",
            "description":"Criteria that determines fee attribute values that are used to dynamically retrieve fees into a list.",
            "items":{
                "$ref":"#/components/schemas/feeGroups-feeCriterias-item-response"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Last Update Date",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Fee Criteria

Type: array

Title: Fee Criteria

Criteria that determines fee attribute values that are used to dynamically retrieve fees into a list.

Show Source

• Array of: object feeGroups-feeCriterias-item-response

{
    "title":"Fee Criteria",
    "type":"array",
    "description":"Criteria that determines fee attribute values that are used to dynamically retrieve fees into a list.",
    "items":{
        "$ref":"#/components/schemas/feeGroups-feeCriterias-item-response"
    }
}

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

• Array of: object feeGroups-feeDetails-item-response

{
    "title":"Fee Details",
    "type":"array",
    "description":"The fee details resource is used to associate the fees with the fee group.",
    "items":{
        "$ref":"#/components/schemas/feeGroups-feeDetails-item-response"
    }
}

Nested Schema : Grouping Structures

Type: array

Title: Grouping Structures

Fee group structures define the method in which fees are grouped in a list.

Show Source

• Array of: object feeGroups-feeGroupStructures-item-response

{
    "title":"Grouping Structures",
    "type":"array",
    "description":"Fee group structures define the method in which fees are grouped in a list.",
    "items":{
        "$ref":"#/components/schemas/feeGroups-feeGroupStructures-item-response"
    }
}

Nested Schema : Fee Lists

Type: array

Title: Fee Lists

Fees added to a list.

Show Source

• Array of: object feeGroups-feeLists-item-response

{
    "title":"Fee Lists",
    "type":"array",
    "description":"Fees added to a list.",
    "items":{
        "$ref":"#/components/schemas/feeGroups-feeLists-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Tag Assignments

Type: array

Title: Tag Assignments

Tags assigned to a fee list.

Show Source

• Array of: object feeGroups-tagAssignments-item-response

{
    "title":"Tag Assignments",
    "type":"array",
    "description":"Tags assigned to a fee list.",
    "items":{
        "$ref":"#/components/schemas/feeGroups-tagAssignments-item-response"
    }
}

Nested Schema : feeGroups-feeCriterias-item-response

Type: object

Show Source

• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 1000

  Description of the fee criteria.
• FeeCriteriaCode: string
  Title: Fee Criteria Code

  Maximum Length: 30

  Name of the fee criteria.
• FeeCriteriaId: integer (int64)
  Title: Fee Criteria ID

  Unique identifier of the fee criteria.
• FeeCriteriaName: string
  Title: Fee Criteria Name

  Read Only: true

  Maximum Length: 50

  User-defined code of the fee criteria.
• FeeGroupCriteriaId: integer (int64)
  Title: Fee List Criteria ID

  Read Only: true

  Unique identifier of the fee list criteria.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "FeeGroupCriteriaId":{
            "title":"Fee List Criteria ID",
            "type":"integer",
            "description":"Unique identifier of the fee list criteria.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"Description of the fee criteria.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeCriteriaCode":{
            "title":"Fee Criteria Code",
            "maxLength":30,
            "type":"string",
            "description":"Name of the fee criteria.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "FeeCriteriaId":{
            "title":"Fee Criteria ID",
            "type":"integer",
            "description":"Unique identifier of the fee criteria.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FeeCriteriaName":{
            "title":"Fee Criteria Name",
            "maxLength":50,
            "type":"string",
            "description":"User-defined code of the fee criteria.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : feeGroups-feeDetails-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "FeeDetailId":{
            "type":"integer",
            "description":"Unique identifier of the fee detail.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "FeeName":{
            "maxLength":50,
            "type":"string",
            "description":"Name of the fee.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "FeeCode"
                ]
            },
            "x-queryable":true
        },
        "FeeTypeName":{
            "title":"Fee Type Name",
            "maxLength":50,
            "type":"string",
            "description":"Name of the fee type.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "FeeId"
                ]
            },
            "x-queryable":true
        },
        "FeeTypeCode":{
            "title":"Fee Type Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "FeeId"
                ]
            },
            "x-queryable":true
        },
        "FeeId":{
            "type":"integer",
            "description":"Unique identifier of the fee associated with the fee group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FeeDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the fee.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "FeeCode"
                ]
            },
            "x-queryable":true
        },
        "FeeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Unique user-defined fee code.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : feeGroups-feeGroupStructures-item-response

Type: object

Show Source

• Description: string
  Title: Description

  Maximum Length: 1000

  Description of the fee group structure.
• FeeGroupStructureId: integer
  Title: Fee List Structure ID

  Read Only: true

  Unique identifier of the fee group structure.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Title: Name

  Maximum Length: 50

  Name of the fee group structure.
• ParentFeeGroupStructureId: integer
  Title: Parent Fee Item ID

  Parent fee of a fee in a fee group.
• Sequence: integer
  Title: Fee List Sequence

  Sequence number of the fee group structure.
• structureDetails: array Structure Details
  Title: Structure Details

  Details about the fee group structure, such as name and description.

{
    "type":"object",
    "properties":{
        "structureDetails":{
            "title":"Structure Details",
            "type":"array",
            "description":"Details about the fee group structure, such as name and description.",
            "items":{
                "$ref":"#/components/schemas/feeGroups-feeGroupStructures-structureDetails-item-response"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"Description of the fee group structure.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ParentFeeGroupStructureId":{
            "title":"Parent Fee Item ID",
            "type":"integer",
            "description":"Parent fee of a fee in a fee group.",
            "nullable":true,
            "x-queryable":true
        },
        "Sequence":{
            "title":"Fee List Sequence",
            "type":"integer",
            "description":"Sequence number of the fee group structure.",
            "nullable":false,
            "x-queryable":true
        },
        "FeeGroupStructureId":{
            "title":"Fee List Structure ID",
            "type":"integer",
            "description":"Unique identifier of the fee group structure.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"Name of the fee group structure.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Structure Details

Type: array

Title: Structure Details

Details about the fee group structure, such as name and description.

Show Source

• Array of: object feeGroups-feeGroupStructures-structureDetails-item-response

{
    "title":"Structure Details",
    "type":"array",
    "description":"Details about the fee group structure, such as name and description.",
    "items":{
        "$ref":"#/components/schemas/feeGroups-feeGroupStructures-structureDetails-item-response"
    }
}

Nested Schema : feeGroups-feeGroupStructures-structureDetails-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Sequence: integer
  Title: Structure Detail Sequence

  Sequence number of the fee item within a fee group.
• SourceObjectCode: string
  Title: Source Object Code

  Maximum Length: 30

  Code of the source object.
• SourceObjectId: integer
  Title: Source Object ID

  Unique identifier of the source object detail.
• SourceObjectMeaning: string
  Title: Source Object Meaning

  Read Only: true

  Maximum Length: 80

  Meaning of the source object.
• StructureDetailId: integer
  Title: Fee Structure Detail ID

  Read Only: true

  Unique identifier of the fee group structure detail.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SourceObjectId":{
            "title":"Source Object ID",
            "type":"integer",
            "description":"Unique identifier of the source object detail.",
            "nullable":false,
            "x-queryable":true
        },
        "Sequence":{
            "title":"Structure Detail Sequence",
            "type":"integer",
            "description":"Sequence number of the fee item within a fee group.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceObjectMeaning":{
            "title":"Source Object Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the source object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceObjectCode":{
            "title":"Source Object Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of the source object.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StructureDetailId":{
            "title":"Fee Structure Detail ID",
            "type":"integer",
            "description":"Unique identifier of the fee group structure detail.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : feeGroups-feeLists-item-response

Type: object

Show Source

• FeeGroupCode: string
  Title: Fee List Code

  Maximum Length: 30

  Unique user-defined code of the fee group.
• FeeGroupId: integer (int64)
  Title: Fee List ID

  Unique identifier of the fee group.
• FeeGroupListId: integer (int64)
  Title: Fee Group List ID

  Read Only: true

  Unique identifier of the fee group.
• FeeGroupName: string
  Title: Fee List Name

  Read Only: true

  Maximum Length: 50

  Unique user-defined name of the fee group.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Notes: string
  Title: Notes

  Read Only: true

  Maximum Length: 240

  User-defined notes about the fee group.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FeeGroupCode":{
            "title":"Fee List Code",
            "maxLength":30,
            "type":"string",
            "description":"Unique user-defined code of the fee group.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "FeeGroupId":{
            "title":"Fee List ID",
            "type":"integer",
            "description":"Unique identifier of the fee group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FeeGroupName":{
            "title":"Fee List Name",
            "maxLength":50,
            "type":"string",
            "description":"Unique user-defined name of the fee group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeGroupListId":{
            "title":"Fee Group List ID",
            "type":"integer",
            "description":"Unique identifier of the fee group.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Notes":{
            "title":"Notes",
            "maxLength":240,
            "type":"string",
            "description":"User-defined notes about the fee group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : feeGroups-tagAssignments-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• TagAssignmentId: integer (int64)
  Title: Tag Assignment ID

  Read Only: true

  Unique identifier of the assignment of the tag.
• TagCode: string
  Title: Tag Code

  Maximum Length: 30

  User-defined code of the assigned tag.
• TagId: integer (int64)
  Title: Tag ID

  Unique identifier of the assigned tag.
• TagName: string
  Title: Tag Name

  Read Only: true

  Maximum Length: 64

  Name of the assigned tag.

{
    "type":"object",
    "properties":{
        "TagId":{
            "title":"Tag ID",
            "type":"integer",
            "description":"Unique identifier of the assigned tag.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TagAssignmentId":{
            "title":"Tag Assignment ID",
            "type":"integer",
            "description":"Unique identifier of the assignment of the tag.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "TagCode":{
            "title":"Tag Code",
            "maxLength":30,
            "type":"string",
            "description":"User-defined code of the assigned tag.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TagName":{
            "title":"Tag Name",
            "maxLength":64,
            "type":"string",
            "description":"Name of the assigned tag.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

feeCriterias

Operation: /fscmRestApi/resources/11.13.18.05/feeGroups/{FeeGroupId}/child/feeCriterias

Parameters:

• FeeGroupId: $request.path.FeeGroupId

Criteria that determines fee attribute values that are used to dynamically retrieve fees into a list.

feeDetails

Operation: /fscmRestApi/resources/11.13.18.05/feeGroups/{FeeGroupId}/child/feeDetails

Parameters:

• FeeGroupId: $request.path.FeeGroupId

The fee details resource is used to associate the fees with the fee group.

feeGroupStructures

Operation: /fscmRestApi/resources/11.13.18.05/feeGroups/{FeeGroupId}/child/feeGroupStructures

Parameters:

• FeeGroupId: $request.path.FeeGroupId

Fee group structures define the method in which fees are grouped in a list.

feeGroupTypesLOV

Operation: /fscmRestApi/resources/11.13.18.05/genericLookupsLOV

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

feeLists

Operation: /fscmRestApi/resources/11.13.18.05/feeGroups/{FeeGroupId}/child/feeLists

Parameters:

• FeeGroupId: $request.path.FeeGroupId

Fees added to a list.

studentFinancialSystemConfigurationsLOV

Operation: /fscmRestApi/resources/11.13.18.05/studentFinancialSystemConfigurationsLOV

The following properties are defined on the LOV link relation:

• Source Attribute: BusinessUnitName; Target Attribute: Name
• Display Attribute: Name

tagAssignments

Operation: /fscmRestApi/resources/11.13.18.05/feeGroups/{FeeGroupId}/child/tagAssignments

Parameters:

• FeeGroupId: $request.path.FeeGroupId

Tags assigned to a fee list.

Back to Top