Jump to

• Request
• Response

Get all student financial system configurations

get

/fscmRestApi/resources/11.13.18.05/studentFinancialSystemConfigurations

Request

Query Parameters

• 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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds the specific student financial system configuration that matches the primary key criteria specified.
    Finder Variables
    • BusinessUnitId; integer; The unique identifier of the student financial system configuration.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AcademicBusinessUnitName; string; Name of the academic business unit.
  • ActiveFlag; boolean; Indicates whether an academic business unit is active or inactive. The default value for this attribute is N.
  • AllowBankFlag; boolean; Indicates whether bank payments are allowed. The default value for this attribute is N.
  • AllowDiscountsFlag; boolean; Indicates whether discounts are allowed. The default value for this attribute is N.
  • AllowManualPaymentFlag; boolean; Indicates whether manual payments are allowed. The default value for this attribute is N.
  • BankReceiptMethodId; integer; The unique identifier of the receipt method associated with all bank payments.
  • BankReceiptMethodName; string; The unique name of the receipt method associated with all bank payments.
  • BatchSourceName; string; Name of the transaction source.
  • BatchSourceSequenceId; integer; Unique identifier of the transaction source.
  • BusinessUnitId; integer; The unique identifier of the student financial system configuration.
  • CardReceiptMethodId; integer; The unique identifier of the credit card receipt method associated with electronic credit card payments.
  • CardReceiptMethodName; string; The unique name of the credit card receipt method associated with electronic credit card payments.
  • CreditTransactionTypeId; integer; Unique identifier of the credit transaction type.
  • CreditTransactionTypeName; string; Name of the credit transaction type.
  • Currency; string; The currency code of the payment.
  • CustomerClassCode; string; Unique identifier of the customer class.
  • CustomerClassMeaning; string; Name of the customer class.
  • CustomerProfileClassId; integer; Unique identifier of the customer profile class.
  • CustomerProfileClassName; string; Name of the customer profile class.
  • DefaultPartyId; integer; Identifies the administrator that will receive payment error notifications. Payment error notifications are triggered by a failure in the payment process.
  • DefaultPartyName; string; Name of the administrator that will receive payment error notifications. Payment error notifications are triggered by a failure in the payment process.
  • DeletableFlag; boolean; 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; Description of the business unit.
  • GenerateTransactionNumberFlag; boolean; Indicates if transaction numbering scheme will be generated by Student Management Cloud.
  • ManualPaymentInformation; string; The user-defined checkout message used when a manual payment is successful.
  • ManualPaymentReceiptMethodId; integer; The unique identifier of the receipt method associated with all manual payments.
  • ManualPaymentReceiptMethodName; string; The unique name of the receipt method associated with all manual payments.
  • MemoLineId; integer; Unique identifier of the memo line.
  • MemoLineName; string; Name of the memo line.
  • Name; string; Name of the business unit.
  • OtherPaymentReceiptMethodId; integer; The unique identifier of the receipt method associated with an external electronic payment provider.
  • OtherPaymentReceiptMethodName; string; The unique name of the receipt method associated with an external electronic payment provider.
  • OtherPaymentSupportFlag; boolean; 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; Custom URL for self-service payments that go through a third-party payment service provider.
  • PaymentOptionCode; string; Indicates payment provider for electronic payments. A list of accepted values is defined in the lookup type ORA_HES_PMT_SERVICE_PROVIDER.
  • PaymentOptionMeaning; string; Indicates payment provider for electronic payments.
  • PaymentTermId; integer; Unique ID for a payment term tied to a customer class.
  • PaymentTermName; string; Name for a payment term tied to a customer class.
  • ReceiptNumberPrefix; string; The user-defined prefix for all receipts.
  • StartReceiptNumber; integer; The starting receipt number for the academic business unit.
  • StartTransactionNumber; integer; The starting transaction number for the academic business unit.
  • TransactionNumberPrefix; string; The user-defined prefix for all transactions.
  • TransactionTypeId; integer; Unique identifier of the transaction type.
  • TransactionTypeName; string; The name of the transaction type.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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 Top

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.

Body ()

