Jump to

• Request
• Response
• Examples

Get a payee bank account

get

/fscmRestApi/resources/11.13.18.05/payeeBankAccountsLOV/{AccountNumber}

Request

Path Parameters

• AccountNumber(required): string
  Account number of the payee bank account.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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 : payeeBankAccountsLOV-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "BankName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the bank where a payee has a bank account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountSuffix":{
            "maxLength":255,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountCountry":{
            "maxLength":255,
            "type":"string",
            "description":"Country of the payee bank account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryAccountReference":{
            "maxLength":255,
            "type":"string",
            "description":"Account number reference, such as the Building Society Roll Number used in the United Kingdom.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the payee bank account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IBAN":{
            "maxLength":255,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AlternateAccountName":{
            "maxLength":255,
            "type":"string",
            "description":"Alternate name of the payee bank account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BankCode":{
            "maxLength":255,
            "type":"string",
            "description":"Code issued to a bank by a banking regulatory authority.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountType":{
            "maxLength":255,
            "type":"string",
            "description":"Bank account types. Possible values are Savings and Checking.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"Date when the payee bank account becomes inactive.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Account number of the payee bank account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CheckDigits":{
            "maxLength":255,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":255,
            "type":"string",
            "description":"Currency code of the payee bank account. A null value represents a multicurrency bank account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SWIFTCode":{
            "maxLength":255,
            "type":"string",
            "description":"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).",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Date when the payee bank account becomes active.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BranchNumber":{
            "maxLength":255,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyLocationCode":{
            "maxLength":255,
            "type":"string",
            "description":"Agency location code used for US Federal payments.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BankAccountId":{
            "type":"integer",
            "description":"Account identifier of the payee bank account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AllowInternationalPaymentsIndicator":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates whether the payee bank account can be used for foreign payments or only for domestic payments.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BranchName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the bank branch where the payee has a bank account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FactorAccountIndicator":{
            "maxLength":255,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the payee bank account.",
            "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."
        }
    }
}

Back to Top

Examples

The following example shows how to retrieve a payee bank account by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/payeeBankAccountsLOV?finder=DefaultPayeeBankAccountsFinder;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": 300100168538433,
      "AccountNumber": "XXXXXX1010",
      "IBAN": null,
      "AccountName": null,
      "AlternateAccountName": null,
      "AccountCountry": "US",
      "CurrencyCode": null,
      "AllowInternationalPaymentsIndicator": "N",
      "BankName": "Bank of America0",
      "BankCode": "CH",
      "BranchName": "Bank of America",
      "BranchNumber": null,
      "SWIFTCode": "BOAUSNY",
      "CheckDigits": null,
      "AccountSuffix": null,
      "SecondaryAccountReference": null,
      "AgencyLocationCode": null,
      "AccountType": null,
      "FactorAccountIndicator": "N",
      "Description": null,
      "StartDate": "2018-07-09",
      "EndDate": "4712-12-31",
      "links": [
        {
          "rel": "self",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.0.0/payeeBankAccountsLOV/XXXXXX1010",
          "name": "payeeBankAccountsLOV",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.0.0/payeeBankAccountsLOV/XXXXXX1010",
          "name": "payeeBankAccountsLOV",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 1,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.0.0/payeeBankAccountsLOV",
      "name": "payeeBankAccountsLOV",
      "kind": "collection"
    }
  ]
}

Back to Top