Get all bank accounts

get

/fscmRestApi/resources/11.13.18.05/cashBankAccountsLOV

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:

    • ActiveBankAccountsFinder: Find all active bank accounts.
      Finder Variables:
      • bindSysdate; string; The current date of the system.
    • BankAccountApArFinder: Find all bank accounts that are used for payables or receivables.
      Finder Variables:
      • bindBankAccountName; string; The name of the bank account.
      • bindBankAccountNum; string; The number of the bank account.
      • bindBankBranchName; string; The name of the bank branch.
      • bindBankName; string; The name of the bank.
    • BankAccountApArLovBuFinder: Find all bank accounts that are used for payables or receivables, and are associated to the specified business unit.
      Finder Variables:
      • bindBankAccountName; string; The name of the bank account.
      • bindBankAccountNum; string; The number of the bank account.
      • bindBankBranchName; string; The name of the bank branch.
      • bindBankName; string; The name of the bank.
      • bindBusinessUnitName; string; The name of the business unit associated to the bank account.
    • BankAccountCeLovBuFinder: Finds bank accounts that match the specified search parameters, such as bank account name, bank account number, branch name, bank name, and business unit.
      Finder Variables:
      • bindBankAccountName; string; The name of the bank account.
      • bindBankAccountNum; string; The number of the bank account.
      • bindBankBranchName; string; The name of the bank branch.
      • bindBankName; string; The name of the bank.
      • bindBusinessUnitName; string; The name of the business unit associated to the bank account.
    • BankAccountCeLovFinder: Finds bank accounts that match specified search parameters, such as bank account name, bank account number, bank branch name, and bank name.
      Finder Variables:
      • bindBankAccountName; string; The name of the bank account.
      • bindBankAccountNum; string; The number of the bank account.
      • bindBankBranchName; string; The name of the bank branch.
      • bindBankName; string; The name of the bank.
    • BankAccountsLOVSearchFinder: Find all bank accounts that match specified search parameters, such as: payables use option, receivables use option, payroll use option, netting account option, bank account name, bank account number, bank branch name, country code, bank name, bank account currency, or IBAN number.
      Finder Variables:
      • bindApUseAllowedFlag; string; The option that indicates whether the account use for payables is enabled.
      • bindArUseAllowedFlag; string; The option that indicates whether the account use for receivables is enabled.
      • bindBankAccountName; string; The name of the bank account.
      • bindBankAccountNum; string; The number of the bank account.
      • bindBankBranchName; string; The name of the bank branch.
      • bindBankHomeCountry; string; The code of the country where the bank account is located.
      • bindBankName; string; The name of the bank.
      • bindCurrency; string; The currency code of the bank account.
      • bindIban; string; The international bank account number (IBAN) of the bank account.
      • bindNettingAccountFlag; string; The option that indicates whether the bank account is a netting account.
      • bindPayUseAllowedFlag; string; The option that indicates whether the account use for payroll is enabled.
      • bindSysdate; string; The current date of the system.
    • BusinessUnitNameFinder: Find all bank accounts associated to the specified business unit.
      Finder Variables:
      • bindBusinessUnitName; string; The name of the business unit associated to the bank account.
    • PrimaryKey: Finds a bank account that matches the specified bank account identifier.
      Finder Variables:
      • BankAccountId; integer; The unique identifier of the bank account.
  • 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:
    • BankAccountName; string; The name of the bank account.
  • 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 : cashBankAccountsLOV
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : cashBankAccountsLOV-item-response
Type: object
Show Source
  • Read Only: true
    The unique identifier of the bank account.
  • Read Only: true
    Maximum Length: 360
    The name of the bank account.
  • Links
  • Title: Account Number
    Read Only: true
    Maximum Length: 4000
    The masked number of the bank account. The masking is generated according to the value of the profile option CE_MASK_INTERNAL_BANK_ACCT_NUM. The profile is predefined with a default value of 'Display last four' at the site level.
Back to Top