1. REST API for Oracle Fusion Cloud Financials
  2. Tasks
  3. Bank Branches

Get all bank branches

get

/fscmRestApi/resources/11.13.18.05/cashBankBranches

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:

    • BankBranchCeLovFinder: Finds a bank branch that matches the specified country code, bank name, bank branch name, bank branch number, and country name.
      Finder Variables:
      • bindBankName; string; The name of the bank associated with the bank branch.
      • bindBranchName; string; The name of the bank branch.
      • bindBranchNumber; string; The number of the bank branch. For banks based in Australia and New Zealand, it represents the Bank State Branch. For banks based in the United Kingdom, Ireland, Jersey, Guernsey, and Isle of Man, it represents the Sort Code. For banks based in the United States and Canada, it represents the Routing Number. For banks based in India, it represents the Indian Financial System Code (IFSC Code).
    • BankBranchSearchFinder: Finds a bank branch that matches the specified country code, bank name, bank branch name, bank branch number, and country name.
      Finder Variables:
      • bindBankHomeCountry; string; The code of the country where the bank branch is located.
      • bindBankName; string; The name of the bank associated with the bank branch.
      • bindBranchName; string; The name of the bank branch.
      • bindBranchNumber; string; The number of the bank branch. For banks based in Australia and New Zealand, it represents the Bank State Branch. For banks based in the United Kingdom, Ireland, Jersey, Guernsey, and Isle of Man, it represents the Sort Code. For banks based in the United States and Canada, it represents the Routing Number. For banks based in India, it represents the Indian Financial System Code (IFSC Code).
      • bindCountryName; string; The name of the country where the bank branch is located.
    • PrimaryKey: Finds a bank branch that matches the specified bank branch identifier.
      Finder Variables:
      • BranchPartyId; integer; The unique identifier of the bank branch.
  • 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:
    • BankBranchName; string; The name of the bank branch.
    • BankBranchNameAlt; string; The alternate name of the bank branch.
    • BankBranchType; string; The type of banking institution to which the bank branch belongs. For example, ABA (American Bankers Association), CHIPS (Clearing House Interbank Payment System), SWIFT (Society for Worldwide Interbank Financial Telecommunication), or Other.
    • BankName; string; The name of the bank associated with the bank branch.
    • BankNameAlt; string; The alternate name of the bank associated with the bank branch.
    • BankNumber; string; The code of the bank associated with the bank branch.
    • BankPartyNumber; string; The unique party identification number of the bank.
    • BranchNumber; string; The number of the bank branch. For banks based in Australia and New Zealand, it represents the Bank State Branch. For banks based in the United Kingdom, Ireland, Jersey, Guernsey, and Isle of Man, it represents the Sort Code. For banks based in the United States and Canada, it represents the Routing Number. For banks based in India, it represents the Indian Financial System Code (IFSC Code).
    • BranchNumberType; string; The type of the bank branch number. For example, CHIPS Code, CHIPS participant ID, Fed Wire routing number.
    • BranchPartyId; integer; The unique identifier of the bank branch.
    • BranchPartyNumber; string; The unique party identification number of the bank branch.
    • CountryName; string; The name of the country where the bank branch is located.
    • CreatedBy; string; The user who created the bank branch.
    • CreationDate; string; The date and time when the bank branch was created.
    • Description; string; The description of the bank branch.
    • EDIIdNumber; string; The number used by the bank in electronic data interchange.
    • EDILocation; string; The name of the location of the electronic data interchange (EDI) for the bank.
    • EFTSWIFTCode; string; The bank identifier code (BIC) used by SWIFT to identify a bank or a bank branch. The BIC is a universal method of identifying financial institutions to facilitate the automated processing of telecommunication messages in banking and related financial environments.
    • EFTUserNumber; string; The user number of the enterprise's electronic funds transfer (EFT). This number is used for identification and validation in the electronic funds transfer.
    • LastUpdateDate; string; The date and time when the bank branch was last updated.
    • LastUpdateLogin; string; The session login associated with the user who last updated the bank branch.
    • LastUpdatedBy; string; The user who last updated the bank branch.
    • RFCIdentifier; string; The code identifier of the Regional Finance Center (RFC). RFC is considered a bank branch of the US Treasury bank and is responsible for the disbursement of public monies on behalf of some federal agencies.
  • 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 : cashBankBranches
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : cashBankBranches-item-response
Type: object
Show Source
  • Title: Branch Name
    Maximum Length: 360
    The name of the bank branch.
  • Title: Alternate Branch Name
    Maximum Length: 360
    The alternate name of the bank branch.
  • Title: Bank Branch Type
    Maximum Length: 255
    The type of banking institution to which the bank branch belongs. For example, ABA (American Bankers Association), CHIPS (Clearing House Interbank Payment System), SWIFT (Society for Worldwide Interbank Financial Telecommunication), or Other.
  • Maximum Length: 360
    The name of the bank associated with the bank branch.
  • Title: Alternate Bank Name
    Maximum Length: 360
    The alternate name of the bank associated with the bank branch.
  • Title: Bank Code
    Maximum Length: 30
    The code of the bank associated with the bank branch.
  • Read Only: true
    Maximum Length: 30
    The unique party identification number of the bank.
  • Title: Branch Number
    Maximum Length: 30
    The number of the bank branch. For banks based in Australia and New Zealand, it represents the Bank State Branch. For banks based in the United Kingdom, Ireland, Jersey, Guernsey, and Isle of Man, it represents the Sort Code. For banks based in the United States and Canada, it represents the Routing Number. For banks based in India, it represents the Indian Financial System Code (IFSC Code).
  • Title: Branch Number Type
    Maximum Length: 255
    The type of the bank branch number. For example, CHIPS Code, CHIPS participant ID, Fed Wire routing number.
  • Title: Bank Branch ID
    Default Value: 1
    The unique identifier of the bank branch.
  • Title: Branch Party Number
    Maximum Length: 30
    Default Value: 1
    The unique party identification number of the bank branch.
  • Maximum Length: 80
    The name of the country where the bank branch is located.
  • Read Only: true
    Maximum Length: 64
    The user who created the bank branch.
  • Read Only: true
    The date and time when the bank branch was created.
  • Title: Description
    Maximum Length: 2000
    The description of the bank branch.
  • Title: EDI ID Number
    Maximum Length: 30
    The number used by the bank in electronic data interchange.
  • Title: EDI Location
    Maximum Length: 40
    The name of the location of the electronic data interchange (EDI) for the bank.
  • Title: BIC Code
    Maximum Length: 30
    The bank identifier code (BIC) used by SWIFT to identify a bank or a bank branch. The BIC is a universal method of identifying financial institutions to facilitate the automated processing of telecommunication messages in banking and related financial environments.
  • Title: EFT Number
    Maximum Length: 30
    The user number of the enterprise's electronic funds transfer (EFT). This number is used for identification and validation in the electronic funds transfer.
  • Read Only: true
    The date and time when the bank branch was last updated.
  • Read Only: true
    Maximum Length: 64
    The user who last updated the bank branch.
  • Read Only: true
    Maximum Length: 32
    The session login associated with the user who last updated the bank branch.
  • Links
  • Title: RFC Identifier
    Maximum Length: 255
    The code identifier of the Regional Finance Center (RFC). RFC is considered a bank branch of the US Treasury bank and is responsible for the disbursement of public monies on behalf of some federal agencies.
Back to Top

Examples

The following example shows how to retrieve all the bank branches 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/cashBankBranches

Example Response Body

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

{
 "items" : [ 
 {
 "BankName" : "VISION USD ACCOUNT",
 "BankNameAlt" : null,
 "BranchPartyId" : 300649,
 "BankNumber" : null,
 ...
 "links" : [ 
 {
 "rel" : "self",
 "href" : "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashBankBranches/300649",
 "name" : "cashBankBranches",
 "kind" : "item",
 "properties" : {
                   "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
                }
 }, 
 {
 "rel" : "canonical",
 "href" : "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashBankBranches/300649",
 "name" : "cashBankBranches",
 "kind" : "item"
 },
 ...
]
},
...
],
 "count" : 500,
 "hasMore" : false,
 "limit" : 500,
 "offset" : 0,
 "links" : [ 
 {
 "rel" : "self",
 "href" : "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashBankBranches",
 "name" : "cashBankBranches",
 "kind" : "collection"
 } 
 ]
}
Back to Top