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.
-
BusinessEntityId(optional):
string
Maximum Length:
50The unique identifier for the business entity associated with this transaction. -
BusinessEntityPartyId(optional):
integer(int64)
The unique identifier for the business entity party associated with this transaction.
-
BusinessProfileId(optional):
integer(int64)
The unique identifier for the profile of the business entity associated with this transaction.
-
EmailId(optional):
string
Title:
EmailMaximum Length:100Email address of user. -
FarReceiptStatus(optional):
string
Maximum Length:
30Status to indicate creation of receipt in Oracle Receivables. -
FarReceiptStatusDescr(optional):
string
Maximum Length:
80Description for the far receipt status. -
links(optional):
array Items
Title:
ItemsLink 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:
3Payment currency for the refund. -
PaymentDate(optional):
string(date)
Date on which the payment transaction occurred.
-
PaymentMethodCode(optional):
string
Maximum Length:
30Payment method of the original payment transaction. -
PaymentMethodDescr(optional):
string
Maximum Length:
80Description for the payment method. -
PaymentReferenceId(optional):
string
Maximum Length:
50A 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 AmountThe amount to be refunded. -
RefundCurrency(optional):
string
Title:
Refund CurrencyMaximum Length:3The currency in which the amount will be refunded. -
RefundDate(optional):
string(date)
Title:
Refund Request DateDate on which the refund occurred. -
RefundDttm(optional):
string(date-time)
Title:
Refund Processed DateThat date and time that the refund occurred. -
RefundFailureCode(optional):
string
Title:
Refund Failure CodeMaximum Length:100Failure code for the refund. -
RefundHistoryKey(optional):
integer(int64)
The unique identifier for the refund history.
-
RefundMethodCode(optional):
string
Maximum Length:
30Method of refund selected for the refund transaction. -
RefundMethodDescr(optional):
string
Title:
Refund MethodMaximum Length:80Description for the refund method. -
RefundReasonCode(optional):
string
Maximum Length:
20Justification for the refund request. -
RefundReasonDescr(optional):
string
Title:
Refund ReasonMaximum Length:80Reason for the refund record. -
RefundRecordsLine(optional):
array Refund Lines
Title:
Refund LinesThe refund lines resource is used to view refund detail lines. -
RefundReferenceId(optional):
string
Title:
Refund IDMaximum Length:50The unique identifier of the refund reference associated with the refund records. -
RefundReferencePrimary(optional):
string
Maximum Length:
50Primary reference for the refund. -
RefundReferenceSecondary(optional):
string
Maximum Length:
50Secondary reference for the refund. -
RefundRequestCode(optional):
string
Title:
Refund Request CodeMaximum Length:50Request code for the given refund. -
RefundStatus(optional):
string
Maximum Length:
10Status of the refund transaction. -
RefundStatusDescr(optional):
string
Title:
Refund StatusMaximum Length:80Description for the refund status. -
RefundTransactionId(optional):
string
Title:
Refund Transaction IDMaximum Length:50The unique identifier of the refund transaction associated with the refund records. -
RefundType(optional):
string
Maximum Length:
10Type of the refund transaction. -
RefundTypeDescr(optional):
string
Title:
Refund TypeMaximum Length:80Description for the refund type. -
ResponseMessageAdditional(optional):
string
Title:
Additional Response MessageMaximum Length:100Response message associated with the refund. -
ResponseMessagePrimary(optional):
string
Title:
Primary Response MessageMaximum Length:100Response message associated with the refund. -
ResponseMessageSecondary(optional):
string
Title:
Secondary Response MessageMaximum Length:100Response message associated with the refund.
Nested Schema : Refund Lines
Type:
arrayTitle:
Refund LinesThe refund lines resource is used to view refund detail lines.
Show Source
Nested Schema : link
Type:
Show Source
object-
href(optional):
string
Title:
hyperlink referenceThe URI to the related resource. -
rel(optional):
string
Title:
relationThe 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:
3Classification of the refund record line. -
FarCashReceiptId(optional):
integer(int64)
Receipt identifier created in Oracle Receivables.
-
FarReceiptStatus(optional):
string
Maximum Length:
30Status to indicate creation of receipt in Oracle Receivables. -
ItemDescription(optional):
string
Title:
Item DescriptionMaximum Length:100Refund records line item description. -
ItemLine(optional):
integer(int32)
Details specific to the item line.
-
ItemName(optional):
string
Title:
Item NameMaximum Length:30Refund record item name. -
ItemPaymentAmount(optional):
number
Refund record item amount to be paid.
-
ItemPaymentCurrency(optional):
string
Maximum Length:
3Refund record item payment currency. -
ItemRefundAmount(optional):
number
Title:
Item Refund AmountRefund record item amount refunded. -
ItemRefundCurrency(optional):
string
Title:
Item Refund CurrencyMaximum Length:3Refund record item amount to be paid. -
ItemRefundReferencePrimary(optional):
string
Title:
Primary ReferenceMaximum Length:50Primary reference refund record item. -
ItemRefundReferenceSecondary(optional):
string
Title:
Secondary ReferenceMaximum Length:50Secondary reference refund record item. -
links(optional):
array Items
Title:
ItemsLink Relations -
RecordId(optional):
string
Maximum Length:
50Source application's record identifier. -
RecordTypeId(optional):
string
Maximum Length:
30Source 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.