Jump to

• Request
• Response

Get a student financial system configuration

get

/fscmRestApi/resources/11.13.18.05/studentFinancialSystemConfigurationsLOV/{BusinessUnitId}

Request

Path Parameters

• BusinessUnitId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : studentFinancialSystemConfigurationsLOV-item-response

Type: object

Show Source

• AcademicBusinessUnitName: string
  Title: Academic Business Unit Name

  Read Only: true

  Maximum Length: 50

  The name of the academic business unit.
• ActiveFlag: boolean
  Title: Status

  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates whether an academic business unit is active or inactive. The default value for this attribute is N.
• AllowManualPaymentFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates that manual payment is allowed. The default value is true.
• BankAccountSupportFlag: boolean
  Read Only: true

  Maximum Length: 255

  Indicates that bank account is supported. The default value is true.
• BankReceiptMethodId: integer (int64)
  Read Only: true

  Unique identifier of the receipt method for bank payments.
• BatchSourceName: string
  Read Only: true

  Maximum Length: 50

  Name of the transaction source.
• BatchSourceSequenceId: integer (int64)
  Title: Transaction Source

  Read Only: true

  Unique identifier of the transaction source.
• BusinessUnitId: integer (int64)
  Read Only: true

  The unique identifier of a business unit.
• CardReceiptMethodId: integer (int64)
  Read Only: true

  Unique identifier of the receipt method for credit card payments.
• CreditCardSupportFlag: boolean
  Read Only: true

  Maximum Length: 255

  Indicates that credit card is supported. The default value is true.
• CreditTransactionTypeId: integer (int64)
  Title: Credit Transaction Type ID

  Read Only: true

  Unique identifier of the credit transaction type.
• CreditTransactionTypeName: string
  Title: Credit Transaction Type

  Read Only: true

  Maximum Length: 255

  Name of the credit transaction type.
• CurrencyCode: string
  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.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManualPaymentInformation: string
  Read Only: true

  Maximum Length: 1000

  The detailed description for the manual payment.
• ManualPmtReceiptMethodId: integer (int64)
  Read Only: true

  Unique identifier of the receipt method for manual payments.
• MemoLineId: integer (int64)
  Title: Memo Line ID

  Read Only: true

  Unique identifier of the memo line.
• MemoLineName: string
  Title: Memo Line Name

  Read Only: true

  Maximum Length: 255

  Name of the memo line.
• Name: string
  Title: Business Unit

  Read Only: true

  Maximum Length: 240

  The name of a business unit.
• OtherPaymentSupportFlag: boolean
  Read Only: true

  Indicates that other payments is supported. The default value is true.
• OtherPmtReceiptMethodId: integer (int64)
  Read Only: true

  Unique identifier of the receipt method for other payments.
• PaymentOptionCode: string
  Read Only: true

  Maximum Length: 30

  Default Value: ORA_IBY_CYBERSOURCE

  Indicates the payment service provider that's used for the collection of fees from students. Default code value for this column is ORA_IBY_CYBERSOURCE.
• TransactionTypeId: integer (int64)
  Title: Transaction Type ID

  Read Only: true

  Unique identifier of the transaction type.
• TransactionTypeName: string
  Title: Transaction Type Name

  Read Only: true

  Maximum Length: 255

  Name of the transaction type.

{
    "type":"object",
    "properties":{
        "CreditCardSupportFlag":{
            "maxLength":"255",
            "type":"boolean",
            "description":"Indicates that credit card is supported. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionTypeName":{
            "title":"Transaction Type Name",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the transaction type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BankAccountSupportFlag":{
            "maxLength":"255",
            "type":"boolean",
            "description":"Indicates that bank account is supported. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BatchSourceSequenceId":{
            "title":"Transaction Source",
            "type":"integer",
            "description":"Unique identifier of the transaction source.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PaymentOptionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the payment service provider that's used for the collection of fees from students. Default code value for this column is ORA_IBY_CYBERSOURCE.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_IBY_CYBERSOURCE",
            "x-queryable":true
        },
        "AcademicBusinessUnitName":{
            "title":"Academic Business Unit Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the academic business unit.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionTypeId":{
            "title":"Transaction Type ID",
            "type":"integer",
            "description":"Unique identifier of the transaction type.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CardReceiptMethodId":{
            "type":"integer",
            "description":"Unique identifier of the receipt method for credit card payments.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CurrencySymbol":{
            "title":"Symbol",
            "maxLength":"12",
            "type":"string",
            "description":"The currency symbol of the amount allowed on the mapping attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Business Unit",
            "maxLength":"240",
            "type":"string",
            "description":"The name of a business unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The currency code of the amount allowed on the mapping attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MemoLineName":{
            "title":"Memo Line Name",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the memo line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OtherPmtReceiptMethodId":{
            "type":"integer",
            "description":"Unique identifier of the receipt method for other payments.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AllowManualPaymentFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that manual payment is allowed. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MemoLineId":{
            "title":"Memo Line ID",
            "type":"integer",
            "description":"Unique identifier of the memo line.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ManualPmtReceiptMethodId":{
            "type":"integer",
            "description":"Unique identifier of the receipt method for manual payments.",
            "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":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"The unique identifier of a business unit.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OtherPaymentSupportFlag":{
            "type":"boolean",
            "description":"Indicates that other payments is supported. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditTransactionTypeId":{
            "title":"Credit Transaction Type ID",
            "type":"integer",
            "description":"Unique identifier of the credit transaction type.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BankReceiptMethodId":{
            "type":"integer",
            "description":"Unique identifier of the receipt method for bank payments.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Status",
            "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,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "CreditTransactionTypeName":{
            "title":"Credit Transaction Type",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the credit transaction type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ManualPaymentInformation":{
            "maxLength":"1000",
            "type":"string",
            "description":"The detailed description for the manual payment.",
            "nullable":true,
            "readOnly":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 : 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."
        }
    }
}

Back to Top