Get a student account as logged-in user
get
/fscmRestApi/resources/11.13.18.05/studentAccounts/{AccountId}
Request
Path Parameters
-
AccountId(required): integer
Unique identifier for the account created for a student.
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 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 : studentAccounts-item-response
Type:
Show Source
object
-
AccountId: integer
Unique identifier for the account created for a student.
-
AccountNumber: string
Unique student account number assigned for display purposes.
-
accountRelationships: array
Account Relationships
Title:
Account Relationships
The account relationships resource is a child of the student accounts resource. It lists the financial accounts that are actively related to this student account. -
AllowManualPaymentFlag: boolean
Maximum Length:
255
Indicates that the manual payment is allowed. The default value is false. -
BalanceAmount: number
Total amount due on the student account.
-
BankAccountSupportFlag: boolean
Indicates whether the student can make a payment using their bank account details.
-
bills: array
Bills
Title:
Bills
The bills resource is a child of the student accounts resource and provides a list of bill numbers for a student account. -
BusinessUnitId: integer
Unique identifier for a business unit.
-
BusinessUnitName: string
Name of the business unit.
-
CountryCode: string
Maximum Length:
255
A short alphabetic code representing the country that is used as the default address. -
CreditCardSupportFlag: boolean
Indicates whether the student can make a payment using his credit card.
-
CurrencyCode: string
Currency code associated with the business unit.
-
CurrencySymbol: string
Currency symbol associated with the currency code.
-
CustomerAccountSiteUseId: integer
Unique identifier for the customer account site to be used for billing purposes. For example, student's home address instead of the dormitory address.
-
DueAmount: number
Amount due from the student.
-
DueDate: string
(date)
The date when the student must pay an amount due.
-
LastPaymentAmount: number
Amount of the last payment received from the student.
-
LastPaymentDate: string
(date)
The date when the last payment was received from the student.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManualPaymentInformation: string
Read Only:
true
Maximum Length:255
The detailed description for the manual payment. -
PartySiteId: integer
Unique identifier of the party site, matching the customer account site. Primarily used to identify the default credit card address for making a payment.
-
PaymentOptionCode: string
Maximum Length:
255
The code of the payment option. Examples are ORA_IBY_CYBERSOURCE or ORA_OTHER_SERVICE_PROVIDER. -
StudentPartyId: integer
Unique identifier for a student.
-
transactionApplications: array
Transaction Applications
Title:
Transaction Applications
The transaction applications resource is a child of the student accounts resource. It lists all the payments applied to a charge for a student account. -
transactions: array
Transactions
Title:
Transactions
The transactions resource is a child of the student accounts resource and provides a list of charges and payments for a student account.
Nested Schema : Account Relationships
Type:
array
Title:
Account Relationships
The account relationships resource is a child of the student accounts resource. It lists the financial accounts that are actively related to this student account.
Show Source
Nested Schema : Bills
Type:
array
Title:
Bills
The bills resource is a child of the student accounts resource and provides a list of bill numbers for a student account.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Transaction Applications
Type:
array
Title:
Transaction Applications
The transaction applications resource is a child of the student accounts resource. It lists all the payments applied to a charge for a student account.
Show Source
Nested Schema : Transactions
Type:
array
Title:
Transactions
The transactions resource is a child of the student accounts resource and provides a list of charges and payments for a student account.
Show Source
Nested Schema : studentAccounts-accountRelationships-item-response
Type:
Show Source
object
-
CustomerAccountRelationshipId: integer
(int64)
Read Only:
true
The unique identifier of the account relationship. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RelatedCustomerAccountId: integer
(int64)
Read Only:
true
The unique identifier of the learner's account. -
RelationshipType: string
Title:
Relationship Type
Read Only:true
Maximum Length:30
Indicates the relationship type of a customer to a learner. The default value is "Parent".
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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 : studentAccounts-bills-item-response
Type:
Show Source
object
-
BalanceAmount: number
Read Only:
true
The total current amount due remaining in this bill. -
BillingDate: string
(date)
Read Only:
true
The date when balance forward transactions are billed. -
BillNumber: string
Read Only:
true
Maximum Length:30
Consolidated billing invoice number. -
CurrencyCode: string
Read Only:
true
Maximum Length:15
Currency code of the transaction. -
CurrencySymbol: string
Read Only:
true
Maximum Length:12
Currency symbol associated with the currency code. -
DueDate: string
(date)
Read Only:
true
The date when this bill is due. -
EventDate: string
(date)
Read Only:
true
The date when a communication event is triggered. -
FormattedAmount: string
Read Only:
true
The formatted amount to be displayed to recipient. -
Institution: string
Read Only:
true
Maximum Length:255
The institution sending the communication. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PersonFirstName: string
Read Only:
true
Maximum Length:255
The preferred first name of the recipient. -
PersonLastName: string
Read Only:
true
Maximum Length:255
The preferred last name of the recipient. -
PreferredName: string
Read Only:
true
Maximum Length:255
The preferred full name of the recipient. -
RecipientId: integer
(int64)
Read Only:
true
Unique identifier of the recipient of the bill communication. -
Report: string
(byte)
Read Only:
true
The business intelligence publisher report containing the information for this bill. -
ViewBillURL: string
Read Only:
true
The token to hold the URL of bill.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : studentAccounts-transactionApplications-item-response
Type:
Show Source
object
-
ApplicationDate: string
(date)
Read Only:
true
The date when a payment was applied to a charge. -
AppliedAmount: number
Title:
Applied Amount
Read Only:true
Payment amount applied to the charge. -
AppliedTransactionId: integer
(int64)
Read Only:
true
Unique identifier for the charge being paid for. -
AppliedTransactionNumber: string
Read Only:
true
Maximum Length:20
Transaction number of the charge being paid for. -
AppliedTrxDescription: string
Read Only:
true
Maximum Length:240
Description of the charge being paid for. -
CreditDescription: string
Read Only:
true
Maximum Length:30
Description of the payment applying to a charge. -
CreditTransactionId: integer
(int64)
Read Only:
true
Unique identifier for the payment applying to a charge. -
CreditTransactionNumber: string
Read Only:
true
Maximum Length:30
Unique transaction number used for the payment of a charge. -
CurrencyCode: string
Title:
Currency Code
Read Only:true
Maximum Length:15
Currency code of the charge. -
CurrencySymbol: string
Title:
Currency Symbol
Read Only:true
Maximum Length:12
Currency symbol associated with the currency code. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PaidBy: string
This shows the names of the proxies who made the payment. A single invoice records the amount paid by multiple proxies.
-
PaidFor: string
This shows the names of the users whose bills were paid by a proxy. A single receipt acknowledges the payment.
-
StatusCode: string
Title:
Status Code
Read Only:true
Maximum Length:30
Status of payment application. -
TransactionApplicationId: integer
Read Only:
true
Unique identifier for the transaction application.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : 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 : 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
Links
- accountRelationships
-
Operation: /fscmRestApi/resources/11.13.18.05/studentAccounts/{AccountId}/child/accountRelationshipsParameters:
- AccountId:
$request.path.AccountId
The account relationships resource is a child of the student accounts resource. It lists the financial accounts that are actively related to this student account. - AccountId:
- bills
-
Parameters:
- AccountId:
$request.path.AccountId
The bills resource is a child of the student accounts resource and provides a list of bill numbers for a student account. - AccountId:
- transactionApplications
-
Operation: /fscmRestApi/resources/11.13.18.05/studentAccounts/{AccountId}/child/transactionApplicationsParameters:
- AccountId:
$request.path.AccountId
The transaction applications resource is a child of the student accounts resource. It lists all the payments applied to a charge for a student account. - AccountId:
- transactions
-
Parameters:
- AccountId:
$request.path.AccountId
The transactions resource is a child of the student accounts resource and provides a list of charges and payments for a student account. - AccountId: