Create an on account payment data
post
/fscmRestApi/resources/11.13.18.05/publicSectorOnAccountPayments
Request
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AdditionalReferenceId: string
Title:
Additional Reference ID
Maximum Length:50
The additional identifier provided along with the payment. -
AdditionalReferenceType: string
Title:
Additional Reference Type
Maximum Length:30
The type of additional identifier provided along with the payment. -
AgencyId: integer
(int32)
The unique identifier of the agency associated with the on account record.
-
AmountDue: number
Title:
Amount Due
The PSCR payment amount on the payment history record. -
AmountPaid: number
The PSCR payment received on the payment history record.
-
BusinessEntityDbaName: string
Maximum Length:
100
The PSCR business entity doing business as name on the payment history record. -
BusinessEntityName: string
Maximum Length:
100
The PSCR business entity name on the payment history record. -
CheckoutId: integer
(int64)
Checkout identifier for the credit applied.
-
CreditAppliedFlag: string
Maximum Length:
1
Default Value:N
Payment on account credit is applied. -
FarCashReceiptId: integer
(int64)
Title:
Receivables Receipt ID
The identifier for the receipt in Fusion Receivables. -
FarReceiptStatus: string
Maximum Length:
30
The status of the receipt in Fusion Receivables. -
MigratedDataFlag: string
Maximum Length:
1
Default Value:N
Indicates whether the data is migrated from a legacy system. -
OnaccountAction: string
Title:
On Account Action
Maximum Length:30
The action the user wants to take for the on account record. -
OnaccountAmount: number
Title:
On Account Amount
The amount that is held on account. -
OnaccountCredit: number
Default Value:
0
Indicates the on account credit amount. -
OnaccountCurrency: string
Title:
On Account Currency
Maximum Length:3
The currency of the amount held on account. -
OnaccountDate: string
(date)
Title:
On Account Date
The date on which the payment was received. -
OnaccountHistoryKey: integer
(int64)
The unique identifier for the transaction.
-
OnaccountReasonCode: string
Title:
On Account Reason Code
Maximum Length:30
The reason payment was not applied to an invoice or a fee record. -
OnaccountReferenceId: 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 the calling app and displayed to the user. -
OnaccountSource: string
Title:
On Account Source
Maximum Length:30
The source of the record. -
OnaccountStatus: string
Title:
On Account Status
Maximum Length:30
The status of the on account record. -
PartyId: integer
(int64)
The party associated to the on account record.
-
PayerEmail: string
Maximum Length:
320
The PSCR payer email address on the payment history record. -
PayerFirstName: string
Title:
Payer First Name
Maximum Length:150
The PSCR payer first name on the payment history record. -
PayerLastName: string
Title:
Payer Last Name
Maximum Length:150
The PSCR payer last name on the payment history record. -
PayerMiddleName: string
Title:
Payer Middle Name
Maximum Length:60
The PSCR payer middle name on the payment history record. -
PayerNameSuffix: string
Title:
Payer Name Suffix
Maximum Length:30
The PSCR payer name suffix on the payment history record. -
PaymentInstrumentDate: string
(date)
Title:
Payment Instrument Date
The date on the payment instrument. -
PaymentInstrumentNumber: string
Title:
Payment Instrument Number
Maximum Length:50
The payment instrument number that can identify the on account payment. -
PaymentMethodCode: string
Maximum Length:
30
The PSCR payment method code. -
PaymentReferenceId: string
Maximum Length:
50
The PSCR payment reference identifier on the payment history record. -
PaymentTransactionId: string
Maximum Length:
50
The PSCR payment transaction identifier on the payment history record. -
PrimaryReferenceId: string
Title:
Primary Reference ID
Maximum Length:50
The primary identifier provided along with the payment. -
PrimaryReferenceType: string
Title:
Primary Reference Type
Maximum Length:30
The type of primary identifier provided along with the payment. -
PrimaryTrackingData: string
Maximum Length:
50
The primary PSCR payment tracking data on the payment history record. -
ProfileId: integer
(int64)
The profile associated to the on account record.
-
RefundAmount: number
The amount to be refunded.
-
RefundCurrency: string
Maximum Length:
3
The currency of the refund amount. -
RefundDate: string
(date)
The date the refund was initiated.
-
RefundMethodCode: string
Maximum Length:
30
The method used for the refund. -
RefundReasonCode: string
Maximum Length:
30
The reason for the refund. -
RefundReferenceId: string
Maximum Length:
50
The refund reference identifier. -
RefundStatus: string
Maximum Length:
30
The status of the refund. -
RequireAccounting: string
Title:
Require Accounting
Maximum Length:1
Default Value:Y
Indicates whether accounting entries should be created for the on account record. -
ReversalFlag: string
Maximum Length:
1
Default Value:N
Specifies whether the record is a reversal of an overpayment. -
ReversalTransactionType: string
Maximum Length:
30
Default Value:ORA_NONE
Indicates the type of reversal transaction. -
SecondaryReferenceId: string
Title:
Secondary Reference ID
Maximum Length:50
The secondary identifier provided along with the payment. -
SecondaryReferenceType: string
Title:
Secondary Reference Type
Maximum Length:30
The type of secondary identifier provided along with the payment. -
SecondaryTrackingData: string
Maximum Length:
50
The secondary PSCR payment tracking data on the payment history record. -
TrustAccountNumber: string
Maximum Length:
30
The PSCR trust account on the payment history record. -
UnappliedFlag: string
Maximum Length:
1
Default Value:N
Identifies the unapplied payment record.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : publicSectorOnAccountPayments-item-response
Type:
Show Source
object
-
AdditionalReferenceId: string
Title:
Additional Reference ID
Maximum Length:50
The additional identifier provided along with the payment. -
AdditionalReferenceType: string
Title:
Additional Reference Type
Maximum Length:30
The type of additional identifier provided along with the payment. -
AgencyId: integer
(int32)
The unique identifier of the agency associated with the on account record.
-
AmountDue: number
Title:
Amount Due
The PSCR payment amount on the payment history record. -
AmountPaid: number
The PSCR payment received on the payment history record.
-
BusinessEntityDbaName: string
Maximum Length:
100
The PSCR business entity doing business as name on the payment history record. -
BusinessEntityName: string
Maximum Length:
100
The PSCR business entity name on the payment history record. -
CheckoutId: integer
(int64)
Checkout identifier for the credit applied.
-
CreditAppliedFlag: string
Maximum Length:
1
Default Value:N
Payment on account credit is applied. -
FarCashReceiptId: integer
(int64)
Title:
Receivables Receipt ID
The identifier for the receipt in Fusion Receivables. -
FarReceiptStatus: string
Maximum Length:
30
The status of the receipt in Fusion Receivables. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Meaning: string
Read Only:
true
Maximum Length:80
The description for the Fusion Receivables receipt status. -
MigratedDataFlag: string
Maximum Length:
1
Default Value:N
Indicates whether the data is migrated from a legacy system. -
OnaccountAction: string
Title:
On Account Action
Maximum Length:30
The action the user wants to take for the on account record. -
OnaccountAmount: number
Title:
On Account Amount
The amount that is held on account. -
OnaccountCredit: number
Default Value:
0
Indicates the on account credit amount. -
OnaccountCurrency: string
Title:
On Account Currency
Maximum Length:3
The currency of the amount held on account. -
OnaccountDate: string
(date)
Title:
On Account Date
The date on which the payment was received. -
OnaccountHistoryKey: integer
(int64)
The unique identifier for the transaction.
-
OnaccountReasonCode: string
Title:
On Account Reason Code
Maximum Length:30
The reason payment was not applied to an invoice or a fee record. -
OnaccountReferenceId: 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 the calling app and displayed to the user. -
OnaccountSource: string
Title:
On Account Source
Maximum Length:30
The source of the record. -
OnaccountStatus: string
Title:
On Account Status
Maximum Length:30
The status of the on account record. -
OnAccountStatusDesc: string
Read Only:
true
Maximum Length:80
Describes the on account status. -
PartyId: integer
(int64)
The party associated to the on account record.
-
PayerEmail: string
Maximum Length:
320
The PSCR payer email address on the payment history record. -
PayerFirstName: string
Title:
Payer First Name
Maximum Length:150
The PSCR payer first name on the payment history record. -
PayerLastName: string
Title:
Payer Last Name
Maximum Length:150
The PSCR payer last name on the payment history record. -
PayerMiddleName: string
Title:
Payer Middle Name
Maximum Length:60
The PSCR payer middle name on the payment history record. -
PayerNameSuffix: string
Title:
Payer Name Suffix
Maximum Length:30
The PSCR payer name suffix on the payment history record. -
PaymentInstrumentDate: string
(date)
Title:
Payment Instrument Date
The date on the payment instrument. -
PaymentInstrumentNumber: string
Title:
Payment Instrument Number
Maximum Length:50
The payment instrument number that can identify the on account payment. -
PaymentMethodCode: string
Maximum Length:
30
The PSCR payment method code. -
PaymentReferenceId: string
Maximum Length:
50
The PSCR payment reference identifier on the payment history record. -
PaymentTransactionId: string
Maximum Length:
50
The PSCR payment transaction identifier on the payment history record. -
PrimaryReferenceId: string
Title:
Primary Reference ID
Maximum Length:50
The primary identifier provided along with the payment. -
PrimaryReferenceType: string
Title:
Primary Reference Type
Maximum Length:30
The type of primary identifier provided along with the payment. -
PrimaryTrackingData: string
Maximum Length:
50
The primary PSCR payment tracking data on the payment history record. -
ProfileId: integer
(int64)
The profile associated to the on account record.
-
RefundAmount: number
The amount to be refunded.
-
RefundCurrency: string
Maximum Length:
3
The currency of the refund amount. -
RefundDate: string
(date)
The date the refund was initiated.
-
RefundMethodCode: string
Maximum Length:
30
The method used for the refund. -
RefundReasonCode: string
Maximum Length:
30
The reason for the refund. -
RefundReferenceId: string
Maximum Length:
50
The refund reference identifier. -
RefundStatus: string
Maximum Length:
30
The status of the refund. -
RequireAccounting: string
Title:
Require Accounting
Maximum Length:1
Default Value:Y
Indicates whether accounting entries should be created for the on account record. -
ReversalFlag: string
Maximum Length:
1
Default Value:N
Specifies whether the record is a reversal of an overpayment. -
ReversalTransactionType: string
Maximum Length:
30
Default Value:ORA_NONE
Indicates the type of reversal transaction. -
SecondaryReferenceId: string
Title:
Secondary Reference ID
Maximum Length:50
The secondary identifier provided along with the payment. -
SecondaryReferenceType: string
Title:
Secondary Reference Type
Maximum Length:30
The type of secondary identifier provided along with the payment. -
SecondaryTrackingData: string
Maximum Length:
50
The secondary PSCR payment tracking data on the payment history record. -
TrustAccountNumber: string
Maximum Length:
30
The PSCR trust account on the payment history record. -
UnappliedFlag: string
Maximum Length:
1
Default Value:N
Identifies the unapplied payment record.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.