Create an on account payment data
post
/fscmRestApi/resources/11.13.18.05/publicSectorOnAccountPayments
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
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 ID
Maximum Length:50
The additional identifier provided along with the payment. -
AdditionalReferenceType(optional):
string
Title:
Additional Reference Type
Maximum Length:30
The 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 Due
The 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:
100
The PSCR business entity doing business as name on the payment history record. -
BusinessEntityName(optional):
string
Maximum Length:
100
The PSCR business entity name on the payment history record. -
FarCashReceiptId(optional):
integer(int64)
Title:
Receivables Receipt ID
The identifier for the receipt in Fusion Receivables. -
FarReceiptStatus(optional):
string
Maximum Length:
30
The status of the receipt in Fusion Receivables. -
links(optional):
array Items
Title:
Items
Link Relations -
Meaning(optional):
string
Maximum Length:
80
The description for the Fusion Receivables receipt status. -
MigratedDataFlag(optional):
string
Maximum Length:
1
Indicates whether the data is migrated from a legacy system. -
OnaccountAction(optional):
string
Title:
On Account Action
Maximum Length:30
The action the user wants to take for the on account record. -
OnaccountAmount(optional):
number
Title:
On Account Amount
The amount that is held on account. -
OnaccountCurrency(optional):
string
Title:
On Account Currency
Maximum Length:3
The currency of the amount held on account. -
OnaccountDate(optional):
string(date)
Title:
On Account Date
The date on which the payment was received. -
OnaccountHistoryKey(optional):
integer(int64)
The unique identifier for the transaction.
-
OnaccountReasonCode(optional):
string
Title:
On Account Reason Code
Maximum Length:30
The reason payment was not applied to an invoice or a fee record. -
OnaccountReferenceId(optional):
string
Title:
On Account Reference ID
Maximum Length:30
Combination 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 Source
Maximum Length:30
The source of the record. -
OnaccountStatus(optional):
string
Title:
On Account Status
Maximum Length:30
The status of the on account record. -
PartyId(optional):
integer(int64)
The party associated to the on account record.
-
PayerEmail(optional):
string
Maximum Length:
320
The PSCR payer email address on the payment history record. -
PayerFirstName(optional):
string
Title:
Payer First Name
Maximum Length:150
The PSCR payer first name on the payment history record. -
PayerLastName(optional):
string
Title:
Payer Last Name
Maximum Length:150
The PSCR payer last name on the payment history record. -
PayerMiddleName(optional):
string
Title:
Payer Middle Name
Maximum Length:60
The PSCR payer middle name on the payment history record. -
PayerNameSuffix(optional):
string
Title:
Payer Name Suffix
Maximum Length:30
The PSCR payer name suffix on the payment history record. -
PaymentInstrumentDate(optional):
string(date)
Title:
Payment Instrument Date
The date on the payment instrument. -
PaymentInstrumentNumber(optional):
string
Title:
Payment Instrument Number
Maximum Length:50
The payment instrument number that can identify the on account payment. -
PaymentMethodCode(optional):
string
Maximum Length:
30
The PSCR payment method code. -
PaymentReferenceId(optional):
string
Maximum Length:
50
The PSCR payment reference identifier on the payment history record. -
PaymentTransactionId(optional):
string
Maximum Length:
50
The PSCR payment transaction identifier on the payment history record. -
PrimaryReferenceId(optional):
string
Title:
Primary Reference ID
Maximum Length:50
The primary identifier provided along with the payment. -
PrimaryReferenceType(optional):
string
Title:
Primary Reference Type
Maximum Length:30
The type of primary identifier provided along with the payment. -
PrimaryTrackingData(optional):
string
Maximum Length:
50
The 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:
3
The currency of the refund amount. -
RefundDate(optional):
string(date)
The date the refund was initiated.
-
RefundMethodCode(optional):
string
Maximum Length:
30
The method use for the refund. -
RefundReasonCode(optional):
string
Maximum Length:
30
The reason for the refund. -
RefundReferenceId(optional):
string
Maximum Length:
50
The refund reference identifier. -
RefundStatus(optional):
string
Maximum Length:
30
The status of the refund. -
RequireAccounting(optional):
string
Title:
Require Accounting
Maximum Length:1
Indicates whether accounting entries should be created for the on account record. -
SecondaryReferenceId(optional):
string
Title:
Secondary Reference ID
Maximum Length:50
The secondary identifier provided along with the payment. -
SecondaryReferenceType(optional):
string
Title:
Secondary Reference Type
Maximum Length:30
The type of secondary identifier provided along with the payment. -
SecondaryTrackingData(optional):
string
Maximum Length:
50
The secondary PSCR payment tracking data on the payment history record. -
TrustAccountNumber(optional):
string
Maximum Length:
30
The PSCR trust account on the payment history record.
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 : publicSectorOnAccountPayments-item
Type:
Show Source
object
-
AdditionalReferenceId(optional):
string
Title:
Additional Reference ID
Maximum Length:50
The additional identifier provided along with the payment. -
AdditionalReferenceType(optional):
string
Title:
Additional Reference Type
Maximum Length:30
The 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 Due
The 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:
100
The PSCR business entity doing business as name on the payment history record. -
BusinessEntityName(optional):
string
Maximum Length:
100
The PSCR business entity name on the payment history record. -
FarCashReceiptId(optional):
integer(int64)
Title:
Receivables Receipt ID
The identifier for the receipt in Fusion Receivables. -
FarReceiptStatus(optional):
string
Maximum Length:
30
The status of the receipt in Fusion Receivables. -
links(optional):
array Items
Title:
Items
Link Relations -
Meaning(optional):
string
Maximum Length:
80
The description for the Fusion Receivables receipt status. -
MigratedDataFlag(optional):
string
Maximum Length:
1
Indicates whether the data is migrated from a legacy system. -
OnaccountAction(optional):
string
Title:
On Account Action
Maximum Length:30
The action the user wants to take for the on account record. -
OnaccountAmount(optional):
number
Title:
On Account Amount
The amount that is held on account. -
OnaccountCurrency(optional):
string
Title:
On Account Currency
Maximum Length:3
The currency of the amount held on account. -
OnaccountDate(optional):
string(date)
Title:
On Account Date
The date on which the payment was received. -
OnaccountHistoryKey(optional):
integer(int64)
The unique identifier for the transaction.
-
OnaccountReasonCode(optional):
string
Title:
On Account Reason Code
Maximum Length:30
The reason payment was not applied to an invoice or a fee record. -
OnaccountReferenceId(optional):
string
Title:
On Account Reference ID
Maximum Length:30
Combination 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 Source
Maximum Length:30
The source of the record. -
OnaccountStatus(optional):
string
Title:
On Account Status
Maximum Length:30
The status of the on account record. -
PartyId(optional):
integer(int64)
The party associated to the on account record.
-
PayerEmail(optional):
string
Maximum Length:
320
The PSCR payer email address on the payment history record. -
PayerFirstName(optional):
string
Title:
Payer First Name
Maximum Length:150
The PSCR payer first name on the payment history record. -
PayerLastName(optional):
string
Title:
Payer Last Name
Maximum Length:150
The PSCR payer last name on the payment history record. -
PayerMiddleName(optional):
string
Title:
Payer Middle Name
Maximum Length:60
The PSCR payer middle name on the payment history record. -
PayerNameSuffix(optional):
string
Title:
Payer Name Suffix
Maximum Length:30
The PSCR payer name suffix on the payment history record. -
PaymentInstrumentDate(optional):
string(date)
Title:
Payment Instrument Date
The date on the payment instrument. -
PaymentInstrumentNumber(optional):
string
Title:
Payment Instrument Number
Maximum Length:50
The payment instrument number that can identify the on account payment. -
PaymentMethodCode(optional):
string
Maximum Length:
30
The PSCR payment method code. -
PaymentReferenceId(optional):
string
Maximum Length:
50
The PSCR payment reference identifier on the payment history record. -
PaymentTransactionId(optional):
string
Maximum Length:
50
The PSCR payment transaction identifier on the payment history record. -
PrimaryReferenceId(optional):
string
Title:
Primary Reference ID
Maximum Length:50
The primary identifier provided along with the payment. -
PrimaryReferenceType(optional):
string
Title:
Primary Reference Type
Maximum Length:30
The type of primary identifier provided along with the payment. -
PrimaryTrackingData(optional):
string
Maximum Length:
50
The 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:
3
The currency of the refund amount. -
RefundDate(optional):
string(date)
The date the refund was initiated.
-
RefundMethodCode(optional):
string
Maximum Length:
30
The method use for the refund. -
RefundReasonCode(optional):
string
Maximum Length:
30
The reason for the refund. -
RefundReferenceId(optional):
string
Maximum Length:
50
The refund reference identifier. -
RefundStatus(optional):
string
Maximum Length:
30
The status of the refund. -
RequireAccounting(optional):
string
Title:
Require Accounting
Maximum Length:1
Indicates whether accounting entries should be created for the on account record. -
SecondaryReferenceId(optional):
string
Title:
Secondary Reference ID
Maximum Length:50
The secondary identifier provided along with the payment. -
SecondaryReferenceType(optional):
string
Title:
Secondary Reference Type
Maximum Length:30
The type of secondary identifier provided along with the payment. -
SecondaryTrackingData(optional):
string
Maximum Length:
50
The secondary PSCR payment tracking data on the payment history record. -
TrustAccountNumber(optional):
string
Maximum Length:
30
The PSCR trust account on the payment history record.
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.