Create a refund line
post
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentRefunds/{RefundHistoryKey}/child/RefundHistoryLine
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
RefundHistoryKey: integer
The unique identifier for the refund transaction.
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorPaymentRefunds-RefundHistoryLine-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
The unique identifier of the agency associated with the refund transaction.
-
Classification(optional):
string
Maximum Length:
3
Source application that generated the fee. -
ItemDescription(optional):
string
Maximum Length:
100
Item description used for the original payment for this item. -
ItemLine(optional):
integer(int32)
Item line used for the original payment for this item.
-
ItemName(optional):
string
Maximum Length:
30
Item name used for the original payment for this item. -
ItemPaymentAmount(optional):
number
Payment amount from the original payment transaction for this item.
-
ItemPaymentCurrency(optional):
string
Maximum Length:
3
Currency code used from the original payment transaction for this item. -
ItemRefundAmount(optional):
number
Refund amount.
-
ItemRefundCurrency(optional):
string
Maximum Length:
3
Refund currency. -
ItemRefundReferencePrimary(optional):
string
Maximum Length:
50
Attribute identifying item level reference value provided by the refund source application. -
ItemRefundReferenceSecondary(optional):
string
Maximum Length:
50
Additional attribute identifying item level reference value provided by the refund source application. -
links(optional):
array Items
Title:
Items
Link Relations -
RecordId(optional):
string
Maximum Length:
50
Source application's record ID identifier. -
RecordTypeId(optional):
string
Maximum Length:
30
Source application's record type identifier. -
RefundHistoryKey(optional):
integer(int64)
Parent history key.
-
RefundRecordKey(optional):
integer(int32)
Auto-sequencing generated value for the unique identification of each line row.
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.
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 : publicSectorPaymentRefunds-RefundHistoryLine-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
The unique identifier of the agency associated with the refund transaction.
-
Classification(optional):
string
Maximum Length:
3
Source application that generated the fee. -
ItemDescription(optional):
string
Maximum Length:
100
Item description used for the original payment for this item. -
ItemLine(optional):
integer(int32)
Item line used for the original payment for this item.
-
ItemName(optional):
string
Maximum Length:
30
Item name used for the original payment for this item. -
ItemPaymentAmount(optional):
number
Payment amount from the original payment transaction for this item.
-
ItemPaymentCurrency(optional):
string
Maximum Length:
3
Currency code used from the original payment transaction for this item. -
ItemRefundAmount(optional):
number
Refund amount.
-
ItemRefundCurrency(optional):
string
Maximum Length:
3
Refund currency. -
ItemRefundReferencePrimary(optional):
string
Maximum Length:
50
Attribute identifying item level reference value provided by the refund source application. -
ItemRefundReferenceSecondary(optional):
string
Maximum Length:
50
Additional attribute identifying item level reference value provided by the refund source application. -
links(optional):
array Items
Title:
Items
Link Relations -
RecordId(optional):
string
Maximum Length:
50
Source application's record ID identifier. -
RecordTypeId(optional):
string
Maximum Length:
30
Source application's record type identifier. -
RefundHistoryKey(optional):
integer(int64)
Parent history key.
-
RefundRecordKey(optional):
integer(int32)
Auto-sequencing generated value for the unique identification of each line row.
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.