Get all on account payment data
get
/fscmRestApi/resources/11.13.18.05/publicSectorOnAccountPayments
Request
Query Parameters
-
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 fields. Only the specified fields are returned, which means that if no fields are specified, no fields 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 fields. 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 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds on account payments that match the primary key criteria specified.
Finder Variables:- OnaccountHistoryKey; integer; The unique identifier for the transaction.
- simpleSearchFinder: Finds on account payments records that match the simple search finder criteria specified.
Finder Variables:- value; string; The bind variable for the simple search finder.
- PrimaryKey: Finds on account payments that match the primary key criteria specified.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AdditionalReferenceId; string; The additional identifier provided along with the payment.
- AdditionalReferenceType; string; The type of additional identifier provided along with the payment.
- AgencyId; integer; The unique identifier of the agency associated with the on account record.
- AmountDue; number; The PSCR payment amount on the payment history record.
- AmountPaid; number; The PSCR payment received on the payment history record.
- BusinessEntityDbaName; string; The PSCR business entity doing business as name on the payment history record.
- BusinessEntityName; string; The PSCR business entity name on the payment history record.
- CheckoutId; integer; Checkout identifier for the credit applied.
- CreditAppliedFlag; string; Payment on account credit is applied.
- FarCashReceiptId; integer; The identifier for the receipt in Fusion Receivables.
- FarReceiptStatus; string; The status of the receipt in Fusion Receivables.
- Meaning; string; The description for the Fusion Receivables receipt status.
- MigratedDataFlag; string; Indicates whether the data is migrated from a legacy system.
- OnAccountStatusDesc; string; Describes the on account status.
- OnaccountAction; string; The action the user wants to take for the on account record.
- OnaccountAmount; number; The amount that is held on account.
- OnaccountCredit; number; Indicates the on account credit amount.
- OnaccountCurrency; string; The currency of the amount held on account.
- OnaccountDate; string; The date on which the payment was received.
- OnaccountHistoryKey; integer; The unique identifier for the transaction.
- OnaccountReasonCode; string; The reason payment was not applied to an invoice or a fee record.
- OnaccountReferenceId; string; 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; The source of the record.
- OnaccountStatus; string; The status of the on account record.
- PartyId; integer; The party associated to the on account record.
- PayerEmail; string; The PSCR payer email address on the payment history record.
- PayerFirstName; string; The PSCR payer first name on the payment history record.
- PayerLastName; string; The PSCR payer last name on the payment history record.
- PayerMiddleName; string; The PSCR payer middle name on the payment history record.
- PayerNameSuffix; string; The PSCR payer name suffix on the payment history record.
- PaymentInstrumentDate; string; The date on the payment instrument.
- PaymentInstrumentNumber; string; The payment instrument number that can identify the on account payment.
- PaymentMethodCode; string; The PSCR payment method code.
- PaymentReferenceId; string; The PSCR payment reference identifier on the payment history record.
- PaymentTransactionId; string; The PSCR payment transaction identifier on the payment history record.
- PrimaryReferenceId; string; The primary identifier provided along with the payment.
- PrimaryReferenceType; string; The type of primary identifier provided along with the payment.
- PrimaryTrackingData; string; The primary PSCR payment tracking data on the payment history record.
- ProfileId; integer; The profile associated to the on account record.
- RefundAmount; number; The amount to be refunded.
- RefundCurrency; string; The currency of the refund amount.
- RefundDate; string; The date the refund was initiated.
- RefundMethodCode; string; The method used for the refund.
- RefundReasonCode; string; The reason for the refund.
- RefundReferenceId; string; The refund reference identifier.
- RefundStatus; string; The status of the refund.
- RequireAccounting; string; Indicates whether accounting entries should be created for the on account record.
- ReversalFlag; string; Specifies whether the record is a reversal of an overpayment.
- ReversalTransactionType; string; Indicates the type of reversal transaction.
- SecondaryReferenceId; string; The secondary identifier provided along with the payment.
- SecondaryReferenceType; string; The type of secondary identifier provided along with the payment.
- SecondaryTrackingData; string; The secondary PSCR payment tracking data on the payment history record.
- TrustAccountNumber; string; The PSCR trust account on the payment history record.
- UnappliedFlag; string; Identifies the unapplied payment record.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.
There's no request body for this operation.
Back to TopResponse
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
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested 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.