Jump to

• Request
• Response
• Examples

Create an external bank account

post

/fscmRestApi/resources/11.13.18.05/externalBankAccounts

Request

Header Parameters

• Metadata-Context: string
  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: string
  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.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.
• attachments: array Account Attachments
  Title: Account Attachments

  The attachments resource is used to view, create, and modify the attachment of an 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.
• OriginApplicationId: number
  The originating application identifier that was used to create the bank account.
• 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.

{
    "type":"object",
    "properties":{
        "AccountSuffix":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "AccountType":{
            "title":"Account Type",
            "maxLength":25,
            "type":"string",
            "description":"Type of external bank account. Possible values are Savings and Checking.",
            "nullable":true
        },
        "AgencyLocationCode":{
            "maxLength":30,
            "type":"string",
            "description":"Agency location code of the external bank account.",
            "nullable":true
        },
        "AllowInternationalPaymentIndicator":{
            "title":"Allow international payments",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the external bank account can be used for foreign payments or only for domestic payments.",
            "nullable":true,
            "default":"N"
        },
        "AlternateAccountName":{
            "maxLength":320,
            "type":"string",
            "description":"Alternate name of the external bank account.",
            "nullable":true
        },
        "BIC":{
            "title":"BIC",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "BankAccountId":{
            "type":"integer",
            "description":"Identifier of the external bank account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "BankAccountName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the external bank account.",
            "nullable":true
        },
        "BankAccountNumber":{
            "maxLength":100,
            "type":"string",
            "description":"Account number of the external bank account.",
            "nullable":true
        },
        "BankBranchIdentifier":{
            "title":"Branch Identifier",
            "type":"integer",
            "description":"Identifier of the bank branch where the external bank account is present.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "BankBranchName":{
            "title":"Bank Branch Name",
            "maxLength":360,
            "type":"string",
            "description":"Name of the bank branch where the customer or supplier has an external bank account.",
            "nullable":true
        },
        "BankBranchNumber":{
            "title":"Branch Number",
            "maxLength":30,
            "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
        },
        "BankBranchPartyIndicator":{
            "title":"Bank Branch Party Indicator",
            "maxLength":1,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "default":"Y"
        },
        "BankIdentifier":{
            "title":"Bank Identifier",
            "type":"integer",
            "description":"Identifier of the bank where the external bank account is present.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "BankName":{
            "title":"Bank Name",
            "maxLength":360,
            "type":"string",
            "description":"Name of the bank where the customer has an external bank account.",
            "nullable":true
        },
        "BankNumber":{
            "title":"Bank Number",
            "maxLength":30,
            "type":"string",
            "description":"Code or identifier issued to an external bank by a banking regulatory authority.",
            "nullable":true
        },
        "CheckDigits":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "CountryCode":{
            "title":"Country Code",
            "maxLength":2,
            "type":"string",
            "description":"Country code of the external bank account.",
            "nullable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"Currency code of the external bank account.",
            "nullable":true
        },
        "EndDate":{
            "type":"string",
            "description":"Date when the external bank account becomes inactive.",
            "format":"date",
            "nullable":true
        },
        "IBAN":{
            "maxLength":50,
            "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
        },
        "Intent":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "OriginApplicationId":{
            "type":"number",
            "description":"The originating application identifier that was used to create the bank account.",
            "nullable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"Party identifier of the external bank account owner.",
            "nullable":true,
            "x-queryable":false
        },
        "PayeeCreation":{
            "maxLength":255,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "PersonId":{
            "type":"integer",
            "description":"Person identifier when the account owner is an employee.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SecondaryAccountReference":{
            "maxLength":30,
            "type":"string",
            "description":"Reference number of a secondary external bank account, such as the Building Society Roll Number used in the United Kingdom.",
            "nullable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date when the external bank account becomes active.",
            "format":"date",
            "nullable":true
        },
        "accountOwners":{
            "title":"Account Owners",
            "type":"array",
            "description":"The account owners resource is used to view, create, and modify the account owner of an external bank account.",
            "items":{
                "$ref":"#/components/schemas/externalBankAccounts-accountOwners-item-post-request"
            }
        },
        "attachments":{
            "title":"Account Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and modify the attachment of an external bank account.",
            "items":{
                "$ref":"#/components/schemas/externalBankAccounts-attachments-item-post-request"
            }
        }
    }
}

Nested Schema : Account Owners

Type: array

Title: Account Owners

The account owners resource is used to view, create, and modify the account owner of an external bank account.

Show Source

• Array of: object externalBankAccounts-accountOwners-item-post-request

{
    "title":"Account Owners",
    "type":"array",
    "description":"The account owners resource is used to view, create, and modify the account owner of an external bank account.",
    "items":{
        "$ref":"#/components/schemas/externalBankAccounts-accountOwners-item-post-request"
    }
}

Nested Schema : Account Attachments

Type: array

Title: Account Attachments

The attachments resource is used to view, create, and modify the attachment of an external bank account.

Show Source

• Array of: object externalBankAccounts-attachments-item-post-request

{
    "title":"Account Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and modify the attachment of an external bank account.",
    "items":{
        "$ref":"#/components/schemas/externalBankAccounts-attachments-item-post-request"
    }
}

Nested Schema : externalBankAccounts-accountOwners-item-post-request

Type: object

Show Source

• 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.
• ApprovalStatus: string
  Maximum Length: 30

  The approval status of the bank account. A list of valid values are defined in the lookup ORA_IBY_OWNER_APPROVAL_STATUS
• 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.
• LastChangeHistoryIdentifier: integer (int64)
  The last change request identifier of the bank account owner.
• OriginApplicationIdentifier: number
  The originating application identifier that was used to create the bank account owner.
• 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.
• VerificationStatus: string
  Maximum Length: 30

  The verification status of the bank account owner. A list of valid values are defined in the lookup ORA_IBY_OWNER_VERIF_STATUS.

{
    "type":"object",
    "properties":{
        "AccountOwnerId":{
            "type":"integer",
            "description":"Application-generated identifier of the external bank account owner.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "AccountOwnerPartyIdentifier":{
            "title":"Account Owner",
            "type":"integer",
            "description":"Party identifier of the external bank account owner.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AccountOwnerPartyName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"Party name of the external bank account owner.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AccountOwnerPartyNumber":{
            "title":"Registry ID",
            "maxLength":30,
            "type":"string",
            "description":"Party number of the external bank account owner.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AddJointAccountOwner":{
            "maxLength":255,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "ApprovalStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The approval status of the bank account. A list of valid values are defined in the lookup ORA_IBY_OWNER_APPROVAL_STATUS",
            "nullable":true
        },
        "EndDate":{
            "type":"string",
            "description":"Date when the external bank account owner becomes inactive.",
            "format":"date",
            "nullable":false
        },
        "Intent":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "LastChangeHistoryIdentifier":{
            "type":"integer",
            "description":"The last change request identifier of the bank account owner.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "OriginApplicationIdentifier":{
            "type":"number",
            "description":"The originating application identifier that was used to create the bank account owner.",
            "nullable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"Person identifier when the account owner is an employee.",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryOwnerIndicator":{
            "title":"Primary",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether an external bank account owner is primary.",
            "nullable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date when the external bank account owner becomes active.",
            "format":"date",
            "nullable":false
        },
        "VerificationStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The verification status of the bank account owner. A list of valid values are defined in the lookup ORA_IBY_OWNER_VERIF_STATUS.",
            "nullable":true
        }
    }
}

Nested Schema : externalBankAccounts-attachments-item-post-request

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The identifier of the document attached to the bank account.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The name of the document category.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  A brief description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL for the attachment file.

{
    "type":"object",
    "properties":{
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The identifier of the document attached to the bank account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The name of the document category.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"A brief description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL for the attachment file.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

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

Type: object

Show Source

• 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.
• attachments: array Account Attachments
  Title: Account Attachments

  The attachments resource is used to view, create, and modify the attachment of an 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.
• ChangeIndicator: string
  Read Only: true

  Maximum Length: 255

  Indicates whether there are any pending approvals for the bank account.
• 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.
• LastChangeHistoryIdentifier: integer (int64)
  Read Only: true

  The last change request identifier of the bank account.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OriginApplicationId: number
  The originating application identifier that was used to create the bank account.
• 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.
• VerificationStatus: string
  Read Only: true

  Maximum Length: 30

  The verification status of the bank account. A list of valid values are defined in the lookup ORA_IBY_BANKACCT_VERIF_STATUS.

{
    "type":"object",
    "properties":{
        "AccountSuffix":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountType":{
            "title":"Account Type",
            "maxLength":25,
            "type":"string",
            "description":"Type of external bank account. Possible values are Savings and Checking.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyLocationCode":{
            "maxLength":30,
            "type":"string",
            "description":"Agency location code of the external bank account.",
            "nullable":true,
            "x-queryable":true
        },
        "AllowInternationalPaymentIndicator":{
            "title":"Allow international payments",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the external bank account can be used for foreign payments or only for domestic payments.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "AlternateAccountName":{
            "maxLength":320,
            "type":"string",
            "description":"Alternate name of the external bank account.",
            "nullable":true,
            "x-queryable":true
        },
        "BIC":{
            "title":"BIC",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "BankAccountId":{
            "type":"integer",
            "description":"Identifier of the external bank account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "BankAccountName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the external bank account.",
            "nullable":true,
            "x-queryable":true
        },
        "BankAccountNumber":{
            "maxLength":100,
            "type":"string",
            "description":"Account number of the external bank account.",
            "nullable":true,
            "x-queryable":true
        },
        "BankBranchIdentifier":{
            "title":"Branch Identifier",
            "type":"integer",
            "description":"Identifier of the bank branch where the external bank account is present.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BankBranchName":{
            "title":"Bank Branch Name",
            "maxLength":360,
            "type":"string",
            "description":"Name of the bank branch where the customer or supplier has an external bank account.",
            "nullable":true,
            "x-queryable":true
        },
        "BankBranchNumber":{
            "title":"Branch Number",
            "maxLength":30,
            "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,
            "x-queryable":true
        },
        "BankBranchPartyIndicator":{
            "title":"Bank Branch Party Indicator",
            "maxLength":1,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "default":"Y",
            "x-queryable":true
        },
        "BankIdentifier":{
            "title":"Bank Identifier",
            "type":"integer",
            "description":"Identifier of the bank where the external bank account is present.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BankName":{
            "title":"Bank Name",
            "maxLength":360,
            "type":"string",
            "description":"Name of the bank where the customer has an external bank account.",
            "nullable":true,
            "x-queryable":true
        },
        "BankNumber":{
            "title":"Bank Number",
            "maxLength":30,
            "type":"string",
            "description":"Code or identifier issued to an external bank by a banking regulatory authority.",
            "nullable":true,
            "x-queryable":true
        },
        "ChangeIndicator":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates whether there are any pending approvals for the bank account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CheckDigits":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "CountryCode":{
            "title":"Country Code",
            "maxLength":2,
            "type":"string",
            "description":"Country code of the external bank account.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"Currency code of the external bank account.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"Date when the external bank account becomes inactive.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "IBAN":{
            "maxLength":50,
            "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,
            "x-queryable":true
        },
        "Intent":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "LastChangeHistoryIdentifier":{
            "type":"integer",
            "description":"The last change request identifier of the bank account.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OriginApplicationId":{
            "type":"number",
            "description":"The originating application identifier that was used to create the bank account.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"Party identifier of the external bank account owner.",
            "nullable":true,
            "x-queryable":false
        },
        "PayeeCreation":{
            "maxLength":255,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "PersonId":{
            "type":"integer",
            "description":"Person identifier when the account owner is an employee.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SecondaryAccountReference":{
            "maxLength":30,
            "type":"string",
            "description":"Reference number of a secondary external bank account, such as the Building Society Roll Number used in the United Kingdom.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date when the external bank account becomes active.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "VendorId":{
            "type":"integer",
            "description":"Vendor identifier when the account owner party is a supplier.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "VerificationStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The verification status of the bank account. A list of valid values are defined in the lookup ORA_IBY_BANKACCT_VERIF_STATUS.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "accountOwners":{
            "title":"Account Owners",
            "type":"array",
            "description":"The account owners resource is used to view, create, and modify the account owner of an external bank account.",
            "items":{
                "$ref":"#/components/schemas/externalBankAccounts-accountOwners-item-response"
            }
        },
        "attachments":{
            "title":"Account Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and modify the attachment of an external bank account.",
            "items":{
                "$ref":"#/components/schemas/externalBankAccounts-attachments-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Account Owners

Type: array

Title: Account Owners

The account owners resource is used to view, create, and modify the account owner of an external bank account.

Show Source

• Array of: object externalBankAccounts-accountOwners-item-response

{
    "title":"Account Owners",
    "type":"array",
    "description":"The account owners resource is used to view, create, and modify the account owner of an external bank account.",
    "items":{
        "$ref":"#/components/schemas/externalBankAccounts-accountOwners-item-response"
    }
}

Nested Schema : Account Attachments

Type: array

Title: Account Attachments

The attachments resource is used to view, create, and modify the attachment of an external bank account.

Show Source

• Array of: object externalBankAccounts-attachments-item-response

{
    "title":"Account Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and modify the attachment of an external bank account.",
    "items":{
        "$ref":"#/components/schemas/externalBankAccounts-attachments-item-response"
    }
}

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 : externalBankAccounts-accountOwners-item-response

Type: object

Show Source

• 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.
• ApprovalStatus: string
  Maximum Length: 30

  The approval status of the bank account. A list of valid values are defined in the lookup ORA_IBY_OWNER_APPROVAL_STATUS
• 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.
• LastChangeHistoryIdentifier: integer (int64)
  The last change request identifier of the bank account owner.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OriginApplicationIdentifier: number
  The originating application identifier that was used to create the bank account owner.
• 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.
• VerificationStatus: string
  Maximum Length: 30

  The verification status of the bank account owner. A list of valid values are defined in the lookup ORA_IBY_OWNER_VERIF_STATUS.

{
    "type":"object",
    "properties":{
        "AccountOwnerId":{
            "type":"integer",
            "description":"Application-generated identifier of the external bank account owner.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AccountOwnerPartyIdentifier":{
            "title":"Account Owner",
            "type":"integer",
            "description":"Party identifier of the external bank account owner.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AccountOwnerPartyName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"Party name of the external bank account owner.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AccountOwnerPartyNumber":{
            "title":"Registry ID",
            "maxLength":30,
            "type":"string",
            "description":"Party number of the external bank account owner.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AddJointAccountOwner":{
            "maxLength":255,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "ApprovalStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The approval status of the bank account. A list of valid values are defined in the lookup ORA_IBY_OWNER_APPROVAL_STATUS",
            "nullable":true,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"Date when the external bank account owner becomes inactive.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "Intent":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "LastChangeHistoryIdentifier":{
            "type":"integer",
            "description":"The last change request identifier of the bank account owner.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OriginApplicationIdentifier":{
            "type":"number",
            "description":"The originating application identifier that was used to create the bank account owner.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"Person identifier when the account owner is an employee.",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryOwnerIndicator":{
            "title":"Primary",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether an external bank account owner is primary.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date when the external bank account owner becomes active.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "VerificationStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The verification status of the bank account owner. A list of valid values are defined in the lookup ORA_IBY_OWNER_VERIF_STATUS.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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."
        }
    }
}

Nested Schema : externalBankAccounts-attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The identifier of the document attached to the bank account.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The name of the document category.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the record.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  The user name who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  A brief description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date and time when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  The user who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The name of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL for the attachment file.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The name of the user who uploaded the attachment.

{
    "type":"object",
    "properties":{
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The identifier of the document attached to the bank account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The name of the document category.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"A brief description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"The base64 encoded image of the file displayed in .png format if the source is a convertible image."
                },
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The name of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL for the attachment file.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"The name of the user who uploaded the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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"
    }
}

Links

accountOwners

Operation: /fscmRestApi/resources/11.13.18.05/externalBankAccounts/{BankAccountId}/child/accountOwners

Parameters:

• BankAccountId: $request.path.BankAccountId

The account owners resource is used to view, create, and modify the account owner of an external bank account.

attachments

Operation: /fscmRestApi/resources/11.13.18.05/externalBankAccounts/{BankAccountId}/child/attachments

Parameters:

• BankAccountId: $request.path.BankAccountId

The attachments resource is used to view, create, and modify the attachment of an external bank account.

Back to Top

Examples

Example 1

The following example shows how to create an external bank account by submitting a POST request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts

Example Request Body

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

{           
"BankAccountNumber": "12398765",
"CountryCode": "US",
"BankBranchIdentifier": 300562,
"BankIdentifier": 298992,
"CurrencyCode": "USD",
"AccountType": "SAVINGS",
"AllowInternationalPaymentIndicator": "Y",
"Intent":"Supplier",
"PartyId": 336590,
"BankAccountName": "Abc Xyz",
"accountOwners":[{
"AccountOwnerPartyIdentifier": 336590
}]
}

Example Response Body

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

{
    "BankAccountNumber": "XXXX8765",
    "CountryCode": "US",
    "BankBranchIdentifier": 300562,
    "BankIdentifier": 298992,
    "CurrencyCode": "USD",
    "AccountType": "SAVINGS",
    "AllowInternationalPaymentIndicator": "Y",
    "Intent":"Supplier",
    "PartyId": 336590,
    "BankAccountName": "Abc Xyz",
    ...
    "accountOwners": [
        {
            "AccountOwnerPartyIdentifier": 336590,
            "AccountOwnerPartyNumber": "143182",
            "AccountOwnerPartyName": "SHORE FINANCIAL SERVICES INC",
            "PrimaryOwnerIndicator": "Y",
            ...
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100173366598/child/accountOwners/300100173366599",
                    "name": "accountOwners",
                    "kind": "item",
                    "properties": {
                                     "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                                  }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100173366598/child/accountOwners/300100173366599",
                    "name": "accountOwners",
                    "kind": "item"
                },
                ...
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100173366598",
            "name": "externalBankAccounts",
            "kind": "item",
            "properties": {
                             "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                          }
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100173366598/child/accountOwners",
            "name": "accountOwners",
            "kind": "collection"
        },
        ...
    ]
}

Example 2

The following example shows how a Procurement user creates a supplier bank account by submitting a POST request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts

Example Request Body

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

{
    "BankAccountNumber": "98589655",
    "CountryCode": "US",
    "BankBranchIdentifier": 300562,
    "BankIdentifier": 298992,
    "CurrencyCode": "USD",
    "AccountType": "SAVINGS",
    "AllowInternationalPaymentIndicator": "Y",
    "Intent": "Supplier",
    "PartyId": 333937,
    "BankAccountName": "Abc Xyz",
    "accountOwners": [
        {
            "AccountOwnerPartyIdentifier": 333937,
            "Intent": "Supplier"
        }
    ]
}

Example Response Body

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

{
    "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": "Y",
    "BankName": "Citi Bank",
    "BankNumber": null,
    "BankBranchName": "Citi Bank",
    "BankBranchNumber": "64251060",
    "BIC": null,
    "VendorId": null,
    "PersonId": null,
    "Intent": "Supplier",
    "PartyId": 333937,
    "accountOwners": [
        {
            "AccountOwnerPartyIdentifier": 333937,
            "AccountOwnerPartyNumber": "139161",
            "AccountOwnerPartyName": "JACK N JILL INC",
            "PrimaryOwnerIndicator": "Y",
            "StartDate": "2019-10-22",
            "EndDate": "4712-12-31",
            "AccountOwnerId": 300100181126860,
            "Intent": "Supplier",
            "PersonId": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126859/child/accountOwners/300100181126860",
                    "name": "accountOwners",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126859/child/accountOwners/300100181126860",
                    "name": "accountOwners",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "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/child/accountOwners/300100181126860/lov/PartyVVOVA",
                    "name": "PartyVVOVA",
                    "kind": "collection"
                }
            ]
        }
    ],
    "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"
        }
    ]
}

Example 3

The following example shows how a Receivables user creates a customer bank account by submitting a POST request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts

Example Request Body

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

{
    "BankAccountNumber": "985896588",
    "CountryCode": "US",
    "BankBranchIdentifier": 300562,
    "BankIdentifier": 298992,
    "CurrencyCode": "USD",
    "AccountType": "SAVINGS",
    "AllowInternationalPaymentIndicator": "Y",
    "Intent": "Customer",
    "PartyId": 1005,
    "BankAccountName": "Abc Xyz",
    "accountOwners": [
        {
            "AccountOwnerPartyIdentifier": 1005,
            "Intent": "Customer"
        }
    ]   
}

Example Response Body

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

{
    "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": null,
    "BankBranchPartyIndicator": "Y",
    "BankName": "Citi Bank",
    "BankNumber": null,
    "BankBranchName": "Citi Bank",
    "BankBranchNumber": "64251060",
    "BIC": null,
    "VendorId": null,
    "PersonId": null,
    "Intent": "Customer",
    "PartyId": 1005,
    "accountOwners": [
        {
            "AccountOwnerPartyIdentifier": 1005,
            "AccountOwnerPartyNumber": "1005",
            "AccountOwnerPartyName": "AT&T Universal Card",
            "PrimaryOwnerIndicator": "Y",
            "StartDate": "2019-10-22",
            "EndDate": "4712-12-31",
            "AccountOwnerId": 300100181126924,
            "Intent": "Customer",
            "PersonId": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126923/child/accountOwners/300100181126924",
                    "name": "accountOwners",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126923/child/accountOwners/300100181126924",
                    "name": "accountOwners",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "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/child/accountOwners/300100181126924/lov/PartyVVOVA",
                    "name": "PartyVVOVA",
                    "kind": "collection"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126923",
            "name": "externalBankAccounts",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "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"
        }
    ]
}

Example 4

The following example shows how a Payroll user creates an employee bank account where a pre-defined bank and branch is used.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts

Example Request Body

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

{
    "BankAccountNumber": "123123100",
    "CountryCode": "US",
    "BankBranchIdentifier": 300562,
    "BankIdentifier": 298992,
    "CurrencyCode": "USD",
    "AccountType": "SAVINGS",
    "AllowInternationalPaymentIndicator": "Y",
    "PersonId": 100100004259841,
    "Intent": "Person",
    "accountOwners": [
        {
            "AccountOwnerPartyIdentifier": 100100004262868,
			"Intent": "Person" 
		}
    ]
}

Example Response Body

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

{
    "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": "Y",
    "BankName": "Citi Bank",
    "BankNumber": null,
    "BankBranchName": "Citi Bank",
    "BankBranchNumber": "64251060",
    "BIC": null,
    "VendorId": null,
    "PersonId": null,
    "Intent": "Person",
    "PartyId": null,
    "accountOwners": [
        {
            "AccountOwnerPartyIdentifier": 300100038056894,
            "AccountOwnerPartyNumber": "CDRM_75839",
            "AccountOwnerPartyName": "ZHRX_VS BV_SECUSER",
            "PrimaryOwnerIndicator": "Y",
            "StartDate": "2019-04-02",
            "EndDate": "4712-12-31",
            "AccountOwnerId": 300100177498427,
            "Intent": "Person",
            "PersonId": 300100038082897,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100177498426/child/accountOwners/300100177498427",
                    "name": "accountOwners",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100177498426/child/accountOwners/300100177498427",
                    "name": "accountOwners",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100177498426",
                    "name": "externalBankAccounts",
                    "kind": "item"
                }
            ]
        }
    ],
    "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"
        }
    ]
}

Example 5

The following example shows how a Payroll user creates an employee bank account where bank and branch are created simultaneously.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts

Example Request Body

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

{
    "BankAccountNumber": "123123101",
    "CountryCode": "US",
    "BankBranchNumber": "123123",
    "CurrencyCode": "USD",
    "AccountType": "SAVINGS",
    "PersonId": 100100004259841,
    "Intent": "Person",
    "accountOwners": [
        {
            "AccountOwnerPartyIdentifier": 100100004262868,
            "Intent": "Person"
        }
    ]
}

Example Response Body

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

{
    "BankAccountNumber": "XXXXX3101",
    "CountryCode": "US",
    "BankBranchIdentifier": 100100115842826,
    "BankIdentifier": 100100115842818,
    "BankAccountId": 300100181126906,
    "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": null,
    "AlternateAccountName": null,
    "BankBranchPartyIndicator": "Y",
    "BankName": null,
    "BankNumber": null,
    "BankBranchName": null,
    "BankBranchNumber": "000123123",
    "BIC": null,
    "VendorId": null,
    "PersonId": null,
    "Intent": "Person",
    "PartyId": null,
    "accountOwners": [
        {
            "AccountOwnerPartyIdentifier": 300100038056894,
            "AccountOwnerPartyNumber": "CDRM_75839",
            "AccountOwnerPartyName": "ZHRX_VS BV_SECUSER",
            "PrimaryOwnerIndicator": "Y",
            "StartDate": "2019-04-02",
            "EndDate": "4712-12-31",
            "AccountOwnerId": 300100177498427,
            "Intent": "Person",
            "PersonId": 300100038082897,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126906/child/accountOwners/300100181126907",
                    "name": "accountOwners",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126906/child/accountOwners/300100181126907",
                    "name": "accountOwners",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126906",
                    "name": "externalBankAccounts",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126906/child/accountOwners/300100181126907/lov/PartyVVOVA",
                    "name": "PartyVVOVA",
                    "kind": "collection"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126906",
            "name": "externalBankAccounts",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126906",
            "name": "externalBankAccounts",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126906/lov/PersonPVA",
            "name": "PersonPVA",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126906/child/accountOwners",
            "name": "accountOwners",
            "kind": "collection"
        }
    ]
}

Example 6

The following example shows how an Expenses user creates an employee bank account where a pre-defined bank and branch is used.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts

Example Request Body

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

{
    "BankAccountNumber": "98589658",
    "CountryCode": "US",
    "BankBranchIdentifier": 300562,
    "BankIdentifier": 298992,
    "CurrencyCode": "USD",
    "AccountType": "SAVINGS",
    "AllowInternationalPaymentIndicator": "Y",
    "Intent": "Employee",
    "PartyId": 300100148480036,
    "BankAccountName": "Abc Xyz",
    "accountOwners": [
        {
            "AccountOwnerPartyIdentifier": 300100148480036,
            "Intent": "Employee"
        }
    ]
}

Example Response Body

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

{
    "BankAccountNumber": "XXXX9658",
    "CountryCode": "US",
    "BankBranchIdentifier": 300562,
    "BankIdentifier": 298992,
    "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": "Abc Xyz",
    "AlternateAccountName": null,
    "BankBranchPartyIndicator": "Y",
    "BankName": "Citi Bank",
    "BankNumber": null,
    "BankBranchName": "Citi Bank",
    "BankBranchNumber": "64251060",
    "BIC": null,
    "VendorId": null,
    "PersonId": null,
    "Intent": "Employee",
    "PartyId": 300100148480036,
    "accountOwners": [
        {
            "AccountOwnerPartyIdentifier": 300100148480036,
            "AccountOwnerPartyNumber": "CDRM_733616",
            "AccountOwnerPartyName": "CVBUYER01_DK",
            "PrimaryOwnerIndicator": "Y",
            "StartDate": "2019-10-22",
            "EndDate": "4712-12-31",
            "AccountOwnerId": 300100181126922,
            "Intent": "Employee",
            "PersonId": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126921/child/accountOwners/300100181126922",
                    "name": "accountOwners",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126921/child/accountOwners/300100181126922",
                    "name": "accountOwners",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "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/child/accountOwners/300100181126922/lov/PartyVVOVA",
                    "name": "PartyVVOVA",
                    "kind": "collection"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126921",
            "name": "externalBankAccounts",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "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"
        }
    ]
}

Example 7

The following example shows how a Expenses user creates an employee bank account where bank and branch are created simultaneously.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts

Example Request Body

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

{
    "BankAccountNumber": "98589601",
    "CountryCode": "US",
    "BankBranchNumber": "00123123",
    "CurrencyCode": "USD",
    "AccountType": "SAVINGS",
    "Intent": "Employee",
    "PartyId": 300100148480036,
    "BankAccountName": "Abc Xyz",
    "accountOwners": [
        {
            "AccountOwnerPartyIdentifier": 300100148480036,
            "Intent": "Employee"
        }
    ]
}

Example Response Body

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

{
  "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": "Y",
  "BankName": null,
  "BankNumber": null,
  "BankBranchName": null,
  "BankBranchNumber": "000123123",
  "BIC": null,
  "VendorId": null,
  "PersonId": null,
  "Intent": "Employee",
  "PartyId": 300100148480036,
  "accountOwners": [
    {
      "AccountOwnerPartyIdentifier": 300100148480036,
      "AccountOwnerPartyNumber": "CDRM_733616",
      "AccountOwnerPartyName": "CVBUYER01_DK",
      "PrimaryOwnerIndicator": "Y",
      "StartDate": "2019-10-22",
      "EndDate": "4712-12-31",
      "AccountOwnerId": 300100181126936,
      "Intent": "Employee",
      "PersonId": null,
      "links": [
        {
          "rel": "self",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126935/child/accountOwners/300100181126936",
          "name": "accountOwners",
          "kind": "item",
          "properties": {
            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
          }
        },
        {
          "rel": "canonical",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126935/child/accountOwners/300100181126936",
          "name": "accountOwners",
          "kind": "item"
        },
        {
          "rel": "parent",
          "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/child/accountOwners/300100181126936/lov/PartyVVOVA",
          "name": "PartyVVOVA",
          "kind": "collection"
        }
      ]
    }
  ],
  "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"
    }
  ]
}

Example 8

The following example shows how a Procurement user creates a one-time payee bank account by submitting a POST request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts

Example Request Body

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

{
    "BankAccountNumber": "98589654",
    "CountryCode": "US",
    "BankBranchNumber": "123123",
    "CurrencyCode": "USD",
    "AccountType": "SAVINGS",
    "BankBranchPartyIndicator": "N",
    "Intent": "Onetime",
    "PartyId": 100100050897855,
    "BankAccountName": "Abc Xyz",
    "accountOwners": [
        {
            "AccountOwnerPartyIdentifier": 100100050897855,
            "Intent": "Onetime"
        }
    ]
}

Example Response Body

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

{
    "BankAccountNumber": "XXXX9654",
    "CountryCode": "US",
    "BankBranchIdentifier": null,
    "BankIdentifier": null,
    "BankAccountId": 300100181538392,
    "CurrencyCode": "USD",
    "IBAN": null,
    "CheckDigits": null,
    "AccountType": "SAVINGS",
    "AccountSuffix": null,
    "AgencyLocationCode": null,
    "AllowInternationalPaymentIndicator": "N",
    "SecondaryAccountReference": null,
    "StartDate": "2019-11-06",
    "EndDate": "4712-12-31",
    "BankAccountName": "Abc Xyz",
    "AlternateAccountName": null,
    "BankBranchPartyIndicator": "N",
    "BankName": null,
    "BankNumber": null,
    "BankBranchName": null,
    "BankBranchNumber": "123123",
    "BIC": null,
    "VendorId": null,
    "PersonId": null,
    "Intent": "Onetime",
    "PartyId": 100100050897855,
    "accountOwners": [
        {
            "AccountOwnerPartyIdentifier": 100100050897855,
            "AccountOwnerPartyNumber": "Registry_RPT_CDRM",
            "AccountOwnerPartyName": "BK_GPAY_RPT_TP_ORG_CDRM",
            "PrimaryOwnerIndicator": "Y",
            "StartDate": "2019-11-06",
            "EndDate": "4712-12-31",
            "AccountOwnerId": 300100181538393,
            "Intent": "Onetime",
            "PersonId": null,
            "links": [
                {
                    "rel": "self",
                    "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181538392/child/accountOwners/300100181538393",
                    "name": "accountOwners",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181538392/child/accountOwners/300100181538393",
                    "name": "accountOwners",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181538392",
                    "name": "externalBankAccounts",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181538392/child/accountOwners/300100181538393/lov/PartyVVOVA",
                    "name": "PartyVVOVA",
                    "kind": "collection"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181538392",
            "name": "externalBankAccounts",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181538392",
            "name": "externalBankAccounts",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181538392/lov/PersonPVA",
            "name": "PersonPVA",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181538392/child/accountOwners",
            "name": "accountOwners",
            "kind": "collection"
        }
    ]
}

Example 9

The following example shows how a Cash Management user creates an ad-hoc bank account by submitting a POST request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts

Example Request Body

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

{
    "BankAccountNumber": "98589644",
    "CountryCode": "US",
    "BankBranchIdentifier": 300562,
    "BankIdentifier": 298992,
    "CurrencyCode": "USD",
    "AccountType": "SAVINGS",
    "AllowInternationalPaymentIndicator": "Y",
    "Intent": "Adhoc",
    "PartyId": 300100121773260,
    "BankAccountName": "Abc Xyz",
    "accountOwners": [
        {
            "AccountOwnerPartyIdentifier": 300100121773260,
            "Intent": "Adhoc"
        }
    ]
}

Example Response Body

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

{
  "BankAccountNumber": "XXXX9644",
  "CountryCode": "US",
  "BankBranchIdentifier": 300562,
  "BankIdentifier": 298992,
  "BankAccountId": 300100181135401,
  "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": "Y",
  "BankName": "Citi Bank",
  "BankNumber": null,
  "BankBranchName": "Citi Bank",
  "BankBranchNumber": "64251060",
  "BIC": null,
  "VendorId": null,
  "PersonId": null,
  "Intent": "Adhoc",
  "PartyId": 300100121773260,
  "accountOwners": [
    {
      "AccountOwnerPartyIdentifier": 300100121773260,
      "AccountOwnerPartyNumber": "CDRM_681211",
      "AccountOwnerPartyName": "CE_ADHOC_Payee",
      "PrimaryOwnerIndicator": "Y",
      "StartDate": "2019-10-22",
      "EndDate": "4712-12-31",
      "AccountOwnerId": 300100181135402,
      "Intent": "Adhoc",
      "PersonId": null,
      "links": [
        {
          "rel": "self",
          "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181135401/child/accountOwners/300100181135402",
          "name": "accountOwners",
          "kind": "item",
          "properties": {
            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
          }
        },
        {
          "rel": "canonical",
          "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181135401/child/accountOwners/300100181135402",
          "name": "accountOwners",
          "kind": "item"
        },
        {
          "rel": "parent",
          "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181135401",
          "name": "externalBankAccounts",
          "kind": "item"
        },
        {
          "rel": "lov",
          "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181135401/child/accountOwners/300100181135402/lov/PartyVVOVA",
          "name": "PartyVVOVA",
          "kind": "collection"
        }
      ]
    }
  ],
  "links": [
    {
      "rel": "self",
      "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181135401",
      "name": "externalBankAccounts",
      "kind": "item",
      "properties": {
        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
      }
    },
    {
      "rel": "canonical",
      "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181135401",
      "name": "externalBankAccounts",
      "kind": "item"
    },
    {
      "rel": "lov",
      "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181135401/lov/PersonPVA",
      "name": "PersonPVA",
      "kind": "collection"
    },
    {
      "rel": "child",
      "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181135401/child/accountOwners",
      "name": "accountOwners",
      "kind": "collection"
    }
  ]
}

Back to Top