Jump to

• Request
• Response

Get student refund detail

get

/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=

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 Top

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.

Body ()

Root Schema : hedRefundDetails-item-response

Type: object

Show Source

• 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: 255

  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.

{
    "type":"object",
    "properties":{
        "PartyTypeMeaning":{
            "title":"Party Type Meaning",
            "type":"string",
            "description":"Description for the type of party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "Meaning",
                    "PartyId2",
                    "PartyId3"
                ]
            }
        },
        "RefundPaymentMethodCode":{
            "title":"Refund Payment Method Code",
            "maxLength":"255",
            "type":"string",
            "description":"Code for the refund payment method.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "payments":{
            "title":"Student Management Refund Detail Payments",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/hedRefundDetails-payments-item-response"
            }
        },
        "AcademicBusinessUnitName":{
            "title":"Academic Business Unit Name",
            "type":"string",
            "description":"The name of the academic business unit.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "AlternateOrgName1",
                    "OrgId2",
                    "OrgId3"
                ]
            },
            "x-queryable":true
        },
        "RefundedTransactionId":{
            "title":"Refunded Transaction ID",
            "type":"integer",
            "description":"Unique identifier of the refunded transaction.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastModifiedOn":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date and time of the last update to the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyName":{
            "type":"string",
            "description":"Name of the party.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "PartyId2",
                    "PartyId3",
                    "PartyName1"
                ]
            },
            "x-queryable":true
        },
        "InvoiceAmount":{
            "title":"Invoice Amount",
            "type":"number",
            "description":"Amount of the invoice.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "Amount1",
                    "AmountDueOriginal"
                ]
            },
            "x-queryable":true
        },
        "InvoiceId":{
            "title":"Invoice ID",
            "type":"integer",
            "description":"Unique numeric identifier for the invoice.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RefundPaymentMethodMeaning":{
            "title":"Refund Payment Method Meaning",
            "maxLength":"255",
            "type":"string",
            "description":"The payment method for the refund.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StatusCode":{
            "title":"Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code for the status of the refund detail.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencySymbol":{
            "title":"Currency Symbol",
            "maxLength":"12",
            "type":"string",
            "description":"The symbol for the refund's currency code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"Currency of the refund represented as the three letter ISO code that's associated with a currency.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RefundedTransactionNumber":{
            "type":"string",
            "description":"Number that identifies a receipt.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "ReceiptNumber",
                    "TrxNumber"
                ]
            },
            "x-queryable":true
        },
        "PartyTypeCode":{
            "title":"Party Type",
            "type":"string",
            "description":"Type of party, such as person or organization.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "PartyId2",
                    "PartyId3",
                    "PartyType"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "InvoiceNumber":{
            "title":"Invoice Number",
            "maxLength":"30",
            "type":"string",
            "description":"String identifying the invoice.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedOn":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time of the creation of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessUnitName":{
            "title":"Business Unit Name",
            "type":"string",
            "description":"The name of the business unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "BUName",
                    "OrgId2",
                    "OrgId3"
                ]
            }
        },
        "BusinessUnitId":{
            "title":"Business Unit ID",
            "type":"integer",
            "description":"Identifier of the business unit associated with the credit being refunded.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "OrgId2",
                    "OrgId3",
                    "OrgId4"
                ]
            },
            "x-queryable":true
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"Amount that will be refunded for the credit.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerAccountNumber":{
            "title":"Customer Account Number",
            "type":"integer",
            "description":"The account number for the customer.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "BillToCustomerId",
                    "PayFromCustomer"
                ]
            },
            "x-queryable":true
        },
        "AccountNumber":{
            "title":"Payee Bank Account Number",
            "maxLength":"30",
            "type":"string",
            "description":"Identifier for the account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusMeaning":{
            "title":"Status Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Description of the refund status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MaskedAccountNumber":{
            "title":"Masked Account Number",
            "maxLength":"100",
            "type":"string",
            "description":"Masked version of the refund recipient's bank account number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"Identifier of the party who received the refund.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RefundDetailId":{
            "title":"Refund Detail ID",
            "type":"integer",
            "description":"Unique identifier of the higher education refund detail.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "StatusDetails":{
            "title":"Status Details",
            "type":"string",
            "description":"Details about the status.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RefundId":{
            "title":"Refund ID",
            "type":"integer",
            "description":"Unique identifier of the higher education refund process.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProcessId":{
            "title":"Process ID",
            "type":"integer",
            "description":"Unique identifier of the scheduled process request. For Oracle Enterprise Scheduler, this column stores the job request ID returned by ESS.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object hedRefundDetails-payments-item-response

{
    "title":"Student Management Refund Detail Payments",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/hedRefundDetails-payments-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : hedRefundDetails-payments-item-response

Type: object

Show Source

• 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 Multiline 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.

{
    "type":"object",
    "properties":{
        "PaymentDate":{
            "title":"Payment Date",
            "type":"string",
            "description":"The date a payment is made.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"Amount of the payment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PayeeName":{
            "title":"Payee Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the person or organization a check is payable to.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CheckNumber":{
            "title":"Check Number",
            "type":"integer",
            "description":"The identifying number printed on a paper check.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PaymentMethodCode":{
            "title":"Payment Method",
            "maxLength":"30",
            "type":"string",
            "description":"Code associated with a payment's method of disbursement",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentMethodMeaning":{
            "title":"Payment Method Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Description for the payment's method of disbursement.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencySymbol":{
            "title":"Currency Symbol",
            "maxLength":"12",
            "type":"string",
            "description":"The symbol for the payment's currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FormattedMultilineAddress":{
            "title":"Formatted Multiline Address",
            "maxLength":"255",
            "type":"string",
            "description":"The delivery address for a check formatted according to country.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountNumber":{
            "title":"Payee Bank Account Number",
            "maxLength":"30",
            "type":"string",
            "description":"Bank account number of a payee.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"Currency of the payment represented as the three letter ISO code that's associated with a currency.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentStatusMeaning":{
            "title":"Payment Status Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Description of a payment's status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MaskedAccountNumber":{
            "title":"Masked Account Number",
            "maxLength":"100",
            "type":"string",
            "description":"Masked version of the refund recipient's bank account number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CheckId":{
            "title":"Check ID",
            "type":"integer",
            "description":"Identifier for a check payment.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PaymentStatusCode":{
            "title":"Payment Status",
            "maxLength":"25",
            "type":"string",
            "description":"Code associated with the status of a payment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

payments

Operation: /fscmRestApi/resources/11.13.18.05/hedRefundDetails/{RefundDetailId}/child/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.

Back to Top