Get all transactions
get
/fscmRestApi/resources/11.13.18.05/transactionReferenceContexts/{transactionReferenceContextsUniqID}/child/studentAccounts/{AccountId}/child/transactions
Request
Path Parameters
-
AccountId(required): integer
Unique identifier for the account created for a student.
-
transactionReferenceContextsUniqID(required): string
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
-
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 -
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 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.
- PrimaryKey: Finds all transactions matching the primary key criteria specified.
-
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:- 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.
-
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 TopResponse
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 : transactionReferenceContexts-studentAccounts-transactions
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : transactionReferenceContexts-studentAccounts-transactions-item-response
Type:
Show Source
object
-
AcademicPeriodId: string
Title:
Academic Period ID
Read Only:true
Maximum Length:30
Unique identifier for an academic period. -
AcademicPeriodName: string
Read Only:
true
Name of the academic period in which student is enrolled. -
AcademicSubjectCode: string
Title:
Subject Code
Read Only:true
Maximum Length:30
Unique identifier for the subject of the scheduled course. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the transaction is posted. -
CurrencyCode: string
Title:
Currency Code
Read Only:true
Maximum Length:15
Currency code of the transaction. -
CurrencySymbol: string
Title:
Currency Symbol
Read Only:true
Maximum Length:12
Currency symbol associated with the currency code. -
CurriculumCatalogNumber: string
Title:
Catalog Number
Read Only:true
Maximum Length:10
Catalog number of the scheduled course. -
CurriculumId: string
Title:
Curriculum ID
Read Only:true
Maximum Length:120
Unique identifier of a scheduled course. -
CurriculumName: string
Title:
Curriculum Name
Read Only:true
Maximum Length:50
Name of the scheduled course student is enrolled in. -
EnrollmentId: string
Read Only:
true
Maximum Length:30
Unique identifier for student enrollment in a scheduled course. -
IndicatorMessage: string
Message that indicates payment was made on behalf of a user.
-
InstitutionId: string
Title:
Institution ID
Read Only:true
Maximum Length:30
Unique identifier for an institution. -
InstitutionName: string
Title:
Name
Read Only:true
Maximum Length:50
Name of the institution to which the scheduled course belongs. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OwningCurriculumName: string
Title:
Owning Name
Read Only:true
Maximum Length:50
Translated name for the parent curriculum item of the scheduled course. -
ProgramCurriculumId: number
Read Only:
true
Curriculum ID of the program to which fee is attached. -
ProgramName: string
Read Only:
true
Maximum Length:50
Name of the program to which fee is attached. -
ReportingAcademicPeriodId: string
Read Only:
true
Maximum Length:30
Unique identifier for a reporting academic period. -
ReportingAcademicPeriodName: string
Read Only:
true
Name of the reporting academic period in which student is enrolled. -
ScheduledCourseCode: string
Read Only:
true
Maximum Length:30
Unique code of the scheduled course. -
StatusCode: string
Title:
Status Code
Read Only:true
Maximum Length:30
Indicates the status of the receipt, such as cleared or reversed. -
transactionActivities: array
Transaction Activities
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. -
TransactionAmount: number
Title:
Transaction Amount
Read Only:true
Actual amount of the transaction. -
TransactionBalanceAmount: number
Title:
Balance
Read Only:true
Balance amount on the transaction. -
TransactionClassCode: string
Read Only:
true
Maximum Length:20
Identifies the type of transaction, such as invoice or receipt. -
TransactionDate: string
(date)
Title:
Transaction Date
Read Only:true
The date when the transaction originated. -
TransactionDescription: string
Read Only:
true
Maximum Length:240
The description of the transaction. -
TransactionId: integer
Read Only:
true
Unique identifier for a transaction. -
TransactionNumber: string
Title:
Transaction Number
Read Only:true
Maximum Length:30
User-defined number used to identify a transaction in accounts receivable.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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 : 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 : transactionReferenceContexts-studentAccounts-transactions-transactionActivities-item-response
Type:
Show Source
object
-
ActivityAmount: number
Read Only:
true
Amount of the transaction activity. -
ActivityDescription: string
Read Only:
true
Maximum Length:960
Description of the charge or receipt. Examples are tuition, housing, or cash. -
ActivityTypeCode: string
Read Only:
true
Maximum Length:80
Code to identify the type of activity. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the transaction occurred. -
CurrencyCode: string
Title:
Currency Code
Read Only:true
Maximum Length:15
Currency code of the activity. -
CurrencySymbol: string
Title:
Currency Symbol
Read Only:true
Maximum Length:12
Currency symbol associated with the currency code. -
DueDate: string
(date)
Title:
Due Date
Read Only:true
The date when the charge is due. -
LineNumber: number
Read Only:
true
Line number of the transaction activity. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TransactionActivityId: integer
Read Only:
true
Unique identifier for a transaction activity. -
TransactionClassCode: string
Read Only:
true
Maximum Length:3
Identifies the type of transaction. -
TransactionDate: string
(date)
Title:
Transaction Date
Read Only:true
The date when the transaction occurred. -
TransactionId: integer
(int64)
Read Only:
true
Unique identifier for a transaction. -
TransactionNumber: string
Title:
Transaction Number
Read Only:true
Maximum Length:30
User-defined number used to identify a transaction in accounts receivable.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source