Get all payee bank accounts
/fscmRestApi/resources/11.13.18.05/payeeBankAccountsLOV
Request
-
expand: string
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).
-
fields: string
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 -
finder: string
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:- AdhocPaymentBankAccountsFinder: Finds all ad hoc payee bank accounts associated with the specified account number.
Finder Variables:- CurrencyCode; string.
- PayeePartyId; integer; Payee party identifier of the ad hoc payee bank account.
- ApplicablePayeeBankAccountsFinder: Finds all applicable payee bank accounts associated with the specified account number.
Finder Variables:- CurrencyCode; string; Currency code of the applicable payee bank account.
- PayeePartyId; integer; Payee party identifier of the applicable payee bank account.
- PayeePartySiteId; integer; Payee party site identifier of the applicable payee bank account.
- PaymentFunction; string; Payment function code of the applicable payee bank account.
- SupplierSiteId; integer; Supplier site identifier of the applicable payee bank account.
- AvailablePayeeBankAccountsFinder: Finds all available payee bank accounts associated with the specified account number.
Finder Variables:- CurrencyCode; string; Currency code of the available payee bank account.
- PayeePartyId; integer; Payee party identifier of the available payee bank account.
- PayeePartySiteId; integer; Payee party site identifier of the available payee bank account.
- PaymentFunction; string; Payment function code of the available payee bank account.
- SupplierSiteId; integer; Supplier site identifier of the available payee bank account.
- DefaultPayeeBankAccountsFinder: Finds all default payee bank accounts associated with the specified account number.
Finder Variables:- CurrencyCode; string; Currency code of the default payee bank account.
- PayeePartyId; integer; Payee party identifier of the default payee bank account.
- PayeePartySiteId; integer; Payee party site identifier of the default payee bank account.
- PaymentFunction; string; Payment function of the default payee bank account.
- SupplierSiteId; integer; Supplier site identifier of the default payee bank account.
- PrimaryKey: Finds the payee bank account that matches the specified account number.
Finder Variables:- AccountNumber; string; Finds the account number that matches the primary key criteria specified.
- AdhocPaymentBankAccountsFinder: Finds all ad hoc payee bank accounts associated with the specified account number.
-
limit: integer
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.
-
links: string
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 -
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
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
-
q: string
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:- AccountCountry; string; Country of the payee bank account.
- AccountName; string; Name of the payee bank account.
- AccountNumber; string; Account number of the payee bank account.
- AccountSuffix; string; Two or three digits added to the end of a bank account number in some countries, such as New Zealand. This format allows customers to have a single account number with differing suffixes that represent different types of accounts.
- AccountType; string; Bank account types. Possible values are Savings and Checking.
- AgencyLocationCode; string; Agency location code used for US Federal payments.
- AllowInternationalPaymentsIndicator; string; Indicates whether the payee bank account can be used for foreign payments or only for domestic payments.
- AlternateAccountName; string; Alternate name of the payee bank account.
- BankAccountId; integer; Account identifier of the payee bank account.
- BankCode; string; Code issued to a bank by a banking regulatory authority.
- BankName; string; Name of the bank where a payee has a bank account.
- BranchName; string; Name of the bank branch where the payee has a bank account.
- BranchNumber; string; Number of a bank branch. This is known as a routing transit number in the United States and a sort code in the United Kingdom.
- CheckDigits; string; Number added to an account number to derive a further number as a means of verifying the accuracy or validity of the account number as it is printed or transmitted.
- CurrencyCode; string; Currency code of the payee bank account. A null value represents a multicurrency bank account.
- Description; string; Description of the payee bank account.
- EndDate; string; Date when the payee bank account becomes inactive.
- FactorAccountIndicator; string; Indicates whether this is a payment factor bank account. A factor bank account can be assigned to any payee without first adding that payee party as a joint owner.
- IBAN; string; International Bank Account Number (IBAN), which is an alphanumeric sequence that conforms to the ISO standard for uniquely identifying a bank account number internationally. The standard IBAN carries all the routing information needed to get a payment from one bank to another.
- SWIFTCode; string; Code used by SWIFT (Society for Worldwide Interbank Financial Telecommunication) to identify a bank or bank branch. This code is known as BIC (Bank Identifier Code) in the Single Euro Payments Area (SEPA).
- SecondaryAccountReference; string; Account number reference, such as the Building Society Roll Number used in the United Kingdom.
- StartDate; string; Date when the payee bank account becomes active.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
-
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.
There's no request body for this operation.
Back to TopResponse
- 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
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
array
Links
object
-
AccountCountry: string
Read Only:
true
Maximum Length:255
Country of the payee bank account. -
AccountName: string
Read Only:
true
Maximum Length:255
Name of the payee bank account. -
AccountNumber: string
Read Only:
true
Maximum Length:255
Account number of the payee bank account. -
AccountSuffix: string
Read Only:
true
Maximum Length:255
Two or three digits added to the end of a bank account number in some countries, such as New Zealand. This format allows customers to have a single account number with differing suffixes that represent different types of accounts. -
AccountType: string
Read Only:
true
Maximum Length:255
Bank account types. Possible values are Savings and Checking. -
AgencyLocationCode: string
Read Only:
true
Maximum Length:255
Agency location code used for US Federal payments. -
AllowInternationalPaymentsIndicator: string
Read Only:
true
Maximum Length:255
Indicates whether the payee bank account can be used for foreign payments or only for domestic payments. -
AlternateAccountName: string
Read Only:
true
Maximum Length:255
Alternate name of the payee bank account. -
BankAccountId: integer
Read Only:
true
Account identifier of the payee bank account. -
BankCode: string
Read Only:
true
Maximum Length:255
Code issued to a bank by a banking regulatory authority. -
BankName: string
Read Only:
true
Maximum Length:255
Name of the bank where a payee has a bank account. -
BranchName: string
Read Only:
true
Maximum Length:255
Name of the bank branch where the payee has a bank account. -
BranchNumber: string
Read Only:
true
Maximum Length:255
Number of a bank branch. This is known as a routing transit number in the United States and a sort code in the United Kingdom. -
CheckDigits: string
Read Only:
true
Maximum Length:255
Number added to an account number to derive a further number as a means of verifying the accuracy or validity of the account number as it is printed or transmitted. -
CurrencyCode: string
Read Only:
true
Maximum Length:255
Currency code of the payee bank account. A null value represents a multicurrency bank account. -
Description: string
Read Only:
true
Maximum Length:255
Description of the payee bank account. -
EndDate: string
(date)
Read Only:
true
Date when the payee bank account becomes inactive. -
FactorAccountIndicator: string
Read Only:
true
Maximum Length:255
Indicates whether this is a payment factor bank account. A factor bank account can be assigned to any payee without first adding that payee party as a joint owner. -
IBAN: string
Read Only:
true
Maximum Length:255
International Bank Account Number (IBAN), which is an alphanumeric sequence that conforms to the ISO standard for uniquely identifying a bank account number internationally. The standard IBAN carries all the routing information needed to get a payment from one bank to another. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SecondaryAccountReference: string
Read Only:
true
Maximum Length:255
Account number reference, such as the Building Society Roll Number used in the United Kingdom. -
StartDate: string
(date)
Read Only:
true
Date when the payee bank account becomes active. -
SWIFTCode: string
Read Only:
true
Maximum Length:255
Code used by SWIFT (Society for Worldwide Interbank Financial Telecommunication) to identify a bank or bank branch. This code is known as BIC (Bank Identifier Code) in the Single Euro Payments Area (SEPA).
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
The following example shows how to retrieve available payee bank accounts when adding bank account at supplier site level 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/payeeBankAccountsLOV?finder=AvailablePayeeBankAccountsFinder;PaymentFunction="PAYABLES_DISB",PayeePartyId=6595597,PayeePartySiteId=2155603,SupplierSiteId=11775,CurrencyCode=USD
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "items": [ { "BankAccountId": 442, "AccountNumber": "XXXXXX4870", "IBAN": null, "AccountName": null, "AlternateAccountName": null, "AccountCountry": "US", "CurrencyCode": "USD", "AllowInternationalPaymentsIndicator": "Y", "BankName": "Bank of America", "BankCode": null, "BranchName": "New York", "BranchNumber": null, "SWIFTCode": null, "CheckDigits": null, "AccountSuffix": null, "SecondaryAccountReference": null, "AgencyLocationCode": null, "AccountType": null, "FactorAccountIndicator": "N", "Description": null, "StartDate": "2007-12-10", "EndDate": "4712-12-31", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payeeBankAccountsLOV/XXXXXX4870", "name": "payeeBankAccountsLOV", "kind": "item" }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payeeBankAccountsLOV/XXXXXX4870", "name": "payeeBankAccountsLOV", "kind": "item" } ] }, ... "count": 3, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payeeBankAccountsLOV", "name": "payeeBankAccountsLOV", "kind": "collection" } ] }
The following example shows how to retrieve the available payee bank accounts when creating a Payables invoice 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/payeeBankAccountsLOV?finder=ApplicablePayeeBankAccountsFinder;PaymentFunction="PAYABLES_DISB",PayeePartyId=6595597,PayeePartySiteId=2155603,SupplierSiteId=11775,CurrencyCode=USD
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "items": [ { "BankAccountId": 442, "AccountNumber": "XXXXXX4870", "IBAN": null, "AccountName": null, "AlternateAccountName": null, "AccountCountry": "US", "CurrencyCode": "USD", "AllowInternationalPaymentsIndicator": "Y", "BankName": "Bank of America", "BankCode": null, "BranchName": "New York", "BranchNumber": null, "SWIFTCode": null, "CheckDigits": null, "AccountSuffix": null, "SecondaryAccountReference": null, "AgencyLocationCode": null, "AccountType": null, "FactorAccountIndicator": "N", "Description": null, "StartDate": "2007-12-10", "EndDate": "4712-12-31", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payeeBankAccountsLOV/XXXXXX4870", "name": "payeeBankAccountsLOV", "kind": "item" }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payeeBankAccountsLOV/XXXXXX4870", "name": "payeeBankAccountsLOV", "kind": "item" } ] }, ... "count": 3, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payeeBankAccountsLOV", "name": "payeeBankAccountsLOV", "kind": "collection" } ] }
The following example shows how to retrieve all the available payee bank accounts when creating an ad-hoc payment in the Cash Management 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/payeeBankAccountsLOV?finder=AdhocPaymentBankAccountsFinder;PayeePartyId=6595597
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "items": [ { "BankAccountId": 442, "AccountNumber": "XXXXXX4870", "IBAN": null, "AccountName": null, "AlternateAccountName": null, "AccountCountry": "US", "CurrencyCode": "USD", "AllowInternationalPaymentsIndicator": "Y", "BankName": "Bank of America", "BankCode": null, "BranchName": "New York", "BranchNumber": null, "SWIFTCode": null, "CheckDigits": null, "AccountSuffix": null, "SecondaryAccountReference": null, "AgencyLocationCode": null, "AccountType": null, "FactorAccountIndicator": "N", "Description": null, "StartDate": "2007-12-10", "EndDate": "4712-12-31", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payeeBankAccountsLOV/XXXXXX4870", "name": "payeeBankAccountsLOV", "kind": "item" }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payeeBankAccountsLOV/XXXXXX4870", "name": "payeeBankAccountsLOV", "kind": "item" } ] }, ... "count": 3, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payeeBankAccountsLOV", "name": "payeeBankAccountsLOV", "kind": "collection" } ] }