Update a set of on account payments data
patch
/fscmRestApi/resources/11.13.18.05/publicSectorOnAccountPayments/{OnaccountHistoryKey}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
OnaccountHistoryKey: integer
The unique identifier for the transaction.
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorOnAccountPayments-item
Type:
Show Source
object-
AdditionalReferenceId(optional):
string
Title:
Additional Reference IDMaximum Length:50The additional identifier provided along with the payment. -
AdditionalReferenceType(optional):
string
Title:
Additional Reference TypeMaximum Length:30The type of additional identifier provided along with the payment. -
AgencyId(optional):
integer(int32)
The unique identifier of the agency associated with the on account record.
-
AmountDue(optional):
number
Title:
Amount DueThe PSCR payment amount on the payment history record. -
AmountPaid(optional):
number
The PSCR payment received on the payment history record.
-
BusinessEntityDbaName(optional):
string
Maximum Length:
100The PSCR business entity doing business as name on the payment history record. -
BusinessEntityName(optional):
string
Maximum Length:
100The PSCR business entity name on the payment history record. -
FarCashReceiptId(optional):
integer(int64)
Title:
Receivables Receipt IDThe identifier for the receipt in Fusion Receivables. -
FarReceiptStatus(optional):
string
Maximum Length:
30The status of the receipt in Fusion Receivables. -
links(optional):
array Items
Title:
ItemsLink Relations -
Meaning(optional):
string
Maximum Length:
80The description for the Fusion Receivables receipt status. -
MigratedDataFlag(optional):
string
Maximum Length:
1Indicates whether the data is migrated from a legacy system. -
OnaccountAction(optional):
string
Title:
On Account ActionMaximum Length:30The action the user wants to take for the on account record. -
OnaccountAmount(optional):
number
Title:
On Account AmountThe amount that is held on account. -
OnaccountCurrency(optional):
string
Title:
On Account CurrencyMaximum Length:3The currency of the amount held on account. -
OnaccountDate(optional):
string(date)
Title:
On Account DateThe date on which the payment was received. -
OnaccountHistoryKey(optional):
integer(int64)
The unique identifier for the transaction.
-
OnaccountReasonCode(optional):
string
Title:
On Account Reason CodeMaximum Length:30The reason payment was not applied to an invoice or a fee record. -
OnaccountReferenceId(optional):
string
Title:
On Account Reference IDMaximum Length:30Combination value consisting of the 'ON-??? prefix plus the value using the PSC GUID function. This value is passed to calling app and displayed to user. -
OnaccountSource(optional):
string
Title:
On Account SourceMaximum Length:30The source of the record. -
OnaccountStatus(optional):
string
Title:
On Account StatusMaximum Length:30The status of the on account record. -
PartyId(optional):
integer(int64)
The party associated to the on account record.
-
PayerEmail(optional):
string
Maximum Length:
320The PSCR payer email address on the payment history record. -
PayerFirstName(optional):
string
Title:
Payer First NameMaximum Length:150The PSCR payer first name on the payment history record. -
PayerLastName(optional):
string
Title:
Payer Last NameMaximum Length:150The PSCR payer last name on the payment history record. -
PayerMiddleName(optional):
string
Title:
Payer Middle NameMaximum Length:60The PSCR payer middle name on the payment history record. -
PayerNameSuffix(optional):
string
Title:
Payer Name SuffixMaximum Length:30The PSCR payer name suffix on the payment history record. -
PaymentInstrumentDate(optional):
string(date)
Title:
Payment Instrument DateThe date on the payment instrument. -
PaymentInstrumentNumber(optional):
string
Title:
Payment Instrument NumberMaximum Length:50The payment instrument number that can identify the on account payment. -
PaymentMethodCode(optional):
string
Maximum Length:
30The PSCR payment method code. -
PaymentReferenceId(optional):
string
Maximum Length:
50The PSCR payment reference identifier on the payment history record. -
PaymentTransactionId(optional):
string
Maximum Length:
50The PSCR payment transaction identifier on the payment history record. -
PrimaryReferenceId(optional):
string
Title:
Primary Reference IDMaximum Length:50The primary identifier provided along with the payment. -
PrimaryReferenceType(optional):
string
Title:
Primary Reference TypeMaximum Length:30The type of primary identifier provided along with the payment. -
PrimaryTrackingData(optional):
string
Maximum Length:
50The primary PSCR payment tracking data on the payment history record. -
ProfileId(optional):
integer(int64)
The profile associated to the on account record.
-
RefundAmount(optional):
number
The amount to be refunded.
-
RefundCurrency(optional):
string
Maximum Length:
3The currency of the refund amount. -
RefundDate(optional):
string(date)
The date the refund was initiated.
-
RefundMethodCode(optional):
string
Maximum Length:
30The method use for the refund. -
RefundReasonCode(optional):
string
Maximum Length:
30The reason for the refund. -
RefundReferenceId(optional):
string
Maximum Length:
50The refund reference identifier. -
RefundStatus(optional):
string
Maximum Length:
30The status of the refund. -
RequireAccounting(optional):
string
Title:
Require AccountingMaximum Length:1Indicates whether accounting entries should be created for the on account record. -
SecondaryReferenceId(optional):
string
Title:
Secondary Reference IDMaximum Length:50The secondary identifier provided along with the payment. -
SecondaryReferenceType(optional):
string
Title:
Secondary Reference TypeMaximum Length:30The type of secondary identifier provided along with the payment. -
SecondaryTrackingData(optional):
string
Maximum Length:
50The secondary PSCR payment tracking data on the payment history record. -
TrustAccountNumber(optional):
string
Maximum Length:
30The PSCR trust account on the payment history record.
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 : publicSectorOnAccountPayments-item
Type:
Show Source
object-
AdditionalReferenceId(optional):
string
Title:
Additional Reference IDMaximum Length:50The additional identifier provided along with the payment. -
AdditionalReferenceType(optional):
string
Title:
Additional Reference TypeMaximum Length:30The type of additional identifier provided along with the payment. -
AgencyId(optional):
integer(int32)
The unique identifier of the agency associated with the on account record.
-
AmountDue(optional):
number
Title:
Amount DueThe PSCR payment amount on the payment history record. -
AmountPaid(optional):
number
The PSCR payment received on the payment history record.
-
BusinessEntityDbaName(optional):
string
Maximum Length:
100The PSCR business entity doing business as name on the payment history record. -
BusinessEntityName(optional):
string
Maximum Length:
100The PSCR business entity name on the payment history record. -
FarCashReceiptId(optional):
integer(int64)
Title:
Receivables Receipt IDThe identifier for the receipt in Fusion Receivables. -
FarReceiptStatus(optional):
string
Maximum Length:
30The status of the receipt in Fusion Receivables. -
links(optional):
array Items
Title:
ItemsLink Relations -
Meaning(optional):
string
Maximum Length:
80The description for the Fusion Receivables receipt status. -
MigratedDataFlag(optional):
string
Maximum Length:
1Indicates whether the data is migrated from a legacy system. -
OnaccountAction(optional):
string
Title:
On Account ActionMaximum Length:30The action the user wants to take for the on account record. -
OnaccountAmount(optional):
number
Title:
On Account AmountThe amount that is held on account. -
OnaccountCurrency(optional):
string
Title:
On Account CurrencyMaximum Length:3The currency of the amount held on account. -
OnaccountDate(optional):
string(date)
Title:
On Account DateThe date on which the payment was received. -
OnaccountHistoryKey(optional):
integer(int64)
The unique identifier for the transaction.
-
OnaccountReasonCode(optional):
string
Title:
On Account Reason CodeMaximum Length:30The reason payment was not applied to an invoice or a fee record. -
OnaccountReferenceId(optional):
string
Title:
On Account Reference IDMaximum Length:30Combination value consisting of the 'ON-??? prefix plus the value using the PSC GUID function. This value is passed to calling app and displayed to user. -
OnaccountSource(optional):
string
Title:
On Account SourceMaximum Length:30The source of the record. -
OnaccountStatus(optional):
string
Title:
On Account StatusMaximum Length:30The status of the on account record. -
PartyId(optional):
integer(int64)
The party associated to the on account record.
-
PayerEmail(optional):
string
Maximum Length:
320The PSCR payer email address on the payment history record. -
PayerFirstName(optional):
string
Title:
Payer First NameMaximum Length:150The PSCR payer first name on the payment history record. -
PayerLastName(optional):
string
Title:
Payer Last NameMaximum Length:150The PSCR payer last name on the payment history record. -
PayerMiddleName(optional):
string
Title:
Payer Middle NameMaximum Length:60The PSCR payer middle name on the payment history record. -
PayerNameSuffix(optional):
string
Title:
Payer Name SuffixMaximum Length:30The PSCR payer name suffix on the payment history record. -
PaymentInstrumentDate(optional):
string(date)
Title:
Payment Instrument DateThe date on the payment instrument. -
PaymentInstrumentNumber(optional):
string
Title:
Payment Instrument NumberMaximum Length:50The payment instrument number that can identify the on account payment. -
PaymentMethodCode(optional):
string
Maximum Length:
30The PSCR payment method code. -
PaymentReferenceId(optional):
string
Maximum Length:
50The PSCR payment reference identifier on the payment history record. -
PaymentTransactionId(optional):
string
Maximum Length:
50The PSCR payment transaction identifier on the payment history record. -
PrimaryReferenceId(optional):
string
Title:
Primary Reference IDMaximum Length:50The primary identifier provided along with the payment. -
PrimaryReferenceType(optional):
string
Title:
Primary Reference TypeMaximum Length:30The type of primary identifier provided along with the payment. -
PrimaryTrackingData(optional):
string
Maximum Length:
50The primary PSCR payment tracking data on the payment history record. -
ProfileId(optional):
integer(int64)
The profile associated to the on account record.
-
RefundAmount(optional):
number
The amount to be refunded.
-
RefundCurrency(optional):
string
Maximum Length:
3The currency of the refund amount. -
RefundDate(optional):
string(date)
The date the refund was initiated.
-
RefundMethodCode(optional):
string
Maximum Length:
30The method use for the refund. -
RefundReasonCode(optional):
string
Maximum Length:
30The reason for the refund. -
RefundReferenceId(optional):
string
Maximum Length:
50The refund reference identifier. -
RefundStatus(optional):
string
Maximum Length:
30The status of the refund. -
RequireAccounting(optional):
string
Title:
Require AccountingMaximum Length:1Indicates whether accounting entries should be created for the on account record. -
SecondaryReferenceId(optional):
string
Title:
Secondary Reference IDMaximum Length:50The secondary identifier provided along with the payment. -
SecondaryReferenceType(optional):
string
Title:
Secondary Reference TypeMaximum Length:30The type of secondary identifier provided along with the payment. -
SecondaryTrackingData(optional):
string
Maximum Length:
50The secondary PSCR payment tracking data on the payment history record. -
TrustAccountNumber(optional):
string
Maximum Length:
30The PSCR trust account on the payment history record.
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.