Create a payment line
post
/fscmRestApi/resources/11.13.18.05/publicSectorPayments/{PaymentHistoryKey}/child/PaymentHistoryLine
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
PaymentHistoryKey: integer
The unique identifier for the payment transaction.
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorPayments-PaymentHistoryLine-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int64)
The unique identifier of the agency associated with the row.
-
ApplicationReferenceId(optional):
string
Maximum Length:
50
Key identifier as the header passed by the consuming application. For example, the CART_ID value from the Pay Cart. -
ApplicationReferenceIdPlus(optional):
string
Maximum Length:
50
Additional key identifier passed by the consuming application. -
Classification(optional):
string
Maximum Length:
3
Source application that generated the fee. -
ItemCurrency(optional):
string
Maximum Length:
3
Currency code for both the unit price and tax amount. -
ItemDescription(optional):
string
Maximum Length:
50
Item description provided by the requesting application. -
ItemLine(optional):
integer(int64)
Item line provided by the requesting application. When none is provided, it is set to zero.
-
ItemName(optional):
string
Maximum Length:
30
Item name provided by the requesting application. -
ItemRecKey(optional):
integer(int64)
The key value for the item in the payment line.
-
ItemReference(optional):
string
Maximum Length:
50
Custom reference value provided by the requesting application. -
ItemTaxAmount(optional):
number
Tax amount assessed for the transaction.
-
ItemUnitPrice(optional):
number
Base price of the item being paid by the payment transaction.
-
links(optional):
array Items
Title:
Items
Link Relations -
PaymentHistoryKey(optional):
integer(int64)
The unique identifier for the payment transaction.
-
RecordId(optional):
string
Maximum Length:
50
Source application's record identifier. -
RecordTypeId(optional):
string
Maximum Length:
30
Source application's record type.
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 : publicSectorPayments-PaymentHistoryLine-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int64)
The unique identifier of the agency associated with the row.
-
ApplicationReferenceId(optional):
string
Maximum Length:
50
Key identifier as the header passed by the consuming application. For example, the CART_ID value from the Pay Cart. -
ApplicationReferenceIdPlus(optional):
string
Maximum Length:
50
Additional key identifier passed by the consuming application. -
Classification(optional):
string
Maximum Length:
3
Source application that generated the fee. -
ItemCurrency(optional):
string
Maximum Length:
3
Currency code for both the unit price and tax amount. -
ItemDescription(optional):
string
Maximum Length:
50
Item description provided by the requesting application. -
ItemLine(optional):
integer(int64)
Item line provided by the requesting application. When none is provided, it is set to zero.
-
ItemName(optional):
string
Maximum Length:
30
Item name provided by the requesting application. -
ItemRecKey(optional):
integer(int64)
The key value for the item in the payment line.
-
ItemReference(optional):
string
Maximum Length:
50
Custom reference value provided by the requesting application. -
ItemTaxAmount(optional):
number
Tax amount assessed for the transaction.
-
ItemUnitPrice(optional):
number
Base price of the item being paid by the payment transaction.
-
links(optional):
array Items
Title:
Items
Link Relations -
PaymentHistoryKey(optional):
integer(int64)
The unique identifier for the payment transaction.
-
RecordId(optional):
string
Maximum Length:
50
Source application's record identifier. -
RecordTypeId(optional):
string
Maximum Length:
30
Source application's record type.
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.