Create a student financial transaction
post
/fscmRestApi/resources/11.13.18.05/studentFinancialTransactions
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AccountType: string
The account type of the bank account associated with the financial transaction.
-
Amount: number
The line amount of the financial transaction.
-
BankAccountNumber: string
The bank account number associated to the financial transaction.
-
BranchNumber: string
The branch number of the bank associated to the financial transaction.
-
BusinessUnitId: integer
(int64)
Unique identifier of the business unit associated to the financial transaction.
-
CurrencyCode: string
Maximum Length:
15
The currency code associated to the financial transaction. -
CustomerAccountId: integer
(int64)
Unique identifier of the customer account associated to the financial transaction.
-
CustomerAccountSiteUseId: integer
(int64)
Unique identifier of the bill to site of the customer account associated to the financial transaction.
-
ExternalTrxReference: string
Maximum Length:
100
The external transaction reference provided by the third party while posting a transaction. -
FinancialTransactionId: integer
(int64)
The unique identifier of the financial transaction.
-
OrderId: string
Maximum Length:
80
The payment order number associated to the financial transaction. -
PaymentInstrumentUseId: integer
(int64)
Unique identifier of the payment instrument associated to the financial transaction.
-
ReceiptDate: string
(date)
The receipt date associated to the financial transaction.
-
ReceiptId: integer
(int64)
Unique identifier of the receipt generated in accounts receivable when the financial transaction is posted.
-
ReceiptMethodId: integer
(int64)
Unique identifier of the receipt method associated to the financial transaction.
-
ReceiptNumber: string
Maximum Length:
30
The receipt number associated to the financial transaction. -
ReceiptPostingStatus: string
Maximum Length:
30
Default Value:PENDING
The posting status of the receipt associated with the financial transaction. -
ReceiptTransactionId: integer
(int64)
The unique identifier of the receipt transaction.
-
ReferenceKey: string
The reference key associated with third party transaction.
-
RelatedPartyId: integer
Unique identifier of the learner for whom the receipt is applied.
-
Status: string
Maximum Length:
30
Default Value:REQUESTED
The status of the financial transaction. -
SubmitDate: string
(date)
The date of submission of the financial transaction.
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.
Root Schema : studentFinancialTransactions-item-response
Type:
Show Source
object
-
AccountType: string
The account type of the bank account associated with the financial transaction.
-
Amount: number
The line amount of the financial transaction.
-
BankAccountNumber: string
The bank account number associated to the financial transaction.
-
BranchNumber: string
The branch number of the bank associated to the financial transaction.
-
BusinessUnitId: integer
(int64)
Unique identifier of the business unit associated to the financial transaction.
-
CreationDate: string
(date-time)
Read Only:
true
The date of creation of the financial transaction. -
CurrencyCode: string
Maximum Length:
15
The currency code associated to the financial transaction. -
CustomerAccountId: integer
(int64)
Unique identifier of the customer account associated to the financial transaction.
-
CustomerAccountSiteUseId: integer
(int64)
Unique identifier of the bill to site of the customer account associated to the financial transaction.
-
ExternalTrxReference: string
Maximum Length:
100
The external transaction reference provided by the third party while posting a transaction. -
FinancialTransactionId: integer
(int64)
The unique identifier of the financial transaction.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrderId: string
Maximum Length:
80
The payment order number associated to the financial transaction. -
PaymentInstrumentUseId: integer
(int64)
Unique identifier of the payment instrument associated to the financial transaction.
-
ReceiptDate: string
(date)
The receipt date associated to the financial transaction.
-
ReceiptId: integer
(int64)
Unique identifier of the receipt generated in accounts receivable when the financial transaction is posted.
-
ReceiptMethodId: integer
(int64)
Unique identifier of the receipt method associated to the financial transaction.
-
ReceiptNumber: string
Maximum Length:
30
The receipt number associated to the financial transaction. -
ReceiptPostingStatus: string
Maximum Length:
30
Default Value:PENDING
The posting status of the receipt associated with the financial transaction. -
ReceiptTransactionId: integer
(int64)
The unique identifier of the receipt transaction.
-
ReferenceKey: string
The reference key associated with third party transaction.
-
RelatedPartyId: integer
Unique identifier of the learner for whom the receipt is applied.
-
Status: string
Maximum Length:
30
Default Value:REQUESTED
The status of the financial transaction. -
SubmitDate: string
(date)
The date of submission of the financial transaction.
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.