Update a cash pool
patch
/fscmRestApi/resources/11.13.18.05/cashPools/{CashPoolId}
Request
Path Parameters
-
CashPoolId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
cashPoolMembers: array
Cash Pool Members
Title:
Cash Pool MembersThe 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. -
CashPoolName: string
Maximum Length:
80User-defined name of the cash pool. -
CurrencyCode: string
Maximum Length:
15Currency of the cash pool. -
EnabledFlag: boolean
Maximum Length:
1Default Value:trueIndicates whether the cash pool is enabled or not. -
SweepSettlementRequiredFlag: boolean
Maximum Length:
1Default Value:falseIndicates whether bank can generate sweep transactions the cash pool.
Nested Schema : Cash Pool Members
Type:
arrayTitle:
Cash Pool MembersThe 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 : schema
Type:
Show Source
object-
SubBankAccountName: string
Maximum Length:
360Name of the subsidiary bank account. -
SubCashPoolName: string
Maximum Length:
80Name of the subsidiary cash pool.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
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.
Root Schema : cashPools-item-response
Type:
Show Source
object-
CashPoolId: integer
(int64)
Unique identifier of the cash pool.
-
cashPoolMembers: array
Cash Pool Members
Title:
Cash Pool MembersThe 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. -
CashPoolName: string
Maximum Length:
80User-defined name of the cash pool. -
CashPoolType: string
Maximum Length:
30Indicates whether the cash pool is Physical or Notional. -
ConcentrationType: string
Maximum Length:
40Default Value:One AccountIndicates the type of concentration activity allowed. The valid values are One Account and Two Account. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the row for cash pool. -
CreationDate: string
(date-time)
Read Only:
trueThe date and time when the row for cash pool was created. -
CurrencyCode: string
Maximum Length:
15Currency of the cash pool. -
EnabledFlag: boolean
Maximum Length:
1Default Value:trueIndicates whether the cash pool is enabled or not. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date and time when the row for cash pool was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who last updated the cash pool row. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32Session login of the last user who updated the cash pool row. -
LegalEntityName: string
Title:
Legal Entity NameRead Only:trueMaximum Length:240The unique identifier of the legal entity associated with the cash pool. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
SweepSettlementRequiredFlag: boolean
Maximum Length:
1Default Value:falseIndicates whether bank can generate sweep transactions the cash pool.
Nested Schema : Cash Pool Members
Type:
arrayTitle:
Cash Pool MembersThe 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 : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : cashPools-cashPoolMembers-item-response
Type:
Show Source
object-
CashPoolMemberId: integer
(int64)
The unique identifier of the cash pool member.
-
CashPoolMinimumPaymentAmount: number
Read Only:
trueThe minimum payment amount that can be transferred from the cash pool member bank account. This amount is derived from the bank account setup. -
CashPoolMinimumReceiptAmount: number
Read Only:
trueThe minimum receipt amount that can be transferred to the cash pool member bank account. This amount is derived from the bank account setup. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the row for cash pool member. -
CreationDate: string
(date-time)
Read Only:
trueThe date and time when the row for cash pool member was created. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date and time when the row for cash pool member was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who last updated the cash pool member row. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32Session login of the last user who updated the cash pool member row. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
SubAccountType: string
Maximum Length:
50Indicates the type of the member associated with the cash pool. Valid values are Subsidiary Account, Investment Concentration Account, Funding Concentration Account, Concentration Account, and Cash Pool. -
SubBankAccountName: string
Maximum Length:
360Name of the subsidiary bank account. -
SubCashPoolName: string
Maximum Length:
80Name of the subsidiary cash pool.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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.
Links
- cashPoolMembers
-
Parameters:
- CashPoolId:
$request.path.CashPoolId
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. - CashPoolId:
Examples
The following example shows how to update a cash pool by submitting a PATCH request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X PATCH -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashPools/300100176456144
Example Request Body
The following example shows the contents of the request body in JSON format:
{
"SweepSettlementRequiredFlag": true
}Example Response Body
The following example shows the contents of the response body in JSON format:
{
"CashPoolId": 300100211346526,
"CashPoolName": "Cash_Pool_Internal_JPY",
"CurrencyCode": "JPY",
"LegalEntityName": "Vision Operations",
"SweepSettlementRequiredFlag": true,
"EnabledFlag": true,
"CreatedBy": "CASH_MANAGER",
"CreationDate": "2020-09-13T16:42:09+00:00",
"LastUpdatedBy": "CASH_MANAGER",
"LastUpdateDate": "2020-09-18T22:35:17.135+00:00",
"LastUpdateLogin": "AE666C98F1BA1A61E0538C96F40AABA9",
"CashPoolType": "Physical",
"ConcentrationType": "Two Account",
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashPools/300100211346526",
"name": "cashPools",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashPools/300100211346526",
"name": "cashPools",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashPools/300100211346526/child/cashPoolMembers",
"name": "cashPoolMembers",
"kind": "collection"
}
]
}