Create student financial system configurations
post
/fscmRestApi/resources/11.13.18.05/studentFinancialSystemConfigurations
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
-
AcademicBusinessUnitName(required): string
Maximum Length:
50
Name of the academic business unit. -
ActiveFlag: boolean
Maximum Length:
1
Default Value:true
Indicates whether an academic business unit is active or inactive. The default value for this attribute is N. -
AllowBankFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether bank payments are allowed. The default value for this attribute is N. -
AllowDiscountsFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether discounts are allowed. The default value for this attribute is N. -
AllowManualPaymentFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether manual payments are allowed. The default value for this attribute is N. -
BankReceiptMethodId: integer
(int64)
The unique identifier of the receipt method associated with all bank payments.
-
BankReceiptMethodName: string
Title:
Receipt Method
Maximum Length:30
The unique name of the receipt method associated with all bank payments. -
BatchSourceName: string
Maximum Length:
50
Name of the transaction source. -
BatchSourceSequenceId: integer
(int64)
Title:
Transaction Source
Unique identifier of the transaction source. -
BusinessUnitId(required): integer
(int64)
The unique identifier of the student financial system configuration.
-
CardReceiptMethodId: integer
(int64)
The unique identifier of the credit card receipt method associated with electronic credit card payments.
-
CardReceiptMethodName: string
Title:
Receipt Method
Maximum Length:30
The unique name of the credit card receipt method associated with electronic credit card payments. -
CreditTransactionTypeId: integer
(int64)
Title:
Credit Transaction Type ID
Unique identifier of the credit transaction type. -
CreditTransactionTypeName: string
Title:
Credit Transaction Type
Name of the credit transaction type. -
CustomerClassCode(required): string
Maximum Length:
30
Unique identifier of the customer class. -
CustomerProfileClassId: integer
(int64)
Unique identifier of the customer profile class.
-
CustomerProfileClassName: string
Title:
Profile Class Name
Maximum Length:30
Name of the customer profile class. -
DefaultPartyId: integer
(int64)
Identifies the administrator that will receive payment error notifications. Payment error notifications are triggered by a failure in the payment process.
-
Description: string
Maximum Length:
4000
Description of the business unit. -
GenerateTransactionNumberFlag: boolean
Maximum Length:
1
Default Value:false
Indicates if transaction numbering scheme will be generated by Student Management Cloud. -
ManualPaymentInformation: string
Maximum Length:
1000
The user-defined checkout message used when a manual payment is successful. -
ManualPaymentReceiptMethodId: integer
(int64)
The unique identifier of the receipt method associated with all manual payments.
-
ManualPaymentReceiptMethodName: string
Title:
Receipt Method
Maximum Length:30
The unique name of the receipt method associated with all manual payments. -
MemoLineId: integer
(int64)
Title:
Memo Line ID
Unique identifier of the memo line. -
MemoLineName: string
Title:
Memo Line Name
Name of the memo line. -
Name: string
Title:
Business Unit
Maximum Length:240
Name of the business unit. -
OtherPaymentReceiptMethodId: integer
(int64)
The unique identifier of the receipt method associated with an external electronic payment provider.
-
OtherPaymentReceiptMethodName: string
Title:
Receipt Method
Maximum Length:30
The unique name of the receipt method associated with an external electronic payment provider. -
OtherPaymentURL: string
Maximum Length:
1000
Custom URL for self-service payments that go through a third-party payment service provider. -
PaymentOptionCode: string
Maximum Length:
30
Default Value:ORA_NONE
Indicates payment provider for electronic payments. A list of accepted values is defined in the lookup type ORA_HES_PMT_SERVICE_PROVIDER. -
ReceiptNumberPrefix: string
Maximum Length:
5
The user-defined prefix for all receipts. -
refundMethods: array
Refund Methods
Title:
Refund Methods
The refund methods resource is used to find refund methods to associate to an academic business unit. Refund methods are used in the issue refunds process. -
TransactionNumberPrefix: string
Maximum Length:
5
The user-defined prefix for all transactions. -
transactionSources: array
Transaction Sources
Title:
Transaction Sources
The transaction sources resource is used to find transaction sources to map user-defined fee types. Transaction source to fee type mapping is also associated to an academic business unit. -
TransactionTypeId: integer
(int64)
Title:
Transaction Type ID
Unique identifier of the transaction type. -
TransactionTypeName: string
Title:
Transaction Type Name
The name of the transaction type.
Nested Schema : Refund Methods
Type:
array
Title:
Refund Methods
The refund methods resource is used to find refund methods to associate to an academic business unit. Refund methods are used in the issue refunds process.
Show Source
Nested Schema : Transaction Sources
Type:
array
Title:
Transaction Sources
The transaction sources resource is used to find transaction sources to map user-defined fee types. Transaction source to fee type mapping is also associated to an academic business unit.
Show Source
Nested Schema : studentFinancialSystemConfigurations-refundMethods-item-post-request
Type:
Show Source
object
-
AllowDebitBalanceFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether debit balances for a refund method are allowed. The default value for this attribute is N. -
RefundMethodCode: string
Maximum Length:
30
The unique identifier of the refund payment method.
Nested Schema : studentFinancialSystemConfigurations-transactionSources-item-post-request
Type:
Show Source
object
-
BatchSourceName: string
Maximum Length:
50
Name of a batch transaction source. -
BatchSourceSequenceId: integer
(int64)
Unique identifier of a batch transaction source.
-
FeeTypeId: integer
(int64)
Unique identifier for a fee type.
-
FeeTypeName: string
Title:
Fee Type Name
Maximum Length:50
Name of a fee 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 : studentFinancialSystemConfigurations-item-response
Type:
Show Source
object
-
AcademicBusinessUnitName: string
Maximum Length:
50
Name of the academic business unit. -
ActiveFlag: boolean
Maximum Length:
1
Default Value:true
Indicates whether an academic business unit is active or inactive. The default value for this attribute is N. -
AllowBankFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether bank payments are allowed. The default value for this attribute is N. -
AllowDiscountsFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether discounts are allowed. The default value for this attribute is N. -
AllowManualPaymentFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether manual payments are allowed. The default value for this attribute is N. -
BankReceiptMethodId: integer
(int64)
The unique identifier of the receipt method associated with all bank payments.
-
BankReceiptMethodName: string
Title:
Receipt Method
Maximum Length:30
The unique name of the receipt method associated with all bank payments. -
BatchSourceName: string
Maximum Length:
50
Name of the transaction source. -
BatchSourceSequenceId: integer
(int64)
Title:
Transaction Source
Unique identifier of the transaction source. -
BusinessUnitId: integer
(int64)
The unique identifier of the student financial system configuration.
-
CardReceiptMethodId: integer
(int64)
The unique identifier of the credit card receipt method associated with electronic credit card payments.
-
CardReceiptMethodName: string
Title:
Receipt Method
Maximum Length:30
The unique name of the credit card receipt method associated with electronic credit card payments. -
CreditTransactionTypeId: integer
(int64)
Title:
Credit Transaction Type ID
Unique identifier of the credit transaction type. -
CreditTransactionTypeName: string
Title:
Credit Transaction Type
Name of the credit transaction type. -
Currency: string
Read Only:
true
Maximum Length:15
The currency code of the payment. -
CustomerClassCode: string
Maximum Length:
30
Unique identifier of the customer class. -
CustomerClassMeaning: string
Read Only:
true
Maximum Length:80
Name of the customer class. -
CustomerProfileClassId: integer
(int64)
Unique identifier of the customer profile class.
-
CustomerProfileClassName: string
Title:
Profile Class Name
Maximum Length:30
Name of the customer profile class. -
DefaultPartyId: integer
(int64)
Identifies the administrator that will receive payment error notifications. Payment error notifications are triggered by a failure in the payment process.
-
DefaultPartyName: string
Title:
Name
Read Only:true
Maximum Length:360
Name of the administrator that will receive payment error notifications. Payment error notifications are triggered by a failure in the payment process. -
DeletableFlag: boolean
Read Only:
true
Maximum Length:1
Contains one of the following values: true or false. If true, then the academic business unit doesn't have any transactions and can be deleted. If false, the academic business unit can't be deleted. -
Description: string
Maximum Length:
4000
Description of the business unit. -
GenerateTransactionNumberFlag: boolean
Maximum Length:
1
Default Value:false
Indicates if transaction numbering scheme will be generated by Student Management Cloud. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManualPaymentInformation: string
Maximum Length:
1000
The user-defined checkout message used when a manual payment is successful. -
ManualPaymentReceiptMethodId: integer
(int64)
The unique identifier of the receipt method associated with all manual payments.
-
ManualPaymentReceiptMethodName: string
Title:
Receipt Method
Maximum Length:30
The unique name of the receipt method associated with all manual payments. -
MemoLineId: integer
(int64)
Title:
Memo Line ID
Unique identifier of the memo line. -
MemoLineName: string
Title:
Memo Line Name
Name of the memo line. -
Name: string
Title:
Business Unit
Maximum Length:240
Name of the business unit. -
OtherPaymentReceiptMethodId: integer
(int64)
The unique identifier of the receipt method associated with an external electronic payment provider.
-
OtherPaymentReceiptMethodName: string
Title:
Receipt Method
Maximum Length:30
The unique name of the receipt method associated with an external electronic payment provider. -
OtherPaymentSupportFlag: boolean
Read Only:
true
Maximum Length:1
Contains one of the following values: true or false. If true, then the institution uses a third-party payment service provider. If false, then another payment method is used. -
OtherPaymentURL: string
Maximum Length:
1000
Custom URL for self-service payments that go through a third-party payment service provider. -
PaymentOptionCode: string
Maximum Length:
30
Default Value:ORA_NONE
Indicates payment provider for electronic payments. A list of accepted values is defined in the lookup type ORA_HES_PMT_SERVICE_PROVIDER. -
PaymentOptionMeaning: string
Read Only:
true
Maximum Length:80
Indicates payment provider for electronic payments. -
PaymentTermId: integer
(int64)
Read Only:
true
Unique ID for a payment term tied to a customer class. -
PaymentTermName: string
Title:
Name
Read Only:true
Maximum Length:15
Name for a payment term tied to a customer class. -
ReceiptNumberPrefix: string
Maximum Length:
5
The user-defined prefix for all receipts. -
refundMethods: array
Refund Methods
Title:
Refund Methods
The refund methods resource is used to find refund methods to associate to an academic business unit. Refund methods are used in the issue refunds process. -
StartReceiptNumber: integer
(int64)
Read Only:
true
Default Value:1000
The starting receipt number for the academic business unit. -
StartTransactionNumber: integer
(int64)
Read Only:
true
The starting transaction number for the academic business unit. -
TransactionNumberPrefix: string
Maximum Length:
5
The user-defined prefix for all transactions. -
transactionSources: array
Transaction Sources
Title:
Transaction Sources
The transaction sources resource is used to find transaction sources to map user-defined fee types. Transaction source to fee type mapping is also associated to an academic business unit. -
TransactionTypeId: integer
(int64)
Title:
Transaction Type ID
Unique identifier of the transaction type. -
TransactionTypeName: string
Title:
Transaction Type Name
The name of the transaction type.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Refund Methods
Type:
array
Title:
Refund Methods
The refund methods resource is used to find refund methods to associate to an academic business unit. Refund methods are used in the issue refunds process.
Show Source
Nested Schema : Transaction Sources
Type:
array
Title:
Transaction Sources
The transaction sources resource is used to find transaction sources to map user-defined fee types. Transaction source to fee type mapping is also associated to an academic business unit.
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 : studentFinancialSystemConfigurations-refundMethods-item-response
Type:
Show Source
object
-
AllowDebitBalanceFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether debit balances for a refund method are allowed. The default value for this attribute is N. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationRefundMethodId: integer
(int64)
Read Only:
true
The primary identifier of an organization's refund method. -
RefundMethodCode: string
Maximum Length:
30
The unique identifier of the refund payment method. -
RefundMethodId: integer
(int64)
Read Only:
true
The unique identifier for a refund method. -
RefundMethodName: string
Title:
Name
Read Only:true
Maximum Length:100
Name of the refund method.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : studentFinancialSystemConfigurations-transactionSources-item-response
Type:
Show Source
object
-
BatchSourceName: string
Maximum Length:
50
Name of a batch transaction source. -
BatchSourceSequenceId: integer
(int64)
Unique identifier of a batch transaction source.
-
FeeTypeId: integer
(int64)
Unique identifier for a fee type.
-
FeeTypeName: string
Title:
Fee Type Name
Maximum Length:50
Name of a fee type. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TransactionSourceId: integer
(int64)
Read Only:
true
Unique identifier for a transaction source.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- businessUnitsLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: Name; Target Attribute: BusinessUnitName
- Display Attribute: BusinessUnitName
- customerClassesLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DCUSTOMER%20CLASS
The following properties are defined on the LOV link relation:- Source Attribute: CustomerClassCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- customerProfileClassesLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: CustomerProfileClassName; Target Attribute: ProfileName
- Display Attribute: ProfileName
- hedTransactionSourcesLOV
-
Parameters:
- finder:
FindByBusinessUnit%3BBusinessUnitId%3D{BusinessUnitId}%2CStudentManagementTransactionNumberingFlag%3D{GenerateTransactionNumberFlag}
The following properties are defined on the LOV link relation:- Source Attribute: BatchSourceName; Target Attribute: BatchSourceName
- Display Attribute: BatchSourceName
- finder:
- paymentOptionCodesLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HES_PMT_SERVICE_PROVIDER
The following properties are defined on the LOV link relation:- Source Attribute: PaymentOptionCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- receiptMethodsLOV
-
Parameters:
- finder:
FindByBusinessUnit
The following properties are defined on the LOV link relation:- Source Attribute: OtherPaymentReceiptMethodName; Target Attribute: ReceiptMethodName
- Display Attribute: ReceiptMethodName
- finder:
- refundMethods
-
Parameters:
- BusinessUnitId:
$request.path.BusinessUnitId
The refund methods resource is used to find refund methods to associate to an academic business unit. Refund methods are used in the issue refunds process. - BusinessUnitId:
- studentMemoLinesLOV
-
Parameters:
- finder:
ByBusinessUnitFinder%3BBusinessUnitName%3D{AcademicBusinessUnitName}
The following properties are defined on the LOV link relation:- Source Attribute: MemoLineName; Target Attribute: MemoLineName
- Display Attribute: MemoLineName
- finder:
- studentTransactionTypesLOV1
-
Parameters:
- finder:
InvoiceTransactionTypeFinder%3BBusinessUnitName%3D{AcademicBusinessUnitName}
The following properties are defined on the LOV link relation:- Source Attribute: TransactionTypeName; Target Attribute: TransactionTypeName
- Display Attribute: TransactionTypeName
- finder:
- studentTransactionTypesLOV2
-
Parameters:
- finder:
CreditMemoTransactionTypeFinder%3BBusinessUnitName%3D{AcademicBusinessUnitName}
The following properties are defined on the LOV link relation:- Source Attribute: CreditTransactionTypeName; Target Attribute: TransactionTypeName
- Display Attribute: TransactionTypeName
- finder:
- transactionSources
-
Parameters:
- BusinessUnitId:
$request.path.BusinessUnitId
The transaction sources resource is used to find transaction sources to map user-defined fee types. Transaction source to fee type mapping is also associated to an academic business unit. - BusinessUnitId: