Create a cash pool
/fscmRestApi/resources/11.13.18.05/cashPools
Request
-
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
- application/json
object
-
CashPoolId: integer
(int64)
Unique identifier of the cash pool.
-
cashPoolMembers: array
Cash Pool Members
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. -
CashPoolName(required): string
Maximum Length:
80
User-defined name of the cash pool. -
CashPoolType: string
Maximum Length:
30
Indicates whether the cash pool is Physical or Notional. -
ConcentrationType: string
Maximum Length:
40
Default Value:One Account
Indicates the type of concentration activity allowed. The valid values are One Account and Two Account. -
CurrencyCode: string
Maximum Length:
15
Currency of the cash pool. -
EnabledFlag: boolean
Maximum Length:
1
Default Value:true
Indicates whether the cash pool is enabled or not. -
SweepSettlementRequiredFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether bank can generate sweep transactions the cash pool.
array
Cash Pool Members
object
-
CashPoolMemberId: integer
(int64)
The unique identifier of the cash pool member.
-
SubAccountType: string
Maximum Length:
50
Indicates 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:
360
Name of the subsidiary bank account. -
SubCashPoolName: string
Maximum Length:
80
Name of the subsidiary cash pool.
Response
- application/json
Default Response
-
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.
object
-
CashPoolId: integer
(int64)
Unique identifier of the cash pool.
-
cashPoolMembers: array
Cash Pool Members
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. -
CashPoolName: string
Maximum Length:
80
User-defined name of the cash pool. -
CashPoolType: string
Maximum Length:
30
Indicates whether the cash pool is Physical or Notional. -
ConcentrationType: string
Maximum Length:
40
Default Value:One Account
Indicates the type of concentration activity allowed. The valid values are One Account and Two Account. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the row for cash pool. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the row for cash pool was created. -
CurrencyCode: string
Maximum Length:
15
Currency of the cash pool. -
EnabledFlag: boolean
Maximum Length:
1
Default Value:true
Indicates whether the cash pool is enabled or not. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the row for cash pool was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the cash pool row. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Session login of the last user who updated the cash pool row. -
LegalEntityName: string
Title:
Legal Entity Name
Read Only:true
Maximum Length:240
The unique identifier of the legal entity associated with the cash pool. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SweepSettlementRequiredFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether bank can generate sweep transactions the cash pool.
array
Cash Pool Members
array
Links
object
-
CashPoolMemberId: integer
(int64)
The unique identifier of the cash pool member.
-
CashPoolMinimumPaymentAmount: number
Read Only:
true
The 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:
true
The 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:
true
Maximum Length:64
User who created the row for cash pool member. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the row for cash pool member was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the row for cash pool member was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the cash pool member row. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Session login of the last user who updated the cash pool member row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SubAccountType: string
Maximum Length:
50
Indicates 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:
360
Name of the subsidiary bank account. -
SubCashPoolName: string
Maximum Length:
80
Name of the subsidiary cash pool.
array
Links
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
- 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
Example 1
The following example shows how to create a physical cash pool with one concentration account and one sub account by submitting a POST request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashPools
Example Request Payload
The following example shows the contents of the request body in JSON format:
{ "CashPoolName": "Cash_Pool_Internal_CAD", "CashPoolType": "Physical", "ConcentrationType": "One Account", "SweepSettlementRequiredFlag": false, "EnabledFlag": true, "cashPoolMembers": [ { "SubBankAccountName": "CE BofA - CAD", "SubAccountType": "Concentration Account" }, { "SubBankAccountName": "CE AR BofA - CAD", "SubAccountType": "Subsidiary Account" } ] }
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "CashPoolId": 300100211346522, "CashPoolName": "Cash_Pool_Internal_CAD", "CurrencyCode": "CAD", "LegalEntityName": "Vision Operations", "SweepSettlementRequiredFlag": false, "EnabledFlag": true, "CreatedBy": "CASH_MANAGER", "CreationDate": "2020-09-13T16:29:45+00:00", "LastUpdatedBy": "CASH_MANAGER", "LastUpdateDate": "2020-09-13T00:00:00+00:00", "LastUpdateLogin": "AE666C98F1BA1A61E0538C96F40AABA9", "CashPoolType": "Physical", "ConcentrationType": "One Account", "cashPoolMembers": [ { "CashPoolMemberId": 300100211346523, "CashPoolMinimumPaymentAmount": null, "CashPoolMinimumReceiptAmount": null, "CreatedBy": "CASH_MANAGER", "CreationDate": "2020-09-13T16:29:45.532+00:00", "LastUpdatedBy": "CASH_MANAGER", "LastUpdateDate": "2020-09-13T16:29:46.297+00:00", "LastUpdateLogin": "AE666C98F1BA1A61E0538C96F40AABA9", "SubAccountType": "Concentration Account", "SubBankAccountName": "CE BofA - CAD", "SubCashPoolName": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashPools/300100211346522/child/cashPoolMembers/300100211346523", "name": "cashPoolMembers", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashPools/300100211346522/child/cashPoolMembers/300100211346523", "name": "cashPoolMembers", "kind": "item" }, { "rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashPools/300100211346522", "name": "cashPools", "kind": "item" } ] }, { "CashPoolMemberId": 300100211346524, "CashPoolMinimumPaymentAmount": null, "CashPoolMinimumReceiptAmount": null, "CreatedBy": "CASH_MANAGER", "CreationDate": "2020-09-13T16:29:45.866+00:00", "LastUpdatedBy": "CASH_MANAGER", "LastUpdateDate": "2020-09-13T16:29:46.527+00:00", "LastUpdateLogin": "AE666C98F1BA1A61E0538C96F40AABA9", "SubAccountType": "Subsidiary Account", "SubBankAccountName": "CE AR BofA - CAD", "SubCashPoolName": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashPools/300100211346522/child/cashPoolMembers/300100211346524", "name": "cashPoolMembers", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashPools/300100211346522/child/cashPoolMembers/300100211346524", "name": "cashPoolMembers", "kind": "item" }, { "rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashPools/300100211346522", "name": "cashPools", "kind": "item" } ] } ], "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashPools/300100211346522", "name": "cashPools", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashPools/300100211346522", "name": "cashPools", "kind": "item" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashPools/300100211346522/child/cashPoolMembers", "name": "cashPoolMembers", "kind": "collection" } ] }
Example 2
The following example shows how to create a notional cash pool with one concentration account and two subsidiary bank accounts by submitting a POST request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashPools
Example Request Payload
The following example shows the contents of the request body in JSON format:
{ "CashPoolName": "Cash_Pool_Notional_EUR", "CashPoolType": "Notional", "ConcentrationType": "One Account", "SweepSettlementRequiredFlag": false, "EnabledFlag": true, "cashPoolMembers": [ { "SubBankAccountName": "CE ForecastAccount-EUR-1", "SubAccountType": "Concentration Account" }, { "SubBankAccountName": "Citi Bank-CON-EUR", "SubAccountType": "Subsidiary Account" }, { "SubBankAccountName": "BelgianAccount", "SubAccountType": "Subsidiary Account" } ] }
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "CashPoolId": 300100211346531, "CashPoolName": "Cash_Pool_Notional_EUR", "CurrencyCode": "EUR", "LegalEntityName": "Vision Operations", "SweepSettlementRequiredFlag": false, "EnabledFlag": true, "CreatedBy": "CASH_MANAGER", "CreationDate": "2020-09-13T16:53:33+00:00", "LastUpdatedBy": "CASH_MANAGER", "LastUpdateDate": "2020-09-13T00:00:00+00:00", "LastUpdateLogin": "AE666C98F1BA1A61E0538C96F40AABA9", "CashPoolType": "Notional", "ConcentrationType": "One Account", "cashPoolMembers": [ { "CashPoolMemberId": 300100211346532, "CashPoolMinimumPaymentAmount": null, "CashPoolMinimumReceiptAmount": null, "CreatedBy": "CASH_MANAGER", "CreationDate": "2020-09-13T16:53:33.021+00:00", "LastUpdatedBy": "CASH_MANAGER", "LastUpdateDate": "2020-09-13T16:53:33.131+00:00", "LastUpdateLogin": "AE666C98F1BA1A61E0538C96F40AABA9", "SubAccountType": "Concentration Account", "SubBankAccountName": "CE ForecastAccount-EUR-1", "SubCashPoolName": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashPools/300100211346531/child/cashPoolMembers/300100211346532", "name": "cashPoolMembers", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashPools/300100211346531/child/cashPoolMembers/300100211346532", "name": "cashPoolMembers", "kind": "item" }, { "rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashPools/300100211346531", "name": "cashPools", "kind": "item" } ] }, { "CashPoolMemberId": 300100211346533, "CashPoolMinimumPaymentAmount": null, "CashPoolMinimumReceiptAmount": null, "CreatedBy": "CASH_MANAGER", "CreationDate": "2020-09-13T16:53:33.071+00:00", "LastUpdatedBy": "CASH_MANAGER", "LastUpdateDate": "2020-09-13T16:53:33.134+00:00", "LastUpdateLogin": "AE666C98F1BA1A61E0538C96F40AABA9", "SubAccountType": "Subsidiary Account", "SubBankAccountName": "Citi Bank-CON-EUR", "SubCashPoolName": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashPools/300100211346531/child/cashPoolMembers/300100211346533", "name": "cashPoolMembers", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashPools/300100211346531/child/cashPoolMembers/300100211346533", "name": "cashPoolMembers", "kind": "item" }, { "rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashPools/300100211346531", "name": "cashPools", "kind": "item" } ] }, { "CashPoolMemberId": 300100211346534, "CashPoolMinimumPaymentAmount": null, "CashPoolMinimumReceiptAmount": null, "CreatedBy": "CASH_MANAGER", "CreationDate": "2020-09-13T16:53:33.093+00:00", "LastUpdatedBy": "CASH_MANAGER", "LastUpdateDate": "2020-09-13T16:53:33.137+00:00", "LastUpdateLogin": "AE666C98F1BA1A61E0538C96F40AABA9", "SubAccountType": "Subsidiary Account", "SubBankAccountName": "BelgianAccount", "SubCashPoolName": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashPools/300100211346531/child/cashPoolMembers/300100211346534", "name": "cashPoolMembers", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashPools/300100211346531/child/cashPoolMembers/300100211346534", "name": "cashPoolMembers", "kind": "item" }, { "rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashPools/300100211346531", "name": "cashPools", "kind": "item" } ] } ], "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashPools/300100211346531", "name": "cashPools", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashPools/300100211346531", "name": "cashPools", "kind": "item" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashPools/300100211346531/child/cashPoolMembers", "name": "cashPoolMembers", "kind": "collection" } ] }