1. REST API for Oracle Fusion Cloud Student Management
  2. Tasks
  3. Transaction Reference Contexts
  4. Student Accounts
  5. Transactions

Get all transactions

get

/fscmRestApi/resources/11.13.18.05/transactionReferenceContexts/{transactionReferenceContextsUniqID}/child/studentAccounts/{AccountId}/child/transactions

Request

Path Parameters
  • 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=
  • This is the hash key of the attributes which make up the composite key for the Transaction Reference Contexts resource and used to uniquely identify an instance of Transaction Reference Contexts. The client should not generate the hash key value. Instead, the client should query on the Transaction Reference Contexts collection resource in order to navigate to a specific instance of Transaction Reference Contexts to get the hash key.
Query Parameters
  • 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>
  • 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).
  • 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
  • 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 all transactions matching the primary key criteria specified.
      Finder Variables
      • TransactionClassCode; string; Identifies the type of transaction.
      • TransactionId; integer; Unique identifier for a transaction of a transaction class.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • AcademicPeriodId; string; Unique identifier for an academic period.
    • AcademicSubjectCode; string; Unique identifier for the subject of the scheduled course.
    • CreationDate; string; The date when the transaction is posted.
    • CurrencyCode; string; Currency code of the transaction.
    • CurrencySymbol; string; Currency symbol associated with the currency code.
    • CurriculumCatalogNumber; string; Catalog number of the scheduled course.
    • CurriculumId; string; Unique identifier of a scheduled course.
    • CurriculumName; string; Name of the scheduled course student is enrolled in.
    • EnrollmentId; string; Unique identifier for student enrollment in a scheduled course.
    • IndicatorMessage; string; Message that indicates payment was made on behalf of a user.
    • InstitutionId; string; Unique identifier for an institution.
    • InstitutionName; string; Name of the institution to which the scheduled course belongs.
    • OwningCurriculumName; string; Translated name for the parent curriculum item of the scheduled course.
    • ProgramCurriculumId; number; Curriculum ID of the program to which fee is attached.
    • ProgramName; string; Name of the program to which fee is attached.
    • ReportingAcademicPeriodId; string; Unique identifier for a reporting academic period.
    • ScheduledCourseCode; string; Unique code of the scheduled course.
    • StatusCode; string; Indicates the status of the receipt, such as cleared or reversed.
    • TransactionAmount; number; Actual amount of the transaction.
    • TransactionBalanceAmount; number; Balance amount on the transaction.
    • TransactionClassCode; string; Identifies the type of transaction, such as invoice or receipt.
    • TransactionDate; string; The date when the transaction originated.
    • TransactionDescription; string; The description of the transaction.
    • TransactionId; integer; Unique identifier for a transaction.
    • TransactionNumber; string; User-defined number used to identify a transaction in accounts receivable.
  • 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
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : transactionReferenceContexts-studentAccounts-transactions
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : transactionReferenceContexts-studentAccounts-transactions-item-response
Type: object
Show Source
Nested Schema : Transaction Activities
Type: array
Title: Transaction Activities
The transaction activities resource is a child of the transactions resource. For a charge, it lists the initial charge details and any changes in the amount of the charge, such as a charge reversal, or a discount. For a payment, it lists any refunds emanating from that payment.
Show Source
Nested Schema : transactionReferenceContexts-studentAccounts-transactions-transactionActivities-item-response
Type: object
Show Source
Back to Top