Create a refund line
post
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentRefunds/{RefundHistoryKey}/child/RefundHistoryLine
Request
Path Parameters
-
RefundHistoryKey(required): integer(int64)
The unique identifier for the refund transaction.
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
-
AgencyId: integer
(int32)
The unique identifier of the agency associated with the refund transaction.
-
Classification: string
Maximum Length:
3
Source application that generated the fee. -
FarCashReceiptId: integer
(int64)
Receipt identifier created in Oracle Receivables.
-
FarReceiptStatus: string
Maximum Length:
30
Status of the receipt creation in Oracle Receivables. -
ItemDescription: string
Maximum Length:
100
Item description used for the original payment for this item. -
ItemLine: integer
(int32)
Item line used for the original payment for this item.
-
ItemName: string
Maximum Length:
30
Item name used for the original payment for this item. -
ItemPaymentAmount: number
Title:
Item Payment Amount
Payment amount from the original payment transaction for this item. -
ItemPaymentCurrency: string
Title:
Item Payment Currency
Maximum Length:3
Currency code used from the original payment transaction for this item. -
ItemRefundAmount: number
Refund amount.
-
ItemRefundCurrency: string
Maximum Length:
3
Refund currency. -
ItemRefundReferencePrimary: string
Maximum Length:
50
Attribute identifying item level reference value provided by the refund source application. -
ItemRefundReferenceSecondary: string
Maximum Length:
50
Additional attribute identifying item level reference value provided by the refund source application. -
RecordId: string
Title:
Record ID
Maximum Length:50
Source application's record ID identifier. -
RecordTypeId: string
Maximum Length:
30
Source application's record type identifier. -
RefundRecordKey: integer
(int32)
The auto-sequencing generated value for the unique identification of each line row.
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 : publicSectorPaymentRefunds-RefundHistoryLine-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
The unique identifier of the agency associated with the refund transaction.
-
Classification: string
Maximum Length:
3
Source application that generated the fee. -
FarCashReceiptId: integer
(int64)
Receipt identifier created in Oracle Receivables.
-
FarReceiptStatus: string
Maximum Length:
30
Status of the receipt creation in Oracle Receivables. -
ItemDescription: string
Maximum Length:
100
Item description used for the original payment for this item. -
ItemLine: integer
(int32)
Item line used for the original payment for this item.
-
ItemName: string
Maximum Length:
30
Item name used for the original payment for this item. -
ItemPaymentAmount: number
Title:
Item Payment Amount
Payment amount from the original payment transaction for this item. -
ItemPaymentCurrency: string
Title:
Item Payment Currency
Maximum Length:3
Currency code used from the original payment transaction for this item. -
ItemRefundAmount: number
Refund amount.
-
ItemRefundCurrency: string
Maximum Length:
3
Refund currency. -
ItemRefundReferencePrimary: string
Maximum Length:
50
Attribute identifying item level reference value provided by the refund source application. -
ItemRefundReferenceSecondary: string
Maximum Length:
50
Additional attribute identifying item level reference value provided by the refund source application. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RecordId: string
Title:
Record ID
Maximum Length:50
Source application's record ID identifier. -
RecordTypeId: string
Maximum Length:
30
Source application's record type identifier. -
RefundHistoryKey: integer
(int64)
Read Only:
true
The parent history key. -
RefundRecordKey: integer
(int32)
The auto-sequencing generated value for the unique identification of each line row.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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.