Get a refund record
get
/fscmRestApi/resources/11.13.18.05/publicSectorRefundRecords/{RefundHistoryKey}
Request
Path Parameters
-
RefundHistoryKey: integer
The unique identifier for the refund history.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes 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 attributes 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 attributes. 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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorRefundRecords-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
The unique identifier of the agency associated with the refund records.
-
EmailId(optional):
string
Title:
Email
Maximum Length:100
Email address of user. -
links(optional):
array Items
Title:
Items
Link Relations -
PartyId(optional):
integer(int64)
The unique identifier for the party associated with this transaction.
-
PaymentAmount(optional):
number
Payment amount for the refund.
-
PaymentCurrency(optional):
string
Maximum Length:
3
Payment currency for the refund. -
PaymentDate(optional):
string(date)
Date on which the payment transaction occurred.
-
PaymentMethodDescr(optional):
string
Maximum Length:
80
Description for the payment method. -
PaymentReferenceId(optional):
string
Maximum Length:
50
A reference value created by the payment module and sent as pass through data to the payment processor, trust account, and cash drawer. -
ProfileId(optional):
integer(int64)
The unique identifier for the profile of the user associated with this transaction.
-
RefundAmount(optional):
number
Title:
Refund Amount
The amount to be refunded. -
RefundCurrency(optional):
string
Title:
Refund Currency
Maximum Length:3
The currency in which the amount will be refunded. -
RefundDate(optional):
string(date)
Title:
Refund Request Date
Date on which the refund occurred. -
RefundDttm(optional):
string(date-time)
Title:
Refund Processed Date
That date and time that the refund occurred. -
RefundFailureCode(optional):
string
Title:
Refund Failure Code
Maximum Length:100
Failure code for the refund. -
RefundHistoryKey(optional):
integer(int64)
The unique identifier for the refund history.
-
RefundMethodDescr(optional):
string
Title:
Refund Method
Maximum Length:80
Description for the refund method. -
RefundReasonDescr(optional):
string
Title:
Refund Reason
Maximum Length:80
Reason for the refund record. -
RefundRecordsLine(optional):
array Refund Lines
Title:
Refund Lines
The refunds records resource is used to view refund records. -
RefundReferenceId(optional):
string
Title:
Refund ID
Maximum Length:50
The unique identifier of the refund reference associated with the refund records. -
RefundReferencePrimary(optional):
string
Maximum Length:
50
Primary reference for the refund. -
RefundReferenceSecondary(optional):
string
Maximum Length:
50
Secondary reference for the refund. -
RefundRequestCode(optional):
string
Title:
Refund Request Code
Maximum Length:50
Request code for the given refund. -
RefundStatusDescr(optional):
string
Title:
Refund Status
Maximum Length:80
Description for the refund status. -
RefundTransactionId(optional):
string
Title:
Refund Transaction ID
Maximum Length:50
The unique identifier of the refund transaction associated with the refund records. -
RefundTypeDescr(optional):
string
Title:
Refund Type
Maximum Length:80
Description for the refund type. -
ResponseMessageAdditional(optional):
string
Title:
Additional Response Message
Maximum Length:100
Response message associated with the refund. -
ResponseMessagePrimary(optional):
string
Title:
Primary Response Message
Maximum Length:100
Response message associated with the refund. -
ResponseMessageSecondary(optional):
string
Title:
Secondary Response Message
Maximum Length:100
Response message associated with the refund.
Nested Schema : Refund Lines
Type:
array
Title:
Refund Lines
The refunds records resource is used to view refund records.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.
Nested Schema : publicSectorRefundRecords-RefundRecordsLine-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
The unique identifier of the agency associated with the refund records line.
-
Classification(optional):
string
Maximum Length:
3
Classification of the refund record line. -
ItemDescription(optional):
string
Title:
Item Description
Maximum Length:100
Refund records line item description. -
ItemLine(optional):
integer(int32)
Details specific to the item line.
-
ItemName(optional):
string
Title:
Item Name
Maximum Length:30
Refund record item name. -
ItemPaymentAmount(optional):
number
Refund record item amount to be paid.
-
ItemPaymentCurrency(optional):
string
Maximum Length:
3
Refund record item payment currency. -
ItemRefundAmount(optional):
number
Title:
Item Refund Amount
Refund record item amount refunded. -
ItemRefundCurrency(optional):
string
Title:
Item Refund Currency
Maximum Length:3
Refund record item amount to be paid. -
ItemRefundReferencePrimary(optional):
string
Title:
Primary Reference
Maximum Length:50
Primary reference refund record item. -
ItemRefundReferenceSecondary(optional):
string
Title:
Secondary Reference
Maximum Length:50
Secondary reference refund record item. -
links(optional):
array Items
Title:
Items
Link Relations -
RecordId(optional):
string
Maximum Length:
50
Source application's record identifier. -
RecordTypeId(optional):
string
Maximum Length:
30
Source application's record type. -
RefundHistoryKey(optional):
integer(int64)
The unique identifier for the refund record line history.
-
RefundRecordKey(optional):
integer(int32)
The unique identifier for the refund record.