Update an account owner for an external bank account
/fscmRestApi/resources/11.13.18.05/externalBankAccounts/{BankAccountId}/child/accountOwners/{AccountOwnerId}
Request
-
AccountOwnerId(required): integer(int64)
Application-generated identifier of the external bank account owner.
-
BankAccountId(required): integer(int64)
Identifier of the external bank account.
-
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.
- application/json
object-
AddJointAccountOwner: string
Maximum Length:
255Indicates 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:
30The approval status of the bank account. A list of valid values are defined in the lookup ORA_IBY_OWNER_APPROVAL_STATUS -
BankAccountInternalVerificationStatus: string
Maximum Length:
255Indicates the status of the bank internal verification. -
EndDate: string
(date)
Date when the external bank account owner becomes inactive.
-
FinalVerificationStatusCode: string
Maximum Length:
255Code representing the final verification status. It is derived from a combination of the bank account verification status and owner verification status. A list of valid values is defined in the lookup type ORA_IBY_OWNER_VERIF_STATUS. -
FinalVerificationStatusDetails: string
Maximum Length:
255Indicates how the final verification status was determined. This value is a concatenation of the bank account verification and owner verification statuses. The possible statuses are defined in the lookup types ORA_IBY_INTRNL_BA_VERIF_RESP and ORA_IBY_INTRNL_OWNER_VERIF_RES. -
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.
-
OwnerInternalVerificationStatus: string
Maximum Length:
255Indicates the status of the owner internal verification. -
PersonId: integer
Person identifier when the account owner is an employee.
-
PrimaryOwnerIndicator: string
Title:
PrimaryMaximum Length:1Indicates whether an external bank account owner is primary. -
StartDate: string
(date)
Title:
Start DateDate when the external bank account owner becomes active. -
VerificationStatus: string
Maximum Length:
30The verification status of the bank account owner. A list of valid values are defined in the lookup ORA_IBY_OWNER_VERIF_STATUS.
Response
- application/json
Default Response
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
object-
AccountOwnerId: integer
(int64)
Application-generated identifier of the external bank account owner.
-
AccountOwnerPartyIdentifier: integer
(int64)
Title:
Account OwnerParty identifier of the external bank account owner. -
AccountOwnerPartyName: string
Title:
NameMaximum Length:360Party name of the external bank account owner. -
AccountOwnerPartyNumber: string
Title:
Registry IDMaximum Length:30Party number of the external bank account owner. -
AddJointAccountOwner: string
Maximum Length:
255Indicates 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:
30The approval status of the bank account. A list of valid values are defined in the lookup ORA_IBY_OWNER_APPROVAL_STATUS -
BankAccountInternalVerificationStatus: string
Maximum Length:
255Indicates the status of the bank internal verification. -
EndDate: string
(date)
Date when the external bank account owner becomes inactive.
-
FinalVerificationStatusCode: string
Maximum Length:
255Code representing the final verification status. It is derived from a combination of the bank account verification status and owner verification status. A list of valid values is defined in the lookup type ORA_IBY_OWNER_VERIF_STATUS. -
FinalVerificationStatusDetails: string
Maximum Length:
255Indicates how the final verification status was determined. This value is a concatenation of the bank account verification and owner verification statuses. The possible statuses are defined in the lookup types ORA_IBY_INTRNL_BA_VERIF_RESP and ORA_IBY_INTRNL_OWNER_VERIF_RES. -
FinalVerificationStatusMeaning: string
Read Only:
trueMaximum Length:255Indicates the status of the final verification. A list of valid values is defined in the lookup type ORA_IBY_OWNER_VERIF_STATUS. -
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:
LinksThe link relations associated with the resource instance. -
OriginApplicationIdentifier: number
The originating application identifier that was used to create the bank account owner.
-
OwnerInternalVerificationStatus: string
Maximum Length:
255Indicates the status of the owner internal verification. -
PersonId: integer
Person identifier when the account owner is an employee.
-
PrimaryOwnerIndicator: string
Title:
PrimaryMaximum Length:1Indicates whether an external bank account owner is primary. -
StartDate: string
(date)
Title:
Start DateDate when the external bank account owner becomes active. -
VerificationStatus: string
Maximum Length:
30The verification status of the bank account owner. A list of valid values are defined in the lookup ORA_IBY_OWNER_VERIF_STATUS.
arrayLinksobject-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
Example 1
The following example shows how to update an account owner for 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/300100179720551/child/accountOwners/300100179720563
Example Request Body
The following example shows the contents of the request body in JSON format:
{
"Intent": "Supplier",
"PrimaryOwnerIndicator": "Y"
}Example Response Body
The following example shows the contents of the response body in JSON format:
{
"AccountOwnerPartyIdentifier": 299480,
"AccountOwnerPartyNumber": "50709",
"AccountOwnerPartyName": "SSC",
"PrimaryOwnerIndicator": "Y",
"StartDate": "2019-06-13",
"EndDate": "4712-12-31",
"AccountOwnerId": 300100179720563,
"Intent": "Supplier",
"PersonId": null,
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100179720551/child/accountOwners/300100179720563",
"name": "accountOwners",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
}
},
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100179720551/child/accountOwners/300100179720563",
"name": "accountOwners",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100179720551",
"name": "externalBankAccounts",
"kind": "item"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100179720551/child/accountOwners/300100179720563/lov/PartyVVOVA",
"name": "PartyVVOVA",
"kind": "collection"
}
]
}Example 2
The following example shows how to update an account owner for 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/300100181126859/child/accountOwners/300100181126860
Example Request Body
The following example shows the contents of the request body in JSON format:
{
"EndDate": "2022-12-31",
"Intent": "Supplier"
}
Example Response Body
The following example shows the contents of the response body in JSON format:
{
"AccountOwnerPartyIdentifier": 333937,
"AccountOwnerPartyNumber": "139161",
"AccountOwnerPartyName": "JACK N JILL INC",
"PrimaryOwnerIndicator": "Y",
"StartDate": "2019-10-22",
"EndDate": "2022-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": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
}
},
{
"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"
}
]
}
Example 3
The following example shows how to update an account owner for 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/child/accountOwners/300100181126924
Example Request Body
The following example shows the contents of the request body in JSON format:
{
"EndDate": "2023-12-31",
"Intent": "Customer"
}
Example Response Body
The following example shows the contents of the response body in JSON format:
{
"AccountOwnerPartyIdentifier": 1005,
"AccountOwnerPartyNumber": "1005",
"AccountOwnerPartyName": "AT&T Universal Card",
"PrimaryOwnerIndicator": "Y",
"StartDate": "2019-10-22",
"EndDate": "2023-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": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
}
},
{
"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"
}
]
}
Example 4
The following example shows how to update an account owner for an employee bank account used in Payroll 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/300100177406393/childs/accountOwners/300100177498432
Example Request Body
The following example shows the contents of the request body in JSON format:
{
"PrimaryOwnerIndicator": "Y",
"PersonId": 300100038082897,
"Intent": "Person"
}
Example Response Body
The following example shows the contents of the response body in JSON format:
{
"AccountOwnerPartyIdentifier": 300100038056894,
"AccountOwnerPartyNumber": "CDRM_75839",
"AccountOwnerPartyName": "ZHRX_VS BV_SECUSER",
"PrimaryOwnerIndicator": "Y",
"StartDate": "2019-04-02",
"EndDate": "4712-12-31",
"AccountOwnerId": 300100177498432,
"Intent": "Person",
"PersonId": 300100038082897,
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100177498431/child/accountOwners/300100177498432",
"name": "accountOwners",
"kind": "item",
"properties": {
"changeIndicator":
"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100177498431/child/accountOwners/300100177498432",
"name": "accountOwners",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100177498431",
"name": "externalBankAccounts",
"kind": "item"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100177498431/child/accountOwners/300100177498432/lov/PartyVVOVA",
"name": "PartyVVOVA",
"kind": "collection"
}
]
}
Example 5
The following example shows how to update an account owner for an employee bank account used in Expenses 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/300100181126921/child/accountOwners/300100181126922
Example Request Body
The following example shows the contents of the request body in JSON format:
{
"EndDate": "2024-12-31",
"Intent": "Employee"
}
Example Response Body
The following example shows the contents of the response body in JSON format:
{
"AccountOwnerPartyIdentifier": 300100148480036,
"AccountOwnerPartyNumber": "CDRM_733616",
"AccountOwnerPartyName": "CVBUYER01_DK",
"PrimaryOwnerIndicator": "Y",
"StartDate": "2019-10-22",
"EndDate": "2024-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": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
}
},
{
"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"
}
]
}
Example 6
The following example shows how to update an account owner for an ad-hoc 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/300100181135401/child/accountOwners/300100181135402
Example Request Body
The following example shows the contents of the request body in JSON format:
{
"EndDate": "2025-12-31",
"Intent": "Adhoc"
}
Example Response Body
The following example shows the contents of the response body in JSON format:
{
"AccountOwnerPartyIdentifier": 300100121773260,
"AccountOwnerPartyNumber": "CDRM_681211",
"AccountOwnerPartyName": "CE_ADHOC_Payee",
"PrimaryOwnerIndicator": "Y",
"StartDate": "2019-10-22",
"EndDate": "2025-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": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
}
},
{
"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"
}
]
}