Jump to

• Request
• Response

Get a fee instance

get

/fscmRestApi/resources/11.13.18.05/hedFeeInstances/{FeeInstanceId}

Request

Path Parameters

• FeeInstanceId(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=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context: string
  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: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

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

Body ()

Root Schema : hedFeeInstances-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active Flag

  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
  Title: Allow Discount

  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)
  Title: Transaction Source ID

  Unique identifier of the batch transaction source setup on the fee instance.
• BatchSourceSequenceName: string
  Title: Transaction Source

  Maximum Length: 255

  Name of the batch transaction source setup on the fee instance.
• BusinessUnitActiveFlag: boolean
  Title: Status

  Read Only: true

  Maximum Length: 1

  Flag to indicate if the business unit is active.
• BusinessUnitDescription: string
  Title: Academic Business Unit Description

  Read Only: true

  Maximum Length: 255

  Description of the business unit.
• BusinessUnitId: integer
  Title: Academic Business Unit Assignment Details

  Unique identifier of the business unit.
• BusinessUnitName: string
  Title: Business Unit

  Maximum Length: 255

  Name of the business unit.
• CreditTransactionTypeId: integer (int64)
  Title: Credit Transaction Type ID

  Unique identifier of the credit transaction type setup on the fee instance.
• CreditTransactionTypeName: string
  Title: Credit Transaction Type

  Maximum Length: 20

  Name of the credit transaction type setup on the fee instance.
• CurrencyCode: string
  Title: Currency

  Read Only: true

  Maximum Length: 15

  The currency code associated with the fees.
• CurrencySymbol: string
  Title: Currency Symbol

  Read Only: true

  Maximum Length: 255

  The currency symbol associated with the fees.
• DeletableFlag: boolean
  Title: Delete Flag

  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)
  Title: Instance End Date

  End date of the fee instance.
• FeeAtrrStatusCode: string
  Title: Status Code

  Read Only: true

  Maximum Length: 255

  Fee instance status code.
• FeeAtrrStatusMeaning: string
  Title: Status Meaning

  Read Only: true

  Maximum Length: 255

  Fee instance status meaning.
• FeeCode: string
  Title: Fee Code

  Maximum Length: 30

  Code of fee instance.
• FeeDescription: string
  Title: Description

  Maximum Length: 240

  Description of the fee.
• FeeId: integer (int64)
  Title: Fee ID

  Unique identifier of the fee.
• FeeInstanceCode: string
  Title: Instance Code

  Maximum Length: 30

  Code of the fees.
• FeeInstanceCodeLockFlag: boolean
  Title: Fee Instance Code Lock Flag

  Read Only: true

  Maximum Length: 1

  Default Value: false

  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.
• FeeInstanceId: integer (int64)
  Title: Fee Attribute ID

  Read Only: true

  Unique identifier of the fee instance.
• FeeName: string
  Title: Fee Name

  Maximum Length: 50

  Name of the fee.
• FeeTypeCode: string
  Title: Fee Type Code

  Maximum Length: 30

  Code of the fee type.
• FeeTypeId: integer
  Title: Fee Type

  Unique identifier of the fee type.
• FeeTypeName: string
  Title: Fee Type Name

  Read Only: true

  Maximum Length: 50

  Name of the fee type.
• FlatAmount: number
  Title: Amount

  Default Value: 0

  The amount setup for the fee instance.
• InheritedBatchSourceSequenceId: integer
  Title: Transaction Source ID

  Read Only: true

  Name of the transaction source setup on the fee instance.
• InheritedBatchSourceSequenceName: string
  Title: Transaction Source

  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
  Title: Credit Transaction Type ID

  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
  Title: Credit Transaction Type

  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
  Title: Memo Line ID

  Read Only: true

  Name of the memo line setup on the business unit from which the fee instance is inheriting the values.
• InheritedMemoLineName: string
  Title: Memo Line Name

  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
  Title: Transaction Type ID

  Read Only: true

  Name of the transaction type setup on the business unit from which the fee instance is inheriting the values.
• InheritedTransactionTypeName: string
  Title: Transaction Type Name

  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
  Title: Inherit Option Flag

  Maximum Length: 1

  Default Value: false

  Unique identifier of the transaction source setup on the fee instance.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  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)
  Title: Memo Line

  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)
  Title: Instance Start 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)
  Title: Transaction Type ID

  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.

