1. REST API for Oracle Fusion Cloud Financials
  2. Tasks
  3. Cash Pools

Get all cash pools

get

/fscmRestApi/resources/11.13.18.05/cashPools

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

    • CashPoolSearchCriteria Finds the cash pool that matches the criteria specified.
      Finder Variables
      • bindCashPoolName; string; Name of the cash pool.
      • bindCashPoolType; string; Type of cash pool.
      • bindCurrencyCode; string; Currency code of the cash pool.
      • bindLegalEntityName; string; Name of the legal entity.
    • PrimaryKey Finds the Cash Pool that matches the primary key criteria specified.
      Finder Variables
      • CashPoolId; integer; The unique identifier of the cash pool.
  • 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:
    • CashPoolId; integer; Unique identifier of the cash pool.
    • CashPoolName; string; User-defined name of the cash pool.
    • CashPoolType; string; Indicates whether the cash pool is Physical or Notional.
    • ConcentrationType; string; Indicates the type of concentration activity allowed. The valid values are One Account and Two Account.
    • CreatedBy; string; User who created the row for cash pool.
    • CreationDate; string; The date and time when the row for cash pool was created.
    • CurrencyCode; string; Currency of the cash pool.
    • EnabledFlag; boolean; Indicates whether the cash pool is enabled or not.
    • LastUpdateDate; string; The date and time when the row for cash pool was last updated.
    • LastUpdateLogin; string; Session login of the last user who updated the cash pool row.
    • LastUpdatedBy; string; The user who last updated the cash pool row.
    • LegalEntityName; string; The unique identifier of the legal entity associated with the cash pool.
    • SweepSettlementRequiredFlag; boolean; Indicates whether bank can generate sweep transactions the cash pool.
  • 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 : cashPools
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : cashPools-item-response
Type: object
Show Source
Nested Schema : Cash Pool Members
Type: array
Title: Cash Pool Members
The cash pool members resource is used to create, view, and delete the members of the cash pool. The members can be individual bank accounts or another cash pool.
Show Source
Nested Schema : cashPools-cashPoolMembers-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to retrieve all the cash pools by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashPools

Example Response Body

The following example shows the contents of the response body in JSON format:

{
    "items": [
        {
            "CashPoolId": 300100211293580,
            "CashPoolName": "CashPool_Level01_Incremental_USD",
            "CurrencyCode": "USD",
            "LegalEntityName": "Vision Operations",
            "SweepSettlementRequiredFlag": false,
            "EnabledFlag": true,
            "CreatedBy": "CASH_MANAGER",
            "CreationDate": "2020-09-11T08:19:19+00:00",
            "LastUpdatedBy": "CASH_MANAGER",
            "LastUpdateDate": "2020-09-11T08:19:19.104+00:00",
            "LastUpdateLogin": "AE666C98DCA11A61E0538C96F40AABA9",
            "CashPoolType": "Physical",
            "ConcentrationType": "One Account",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashPools/300100211293580",
                    "name": "cashPools",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashPools/300100211293580",
                    "name": "cashPools",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashPools/300100211293580/child/cashPoolMembers",
                    "name": "cashPoolMembers",
                    "kind": "collection"
                }
            ]
        },
        {
            "CashPoolId": 300100211293576,
            "CashPoolName": "Cash_Pool_Incremental_USD",
            "CurrencyCode": "USD",
            "LegalEntityName": "Vision Operations",
            "SweepSettlementRequiredFlag": false,
            "EnabledFlag": true,
            "CreatedBy": "CASH_MANAGER",
            "CreationDate": "2020-09-11T08:19:09+00:00",
            "LastUpdatedBy": "CASH_MANAGER",
            "LastUpdateDate": "2020-09-11T08:19:09.583+00:00",
            "LastUpdateLogin": "AE666EC8C5041A63E0538C96F40AFE98",
            "CashPoolType": "Physical",
            "ConcentrationType": "Two Account",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashPools/300100211293576",
                    "name": "cashPools",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashPools/300100211293576",
                    "name": "cashPools",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashPools/300100211293576/child/cashPoolMembers",
                    "name": "cashPoolMembers",
                    "kind": "collection"
                }
            ]
        }
    ],
    "count": 2,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashPools",
            "name": "cashPools",
            "kind": "collection"
        }
    ]
}
Back to Top