Get all payment data
get
/fscmRestApi/resources/11.13.18.05/publicSectorPayments
Request
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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 payments that match the primary key criteria specified. Finder Variables:
- PaymentHistoryKey; integer; The unique identifier for the payment transaction.
- PrimaryKey: Finds payments that match the primary key criteria specified. Finder Variables:
-
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.
-
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 attributes. 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 -
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".
Response
Supported Media Types
- application/vnd.oracle.adf.resourcecollection+json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorPayments
Type:
Show Source
object-
count(optional):
integer
Title:
CountThe number of resource instances returned in the current range. -
hasMore(optional):
boolean
Title:
HasMoreIndicates 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(optional):
array Items
Title:
ItemsThe items in the collection. -
limit(optional):
integer
Title:
LimitThe actual paging size used by the server. -
links(optional):
array Items
Title:
ItemsThe link relations associated with the resource instance. -
offset(optional):
integer
Title:
OffsetThe offset value used in the current page.
Nested Schema : Items
Type:
arrayTitle:
ItemsThe link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorPayments-item
Type:
Show Source
object-
Address1(optional):
string
Maximum Length:
240First line of the payer billing address. Requires a valid street number and name. -
Address2(optional):
string
Maximum Length:
240Second line of the payer billing address such as apartment, suite, unit, building, floor, or village information. -
Address3(optional):
string
Maximum Length:
240Third line of the payer billing address. -
Address4(optional):
string
Maximum Length:
240Fourth line of the payer billing address. -
AgencyId(optional):
integer(int64)
The unique identifier of the agency associated with the payment transaction.
-
AmountDue(optional):
number
Total Payment amount due that is the sum total of the amounts on payment history lines.
-
AuthorizationCode(optional):
string
Maximum Length:
10Authorization code value returned by the payment gateway or trust account system. -
AuthorizationStatus(optional):
string
Maximum Length:
4The status value returned by the payment gateway or trust account system. -
BusinessEntityDbaName(optional):
string
Maximum Length:
100Doing business as name of the business making the payment. -
BusinessEntityId(optional):
string
Maximum Length:
50The unique identifier for the business entity associated with this transaction. -
BusinessEntityName(optional):
string
Maximum Length:
100Entity name of the business making the payment. -
BusinessEntityPartyId(optional):
integer(int64)
The unique identifier for the business entity party associated with this transaction.
-
BusinessLocationId(optional):
string
Maximum Length:
50The unique identifier for the location of the business entity. -
BusinessLocationPartyId(optional):
integer(int64)
The unique identifier for the party associated with the business entity location.
-
BusinessProfileId(optional):
integer(int64)
The unique identifier for the profile of the business entity associated with this transaction.
-
CreditCardDigits(optional):
integer(int64)
Title:
Credit Card DigitsThe last four digits of the credit card number used for a payment. -
CreditCardType(optional):
string
Title:
Credit Card TypeMaximum Length:4The type of credit card used for a payment. Examples are MasterCard and Visa. -
FarReceiptStatus(optional):
string
Title:
Receivables Receipt StatusMaximum Length:30Status to indicate creation of receipt in Oracle Receivables. -
FarReceiptStatusDescr(optional):
string
Maximum Length:
80Status to indicate creation of receipt in Oracle Receivables. -
FirstResponseMessage(optional):
string
Maximum Length:
100First part of the response message returned by the payment gateway or a free form message entered by agency staff for cash drawer or trust account. -
links(optional):
array Items
Title:
ItemsLink Relations -
Meaning(optional):
string
Maximum Length:
80Payment method description. -
MigratedDataFlag(optional):
string
Maximum Length:
3Flag to indicate data is migrated from another system. -
PartyId(optional):
integer(int64)
The unique identifier for the party associated with this transaction.
-
PayerCity(optional):
string
Maximum Length:
60City of the payer billing address. -
PayerCountryThreeCharacterCode(optional):
string
Maximum Length:
3International three-digit country code call prefix of the payer's phone number. -
PayerCountryTwoCharacterCode(optional):
string
Maximum Length:
2International two-digit country code call prefix of the payer's phone number. -
PayerCounty(optional):
string
Maximum Length:
60County of the payer billing address. This is a geographical subdivision within a state or region and encompasses multiple cities. -
PayerEmail(optional):
string
Title:
EmailMaximum Length:320Email address of the payer for a payment transaction. -
PayerFirstName(optional):
string
Title:
First NameMaximum Length:150The first name of the payer for a payment transaction. -
PayerLastName(optional):
string
Title:
Last NameMaximum Length:150The last name of the payer for a payment transaction. -
PayerMiddleName(optional):
string
Title:
Middle NameMaximum Length:60The middle name of the payer for a payment transaction. -
PayerNameSuffix(optional):
string
Title:
SuffixMaximum Length:30Suffix for the name of the payer for a payment transaction. -
PayerPhone(optional):
string
Maximum Length:
60Phone number of the person making the payment. -
PayerPostalAddOnCode(optional):
string
Maximum Length:
10Additional digits used to identify a specific mail delivery route. -
PayerPostalCode(optional):
string
Maximum Length:
60Postal code of the payer billing address. Can be a series of digits or letters or both. -
PayerProvince(optional):
string
Maximum Length:
60Region code for the payer billing address in non-US countries. In Canada, this is the two character province abbreviation by the Canada Post. -
PayerState(optional):
string
Maximum Length:
60State code of the payer billing address. In the U.S, this is the two character USPS state abbreviation. For example, NY for New York. -
PaymentAdapterId(optional):
string
Maximum Length:
100The unique identifier of the payment adapter associated with the agency and payment method. -
PaymentAmount(optional):
number
Title:
Amount PaidTotal payment amount authorized and settled by the payment gateway or verified by the trust account system. -
PaymentCurrency(optional):
string
Title:
CurrencyMaximum Length:3Currency used for the payment transaction. -
PaymentDate(optional):
string(date)
Title:
Receipt DateDate on which the payment transaction occurred. -
PaymentHistoryKey(optional):
integer(int64)
The unique identifier for the payment transaction.
-
PaymentHistoryLine(optional):
array Payment Lines
Title:
Payment LinesThe payment lines resource is used to view or create payment detail lines. -
PaymentMethodCode(optional):
string
Maximum Length:
30Method of payment used for a payment transaction, such as credit card, cash, personal check, or cashier's check. -
PaymentReferenceId(optional):
string
Title:
Payment Reference IDMaximum Length:50A reference value created by the payment module and sent as pass through data to the payment processor, trust account, and cash drawer. -
PaymentTrackingData(optional):
string
Title:
Primary Payment Tracking DataMaximum Length:50The identifying attribute passed during checkout by the originator of the assessed fees. -
PaymentTrackingDataPlus(optional):
string
Title:
Secondary Payment Tracking DataMaximum Length:50The additional identifying attribute passed during checkout by the originator of the assessed fees. -
PaymentTransactionId(optional):
string
Title:
Payment Transaction IDMaximum Length:50The unique identifier of the transaction that is received from the payment gateway or from the trust account system. -
ProfileId(optional):
integer(int64)
The unique identifier for the profile of the user associated with this transaction.
-
SecondResponseMessage(optional):
string
Maximum Length:
100Second part of the response message returned by the payment gateway or a free form message entered by agency staff for cash drawer or trust account. -
ServiceChargeAmount(optional):
number
Convenience fee assessed by the department for using a specific payment method.
-
ServiceChargeCurrency(optional):
string
Maximum Length:
3Currency used for the service charge. -
ThirdResponseMessage(optional):
string
Maximum Length:
100Third part of the response message returned by the payment gateway or a free form message entered by agency staff for cash drawer or trust account. -
TrustAccountNumber(optional):
string
Title:
Trust Account NumberMaximum Length:30An attribute that identifies the logical trust account number.
Nested Schema : Payment Lines
Type:
arrayTitle:
Payment LinesThe payment lines resource is used to view or create payment detail lines.
Show Source
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.
Nested Schema : publicSectorPayments-PaymentHistoryLine-item
Type:
Show Source
object-
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. -
Classification(optional):
string
Maximum Length:
3Source application that generated the fee. -
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.
-
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. -
RecordId(optional):
string
Title:
Record IDMaximum Length:50Source application's record identifier. -
RecordTypeId(optional):
string
Title:
Record TypeMaximum Length:30Source application's record type.