Create a cash pool member
/fscmRestApi/resources/11.13.18.05/cashPools/{CashPoolId}/child/cashPoolMembers
Request
-
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=
-
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
-
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
-
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.
Examples
Example 1
The following example shows how to create a cash pool member, of the subsidiary bank account type, for a physical cash pool 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/300100211346526/child/cashPoolMembers
Example Request Body
The following example shows the contents of the request body in JSON format:
{ "SubBankAccountName": "SKA_TEST_ACCT01", "SubAccountType": "Subsidiary Account" }
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "CashPoolMemberId": 300100211346530, "CashPoolMinimumPaymentAmount": null, "CashPoolMinimumReceiptAmount": null, "CreatedBy": "CASH_MANAGER", "CreationDate": "2020-09-13T16:48:51+00:00", "LastUpdatedBy": "CASH_MANAGER", "LastUpdateDate": "2020-09-13T16:48:51.043+00:00", "LastUpdateLogin": "AE666C98F1BA1A61E0538C96F40AABA9", "SubAccountType": "Subsidiary Account", "SubBankAccountName": "SKA_TEST_ACCT01", "SubCashPoolName": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashPools/300100211346526/child/cashPoolMembers/300100211346530", "name": "cashPoolMembers", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashPools/300100211346526/child/cashPoolMembers/300100211346530", "name": "cashPoolMembers", "kind": "item" }, { "rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashPools/300100211346526", "name": "cashPools", "kind": "item" } ] }
Example 2
The following example shows how to create a cash pool member, of the cash pool type, for a physical cash pool 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/300100211293580/child/cashPoolMembers
Example Request Body
The following example shows the contents of the request body in JSON format:
{ "SubCashPoolName": "Cash_Pool_USD_Current", "SubAccountType": "Cash Pool" }
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "CashPoolMemberId": 300100211346540, "CashPoolMinimumPaymentAmount": null, "CashPoolMinimumReceiptAmount": null, "CreatedBy": "CASH_MANAGER", "CreationDate": "2020-09-13T17:16:57+00:00", "LastUpdatedBy": "CASH_MANAGER", "LastUpdateDate": "2020-09-13T17:16:57.486+00:00", "LastUpdateLogin": "AE666C9900C61A65E0538C96F40AB886", "SubAccountType": "Cash Pool", "SubBankAccountName": null, "SubCashPoolName": "Cash_Pool_USD_Current", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashPools/300100211293580/child/cashPoolMembers/300100211346540", "name": "cashPoolMembers", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashPools/300100211293580/child/cashPoolMembers/300100211346540", "name": "cashPoolMembers", "kind": "item" }, { "rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashPools/300100211293580", "name": "cashPools", "kind": "item" } ] }