Root Schema : studentFinancialSystemConfigurations

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/studentFinancialSystemConfigurations-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"HED"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object studentFinancialSystemConfigurations-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/studentFinancialSystemConfigurations-item-response"
    }
}

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 : studentFinancialSystemConfigurations-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "PaymentTermName":{
            "title":"Name",
            "maxLength":15,
            "type":"string",
            "description":"Name for a payment term tied to a customer class.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CardReceiptMethodName":{
            "title":"Receipt Method",
            "maxLength":30,
            "type":"string",
            "description":"The unique name of the credit card receipt method associated with electronic credit card payments.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "BusinessUnitId"
                ]
            },
            "x-queryable":true
        },
        "TransactionTypeName":{
            "title":"Transaction Type Name",
            "type":"string",
            "description":"The name of the transaction type.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "Description":{
            "maxLength":4000,
            "type":"string",
            "description":"Description of the business unit.",
            "nullable":true,
            "x-queryable":true
        },
        "BatchSourceSequenceId":{
            "title":"Transaction Source",
            "type":"integer",
            "description":"Unique identifier of the transaction source.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "BatchSourceName"
                ]
            },
            "x-queryable":true
        },
        "AllowDiscountsFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether discounts are allowed. The default value for this attribute is N.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "PaymentOptionCode":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates payment provider for electronic payments. A list of accepted values is defined in the lookup type ORA_HES_PMT_SERVICE_PROVIDER.",
            "nullable":false,
            "default":"ORA_NONE",
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "AcademicBusinessUnitName":{
            "maxLength":50,
            "type":"string",
            "description":"Name of the academic business unit.",
            "nullable":false,
            "x-queryable":true
        },
        "TransactionTypeId":{
            "title":"Transaction Type ID",
            "type":"integer",
            "description":"Unique identifier of the transaction type.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "TransactionTypeName"
                ]
            },
            "x-queryable":true
        },
        "ReceiptNumberPrefix":{
            "maxLength":5,
            "type":"string",
            "description":"The user-defined prefix for all receipts.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerProfileClassId":{
            "type":"integer",
            "description":"Unique identifier of the customer profile class.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OtherPaymentURL":{
            "maxLength":1000,
            "type":"string",
            "description":"Custom URL for self-service payments that go through a third-party payment service provider.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "DeletableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AllowBankFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether bank payments are allowed. The default value for this attribute is N.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "CardReceiptMethodId":{
            "type":"integer",
            "description":"The unique identifier of the credit card receipt method associated with electronic credit card payments.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "PaymentOptionCode"
                ]
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Business Unit",
            "maxLength":240,
            "type":"string",
            "description":"Name of the business unit.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TransactionNumberPrefix":{
            "maxLength":5,
            "type":"string",
            "description":"The user-defined prefix for all transactions.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "GenerateTransactionNumberFlag"
                ]
            },
            "x-queryable":true
        },
        "CustomerClassCode":{
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier of the customer class.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "MemoLineName":{
            "title":"Memo Line Name",
            "type":"string",
            "description":"Name of the memo line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "transactionSources":{
            "title":"Transaction Sources",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/studentFinancialSystemConfigurations-transactionSources-item-response"
            }
        },
        "GenerateTransactionNumberFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if transaction numbering scheme will be generated by Student Management Cloud.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "CustomerClassMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the customer class.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Currency":{
            "maxLength":15,
            "type":"string",
            "description":"The currency code of the payment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AllowManualPaymentFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether manual payments are allowed. The default value for this attribute is N.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "MemoLineId":{
            "title":"Memo Line ID",
            "type":"integer",
            "description":"Unique identifier of the memo line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StartReceiptNumber":{
            "type":"integer",
            "description":"The starting receipt number for the academic business unit.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "default":1000,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PaymentTermId":{
            "type":"integer",
            "description":"Unique ID for a payment term tied to a customer class.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BatchSourceName":{
            "maxLength":50,
            "type":"string",
            "description":"Name of the transaction source.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BusinessUnitId",
                    "GenerateTransactionNumberFlag"
                ]
            },
            "x-queryable":true
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"The unique identifier of the student financial system configuration.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "Name"
                ]
            },
            "x-queryable":true
        },
        "BankReceiptMethodName":{
            "title":"Receipt Method",
            "maxLength":30,
            "type":"string",
            "description":"The unique name of the receipt method associated with all bank payments.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "BusinessUnitId"
                ]
            },
            "x-queryable":true
        },
        "OtherPaymentSupportFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "OtherPaymentReceiptMethodId"
                ]
            },
            "x-queryable":true
        },
        "CreditTransactionTypeId":{
            "title":"Credit Transaction Type ID",
            "type":"integer",
            "description":"Unique identifier of the credit transaction type.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "CreditTransactionTypeName"
                ]
            },
            "x-queryable":true
        },
        "BankReceiptMethodId":{
            "type":"integer",
            "description":"The unique identifier of the receipt method associated with all bank payments.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "AllowBankFlag"
                ]
            },
            "x-queryable":true
        },
        "ActiveFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether an academic business unit is active or inactive. The default value for this attribute is N.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "CustomerProfileClassName":{
            "title":"Profile Class Name",
            "maxLength":30,
            "type":"string",
            "description":"Name of the customer profile class.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DefaultPartyName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"Name of the administrator that will receive payment error notifications. Payment error notifications are triggered by a failure in the payment process.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditTransactionTypeName":{
            "title":"Credit Transaction Type",
            "type":"string",
            "description":"Name of the credit transaction type.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ManualPaymentReceiptMethodId":{
            "type":"integer",
            "description":"The unique identifier of the receipt method associated with all manual payments.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "AllowManualPaymentFlag"
                ]
            },
            "x-queryable":true
        },
        "refundMethods":{
            "title":"Refund Methods",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/studentFinancialSystemConfigurations-refundMethods-item-response"
            }
        },
        "ManualPaymentReceiptMethodName":{
            "title":"Receipt Method",
            "maxLength":30,
            "type":"string",
            "description":"The unique name of the receipt method associated with all manual payments.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "BusinessUnitId"
                ]
            },
            "x-queryable":true
        },
        "PaymentOptionMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"Indicates payment provider for electronic payments.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OtherPaymentReceiptMethodId":{
            "type":"integer",
            "description":"The unique identifier of the receipt method associated with an external electronic payment provider.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "PaymentOptionCode"
                ]
            },
            "x-queryable":true
        },
        "DefaultPartyId":{
            "type":"integer",
            "description":"Identifies the administrator that will receive payment error notifications. Payment error notifications are triggered by a failure in the payment process.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "OtherPaymentReceiptMethodName":{
            "title":"Receipt Method",
            "maxLength":30,
            "type":"string",
            "description":"The unique name of the receipt method associated with an external electronic payment provider.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "BusinessUnitId"
                ]
            },
            "x-queryable":true
        },
        "StartTransactionNumber":{
            "type":"integer",
            "description":"The starting transaction number for the academic business unit.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ManualPaymentInformation":{
            "maxLength":1000,
            "type":"string",
            "description":"The user-defined checkout message used when a manual payment is successful.",
            "nullable":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 : 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

• Array of: object studentFinancialSystemConfigurations-refundMethods-item-response

{
    "title":"Refund Methods",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/studentFinancialSystemConfigurations-refundMethods-item-response"
    }
}

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

• Array of: object studentFinancialSystemConfigurations-transactionSources-item-response

{
    "title":"Transaction Sources",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/studentFinancialSystemConfigurations-transactionSources-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 : studentFinancialSystemConfigurations-refundMethods-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "RefundMethodName":{
            "title":"Name",
            "maxLength":100,
            "type":"string",
            "description":"Name of the refund method.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RefundMethodCode":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the refund payment method.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "BusinessUnitId",
                    "CurrencyCode"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AllowDebitBalanceFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether debit balances for a refund method are allowed. The default value for this attribute is N.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "OrganizationRefundMethodId":{
            "type":"integer",
            "description":"The primary identifier of an organization's refund method.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "RefundMethodId":{
            "type":"integer",
            "description":"The unique identifier for a refund method.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "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 : studentFinancialSystemConfigurations-transactionSources-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "TransactionSourceId":{
            "type":"integer",
            "description":"Unique identifier for a transaction source.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "FeeTypeName":{
            "title":"Fee Type Name",
            "maxLength":50,
            "type":"string",
            "description":"Name of a fee type.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BatchSourceName":{
            "maxLength":50,
            "type":"string",
            "description":"Name of a batch transaction source.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "BusinessUnitId",
                    "GenerateTransactionNumberFlag"
                ]
            },
            "x-queryable":true
        },
        "FeeTypeId":{
            "type":"integer",
            "description":"Unique identifier for a fee type.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BatchSourceSequenceId":{
            "type":"integer",
            "description":"Unique identifier of a batch transaction source.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "BatchSourceName"
                ]
            },
            "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"
    }
}

Back to Top