Update a set of payments line data
patch
/fscmRestApi/resources/11.13.18.05/publicSectorPayments/{PaymentHistoryKey}/child/PaymentHistoryLine/{PaymentHistoryLineUniqID}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
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>
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorPayments-PaymentHistoryLine-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. -
AgencyId(optional):
integer(int64)
The unique identifier of the agency associated with the row.
-
ApplicationReferenceId(optional):
string
Maximum Length:
50Key identifier as the header passed by the consuming application. For example, the CART_ID value from the Pay Cart. -
ApplicationReferenceIdPlus(optional):
string
Maximum Length:
50Additional key identifier passed by the consuming application. -
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:
3Source 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
Maximum Length:
30Department associated with the fee item. -
FarCashReceiptId(optional):
integer(int64)
Receipt Identifier created in Oracle Receivables.
-
FarReceiptStatus(optional):
string
Maximum Length:
30Status to indicate creation of receipt in Oracle Receivables. -
FeeItemId(optional):
string
Maximum Length:
30The unique identifier for the fee item. -
FeeReferenceId(optional):
string
Maximum Length:
50The reference identifier for the fee item. -
FeeReferencePuid(optional):
string
Maximum Length:
480The PUID reference identifier for the fee item. -
Invoice(optional):
string
Maximum Length:
50Unique billing identifier. -
ItemCurrency(optional):
string
Title:
Item CurrencyMaximum Length:3Currency code for both the unit price and tax amount. -
ItemDescription(optional):
string
Title:
Item DescriptionMaximum Length:50Item 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:
30Item name provided by the requesting application. -
ItemRecKey(optional):
integer(int64)
The key value for the item in the payment line.
-
ItemReference(optional):
string
Title:
Item ReferenceMaximum Length:50Custom reference value provided by the requesting application. -
ItemTaxAmount(optional):
number
Title:
Item Tax AmountTax amount assessed for the transaction. -
ItemUnitPrice(optional):
number
Title:
Item AmountBase price of the item being paid by the payment transaction. -
links(optional):
array Items
Title:
ItemsLink Relations -
MigratedDataFlag(optional):
string
Maximum Length:
3Indicates whether the data is migrated from another system. -
PaymentHistoryKey(optional):
integer(int64)
The unique identifier for the payment transaction.
-
PaymentLinePuid(optional):
string
Maximum Length:
480The unique key identifier for the payment-related data migration 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:50Source application's record identifier. -
RecordTypeId(optional):
string
Title:
Record TypeMaximum Length:30Source 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.
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-
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. -
AgencyId(optional):
integer(int64)
The unique identifier of the agency associated with the row.
-
ApplicationReferenceId(optional):
string
Maximum Length:
50Key identifier as the header passed by the consuming application. For example, the CART_ID value from the Pay Cart. -
ApplicationReferenceIdPlus(optional):
string
Maximum Length:
50Additional key identifier passed by the consuming application. -
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:
3Source 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
Maximum Length:
30Department associated with the fee item. -
FarCashReceiptId(optional):
integer(int64)
Receipt Identifier created in Oracle Receivables.
-
FarReceiptStatus(optional):
string
Maximum Length:
30Status to indicate creation of receipt in Oracle Receivables. -
FeeItemId(optional):
string
Maximum Length:
30The unique identifier for the fee item. -
FeeReferenceId(optional):
string
Maximum Length:
50The reference identifier for the fee item. -
FeeReferencePuid(optional):
string
Maximum Length:
480The PUID reference identifier for the fee item. -
Invoice(optional):
string
Maximum Length:
50Unique billing identifier. -
ItemCurrency(optional):
string
Title:
Item CurrencyMaximum Length:3Currency code for both the unit price and tax amount. -
ItemDescription(optional):
string
Title:
Item DescriptionMaximum Length:50Item 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:
30Item name provided by the requesting application. -
ItemRecKey(optional):
integer(int64)
The key value for the item in the payment line.
-
ItemReference(optional):
string
Title:
Item ReferenceMaximum Length:50Custom reference value provided by the requesting application. -
ItemTaxAmount(optional):
number
Title:
Item Tax AmountTax amount assessed for the transaction. -
ItemUnitPrice(optional):
number
Title:
Item AmountBase price of the item being paid by the payment transaction. -
links(optional):
array Items
Title:
ItemsLink Relations -
MigratedDataFlag(optional):
string
Maximum Length:
3Indicates whether the data is migrated from another system. -
PaymentHistoryKey(optional):
integer(int64)
The unique identifier for the payment transaction.
-
PaymentLinePuid(optional):
string
Maximum Length:
480The unique key identifier for the payment-related data migration 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:50Source application's record identifier. -
RecordTypeId(optional):
string
Title:
Record TypeMaximum Length:30Source 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.