Jump to

• Request
• Response
• Examples

Update an external bank account

patch

/fscmRestApi/resources/11.13.18.05/externalBankAccounts/{BankAccountId}

Request

Path Parameters

• BankAccountId(required): integer(int64)
  Identifier of the external bank account.

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

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.
• 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.
• 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":{
        "BankName":{
            "title":"Bank Name",
            "maxLength":360,
            "type":"string",
            "description":"Name of the bank where the customer has an external bank account.",
            "nullable":true
        },
        "AlternateAccountName":{
            "maxLength":320,
            "type":"string",
            "description":"Alternate name of the external bank account.",
            "nullable":true
        },
        "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
        },
        "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
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"Currency code of the external bank account.",
            "nullable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date when the external bank account becomes active.",
            "format":"date",
            "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
        },
        "CountryCode":{
            "title":"Country Code",
            "maxLength":2,
            "type":"string",
            "description":"Country code 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
        },
        "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
        },
        "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"
        },
        "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
        },
        "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
        },
        "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-patch-request"
            }
        },
        "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
        },
        "AccountType":{
            "title":"Account Type",
            "maxLength":25,
            "type":"string",
            "description":"Type of external bank account. Possible values are Savings and Checking.",
            "nullable":true
        },
        "EndDate":{
            "type":"string",
            "description":"Date when the external bank account becomes inactive.",
            "format":"date",
            "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
        },
        "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"
        },
        "BankAccountName":{
            "maxLength":80,
            "type":"string",
            "description":"Name 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
            }
        },
        "AgencyLocationCode":{
            "maxLength":30,
            "type":"string",
            "description":"Agency location code of the external bank account.",
            "nullable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"Person identifier when the account owner is an employee.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PartyId":{
            "type":"integer",
            "description":"Party identifier of the external bank account owner.",
            "nullable":true,
            "x-queryable":false
        },
        "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
            }
        },
        "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
        },
        "BankAccountNumber":{
            "maxLength":100,
            "type":"string",
            "description":"Account number of the external bank account.",
            "nullable":true
        }
    }
}

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 schema

{
    "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-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• AddJointAccountOwner: string
  Maximum Length: 255

  Indicates whether the joint owner should be created if the bank account is already existing. Valid values are Y and N. For internal use only.
• EndDate: string (date)
  Date when the external bank account owner becomes inactive.
• Intent: string
  Purpose of the external bank account. The value is based on the payment function of the external payee or the external payer of the account owner. The following are the expected values: PAYABLES_DISB - Supplier, EMPLOYEE_EXP - Person, EMPLOYEE_EXP - Employee, AR_CUSTOMER_REFUNDS - Refund, CUSTOMER_PAYMENT - Customer, ONETIME_PAYMENT - Onetime, and ADHOC_PAYMENT - Adhoc.
• 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.

{
    "type":"object",
    "properties":{
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date when the external bank account owner becomes active.",
            "format":"date",
            "nullable":false
        },
        "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
        },
        "PersonId":{
            "type":"integer",
            "description":"Person identifier when the account owner is an employee.",
            "nullable":true,
            "x-queryable":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
        },
        "PrimaryOwnerIndicator":{
            "title":"Primary",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether an external bank account owner is primary.",
            "nullable":true
        },
        "EndDate":{
            "type":"string",
            "description":"Date when the external bank account owner becomes inactive.",
            "format":"date",
            "nullable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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.
• BankAccountId: integer (int64)
  Identifier of the external bank account.
• BankAccountName: string
  Maximum Length: 80

  Name of the external bank account.
• BankAccountNumber: string
  Maximum Length: 100

  Account number of the external bank account.
• BankBranchIdentifier: integer (int64)
  Title: Branch Identifier

  Identifier of the bank branch where the external bank account is present.
• BankBranchName: string
  Title: Bank Branch Name

  Maximum Length: 360

  Name of the bank branch where the customer or supplier has an external bank account.
• BankBranchNumber: string
  Title: Branch Number

  Maximum Length: 30

  Number of a bank branch. This is known as a routing transit number in the United States and a sort code in the United Kingdom.
• BankBranchPartyIndicator: string
  Title: Bank Branch Party Indicator

  Maximum Length: 1

  Default Value: Y

  Indicates whether an external bank account is associated with any external bank and branch created in Trading Community Architecture (TCA). If the value is Yes or Null, external bank and branch information is stored in TCA and the external bank and branch identifiers are stored on the external bank account. If the value is No, external bank and branch attributes are stored on the external bank account.
• BankIdentifier: integer (int64)
  Title: Bank Identifier

  Identifier of the bank where the external bank account is present.
• BankName: string
  Title: Bank Name

  Maximum Length: 360

  Name of the bank where the customer has an external bank account.
• BankNumber: string
  Title: Bank Number

  Maximum Length: 30

  Code or identifier issued to an external bank by a banking regulatory authority.
• BIC: string
  Title: BIC

  Maximum Length: 30

  Bank Identifier Code (BIC), which is the identifier code used by SWIFT to identify an external bank or bank branch. The BIC is a universal method of identifying financial institutions to facilitate the automated processing of telecommunication messages in banking and related financial environments.
• CheckDigits: string
  Maximum Length: 30

  Number added to the external bank account number to derive a further number as a means of verifying the accuracy or validity of the external account number as it is printed or transmitted.
• CountryCode: string
  Title: Country Code

  Maximum Length: 2

  Country code of the external bank account.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  Currency code of the external bank account.
• EndDate: string (date)
  Date when the external bank account becomes inactive.
• IBAN: string
  Maximum Length: 50

  International Bank Account Number (IBAN), which is an alphanumeric sequence that conforms to the ISO standard for uniquely identifying a bank account number internationally. The standard IBAN carries all the routing information needed to get a payment from one bank to another.
• Intent: string
  Purpose of the external bank account. The value is based on the payment function of the external payee or the external payer of the account owner. The following are the expected values: PAYABLES_DISB - Supplier, EMPLOYEE_EXP - Person, EMPLOYEE_EXP - Employee, AR_CUSTOMER_REFUNDS - Refund, CUSTOMER_PAYMENT - Customer, ONETIME_PAYMENT - Onetime, and ADHOC_PAYMENT - Adhoc.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PartyId: integer
  Party identifier of the external bank account owner.
• PayeeCreation: string
  Maximum Length: 255

  Indicates whether the external payee and instrument assignments should be created along with the bank account. Valid values are Y and N. For internal use only.
• PersonId: integer
  Person identifier when the account owner is an employee.
• SecondaryAccountReference: string
  Maximum Length: 30

  Reference number of a secondary external bank account, such as the Building Society Roll Number used in the United Kingdom.
• StartDate: string (date)
  Title: Start Date

  Date when the external bank account becomes active.
• VendorId: integer (int64)
  Read Only: true

  Vendor identifier when the account owner party is a supplier.

{
    "type":"object",
    "properties":{
        "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
        },
        "AlternateAccountName":{
            "maxLength":320,
            "type":"string",
            "description":"Alternate name of the external bank account.",
            "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
        },
        "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
        },
        "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
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"Currency code of the external bank account.",
            "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
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CountryCode":{
            "title":"Country Code",
            "maxLength":2,
            "type":"string",
            "description":"Country code 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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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"
            }
        },
        "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
        },
        "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
        },
        "EndDate":{
            "type":"string",
            "description":"Date when the external bank account becomes inactive.",
            "format":"date",
            "nullable":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
        },
        "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
        },
        "BankAccountName":{
            "maxLength":80,
            "type":"string",
            "description":"Name 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
        },
        "AgencyLocationCode":{
            "maxLength":30,
            "type":"string",
            "description":"Agency location code of the external bank account.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"Person identifier when the account owner is an employee.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"Party identifier of the external bank account owner.",
            "nullable":true,
            "x-queryable":false
        },
        "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
        },
        "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
        },
        "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
        },
        "BankAccountNumber":{
            "maxLength":100,
            "type":"string",
            "description":"Account number of the external bank account.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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 : 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.
• EndDate: string (date)
  Date when the external bank account owner becomes inactive.
• Intent: string
  Purpose of the external bank account. The value is based on the payment function of the external payee or the external payer of the account owner. The following are the expected values: PAYABLES_DISB - Supplier, EMPLOYEE_EXP - Person, EMPLOYEE_EXP - Employee, AR_CUSTOMER_REFUNDS - Refund, CUSTOMER_PAYMENT - Customer, ONETIME_PAYMENT - Onetime, and ADHOC_PAYMENT - Adhoc.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PersonId: integer
  Person identifier when the account owner is an employee.
• PrimaryOwnerIndicator: string
  Title: Primary

  Maximum Length: 1

  Indicates whether an external bank account owner is primary.
• StartDate: string (date)
  Title: Start Date

  Date when the external bank account owner becomes active.

{
    "type":"object",
    "properties":{
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date when the external bank account owner becomes active.",
            "format":"date",
            "nullable":false,
            "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
        },
        "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
        },
        "PersonId":{
            "type":"integer",
            "description":"Person identifier when the account owner is an employee.",
            "nullable":true,
            "x-queryable":false
        },
        "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
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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
        },
        "PrimaryOwnerIndicator":{
            "title":"Primary",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether an external bank account owner is primary.",
            "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
        },
        "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
        }
    }
}

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

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.

Back to Top

Examples

Example 1

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

curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X PATCH -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100173366598

Example Request Body

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

{
"AlternateAccountName": "Test 1",
"Intent" :"Supplier",
"PartyId": 336590
}

Example Response Body

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

{
    "BankAccountNumber": "XXXX8765",
    "AlternateAccountName": "Test 1",
    "Intent" :"Supplier",
    "PartyId": 336590,
    ...
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100173366598",
            "name": "externalBankAccounts",
            "kind": "item",
            "properties": {
                             "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
                          }
        },
        {
            "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 updates a supplier bank account by submitting a PATCH request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X PATCH -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126862

Example Request Body

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

{
    "AlternateAccountName": "Test 1",
    "Intent": "Supplier",
    "PartyId": 333937
}

Example Response Body

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

{
    "BankAccountNumber": "XXXX9656",
    "CountryCode": "US",
    "BankBranchIdentifier": 300562,
    "BankIdentifier": 298992,
    "BankAccountId": 300100181126862,
    "CurrencyCode": "USD",
    "IBAN": null,
    "CheckDigits": null,
    "AccountType": "SAVINGS",
    "AccountSuffix": null,
    "AgencyLocationCode": null,
    "AllowInternationalPaymentIndicator": "Y",
    "SecondaryAccountReference": null,
    "StartDate": "2019-10-22",
    "EndDate": "4712-12-31",
    "BankAccountName": "Abc Xyz",
    "AlternateAccountName": "Test 1",
    "BankBranchPartyIndicator": null,
    "BankName": null,
    "BankNumber": null,
    "BankBranchName": null,
    "BankBranchNumber": null,
    "BIC": null,
    "VendorId": null,
    "PersonId": null,
    "Intent": "Supplier",
    "PartyId": 333937,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126862",
            "name": "externalBankAccounts",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126862",
            "name": "externalBankAccounts",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126862/lov/PersonPVA",
            "name": "PersonPVA",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126862/child/accountOwners",
            "name": "accountOwners",
            "kind": "collection"
        }
    ]
}

Example 3

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

curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X PATCH -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126923

Example Request Body

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

{
    "AlternateAccountName": "Test 123",
    "Intent": "Customer",
    "PartyId": 1005
}

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": "Test 123",
    "BankBranchPartyIndicator": null,
    "BankName": null,
    "BankNumber": null,
    "BankBranchName": null,
    "BankBranchNumber": null,
    "BIC": null,
    "VendorId": null,
    "PersonId": null,
    "Intent": "Customer",
    "PartyId": 1005,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126923",
            "name": "externalBankAccounts",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126923",
            "name": "externalBankAccounts",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126923/lov/PersonPVA",
            "name": "PersonPVA",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126923/child/accountOwners",
            "name": "accountOwners",
            "kind": "collection"
        }
    ]
}

Example 4

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

curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X PATCH -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100177498426

Example Request Body

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

{          
	"BankAccountName": "Test BA",
	"Intent": "Person",
	"PersonId": 300100038082897
}

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": "Test BA",
    "AlternateAccountName": null,
    "BankBranchPartyIndicator": null,
    "BankName": null,
    "BankNumber": null,
    "BankBranchName": null,
    "BankBranchNumber": null,
    "BIC": null,
    "VendorId": null,
    "PersonId": 300100038082897,
    "Intent": "Person",
    "PartyId": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100177498426",
            "name": "externalBankAccounts",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100177498426",
            "name": "externalBankAccounts",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100177498426/lov/PersonPVA",
            "name": "PersonPVA",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100177498426/child/accountOwners",
            "name": "accountOwners",
            "kind": "collection"
        }
    ]
}

Example 5

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

curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X PATCH -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126906

Example Request Body

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

{          
	"BankAccountName": "Test BA",
	"Intent": "Person",
	"PersonId": 300100038082897
}

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": "Test BA",
    "AlternateAccountName": null,
    "BankBranchPartyIndicator": "Y",
    "BankName": null,
    "BankNumber": null,
    "BankBranchName": null,
    "BankBranchNumber": "000123123",
    "BIC": null,
    "VendorId": null,
    "PersonId": null,
    "Intent": "Person",
    "PartyId": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100177498426",
            "name": "externalBankAccounts",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100177498426",
            "name": "externalBankAccounts",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100177498426/lov/PersonPVA",
            "name": "PersonPVA",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100177498426/child/accountOwners",
            "name": "accountOwners",
            "kind": "collection"
        }
    ]
}

Example 6

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

curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X PATCH -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126921

Example Request Body

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

{         
	"BankAccountName": "Test BA 123",
	"Intent": "Employee",
	"PartyId": 300100148480036
}

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": "Test BA 123",
    "AlternateAccountName": null,
    "BankBranchPartyIndicator": null,
    "BankName": null,
    "BankNumber": null,
    "BankBranchName": null,
    "BankBranchNumber": null,
    "BIC": null,
    "VendorId": null,
    "PersonId": null,
    "Intent": "Employee",
    "PartyId": 300100148480036,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126921",
            "name": "externalBankAccounts",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "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 an Expenses user updates an employee bank account where bank and branch are updated simultaneously.

curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X PATCH -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126921

Example Request Body

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

{
    "BankIdentifier": 298970,
    "BankBranchIdentifier": 300540,
    "BankAccountName": "Test Bank Account",
    "Intent": "Employee",
    "PartyId": 300100148480036
}

Example Response Body

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

{
    "BankAccountNumber": "XXXX9658",
    "CountryCode": "US",
    "BankBranchIdentifier": 300540,
    "BankIdentifier": 298970,
    "BankAccountId": 300100181126921,
    "CurrencyCode": "USD",
    "IBAN": null,
    "CheckDigits": null,
    "AccountType": "SAVINGS",
    "AccountSuffix": null,
    "AgencyLocationCode": null,
    "AllowInternationalPaymentIndicator": "Y",
    "SecondaryAccountReference": null,
    "StartDate": "2019-10-22",
    "EndDate": "4712-12-31",
    "BankAccountName": "Test Bank Account",
    "AlternateAccountName": null,
    "BankBranchPartyIndicator": null,
    "BankName": null,
    "BankNumber": null,
    "BankBranchName": null,
    "BankBranchNumber": null,
    "BIC": null,
    "VendorId": null,
    "PersonId": null,
    "Intent": "Employee",
    "PartyId": 300100148480036,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126921",
            "name": "externalBankAccounts",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000478"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126921",
            "name": "externalBankAccounts",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126921/lov/PersonPVA",
            "name": "PersonPVA",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181126921/child/accountOwners",
            "name": "accountOwners",
            "kind": "collection"
        }
    ]
}

Example 8

The following example shows how a Payables user updates a one-time payee bank account by submitting a PATCH request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X PATCH -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/249304

Example Request Body

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

{
    "BankAccountName": "Test 123",
    "Intent": "Onetime",
    "PartyId": 100100050897855
}

Example Response Body

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

{
    "BankAccountNumber": "XXXXXXXXXX1047",
    "CountryCode": "US",
    "BankBranchIdentifier": null,
    "BankIdentifier": null,
    "BankAccountId": 249304,
    "CurrencyCode": "USD",
    "IBAN": null,
    "CheckDigits": null,
    "AccountType": "SAVINGS",
    "AccountSuffix": "BIQA",
    "AgencyLocationCode": null,
    "AllowInternationalPaymentIndicator": "Y",
    "SecondaryAccountReference": null,
    "StartDate": "2019-10-22",
    "EndDate": "4712-12-31",
    "BankAccountName": "Test 123",
    "AlternateAccountName": "ALTERNATE ACCOUNT NAME 20191022031047",
    "BankBranchPartyIndicator": "N",
    "BankName": "BANK NAME 20191022031047",
    "BankNumber": "20191022031047",
    "BankBranchName": "BRANCH NAME 20191022031047",
    "BankBranchNumber": "000123123",
    "BIC": null,
    "VendorId": null,
    "PersonId": null,
    "Intent": "Onetime",
    "PartyId": 100100050897855,
    "links": [
        {
            "rel": "self",
            "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/249304",
            "name": "externalBankAccounts",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/249304",
            "name": "externalBankAccounts",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/249304/lov/PersonPVA",
            "name": "PersonPVA",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/249304/child/accountOwners",
            "name": "accountOwners",
            "kind": "collection"
        }
    ]
}

Example 9

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

curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X PATCH -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181135401

Example Request Body

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

{
    "BankAccountName": "Test 123",
    "Intent": "Adhoc",
    "PartyId": 300100121773260
}

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": "Test 123",
    "AlternateAccountName": null,
    "BankBranchPartyIndicator": null,
    "BankName": null,
    "BankNumber": null,
    "BankBranchName": null,
    "BankBranchNumber": null,
    "BIC": null,
    "VendorId": null,
    "PersonId": null,
    "Intent": "Adhoc",
    "PartyId": 300100121773260,
    "links": [
        {
            "rel": "self",
            "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100181135401",
            "name": "externalBankAccounts",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "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