Get a payment line
get
/fscmRestApi/resources/11.13.18.05/publicSectorPayments/{PaymentHistoryKey}/child/PaymentHistoryLine/{PaymentHistoryLineUniqID}
Request
Path Parameters
-
PaymentHistoryKey: integer
The unique identifier for the payment transaction.
-
PaymentHistoryLineUniqID: integer
This is the hash key of the attributes which make up the composite key--- PaymentHistoryKey and ItemRecKey ---for the Payment Lines resource and used to uniquely identify an instance of Payment Lines. The client should not generate the hash key value. Instead, the client should query on the Payment Lines collection resource with a filter on the primary key values in order to navigate to a specific instance of Payment Lines.
For example: PaymentHistoryLine?q=PaymentHistoryKey=<value1>;ItemRecKey=<value2>
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 : 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.