Create a student waiver credit
post
/fscmRestApi/resources/11.13.18.05/studentCreditWaivers
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
-
Amount: number
The amount that's waived based on the waiver type.
-
AmountTypeCode: string
Maximum Length:
30
The unique code of the waiver type. -
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.
-
CreditCode(required): string
Maximum Length:
30
The unique code to identify the student credit. -
creditCurriculums: array
Student Credit Waiver Curriculums
Title:
Student Credit Waiver Curriculums
The student credit curriculums resource lists all curriculums associated with a waiver. -
CreditDescription: string
Maximum Length:
240
The description of the student credit. -
CreditName(required): string
Maximum Length:
50
The name of the student credit. -
creditPeriods: array
Student Credit Waiver Periods
Title:
Student Credit Waiver Periods
The student credit periods resource lists all credit periods associated with a waiver. -
CreditReferenceCode(required): string
Maximum Length:
100
The credit reference code of the student credit. -
CreditSourceCode: string
Maximum Length:
30
The unique code of the source of credit. -
EligibilityEndDate: string
(date)
The date when the eligibility for waiver by amount ends.
-
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. -
Priority: integer
(int32)
Default Value:
9999
The priority in which a credit is processed. -
ReceivableActivityId(required): 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(required): boolean
Maximum Length:
1
Indicates whether an excess student credit amount can be refunded. If the value is true, the credit is refundable. -
SetupTypeCode: string
Maximum Length:
30
The unique code indicating the setup type of the waiver. -
StatusCode(required): string
Maximum Length:
30
The activation status of the student credit. -
TransactionTypeId(required): 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 : Student Credit Waiver Curriculums
Type:
array
Title:
Student Credit Waiver Curriculums
The student credit curriculums resource lists all curriculums associated with a waiver.
Show Source
Nested Schema : Student Credit Waiver Periods
Type:
array
Title:
Student Credit Waiver Periods
The student credit periods resource lists all credit periods associated with a waiver.
Show Source
Nested Schema : studentCreditWaivers-creditCurriculums-item-post-request
Type:
Show Source
object
-
CreditPeriodId: integer
(int64)
The unique identifier of the credit period associated to the curriculum ID.
-
CurriculumId: integer
(int64)
Unique identifier of the curriculum.
-
CurriculumTypeId: integer
(int64)
Unique identifier of the type of the curriculum associated with the credit period. Here are examples: course, scheduled course, program, or course list.
Nested Schema : schema
Type:
Show Source
object
-
AcademicPeriodId: integer
(int64)
Unique identifier of the academic period.
-
AcademicPeriodName: string
Title:
Period Name
Maximum Length:50
Name of the academic period. -
Amount: number
The amount associated with the amount type for the waiver.
-
AmountTypeCode: string
Maximum Length:
255
The unique code of the waiver type. -
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.
-
CreditPeriodDescription: string
Maximum Length:
240
The description of the credit period. -
EligibilityEndDate: string
(date)
The date when the eligibility for waiver by amount ends.
-
EndDate: string
(date)
The date when the credit period's validity ends.
-
MaximumAmount: number
Maximum amount of the credit.
-
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. -
OverrideAmountFlag: boolean
Maximum Length:
1
Indicates whether the default student credit amount is overridden. If the value is true, the credit has unique amount setup values. -
ReceivableActivityId: integer
(int64)
Unique identifier of the receivables activity when the credit is posted for the academic period.
-
ReceivableActivityName: string
Maximum Length:
255
Name of the receivables activity. -
StartDate: string
(date)
The date when the credit period is active.
-
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.
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 : studentCreditWaivers-item-response
Type:
Show Source
object
-
Amount: number
The amount that's waived based on the waiver type.
-
AmountTypeCode: string
Maximum Length:
30
The unique code of the waiver type. -
AmountTypeMeaning: string
Read Only:
true
Maximum Length:80
The name of the waiver type. -
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. -
creditCurriculums: array
Student Credit Waiver Curriculums
Title:
Student Credit Waiver Curriculums
The student credit curriculums resource lists all curriculums associated with a waiver. -
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. -
creditPeriods: array
Student Credit Waiver Periods
Title:
Student Credit Waiver Periods
The student credit periods resource lists all credit periods associated with a waiver. -
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. -
EligibilityEndDate: string
(date)
The date when the eligibility for waiver by amount ends.
-
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. -
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. -
SetupTypeCode: string
Maximum Length:
30
The unique code indicating the setup type of the waiver. -
SetupTypeName: string
Read Only:
true
Maximum Length:80
The name of the setup type of the waiver. -
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 : Student Credit Waiver Curriculums
Type:
array
Title:
Student Credit Waiver Curriculums
The student credit curriculums resource lists all curriculums associated with a waiver.
Show Source
Nested Schema : Student Credit Waiver Periods
Type:
array
Title:
Student Credit Waiver Periods
The student credit periods resource lists all credit periods associated with a waiver.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : studentCreditWaivers-creditCurriculums-item-response
Type:
Show Source
object
-
CreditCurriculumId: integer
(int64)
Read Only:
true
Unique identifier of the curriculum associated with the credit period. -
CreditPeriodId: integer
(int64)
The unique identifier of the credit period associated to the curriculum ID.
-
CurriculumId: integer
(int64)
Unique identifier of the curriculum.
-
CurriculumName: string
Title:
Name
Read Only:true
Maximum Length:50
Name of the curriculum. -
CurriculumTypeId: integer
(int64)
Unique identifier of the type of the curriculum associated with the credit period. Here are examples: course, scheduled course, program, or course list.
-
CurriculumTypeMeaning: string
Read Only:
true
Maximum Length:50
Name of the curriculum type for the curriculum associated with the credit period. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : studentCreditWaivers-creditPeriods-item-response
Type:
Show Source
object
-
AcademicPeriodId: integer
(int64)
Unique identifier of the academic period.
-
AcademicPeriodName: string
Title:
Period Name
Maximum Length:50
Name of the academic period. -
Amount: number
The amount associated with the amount type for the waiver.
-
AmountTypeCode: string
Maximum Length:
255
The unique code of the waiver type. -
AmountTypeMeaning: string
Read Only:
true
Maximum Length:80
The name of the waiver type. -
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. -
CreditPeriodDescription: string
Maximum Length:
240
The description of the credit period. -
CreditPeriodId: integer
(int64)
Read Only:
true
The unique identifier of the credit period. -
EligibilityEndDate: string
(date)
The date when the eligibility for waiver by amount ends.
-
EndDate: string
(date)
The date when the credit period's validity ends.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumAmount: number
Maximum amount of the credit.
-
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. -
OverrideAmountFlag: boolean
Maximum Length:
1
Indicates whether the default student credit amount is overridden. If the value is true, the credit has unique amount setup values. -
ReceivableActivityId: integer
(int64)
Unique identifier of the receivables activity when the credit is posted for the academic period.
-
ReceivableActivityName: string
Maximum Length:
255
Name of the receivables activity. -
StartDate: string
(date)
The date when the credit period is active.
-
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
- amountTypesLOV
-
Parameters:
- finder:
LookupTypeFinder%3BApplicationCode%3DHES%2CLookupType%3DORA_HES_CREDIT_AMOUNT_TYPE%2CLookupCode%3D{AmountTypeCode}
The following properties are defined on the LOV link relation:- Source Attribute: AmountTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- 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:
- creditCurriculums
-
Parameters:
- studentCreditWaiversUniqID:
$request.path.studentCreditWaiversUniqID
The student credit curriculums resource lists all curriculums associated with a waiver. - studentCreditWaiversUniqID:
- creditPeriods
-
Parameters:
- studentCreditWaiversUniqID:
$request.path.studentCreditWaiversUniqID
The student credit periods resource lists all credit periods associated with a waiver. - studentCreditWaiversUniqID:
- 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:
- 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:
- setupTypesLOV
-
Parameters:
- finder:
LookupTypeFinder%3BApplicationCode%3DHES%2CLookupType%3DORA_HES_CREDIT_SETUP_TYPE%2CLookupCode%3D{SetupTypeCode}
The following properties are defined on the LOV link relation:- Source Attribute: SetupTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- 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: