Get all external bank accounts
/fscmRestApi/resources/11.13.18.05/externalBankAccounts
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:- PrimaryKey: Finds external bank accounts with the specified primary key.
Finder Variables:- BankAccountId; integer; The identifier of an external bank account.
- SearchExternalBankAccount: Finds external bank accounts that match specified search parameters.
Finder Variables:- BankAccountId; integer; The identifier of an external bank account.
- BankAccountNumber; string; The account number of an external bank account.
- BankBranchIdentifier; integer; The bank branch identifier of an external bank account.
- BankBranchName; string; The bank branch name of an external bank account.
- BankIdentifier; integer; The bank identifier of an external bank account.
- BankName; string; The bank name of an external bank account.
- CountryCode; string; The country code of an external bank account.
- CurrencyCode; string; The currency code of an external bank account.
- IBAN; string; The international bank account number (IBAN) of an external bank account.
- Intent; string.
- PrimaryKey: Finds external bank accounts with the specified primary key.
-
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:- AccountSuffix; string; Two or three digits added to the end of an external 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; Type of external bank account. Possible values are Savings and Checking.
- AgencyLocationCode; string; Agency location code of the external bank account.
- AllowInternationalPaymentIndicator; string; Indicates whether the external bank account can be used for foreign payments or only for domestic payments.
- AlternateAccountName; string; Alternate name of the external bank account.
- BIC; string; Bank Identifier Code (BIC), which is the identifier code used by SWIFT to identify an external bank or 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.
- BankAccountId; integer; Identifier of the external bank account.
- BankAccountName; string; Name of the external bank account.
- BankAccountNumber; string; Account number of the external bank account.
- BankBranchIdentifier; integer; Identifier of the bank branch where the external bank account is present.
- BankBranchName; string; Name of the bank branch where the customer or supplier has an external bank account.
- BankBranchNumber; 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.
- BankBranchPartyIndicator; string; Indicates whether an external bank account is associated with any external bank and branch created in Trading Community Architecture (TCA). If the value is Yes or Null, external bank and branch information is stored in TCA and the external bank and branch identifiers are stored on the external bank account. If the value is No, external bank and branch attributes are stored on the external bank account.
- BankIdentifier; integer; Identifier of the bank where the external bank account is present.
- BankName; string; Name of the bank where the customer has an external bank account.
- BankNumber; string; Code or identifier issued to an external bank by a banking regulatory authority.
- CheckDigits; string; Number added to the external bank account number to derive a further number as a means of verifying the accuracy or validity of the external account number as it is printed or transmitted.
- CountryCode; string; Country code of the external bank account.
- CurrencyCode; string; Currency code of the external bank account.
- EndDate; string; Date when the external bank account becomes inactive.
- 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.
- PersonId; integer; Person identifier when the account owner is an employee.
- SecondaryAccountReference; string; Reference number of a secondary external bank account, such as the Building Society Roll Number used in the United Kingdom.
- StartDate; string; Date when the external bank account becomes active.
- VendorId; integer; Vendor identifier when the account owner party is a supplier.
-
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
-
accountOwners: array
Account Owners
Title:
Account Owners
The account owners resource is used to view, create, and modify the account owner of an external bank account. -
AccountSuffix: string
Maximum Length:
30
Two or three digits added to the end of an external 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
Title:
Account Type
Maximum Length:25
Type of external bank account. Possible values are Savings and Checking. -
AgencyLocationCode: string
Maximum Length:
30
Agency location code of the external bank account. -
AllowInternationalPaymentIndicator: string
Title:
Allow international payments
Maximum Length:1
Default Value:N
Indicates whether the external bank account can be used for foreign payments or only for domestic payments. -
AlternateAccountName: string
Maximum Length:
320
Alternate name of the external bank account. -
BankAccountId: integer
(int64)
Identifier of the external bank account.
-
BankAccountName: string
Maximum Length:
80
Name of the external bank account. -
BankAccountNumber: string
Maximum Length:
100
Account number of the external bank account. -
BankBranchIdentifier: integer
(int64)
Title:
Branch Identifier
Identifier of the bank branch where the external bank account is present. -
BankBranchName: string
Title:
Bank Branch Name
Maximum Length:360
Name of the bank branch where the customer or supplier has an external bank account. -
BankBranchNumber: string
Title:
Branch Number
Maximum Length:30
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. -
BankBranchPartyIndicator: string
Title:
Bank Branch Party Indicator
Maximum Length:1
Default Value:Y
Indicates whether an external bank account is associated with any external bank and branch created in Trading Community Architecture (TCA). If the value is Yes or Null, external bank and branch information is stored in TCA and the external bank and branch identifiers are stored on the external bank account. If the value is No, external bank and branch attributes are stored on the external bank account. -
BankIdentifier: integer
(int64)
Title:
Bank Identifier
Identifier of the bank where the external bank account is present. -
BankName: string
Title:
Bank Name
Maximum Length:360
Name of the bank where the customer has an external bank account. -
BankNumber: string
Title:
Bank Number
Maximum Length:30
Code or identifier issued to an external bank by a banking regulatory authority. -
BIC: string
Title:
BIC
Maximum Length:30
Bank Identifier Code (BIC), which is the identifier code used by SWIFT to identify an external bank or 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. -
CheckDigits: string
Maximum Length:
30
Number added to the external bank account number to derive a further number as a means of verifying the accuracy or validity of the external account number as it is printed or transmitted. -
CountryCode: string
Title:
Country Code
Maximum Length:2
Country code of the external bank account. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
Currency code of the external bank account. -
EndDate: string
(date)
Date when the external bank account becomes inactive.
-
IBAN: string
Maximum Length:
50
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. -
Intent: string
Purpose of the external bank account. The value is based on the payment function of the external payee or the external payer of the account owner. The following are the expected values: PAYABLES_DISB - Supplier, EMPLOYEE_EXP - Person, EMPLOYEE_EXP - Employee, AR_CUSTOMER_REFUNDS - Refund, CUSTOMER_PAYMENT - Customer, ONETIME_PAYMENT - Onetime, and ADHOC_PAYMENT - Adhoc.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartyId: integer
Party identifier of the external bank account owner.
-
PayeeCreation: string
Maximum Length:
255
Indicates whether the external payee and instrument assignments should be created along with the bank account. Valid values are Y and N. For internal use only. -
PersonId: integer
Person identifier when the account owner is an employee.
-
SecondaryAccountReference: string
Maximum Length:
30
Reference number of a secondary external bank account, such as the Building Society Roll Number used in the United Kingdom. -
StartDate: string
(date)
Title:
Start Date
Date when the external bank account becomes active. -
VendorId: integer
(int64)
Read Only:
true
Vendor identifier when the account owner party is a supplier.
array
Account Owners
array
Links
object
-
AccountOwnerId: integer
(int64)
Application-generated identifier of the external bank account owner.
-
AccountOwnerPartyIdentifier: integer
(int64)
Title:
Account Owner
Party identifier of the external bank account owner. -
AccountOwnerPartyName: string
Title:
Name
Maximum Length:360
Party name of the external bank account owner. -
AccountOwnerPartyNumber: string
Title:
Registry ID
Maximum Length:30
Party number of the external bank account owner. -
AddJointAccountOwner: string
Maximum Length:
255
Indicates whether the joint owner should be created if the bank account is already existing. Valid values are Y and N. For internal use only. -
EndDate: string
(date)
Date when the external bank account owner becomes inactive.
-
Intent: string
Purpose of the external bank account. The value is based on the payment function of the external payee or the external payer of the account owner. The following are the expected values: PAYABLES_DISB - Supplier, EMPLOYEE_EXP - Person, EMPLOYEE_EXP - Employee, AR_CUSTOMER_REFUNDS - Refund, CUSTOMER_PAYMENT - Customer, ONETIME_PAYMENT - Onetime, and ADHOC_PAYMENT - Adhoc.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PersonId: integer
Person identifier when the account owner is an employee.
-
PrimaryOwnerIndicator: string
Title:
Primary
Maximum Length:1
Indicates whether an external bank account owner is primary. -
StartDate: string
(date)
Title:
Start Date
Date when the external bank account owner becomes active.
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 retrieve all the external bank accounts 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/externalBankAccounts?finder=SearchExternalBankAccount;BankAccountId=78,Intent=Supplier
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "items": [ { "BankAccountNumber": "XXX3526", "CountryCode": "DE", "BankBranchIdentifier": 300579, "BankAccountId": 78, ... "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/78", "name": "externalBankAccounts", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000C78" } }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/78/child/accountOwners", "name": "accountOwners", "kind": "collection" }, ... ] }, ... ], "count": 10, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts", "name": "externalBankAccounts", "kind": "collection" } ] }
Example 2
The following example shows how a Procurement user retrieves a supplier bank account 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/externalBankAccounts?finder=SearchExternalBankAccount;Intent=Supplier,BankAccountId=300100181126859
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "items": [ { "BankAccountNumber": "XXXX9655", "CountryCode": "US", "BankBranchIdentifier": 300562, "BankIdentifier": 298992, "BankAccountId": 300100181126859, "CurrencyCode": "USD", "IBAN": null, "CheckDigits": null, "AccountType": "SAVINGS", "AccountSuffix": null, "AgencyLocationCode": null, "AllowInternationalPaymentIndicator": "Y", "SecondaryAccountReference": null, "StartDate": "2019-10-22", "EndDate": "4712-12-31", "BankAccountName": "Abc Xyz", "AlternateAccountName": null, "BankBranchPartyIndicator": null, "BankName": "Citi Bank", "BankNumber": null, "BankBranchName": "Citi Bank", "BankBranchNumber": "64251060", "BIC": null, "VendorId": 999992000331527, "PersonId": null, "Intent": null, "PartyId": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126859", "name": "externalBankAccounts", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126859", "name": "externalBankAccounts", "kind": "item" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126859/lov/PersonPVA", "name": "PersonPVA", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126859/child/accountOwners", "name": "accountOwners", "kind": "collection" } ] } ], "count": 1, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts", "name": "externalBankAccounts", "kind": "collection" } ] }
Example 3
The following example shows how a Receivables user retrieves a customer bank account 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/externalBankAccounts?finder=SearchExternalBankAccount;Intent=Customer,BankAccountId=300100181126923
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "items": [ { "BankAccountNumber": "XXXXX6588", "CountryCode": "US", "BankBranchIdentifier": 300562, "BankIdentifier": 298992, "BankAccountId": 300100181126923, "CurrencyCode": "USD", "IBAN": null, "CheckDigits": null, "AccountType": "SAVINGS", "AccountSuffix": null, "AgencyLocationCode": null, "AllowInternationalPaymentIndicator": "Y", "SecondaryAccountReference": null, "StartDate": "2019-10-22", "EndDate": "4712-12-31", "BankAccountName": "Abc Xyz", "AlternateAccountName": "Test 123", "BankBranchPartyIndicator": null, "BankName": "Citi Bank", "BankNumber": null, "BankBranchName": "Citi Bank", "BankBranchNumber": "64251060", "BIC": null, "VendorId": null, "PersonId": null, "Intent": null, "PartyId": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126923", "name": "externalBankAccounts", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126923", "name": "externalBankAccounts", "kind": "item" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126923/lov/PersonPVA", "name": "PersonPVA", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126923/child/accountOwners", "name": "accountOwners", "kind": "collection" } ] } ], "count": 1, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts", "name": "externalBankAccounts", "kind": "collection" } ] }
Example 4
The following example shows how a Payroll user retrieves an employee bank account 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/externalBankAccounts?finder=SearchExternalBankAccount;Intent=Person
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "items": [ { "BankAccountNumber": "XXXXX3801", "CountryCode": "US", "BankBranchIdentifier": 300562, "BankIdentifier": 298992, "BankAccountId": 300100177498426, "CurrencyCode": "USD", "IBAN": null, "CheckDigits": null, "AccountType": "SAVINGS", "AccountSuffix": null, "AgencyLocationCode": null, "AllowInternationalPaymentIndicator": "Y", "SecondaryAccountReference": null, "StartDate": "2019-04-02", "EndDate": "4712-12-31", "BankAccountName": null, "AlternateAccountName": null, "BankBranchPartyIndicator": null, "BankName": "Citi Bank", "BankNumber": null, "BankBranchName": "Citi Bank", "BankBranchNumber": "64251060", "BIC": null, "VendorId": null, "PersonId": 300100038082897, "Intent": null, "PartyId": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100177498426", "name": "externalBankAccounts", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100177498426", "name": "externalBankAccounts", "kind": "item" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100177498426/lov/PersonPVA", "name": "PersonPVA", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100177498426/child/accountOwners", "name": "accountOwners", "kind": "collection" } ] } ], "count": 1, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts", "name": "externalBankAccounts", "kind": "collection" } ] }
Example 5
The following example shows how an Expenses user retrieves an employee bank account 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/externalBankAccounts?finder=SearchExternalBankAccount;Intent=Employee
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "items": [ { "BankAccountNumber": "XXXX9601", "CountryCode": "US", "BankBranchIdentifier": 100100115842864, "BankIdentifier": 100100115842856, "BankAccountId": 300100181126935, "CurrencyCode": "USD", "IBAN": null, "CheckDigits": null, "AccountType": "SAVINGS", "AccountSuffix": null, "AgencyLocationCode": null, "AllowInternationalPaymentIndicator": "N", "SecondaryAccountReference": null, "StartDate": "2019-10-22", "EndDate": "4712-12-31", "BankAccountName": "Abc Xyz", "AlternateAccountName": null, "BankBranchPartyIndicator": null, "BankName": null, "BankNumber": null, "BankBranchName": null, "BankBranchNumber": "000123123", "BIC": null, "VendorId": null, "PersonId": null, "Intent": null, "PartyId": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126935", "name": "externalBankAccounts", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126935", "name": "externalBankAccounts", "kind": "item" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126935/lov/PersonPVA", "name": "PersonPVA", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126935/child/accountOwners", "name": "accountOwners", "kind": "collection" } ] }, { "BankAccountNumber": "XXXX9658", "CountryCode": "US", "BankBranchIdentifier": 300540, "BankIdentifier": 298970, "BankAccountId": 300100181126921, "CurrencyCode": "USD", "IBAN": null, "CheckDigits": null, "AccountType": "SAVINGS", "AccountSuffix": null, "AgencyLocationCode": null, "AllowInternationalPaymentIndicator": "Y", "SecondaryAccountReference": null, "StartDate": "2019-10-22", "EndDate": "4712-12-31", "BankAccountName": "Test Bank Account", "AlternateAccountName": null, "BankBranchPartyIndicator": null, "BankName": "Bank of America", "BankNumber": "163281189", "BankBranchName": "New York", "BankBranchNumber": "122000247", "BIC": null, "VendorId": null, "PersonId": null, "Intent": null, "PartyId": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126921", "name": "externalBankAccounts", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000478" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126921", "name": "externalBankAccounts", "kind": "item" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126921/lov/PersonPVA", "name": "PersonPVA", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126921/child/accountOwners", "name": "accountOwners", "kind": "collection" } ] } ], "count": 2, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts", "name": "externalBankAccounts", "kind": "collection" } ] }
Example 6
The following example shows how to retrieve an ad-hoc payee bank account 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/externalBankAccounts?finder=SearchExternalBankAccount;Intent=Adhoc,BankAccountId=51806
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "items": [ { "BankAccountNumber": "XXXXXXXXX0844", "CountryCode": "US", "BankBranchIdentifier": 300540, "BankIdentifier": 298970, "BankAccountId": 51806, "CurrencyCode": "USD", "IBAN": null, "CheckDigits": null, "AccountType": "SAVINGS", "AccountSuffix": null, "AgencyLocationCode": null, "AllowInternationalPaymentIndicator": "Y", "SecondaryAccountReference": null, "StartDate": "2017-09-29", "EndDate": "4712-12-31", "BankAccountName": "AutoPayee290917-130844", "AlternateAccountName": null, "BankBranchPartyIndicator": null, "BankName": "Bank of America", "BankNumber": "163281189", "BankBranchName": "New York", "BankBranchNumber": "122000247", "BIC": null, "VendorId": null, "PersonId": null, "Intent": null, "PartyId": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/51806", "name": "externalBankAccounts", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000B78" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/51806", "name": "externalBankAccounts", "kind": "item" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/51806/lov/PersonPVA", "name": "PersonPVA", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/51806/child/accountOwners", "name": "accountOwners", "kind": "collection" } ] } ], "count": 1, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts", "name": "externalBankAccounts", "kind": "collection" } ] }
Example 7
The following example shows how to retrieve a one-time payee bank account 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/externalBankAccounts?finder=SearchExternalBankAccount;Intent=Onetime
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "items": [ { "BankAccountNumber": "XXXXXXXXXX1047", "CountryCode": "US", "BankBranchIdentifier": null, "BankIdentifier": null, "BankAccountId": 249304, "CurrencyCode": "USD", "IBAN": null, "CheckDigits": null, "AccountType": "SAVINGS", "AccountSuffix": "BIQA", "AgencyLocationCode": null, "AllowInternationalPaymentIndicator": "Y", "SecondaryAccountReference": null, "StartDate": "2019-10-22", "EndDate": "4712-12-31", "BankAccountName": "TEST DENORM BANK ACCOUNT 20191022031047", "AlternateAccountName": "ALTERNATE ACCOUNT NAME 20191022031047", "BankBranchPartyIndicator": "N", "BankName": "BANK NAME 20191022031047", "BankNumber": "20191022031047", "BankBranchName": "BRANCH NAME 20191022031047", "BankBranchNumber": "000123123", "BIC": null, "VendorId": null, "PersonId": null, "Intent": null, "PartyId": null, "links": [ { "rel": "self", "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/249304", "name": "externalBankAccounts", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/249304", "name": "externalBankAccounts", "kind": "item" }, { "rel": "lov", "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/249304/lov/PersonPVA", "name": "PersonPVA", "kind": "collection" }, { "rel": "child", "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/249304/child/accountOwners", "name": "accountOwners", "kind": "collection" } ] } ], "count": 1, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts", "name": "externalBankAccounts", "kind": "collection" } ] }