{
    "type":"object",
    "properties":{
        "TransactionTypeName":{
            "title":"Transaction Type Name",
            "maxLength":20,
            "type":"string",
            "description":"Name of the transaction type setup on the fee instance.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "tagAssignments":{
            "title":"Tag Assignments",
            "type":"array",
            "description":"Tags provide a way to classify, group, or process fees as well as report on fee transactions.",
            "items":{
                "$ref":"#/components/schemas/hedFeeInstances-tagAssignments-item-response"
            }
        },
        "AllowDiscountFlag":{
            "title":"Allow Discount",
            "maxLength":1,
            "type":"boolean",
            "description":"Flag to indicate if discount is allowed for the fee or not. If set to yes, discount is allowed.",
            "nullable":false,
            "x-queryable":true
        },
        "BusinessUnitDescription":{
            "title":"Academic Business Unit Description",
            "maxLength":255,
            "type":"string",
            "description":"Description of the business unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InheritedTransactionTypeId":{
            "title":"Transaction Type ID",
            "type":"integer",
            "description":"Name of the transaction type setup on the business unit from which the fee instance is inheriting the values.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BatchSourceSequenceId":{
            "title":"Transaction Source ID",
            "type":"integer",
            "description":"Unique identifier of the batch transaction source setup on the fee instance.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "BatchSourceSequenceName"
                ]
            },
            "x-queryable":true
        },
        "FeeAtrrStatusMeaning":{
            "title":"Status Meaning",
            "maxLength":255,
            "type":"string",
            "description":"Fee instance status meaning.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeTypeCode":{
            "title":"Fee Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of the fee type.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TransactionTypeId":{
            "title":"Transaction Type ID",
            "type":"integer",
            "description":"Unique identifier of the transaction type setup on the fee instance.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DeletableFlag":{
            "title":"Delete Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"Flag to indicate if the fee instance can be deleted. If set to yes, delete is allowed, else it's not allowed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "FeeInstanceId",
                    "FeeId"
                ]
            }
        },
        "CurrencySymbol":{
            "title":"Currency Symbol",
            "maxLength":255,
            "type":"string",
            "description":"The currency symbol associated with the fees.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeCode":{
            "title":"Fee Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of fee instance.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "FeeId"
                ]
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency code associated with the fees.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeName":{
            "title":"Fee Name",
            "maxLength":50,
            "type":"string",
            "description":"Name of the fee.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Instance Start Date",
            "type":"string",
            "description":"Start date of the fee instance.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "MemoLineName":{
            "title":"Memo Line Name",
            "maxLength":50,
            "type":"string",
            "description":"Name of the memo line setup on the fee instance.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "InheritedBatchSourceSequenceName":{
            "title":"Transaction Source",
            "maxLength":255,
            "type":"string",
            "description":"Unique identifier of the credit transaction type setup on the business unit from which the fee instance is inheriting the values.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeInstanceCode":{
            "title":"Instance Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of the fees.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BusinessUnitName":{
            "title":"Business Unit",
            "maxLength":255,
            "type":"string",
            "description":"Name of the business unit.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "FeeAtrrStatusCode":{
            "title":"Status Code",
            "maxLength":255,
            "type":"string",
            "description":"Fee instance status code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InheritedMemoLineName":{
            "title":"Memo Line Name",
            "maxLength":255,
            "type":"string",
            "description":"Unique identifier of the transaction source setup on the business unit from which the fee instance is inheriting the values.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MemoLineId":{
            "title":"Memo Line",
            "type":"integer",
            "description":"Unique identifier of the memo line setup on the fee instance.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FeeTypeName":{
            "title":"Fee Type Name",
            "maxLength":50,
            "type":"string",
            "description":"Name of the fee type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InheritedMemoLineId":{
            "title":"Memo Line ID",
            "type":"integer",
            "description":"Name of the memo line setup on the business unit from which the fee instance is inheriting the values.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FlatAmount":{
            "title":"Amount",
            "type":"number",
            "description":"The amount setup for the fee instance.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "BusinessUnitActiveFlag":{
            "title":"Status",
            "maxLength":1,
            "type":"boolean",
            "description":"Flag to indicate if the business unit is active.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessUnitId":{
            "title":"Academic Business Unit Assignment Details",
            "type":"integer",
            "description":"Unique identifier of the business unit.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "BusinessUnitName"
                ]
            },
            "x-queryable":true
        },
        "FeeId":{
            "title":"Fee ID",
            "type":"integer",
            "description":"Unique identifier of the fee.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BatchSourceSequenceName":{
            "title":"Transaction Source",
            "maxLength":255,
            "type":"string",
            "description":"Name of the batch transaction source setup on the fee instance.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "CreditTransactionTypeId":{
            "title":"Credit Transaction Type ID",
            "type":"integer",
            "description":"Unique identifier of the credit transaction type setup on the fee instance.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FeeInstanceId":{
            "title":"Fee Attribute ID",
            "type":"integer",
            "description":"Unique identifier of the fee instance.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "FeeTypeId":{
            "title":"Fee Type",
            "type":"integer",
            "description":"Unique identifier of the fee type.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "FeeTypeCode"
                ]
            },
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"Flag to indicate if the fee is active or inactive. If yes, the fee is active, else it's inactive.",
            "nullable":false,
            "x-queryable":true
        },
        "EndDate":{
            "title":"Instance End Date",
            "type":"string",
            "description":"End date of the fee instance.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CreditTransactionTypeName":{
            "title":"Credit Transaction Type",
            "maxLength":20,
            "type":"string",
            "description":"Name of the credit transaction type setup on the fee instance.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "InheritedTransactionTypeName":{
            "title":"Transaction Type Name",
            "maxLength":255,
            "type":"string",
            "description":"Flag to indicate if the accounts receivable attributes for the fees should be inherited from the business unit setup or not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeInstanceCodeLockFlag":{
            "title":"Fee Instance Code Lock Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "FeeDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the fee.",
            "nullable":false,
            "x-queryable":true
        },
        "InheritedCreditTransactionTypeName":{
            "title":"Credit Transaction Type",
            "maxLength":255,
            "type":"string",
            "description":"Unique identifier of the memo line setup on the business unit from which the fee instance is inheriting the values.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InheritedCreditTransactionTypeId":{
            "title":"Credit Transaction Type ID",
            "type":"integer",
            "description":"Name of the credit transaction type setup on the business unit from which the fee instance is inheriting the values.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InheritOptionFlag":{
            "title":"Inherit Option Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"Unique identifier of the transaction source setup on the fee instance.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Last updated date of the fee record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InheritedBatchSourceSequenceId":{
            "title":"Transaction Source ID",
            "type":"integer",
            "description":"Name of the transaction source setup on the fee instance.",
            "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 : 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

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

{
    "title":"Tag Assignments",
    "type":"array",
    "description":"Tags provide a way to classify, group, or process fees as well as report on fee transactions.",
    "items":{
        "$ref":"#/components/schemas/hedFeeInstances-tagAssignments-item-response"
    }
}

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 : hedFeeInstances-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 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.

{
    "type":"object",
    "properties":{
        "TagId":{
            "title":"Tag ID",
            "type":"integer",
            "description":"Unique identifier of a tag assigned to the fee.",
            "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 a tag to the fee.",
            "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":"Code of a tag assigned to a fee.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TagName":{
            "title":"Tag Name",
            "maxLength":64,
            "type":"string",
            "description":"Name of a tag assigned to a fee.",
            "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

batchSourceSequencesLOV

Operation: /fscmRestApi/resources/11.13.18.05/hedTransactionSourcesLOV

Parameters:

• finder: FindByBusinessUnit%3BBusinessUnitId%3D{BusinessUnitId}%2CStudentManagementTransactionNumberingFlag%3D{GenerateTransactionNumberFlag}

The following properties are defined on the LOV link relation:

• Source Attribute: BatchSourceSequenceName; Target Attribute: BatchSourceName
• Display Attribute: BatchSourceName

feeTypesLOV

Operation: /fscmRestApi/resources/11.13.18.05/feeTypesLOV

The following properties are defined on the LOV link relation:

• Source Attribute: FeeTypeCode; Target Attribute: FeeTypeCode
• Display Attribute: FeeTypeName

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

studentMemoLinesLOV

Operation: /fscmRestApi/resources/11.13.18.05/studentMemoLinesLOV

Parameters:

• finder: ByBusinessUnitFinder%3BBusinessUnitName%3D{BusinessUnitName}

The following properties are defined on the LOV link relation:

• Source Attribute: MemoLineName; Target Attribute: MemoLineName
• Display Attribute: MemoLineName

studentTransactionTypesLOV

Operation: /fscmRestApi/resources/11.13.18.05/studentTransactionTypesLOV

Parameters:

• finder: CreditMemoTransactionTypeFinder%3BBusinessUnitName%3D{BusinessUnitName}

The following properties are defined on the LOV link relation:

• Source Attribute: CreditTransactionTypeName; Target Attribute: TransactionTypeName
• Display Attribute: TransactionTypeName

tagAssignments

Operation: /fscmRestApi/resources/11.13.18.05/hedFeeInstances/{FeeInstanceId}/child/tagAssignments

Parameters:

• FeeInstanceId: $request.path.FeeInstanceId

Tags provide a way to classify, group, or process fees as well as report on fee transactions.

Back to Top