1. REST API for Oracle Public Sector Permitting and Licensing
  2. Tasks
  3. Projects
  4. Project Record Fee Payments
  5. Record Fee Payments

Get all fees for the project record

get

/fscmRestApi/resources/11.13.18.05/publicSectorProjectRecordFeePayments/{publicSectorProjectRecordFeePaymentsUniqID}/child/FeeRecordDisplay

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key--- AgencyId, ProjectCode and RecordKey ---for the Project Record Fee Payments resource and used to uniquely identify an instance of Project Record Fee Payments. The client should not generate the hash key value. Instead, the client should query on the Project Record Fee Payments collection resource with a filter on the primary key values in order to navigate to a specific instance of Project Record Fee Payments.

    For example: publicSectorProjectRecordFeePayments?q=AgencyId=<value1>;ProjectCode=<value2>;RecordKey=<value3>
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields 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 fields 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 fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • 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).
  • 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
  • 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 the row that matches the primary key criteria.
      Finder Variables:
      • FeeRecordKey; integer; The unique identifier of the fee.
    • simpleSearchFinder: Finds the row that matches the specified keyword.
      Finder Variables:
      • value; string; Finds the row that matches the specified value.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • AccountingEventStatus; string; The status of the accounting event.
    • AgencyId; integer; The unique identifier of the public sector agency.
    • AssessedDate; string; The date when the fee item was assessed.
    • BillType; string; Determines the default invoice values for the invoice form and invoice number ID. The values are taken from the source application.
    • CurrencyCode; string; The default currency code for the fee schedule.
    • DepartmentDescription; string; The description of the department.
    • DepartmentId; string; The department identifier of the fee item.
    • Description; string; The description of the fee item.
    • DueDate; string; The due date for the fee item.
    • FeeAmount; number; The fee amount.
    • FeeItemId; string; The unique identifier of the fee that can be assessed for one or more record types.
    • FeeMemo; string; The memo content for the fee item.
    • FeeQuantity; number; The fee quantity.
    • FeeRecordKey; integer; The unique identifier of the fee record.
    • FeeSource; string; The source from which the fee is collected.
    • FeeStatus; string; The fee status.
    • FeeStatusMeaning; string; The meaning of the fee status.
    • Invoice; string; The invoice number for the associated bill header.
    • InvoiceLine; integer; The invoice line number.
    • LnpRecordKey; integer; The unique identifier of the record.
    • MappingSource; string; The mapping source of the application.
    • PaymentDate; string; The date when the payment was made.
    • PaymentMethodCode; string; The payment method code that is configured for the current payment option.
    • PaymentReferenceId; string; The unique identifier of the payment.
    • ReceiptNumber; string; The receipt number.
    • RefundReason; string; The reason for the refund.
    • RefundedAmount; number; The total amount refunded for the fee item.
    • RefundedCurrencyCode; string; The currency code for the refund.
    • ReversalReason; string; The reason for the reversal.
    • ReversedAmount; number; The total fee amount reversed.
    • ReversedCurrencyCode; string; The currency code for the reversal.
    • RevrecDateOption; string; Indicates the options for the revenue recognition accounting date. The options are Fee Paid, Fee Assessed, and Fee Refunded. The default value is None.
  • 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
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : publicSectorProjectRecordFeePayments-FeeRecordDisplay
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : publicSectorProjectRecordFeePayments-FeeRecordDisplay-item-response
Type: object
Show Source
Links
bulkDelete
Parameters:
  • publicSectorProjectRecordFeePaymentsUniqID: $request.path.publicSectorProjectRecordFeePaymentsUniqID
Bulk delete is a custom action that deletes more than one record on the fee records display.
Back to Top