Create a financial mapping attribute
post
/fscmRestApi/resources/11.13.18.05/financialMappingAttributes
Request
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
BusinessUnitId: integer
(int64)
Unique identifier of the business unit.
-
BusinessUnitName: string
Title:
Business Unit
Maximum Length:240
Name of the business unit. -
CurrentPeriodGrantAmount: number
Amount allowed to be applied during the current period.
-
CurrentPeriodGrantCode: string
Maximum Length:
30
Unique code for the current period type. A list of accepted values is defined in the lookup type ORA_HES_PERIOD_TYPE. Review and update the list of values in the Setup and Maintenance work area, Manage Student Management Lookups task. -
DefaultFlag: boolean
Maximum Length:
1
Indicates that the specific mapping attribute is the default. -
FuturePeriodGrantAmount: number
Amount allowed to be applied during the future period.
-
FuturePeriodGrantCode: string
Maximum Length:
30
Unique code for the future period type. A list of accepted values is defined in the lookup type ORA_HES_PERIOD_TYPE. Review and update the list of values in the Setup and Maintenance work area, Manage Student Management Lookups task. -
MappingAttributeCode: string
Maximum Length:
30
Unique user-defined code of the mapping attribute. -
MappingAttributeName: string
Maximum Length:
50
Unique user-defined name of the mapping attribute. -
PriorPeriodGrantAmount: number
Amount allowed to be applied during the prior period.
-
PriorPeriodGrantCode: string
Maximum Length:
30
Unique code for the prior period type. A list of accepted values is defined in the lookup type ORA_HES_PERIOD_TYPE. Review and update the list of values in the Setup and Maintenance work area, Manage Student Management Lookups task. -
PriorYearGrantAmount: number
Amount allowed to be applied during the prior year.
-
PriorYearGrantCode: string
Maximum Length:
30
Unique code for the prior year type. A list of accepted values is defined in the lookup type ORA_HES_PERIOD_TYPE. Review and update the list of values in the Setup and Maintenance work area, Manage Student Management Lookups task.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : financialMappingAttributes-item-response
Type:
Show Source
object
-
BusinessUnitId: integer
(int64)
Unique identifier of the business unit.
-
BusinessUnitName: string
Title:
Business Unit
Maximum Length:240
Name of the business unit. -
CurrencyCode: string
Title:
Currency Code
Read Only:true
Maximum Length:15
The currency code of the amount allowed on the mapping attribute. -
CurrencySymbol: string
Title:
Symbol
Read Only:true
Maximum Length:12
The currency symbol of the amount allowed on the mapping attribute. -
CurrentPeriodGrantAmount: number
Amount allowed to be applied during the current period.
-
CurrentPeriodGrantCode: string
Maximum Length:
30
Unique code for the current period type. A list of accepted values is defined in the lookup type ORA_HES_PERIOD_TYPE. Review and update the list of values in the Setup and Maintenance work area, Manage Student Management Lookups task. -
CurrentPeriodGrantMeaning: string
Read Only:
true
Maximum Length:80
Name of the current period. -
DefaultFlag: boolean
Maximum Length:
1
Indicates that the specific mapping attribute is the default. -
FuturePeriodGrantAmount: number
Amount allowed to be applied during the future period.
-
FuturePeriodGrantCode: string
Maximum Length:
30
Unique code for the future period type. A list of accepted values is defined in the lookup type ORA_HES_PERIOD_TYPE. Review and update the list of values in the Setup and Maintenance work area, Manage Student Management Lookups task. -
FuturePeriodGrantMeaning: string
Read Only:
true
Maximum Length:80
Name of the future period. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MappingAttributeCode: string
Maximum Length:
30
Unique user-defined code of the mapping attribute. -
MappingAttributeId: integer
(int64)
Read Only:
true
Unique identifier of the mapping attribute. -
MappingAttributeName: string
Maximum Length:
50
Unique user-defined name of the mapping attribute. -
PriorPeriodGrantAmount: number
Amount allowed to be applied during the prior period.
-
PriorPeriodGrantCode: string
Maximum Length:
30
Unique code for the prior period type. A list of accepted values is defined in the lookup type ORA_HES_PERIOD_TYPE. Review and update the list of values in the Setup and Maintenance work area, Manage Student Management Lookups task. -
PriorPeriodGrantMeaning: string
Read Only:
true
Maximum Length:80
Name of the prior period. -
PriorYearGrantAmount: number
Amount allowed to be applied during the prior year.
-
PriorYearGrantCode: string
Maximum Length:
30
Unique code for the prior year type. A list of accepted values is defined in the lookup type ORA_HES_PERIOD_TYPE. Review and update the list of values in the Setup and Maintenance work area, Manage Student Management Lookups task. -
PriorYearGrantMeaning: string
Read Only:
true
Maximum Length:80
Name of the prior year.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- periodGrantCodesLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HES_PERIOD_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: FuturePeriodGrantCode; 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