Get an external fund credit
get
/fscmRestApi/resources/11.13.18.05/studentCreditExternalFunds/{studentCreditExternalFundsUniqID}
Request
Path Parameters
-
studentCreditExternalFundsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the External Fund Credits resource and used to uniquely identify an instance of External Fund Credits. The client should not generate the hash key value. Instead, the client should query on the External Fund Credits collection resource in order to navigate to a specific instance of External Fund Credits to get the hash key.
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:
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(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 : studentCreditExternalFunds-item-response
Type:
Show Source
object
-
BusinessUnitId: integer
(int64)
The unique identifier of the academic business unit.
-
BusinessUnitName: string
Title:
Business Unit
Maximum Length:240
The name of the academic business unit. -
ChargePriorityCode: string
Maximum Length:
30
The unique code of the charge priority mapping rule. -
ChargePriorityId: integer
(int64)
The unique identifier of the charge priority mapping rule.
-
ChargePriorityName: string
Read Only:
true
Maximum Length:50
The name of the charge priority mapping rule. -
CreditCode: string
Maximum Length:
30
The unique code to identify the student credit. -
CreditDescription: string
Maximum Length:
240
The description of the student credit. -
CreditId: integer
(int64)
Read Only:
true
The unique identifier of the student credit. -
CreditName: string
Maximum Length:
50
The name of the student credit. -
CreditReferenceCode: string
Maximum Length:
100
The credit reference code of the student credit. -
CreditReferenceMeaning: string
Read Only:
true
Maximum Length:80
The name of the credit reference code. -
CreditSourceCode: string
Maximum Length:
30
The unique code of the source of credit. -
CreditSourceMeaning: string
Read Only:
true
Maximum Length:80
The name of the source of the credit. -
CurrencyCode: string
Read Only:
true
Maximum Length:15
The currency code associated with the student credit. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumAmount: number
Maximum amount of the credit.
-
MemoLineId: integer
(int64)
The identifier of the memo line assigned to a transaction. The memo line designates a revenue account.
-
MemoLineName: string
Title:
Memo Line Name
Maximum Length:50
The name of the memo line assigned to a transaction. -
periodOverrides: array
Period Overrides
Title:
Period Overrides
The period overrides resource lists all the academic periods that are excluded from the external fund credits. -
Priority: integer
(int32)
Default Value:
9999
The priority in which a credit is processed. -
ReceivableActivityId: integer
(int64)
The identifier of the receivables activity assigned to a transaction.
-
ReceivableActivityName: string
Maximum Length:
50
The name of the receivables activity assigned to a transaction. -
RefundableFlag: boolean
Maximum Length:
1
Indicates whether an excess student credit amount can be refunded. If the value is true, the credit is refundable. -
StatusCode: string
Maximum Length:
30
The activation status of the student credit. -
StatusMeaning: string
Read Only:
true
Maximum Length:80
The activation status name of the student credit. -
TransactionTypeId: integer
(int64)
The transaction type of the student credit setup.
-
TransactionTypeName: string
Title:
Transaction Type Name
Maximum Length:20
The name of the transaction type of the student credit setup.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Period Overrides
Type:
array
Title:
Period Overrides
The period overrides resource lists all the academic periods that are excluded from the external fund credits.
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 : studentCreditExternalFunds-periodOverrides-item-response
Type:
Show Source
object
-
AcademicPeriodEndDate: string
(date)
Title:
End Date
Read Only:true
The end date of the academic period. -
AcademicPeriodId: integer
(int64)
Unique identifier of the academic period.
-
AcademicPeriodName: string
Title:
Period Name
Maximum Length:50
Name of the academic period. -
AcademicPeriodStartDate: string
(date)
Title:
Start Date
Read Only:true
The start date of the academic period. -
CreditPeriodId: integer
(int64)
Unique identifier of the credit period.
-
EndDate: string
(date)
Date when the credit period is archived.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MemoLineId: integer
(int64)
The unique identifier of the memo line used when the credit is posted for the academic period.
-
MemoLineName: string
Title:
Memo Line Name
Maximum Length:50
The name of the memo line. -
ReceivableActivityId: integer
(int64)
Unique identifier of the receivables activity when the credit is posted for the academic period.
-
ReceivableActivityName: string
Maximum Length:
255
The name of the receivables activity assigned to a transaction. -
TransactionTypeId: integer
(int64)
Unique identifier of the transaction type when the credit is posted for the academic period.
-
TransactionTypeName: string
Title:
Transaction Type Name
Maximum Length:20
Name of the transaction type.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- chargePrioritiesLOV
-
Parameters:
- finder:
FindByActiveDateAndBusinessUnit%3BBusinessUnitName%3D{BusinessUnitName}
The following properties are defined on the LOV link relation:- Source Attribute: ChargePriorityCode; Target Attribute: ChargePriorityCode
- Display Attribute: ChargePriorityName
- finder:
- creditReferencesLOV
-
Parameters:
- finder:
LookupTypeFinder%3BApplicationCode%3DHES%2CLookupType%3DORA_CREDIT_REFERENCE%2CLookupCode%3D{CreditReferenceCode}
The following properties are defined on the LOV link relation:- Source Attribute: CreditReferenceCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- creditSourcesLOV
-
Parameters:
- finder:
LookupTypeFinder%3BApplicationCode%3DHES%2CLookupType%3DORA_CREDIT_SOURCE_CODE%2CLookupCode%3D{CreditSourceCode}
The following properties are defined on the LOV link relation:- Source Attribute: CreditSourceCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- memoLinesLOV
-
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
- finder:
- periodOverrides
-
Parameters:
- studentCreditExternalFundsUniqID:
$request.path.studentCreditExternalFundsUniqID
The period overrides resource lists all the academic periods that are excluded from the external fund credits. - studentCreditExternalFundsUniqID:
- receivableActivitiesLOV
-
Parameters:
- finder:
FindByBusinessUnitAndType%3BOrganizationName%3D{BusinessUnitName}%2CType%3DADJUST%2CFINCHRG
The following properties are defined on the LOV link relation:- Source Attribute: ReceivableActivityName; Target Attribute: ReceivableActivityName
- Display Attribute: ReceivableActivityName
- finder:
- statusesLOV
-
Parameters:
- finder:
LookupTypeFinder%3BApplicationCode%3DHES%2CLookupType%3DORA_HES_CREDIT_STATUS_CODE%2CLookupCode%3D{StatusCode}
The following properties are defined on the LOV link relation:- Source Attribute: StatusCode; 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
- transactionTypesLOV
-
Parameters:
- finder:
CreditMemoTransactionTypeFinder%3BBusinessUnitName%3D{BusinessUnitName}
The following properties are defined on the LOV link relation:- Source Attribute: TransactionTypeName; Target Attribute: TransactionTypeName
- Display Attribute: TransactionTypeName
- finder: