1. REST API for Oracle Public Sector Permitting and Licensing
  2. Tasks
  3. Billing and Payment
  4. Deposit Account Related Fee Dues

Get all deposit accounts and fees payable by authorized users with funds in each deposit account

get

/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountRelatedFeeDues

Request

Query Parameters
  • 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 a record using the primary key criteria.
      Finder Variables:
      • FeeRecordKey; integer; The unique identifier of the fee record.
    • simpleSearchFinder: Finds a fee record using the specified record identifier.
      Finder Variables:
      • value; string; The unique identifier for the fee record.
  • 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:
    • AccountDescription; string; The value of description on the deposit account record.
    • AccountType; string; The identifier assigned to classify the deposit account.
    • AgencyId; integer; The unique identifier of the agency on the agency record.
    • AssessedDate; string; The date by which fee is payable.
    • AuthorizedId; integer; The party identifier of the authorized user.
    • AuthorizedUser; string; The name of the user eligible to access a deposit account record.
    • AvailableBalance; number; The value of balance available in the deposit account.
    • Classification; string; The identifier assigned to classify a source record.
    • CurrencyCode; string; The value of currency of deposit account funds.
    • DepartmentDescription; string; The descriptive value of the department specified on the fee record.
    • DepartmentId; string; The identifier of department specified on the fee record.
    • DepositAccountKey; integer; The unique identifier of the deposit account record.
    • DepositAccountName; string; The unique name of the deposit account that is assigned by user.
    • DepositAccountNumber; string; The unique identifier of the deposit account that is generated using a numbering schema.
    • FeeAmount; number; The amount on the fee record.
    • FeeChargeOption; string; The code that identifies the intent of utilization of funds in the deposit account.
    • FeeChargeOptionDesc; string; The descriptive value that identifies the intent of utilization of funds in the deposit account.
    • FeeCurrency; string; The currency code value on the fee record.
    • FeeDescription; string; The descriptive value of the fee item.
    • FeeItemId; string; The value that identifies the fee item.
    • FeeRecordKey; integer; The unique identifier of the fee record.
    • FeeStatus; string; The status of the fee record.
    • LnpRecordId; string; The unique identifier of the source record that is generated using a numbering schema.
    • LnpRecordKey; integer; The unique identifier of the source record.
    • MinimumBalance; number; The minimum balance that should be maintained in the deposit account.
    • OwnerName; string; The name of the primary owner on a deposit account owner record.
    • PartyId; integer; The party identifier of the applicant or contact.
    • ProjectCode; string; The project code assigned to a deposit account.
    • ProjectPrimaryAccount; string; Indicates whether the deposit account is the primary account for the specified project.
    • Purpose; string; The purpose for which the deposit account is set up.
    • RecoryTypeId; string; The unique identifier of the source record type.
  • 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 : publicSectorDepositAccountRelatedFeeDues
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : publicSectorDepositAccountRelatedFeeDues-item-response
Type: object
Show Source
Back to Top