Jump to

• Request
• Response
• Examples

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.
• 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.

{
    "type":"object",
    "properties":{
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Currency of the cash pool.",
            "nullable":true
        },
        "CashPoolName":{
            "maxLength":80,
            "type":"string",
            "description":"User-defined name of the cash pool.",
            "nullable":false
        },
        "SweepSettlementRequiredFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether bank can generate sweep transactions the cash pool.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the cash pool is enabled or not.",
            "nullable":false,
            "default":true
        },
        "cashPoolMembers":{
            "title":"Cash Pool Members",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/cashPools-cashPoolMembers-item-patch-request"
            }
        }
    }
}

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

• Array of: object schema

{
    "title":"Cash Pool Members",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/cashPools-cashPoolMembers-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• SubBankAccountName: string
  Maximum Length: 360

  Name of the subsidiary bank account.
• SubCashPoolName: string
  Maximum Length: 80

  Name of the subsidiary cash pool.

{
    "type":"object",
    "properties":{
        "SubBankAccountName":{
            "maxLength":360,
            "type":"string",
            "description":"Name of the subsidiary bank account.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BankAccountName"
                ]
            }
        },
        "SubCashPoolName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the subsidiary cash pool.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SubCPName"
                ]
            }
        }
    }
}

Back to Top

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.

Body ()

Root Schema : cashPools-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the cash pool row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the row for cash pool was created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the row for cash pool.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CashPoolId":{
            "type":"integer",
            "description":"Unique identifier of the cash pool.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SweepSettlementRequiredFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether bank can generate sweep transactions the cash pool.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ConcentrationType":{
            "maxLength":40,
            "type":"string",
            "description":"Indicates the type of concentration activity allowed. The valid values are One Account and Two Account.",
            "nullable":true,
            "default":"One Account",
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "CashPoolConcTypeMeaning"
                ]
            },
            "x-queryable":true
        },
        "cashPoolMembers":{
            "title":"Cash Pool Members",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/cashPools-cashPoolMembers-item-response"
            }
        },
        "CashPoolType":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the cash pool is Physical or Notional.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "CashPoolTypeMeaning"
                ]
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Currency of the cash pool.",
            "nullable":true,
            "x-queryable":true
        },
        "LegalEntityName":{
            "title":"Legal Entity Name",
            "maxLength":240,
            "type":"string",
            "description":"The unique identifier of the legal entity associated with the cash pool.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CashPoolName":{
            "maxLength":80,
            "type":"string",
            "description":"User-defined name of the cash pool.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the cash pool is enabled or not.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the row for cash pool was last updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Session login of the last user who updated the cash pool row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

• Array of: object cashPools-cashPoolMembers-item-response

{
    "title":"Cash Pool Members",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/cashPools-cashPoolMembers-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : cashPools-cashPoolMembers-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the cash pool member row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the row for cash pool member was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CashPoolMemberId":{
            "type":"integer",
            "description":"The unique identifier of the cash pool member.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SubAccountType":{
            "maxLength":50,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SubAccountTypeMeaning"
                ]
            },
            "x-queryable":true
        },
        "CashPoolMinimumPaymentAmount":{
            "type":"number",
            "description":"The minimum payment amount that can be transferred from the cash pool member bank account. This amount is derived from the bank account setup.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the row for cash pool member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubCashPoolName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the subsidiary cash pool.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SubCPName"
                ]
            },
            "x-queryable":true
        },
        "SubBankAccountName":{
            "maxLength":360,
            "type":"string",
            "description":"Name of the subsidiary bank account.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BankAccountName"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CashPoolMinimumReceiptAmount":{
            "type":"number",
            "description":"The minimum receipt amount that can be transferred to the cash pool member bank account. This amount is derived from the bank account setup.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the row for cash pool member was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Session login of the last user who updated the cash pool member row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

cashPoolMembers

Operation: /fscmRestApi/resources/11.13.18.05/cashPools/{CashPoolId}/child/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.

Back to Top

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"
        }
    ]
}

Back to Top