Get a payment line data
get
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentLineCommunications/{PaymentHistoryKey}
Request
Path Parameters
-
PaymentHistoryKey: integer
The unique identifier for the payment transaction.
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 : publicSectorPaymentLineCommunications-item
Type:
Show Source
object-
Address1(optional):
string
Maximum Length:
240First line of the property address. -
Address2(optional):
string
Maximum Length:
240Second line of the property address. -
Address3(optional):
string
Maximum Length:
240Third line of the property address. -
Address4(optional):
string
Maximum Length:
240Fourth line of the property address. -
BillAgencyId(optional):
integer(int64)
Unique identifier of the agency associated with the invoice.
-
BillType(optional):
string
Maximum Length:
15Determines the default invoice values for invoice form and invoice number ID. -
CaseId(optional):
string
Maximum Length:
50Case identifier for a code enforcement fee. -
City(optional):
string
Maximum Length:
60City of the property address. -
Classification(optional):
string
Maximum Length:
80Source application that generated the fee. -
Country(optional):
string
Maximum Length:
60Country of the property address. -
County(optional):
string
Maximum Length:
60County of the property address. -
DepartmentId(optional):
string
Title:
Department IDMaximum Length:30Unique identifier for the department associated with the fee item. -
Invoice(optional):
string
Maximum Length:
50Unique billing identifier. -
ItemCurrency(optional):
string
Maximum Length:
3Currency code for both the unit price and tax amount. -
ItemDescription(optional):
string
Title:
Item DescriptionMaximum Length:100Item description provided by the requesting application. -
ItemLine(optional):
integer(int32)
Item line provided by the requesting application. When none is provided, it is set to zero.
-
ItemRecKey(optional):
integer(int32)
Title:
Line NumberThe key value for the item in the payment line. -
ItemUnitPrice(optional):
number
Title:
Item AmountBase price of the item being paid by the payment transaction. -
links(optional):
array Items
Title:
ItemsLink Relations -
PaymentHistoryKey(optional):
integer(int64)
The unique identifier for the payment transaction.
-
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. -
PostalCode(optional):
string
Maximum Length:
60Postal code of the property address. -
PostalPlus4Code(optional):
string
Maximum Length:
10Extended postal code of the property address. -
Province(optional):
string
Maximum Length:
60Province of the property address. -
RecordId(optional):
string
Title:
Record IDMaximum Length:50Unique identifier for the source application's record. -
RecordType(optional):
string
Title:
Record TypeMaximum Length:100Source application's record type. -
RecordTypeId(optional):
string
Maximum Length:
30Unique identifier for the source application's record type. -
State(optional):
string
Maximum Length:
60State of the property address.
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.