Update a student refund detail
patch
/fscmRestApi/resources/11.13.18.05/hedRefundDetails/{RefundDetailId}
Request
Path Parameters
-
RefundDetailId(required): integer(int64)
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=
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
payments: array
Student Management Refund Detail Payments
Title:
Student Management Refund Detail Payments
The refund detail payments resource is a child of the refund details resource. It lists all of the refund payments associated with a given refund. -
StatusCode: string
Title:
Status Code
Maximum Length:30
Code for the status of the refund detail.
Nested Schema : Student Management Refund Detail Payments
Type:
array
Title:
Student Management Refund Detail Payments
The refund detail payments resource is a child of the refund details resource. It lists all of the refund payments associated with a given refund.
Show Source
Response
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 : hedRefundDetails-item-response
Type:
Show Source
object
-
AcademicBusinessUnitName: string
Title:
Academic Business Unit Name
Read Only:true
The name of the academic business unit. -
AccountNumber: string
Title:
Payee Bank Account Number
Read Only:true
Maximum Length:30
Identifier for the account. -
Amount: number
Title:
Amount
Read Only:true
Amount that will be refunded for the credit. -
BusinessUnitId: integer
Title:
Business Unit ID
Read Only:true
Identifier of the business unit associated with the credit being refunded. -
BusinessUnitName: string
Title:
Business Unit Name
Read Only:true
The name of the business unit. -
CreatedOn: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time of the creation of the row. -
CurrencyCode: string
Title:
Currency Code
Read Only:true
Maximum Length:15
Currency of the refund represented as the three letter ISO code that's associated with a currency. -
CurrencySymbol: string
Title:
Currency Symbol
Read Only:true
Maximum Length:12
The symbol for the refund's currency code. -
CustomerAccountNumber: integer
Title:
Customer Account Number
Read Only:true
The account number for the customer. -
InvoiceAmount: number
Title:
Invoice Amount
Read Only:true
Amount of the invoice. -
InvoiceId: integer
(int64)
Title:
Invoice ID
Read Only:true
Unique numeric identifier for the invoice. -
InvoiceNumber: string
Title:
Invoice Number
Read Only:true
Maximum Length:30
String identifying the invoice. -
LastModifiedOn: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date and time of the last update to the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaskedAccountNumber: string
Title:
Masked Account Number
Read Only:true
Maximum Length:100
Masked version of the refund recipient's bank account number. -
PartyId: integer
(int64)
Title:
Party ID
Read Only:true
Identifier of the party who received the refund. -
PartyName: string
Read Only:
true
Name of the party. -
PartyTypeCode: string
Title:
Party Type
Read Only:true
Type of party, such as person or organization. -
PartyTypeMeaning: string
Title:
Party Type Meaning
Read Only:true
Description for the type of party. -
payments: array
Student Management Refund Detail Payments
Title:
Student Management Refund Detail Payments
The refund detail payments resource is a child of the refund details resource. It lists all of the refund payments associated with a given refund. -
ProcessId: integer
(int64)
Title:
Process ID
Read Only:true
Unique identifier of the scheduled process request. For Oracle Enterprise Scheduler, this column stores the job request ID returned by ESS. -
RefundDetailId: integer
(int64)
Title:
Refund Detail ID
Read Only:true
Unique identifier of the higher education refund detail. -
RefundedTransactionId: integer
(int64)
Title:
Refunded Transaction ID
Read Only:true
Unique identifier of the refunded transaction. -
RefundedTransactionNumber: string
Read Only:
true
Number that identifies a receipt. -
RefundId: integer
(int64)
Title:
Refund ID
Read Only:true
Unique identifier of the higher education refund process. -
RefundPaymentMethodCode: string
Title:
Refund Payment Method Code
Read Only:true
Maximum Length:30
Code for the refund payment method. -
RefundPaymentMethodMeaning: string
Title:
Refund Payment Method Meaning
Read Only:true
Maximum Length:255
The payment method for the refund. -
StatusCode: string
Title:
Status Code
Maximum Length:30
Code for the status of the refund detail. -
StatusDetails: string
(byte)
Title:
Status Details
Read Only:true
Details about the status. -
StatusMeaning: string
Title:
Status Meaning
Read Only:true
Maximum Length:80
Description of the refund status.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Student Management Refund Detail Payments
Type:
array
Title:
Student Management Refund Detail Payments
The refund detail payments resource is a child of the refund details resource. It lists all of the refund payments associated with a given refund.
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 : hedRefundDetails-payments-item-response
Type:
Show Source
object
-
AccountNumber: string
Title:
Payee Bank Account Number
Read Only:true
Maximum Length:30
Bank account number of a payee. -
Amount: number
Title:
Amount
Read Only:true
Amount of the payment. -
CheckId: integer
(int64)
Title:
Check ID
Read Only:true
Identifier for a check payment. -
CheckNumber: integer
(int64)
Title:
Check Number
Read Only:true
The identifying number printed on a paper check. -
CurrencyCode: string
Title:
Currency Code
Read Only:true
Maximum Length:15
Currency of the payment represented as the three letter ISO code that's associated with a currency. -
CurrencySymbol: string
Title:
Currency Symbol
Read Only:true
Maximum Length:12
The symbol for the payment's currency. -
FormattedMultilineAddress: string
Title:
Formatted Multi-Line Address
Read Only:true
Maximum Length:255
The delivery address for a check formatted according to country. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaskedAccountNumber: string
Title:
Masked Account Number
Read Only:true
Maximum Length:100
Masked version of the refund recipient's bank account number. -
PayeeName: string
Title:
Payee Name
Read Only:true
Maximum Length:240
Name of the person or organization a check is payable to. -
PaymentDate: string
(date)
Title:
Payment Date
Read Only:true
The date a payment is made. -
PaymentMethodCode: string
Title:
Payment Method
Read Only:true
Maximum Length:30
Code associated with a payment's method of disbursement -
PaymentMethodMeaning: string
Title:
Payment Method Meaning
Read Only:true
Maximum Length:80
Description for the payment's method of disbursement. -
PaymentStatusCode: string
Title:
Payment Status
Read Only:true
Maximum Length:25
Code associated with the status of a payment. -
PaymentStatusMeaning: string
Title:
Payment Status Meaning
Read Only:true
Maximum Length:80
Description of a payment's status.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- payments
-
Parameters:
- RefundDetailId:
$request.path.RefundDetailId
The refund detail payments resource is a child of the refund details resource. It lists all of the refund payments associated with a given refund. - RefundDetailId: