Get all transaction reference context
get
/fscmRestApi/resources/11.13.18.05/transactionReferenceContexts
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:- TransRefContextFinder: Finds all transaction reference contexts that match the primary key criteria specified
Finder Variables:- AppCode; string; Unique identifier for an application registration.
- RefKey; string; Unique identifier for a transaction reference context.
- TransRefContextFinder: Finds all transaction reference contexts that match 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:- ObjectId; integer; Identifies the object that initiates transaction.
- PayPointCode; string; Code that identifies from where the amount that needs to be paid is being initiated.
- ReferenceKey; string; Randomly generated key used by student to make payments through third-party service provider.
-
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
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-item-response
Type:
Show Source
object
-
admissionApplications: array
Admission Applications
Title:
Admission Applications
The admission applications resource provides financial transaction records about a student's course application. -
carts: array
Carts
Title:
Carts
The carts resource provides the active cart information for the specific user. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectId: integer
(int64)
Read Only:
true
Identifies the object that initiates transaction. -
PayPointCode: string
Read Only:
true
Maximum Length:30
Code that identifies from where the amount that needs to be paid is being initiated. -
ReferenceKey: string
Read Only:
true
Maximum Length:30
Randomly generated key used by student to make payments through third-party service provider. -
studentAccounts: array
Student Accounts
Title:
Student Accounts
The student accounts resource provides the account information for the specific user.
Nested Schema : Admission Applications
Type:
array
Title:
Admission Applications
The admission applications resource provides financial transaction records about a student's course application.
Show Source
Nested Schema : Carts
Type:
array
Title:
Carts
The carts resource provides the active cart information for the specific user.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Student Accounts
Type:
array
Title:
Student Accounts
The student accounts resource provides the account information for the specific user.
Show Source
Nested Schema : transactionReferenceContexts-admissionApplications-item-response
Type:
Show Source
object
-
ApplicationURL: string
Title:
Application URL
Read Only:true
The URL that displays the application. -
courseSelections: array
Course Selections
Title:
Course Selections
The course selections resource captures course preference selections for an admissions application. -
DiscountAmount: number
Read Only:
true
The amount deducted from the total amount charged for the application. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectFees: array
Object Fees
Title:
Object Fees
The object fees resource lists all the different fees on the student application. -
ObjectId: integer
Read Only:
true
Identifies the object that initiates the application. -
ObjectType: string
Read Only:
true
Indicates the type of application. -
ProgramCurriculumId: integer
Title:
Program Curriculum ID
Read Only:true
The curriculum identifier for the program of the selected course. -
ProgramName: string
Title:
Program Name
Read Only:true
The name for the academic program of the selected course. -
ProgramTitle: string
Title:
Program Title
Read Only:true
The title for the academic program of the selected course. -
TotalAmount: number
Read Only:
true
The total amount charged for the application.
Nested Schema : Course Selections
Type:
array
Title:
Course Selections
The course selections resource captures course preference selections for an admissions application.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Object Fees
Type:
array
Title:
Object Fees
The object fees resource lists all the different fees on the student application.
Show Source
Nested Schema : transactionReferenceContexts-admissionApplications-courseSelections-item-response
Type:
Show Source
object
-
CatalogNumber: string
Title:
Catalog Number
Read Only:true
Maximum Length:10
The catalog number of the course selection. -
CourseCurriculumId: integer
(int64)
Read Only:
true
The curriculum identifier for the selected course. -
CourseDescription: string
The description of the selected course.
-
CourseListCurriculumId: integer
(int64)
Read Only:
true
The curriculum identifier for the course list of the selected course. -
CourseListName: string
Title:
Name
Read Only:true
Maximum Length:50
The name for the course list of the selected course. -
CourseListSequence: integer
(int32)
Read Only:
true
The sequence of the course list for the associated course selection. -
CourseListTitle: string
Title:
Title
Read Only:true
Maximum Length:100
The title for the course list of the selected course. -
CourseName: string
Title:
Name
Read Only:true
Maximum Length:50
The name of the selected course. -
CoursePreference: integer
(int32)
Read Only:
true
Course selection preference sequence number. -
CourseSelectionId: integer
(int64)
Read Only:
true
Unique identifier for the course selection. -
CourseTitle: string
Title:
Title
Read Only:true
Maximum Length:100
The title of the selected course. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SelectionDateTime: string
(date-time)
Read Only:
true
The date of the course selection. -
Subject: string
Title:
Name
Read Only:true
Maximum Length:50
The subject of the course selection. -
SubjectCode: string
Title:
Subject Code
Read Only:true
Maximum Length:30
The subject code of the course selection.
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 : transactionReferenceContexts-admissionApplications-ObjectFees-item-response
Type:
Show Source
object
-
Amount: number
Read Only:
true
The amount charged as part of the student???s application fee. -
CurrencyCode: string
Read Only:
true
Currency code associated with the application. -
CurrencySymbol: string
Read Only:
true
The currency symbol associated with the application. -
DiscountAmount: number
Read Only:
true
The amount deducted from the amount that???s charged as part of the student???s application fee. -
DiscountDescription: string
Read Only:
true
The description of the discount associated with the application. -
DiscountErrorFlag: boolean
Read Only:
true
Indicates whether an error occurred during discount calculation. Default value is 'False'. -
DiscountId: integer
Read Only:
true
Identifies the discount on the application. -
DiscountTitle: string
Read Only:
true
The title of the discount associated with the application. -
FeeAttributeId: integer
Read Only:
true
Identifies the application fee attribute. -
FeeId: integer
Read Only:
true
Identifies the application fee. -
FeeName: string
Read Only:
true
The name of the fee. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectId: integer
Read Only:
true
Identifies the object that initiates the application.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : transactionReferenceContexts-carts-item-response
Type:
Show Source
object
-
CartHeaderId: integer
(int64)
Title:
Cart Header ID
Read Only:true
The unique identifier of the shopping cart header. -
CountryCode: string
A short alphabetic code representing the country that is used as the default address.
-
CurrencyCode: string
Title:
Currency Code
Read Only:true
The currency code associated with a cart. -
CurrencySymbol: string
Title:
Currency Symbol
Read Only:true
The currency symbol associated with a cart. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
miscellaneousFeeItems: array
Miscellaneous Fee Items
Title:
Miscellaneous Fee Items
The miscellaneous fee items resource provides a list of miscellaneous fee items present in the cart. -
PromotionCode: string
Title:
Promotion Code
The promotion code applied to the cart. -
scheduledCourseItems: array
Scheduled Course Items
Title:
Scheduled Course Items
The scheduled course items resource provides a list of scheduled course items present in the cart. -
TotalAmount: number
Title:
Total Amount
Read Only:true
The numeric value of the total amount charge of a cart. -
TotalDiscountAmount: number
Title:
Total Discount Amount
Read Only:true
The numeric value of the total discount amount given for a cart.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Miscellaneous Fee Items
Type:
array
Title:
Miscellaneous Fee Items
The miscellaneous fee items resource provides a list of miscellaneous fee items present in the cart.
Show Source
Nested Schema : Scheduled Course Items
Type:
array
Title:
Scheduled Course Items
The scheduled course items resource provides a list of scheduled course items present in the cart.
Show Source
Nested Schema : transactionReferenceContexts-carts-miscellaneousFeeItems-item-response
Type:
Show Source
object
-
CartDetailId: integer
(int64)
Title:
Miscellaneous Fee Cart ID
Read Only:true
The unique identifier of the cart detail of the miscellaneous fee item. -
CurrencyCode: string
Title:
Currency Code
Read Only:true
Maximum Length:15
The currency code associated with a miscellaneous fee. -
CurrencySymbol: string
Title:
Currency Symbol
Read Only:true
The currency symbol associated with a miscellaneous fee. -
DiscountAmount: number
Title:
Discount Amount
Read Only:true
The numeric value of the discount amount given for a miscellaneous item. -
FeeAttributeLongDescription: string
Title:
Fee Attribute Long Description
Read Only:true
Maximum Length:240
The detailed description for the miscellaneous fee attribute. -
FeeAttributeTransactionDescription: string
Title:
Fee Attribute Transaction Description
Read Only:true
Maximum Length:100
The invoices and credit memos description. -
FeeCategoryName: string
Title:
Fee Category Name
Read Only:true
Maximum Length:50
The name of the fee category. -
FlatAmount: number
Title:
Amount
Read Only:true
The amount that will be charged for the fee. For example, a flat fee amount could be charged regardless of whether the student is an undergraduate or graduate student. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : transactionReferenceContexts-carts-scheduledCourseItems-item-response
Type:
Show Source
object
-
AcademicSubjectCode: string
Title:
Subject Code
Read Only:true
Maximum Length:30
The code for the academic subject of the scheduled course. -
CartDetailId: integer
(int64)
Title:
Scheduled Course Cart ID
Read Only:true
The unique identifier of the cart detail of the scheduled course. -
CreditTypeMeaning: string
Title:
Type of Credit Meaning
Read Only:true
Maximum Length:80
The meaning of the type of credit of the scheduled course. Valid values include Continuing education units, Credit hours, or No credit type. -
CurrencyCode: string
Title:
Currency Code
Read Only:true
The currency code associated with a scheduled course fee. -
CurrencySymbol: string
Title:
Currency Symbol
Read Only:true
The currency symbol associated with a scheduled course fee. -
CurriculumCatalogNumber: string
Title:
Catalog Number
Read Only:true
Maximum Length:10
The code for the scheduled course. -
GradingOptionName: string
Title:
Grading Option Name
Read Only:true
The name for the grading option of a scheduled course. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OwningCurriculumName: string
Title:
Owning Name
Read Only:true
Maximum Length:50
The unique identifier of the parent curriculum item. -
ScheduledCourseCode: string
Title:
Scheduled Course Code
Read Only:true
Maximum Length:30
The code used to identify a scheduled course within a given course and academic period. -
SelfPacedCalculatedClassEndDate: string
(date)
Title:
Self-Paced End Date
Read Only:true
The end date of self-paced classes. -
SelfPacedClassStartDate: string
(date)
Title:
Self-Paced Start Date
The start date of self-paced classes. -
TotalAmount: number
Title:
Total Amount
Read Only:true
The numeric value of the total amount charge of a scheduled course item. -
TotalDiscountAmount: number
Title:
Total Discount Amount
Read Only:true
The numeric value of the total discount amount given for a scheduled course item.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : transactionReferenceContexts-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.
-
BalanceAmount: number
Total amount due on the student account.
-
bills: array
Bills
Title:
Bills
The bills resource is a child of the student account resource and provides a list of bill numbers for a student account. -
CountryCode: string
Maximum Length:
255
A short alphabetic code representing the country that is used as the default address. -
CurrencyCode: string
Currency code associated with the business unit.
-
CurrencySymbol: string
Currency symbol associated with the currency code.
-
DueAmount: number
Amount due from the student.
-
DueDate: string
(date)
The date when the student must pay an amount due.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
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 : Bills
Type:
array
Title:
Bills
The bills resource is a child of the student account 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 : transactionReferenceContexts-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. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : transactionReferenceContexts-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 : 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 : 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