Create an account owner for an external bank account
post
/fscmRestApi/resources/11.13.18.05/externalBankAccounts/{BankAccountId}/child/accountOwners
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.
-
Upsert-Mode:
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
Root Schema : schema
Type:
Show Source
object
-
AccountOwnerId: integer
(int64)
Application-generated identifier of the external bank account owner.
-
AccountOwnerPartyIdentifier: integer
(int64)
Title:
Account Owner
Party identifier of the external bank account owner. -
AccountOwnerPartyName: string
Title:
Name
Maximum Length:360
Party name of the external bank account owner. -
AccountOwnerPartyNumber: string
Title:
Registry ID
Maximum Length:30
Party number of the external bank account owner. -
AddJointAccountOwner: string
Maximum Length:
255
Indicates whether the joint owner should be created if the bank account is already existing. Valid values are Y and N. For internal use only. -
EndDate: string
(date)
Date when the external bank account owner becomes inactive.
-
Intent: string
Purpose of the external bank account. The value is based on the payment function of the external payee or the external payer of the account owner. The following are the expected values: PAYABLES_DISB - Supplier, EMPLOYEE_EXP - Person, EMPLOYEE_EXP - Employee, AR_CUSTOMER_REFUNDS - Refund, CUSTOMER_PAYMENT - Customer, ONETIME_PAYMENT - Onetime, and ADHOC_PAYMENT - Adhoc.
-
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.
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.
Root Schema : externalBankAccounts-accountOwners-item-response
Type:
Show Source
object
-
AccountOwnerId: integer
(int64)
Application-generated identifier of the external bank account owner.
-
AccountOwnerPartyIdentifier: integer
(int64)
Title:
Account Owner
Party identifier of the external bank account owner. -
AccountOwnerPartyName: string
Title:
Name
Maximum Length:360
Party name of the external bank account owner. -
AccountOwnerPartyNumber: string
Title:
Registry ID
Maximum Length:30
Party number of the external bank account owner. -
AddJointAccountOwner: string
Maximum Length:
255
Indicates whether the joint owner should be created if the bank account is already existing. Valid values are Y and N. For internal use only. -
EndDate: string
(date)
Date when the external bank account owner becomes inactive.
-
Intent: string
Purpose of the external bank account. The value is based on the payment function of the external payee or the external payer of the account owner. The following are the expected values: PAYABLES_DISB - Supplier, EMPLOYEE_EXP - Person, EMPLOYEE_EXP - Employee, AR_CUSTOMER_REFUNDS - Refund, CUSTOMER_PAYMENT - Customer, ONETIME_PAYMENT - Onetime, and ADHOC_PAYMENT - Adhoc.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PersonId: integer
Person identifier when the account owner is an employee.
-
PrimaryOwnerIndicator: string
Title:
Primary
Maximum Length:1
Indicates whether an external bank account owner is primary. -
StartDate: string
(date)
Title:
Start Date
Date when the external bank account owner becomes active.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
The following example shows how to create an account owner for 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/300100179720551/child/accountOwners
Example Request Payload
The following example shows the contents of the request body in JSON format:
{ "AccountOwnerPartyIdentifier": 1001, "Intent" : "Supplier" }
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "AccountOwnerPartyIdentifier": 1001, "AccountOwnerPartyNumber": "1001", "AccountOwnerPartyName": "A T & T SOLUTIONS INC", "PrimaryOwnerIndicator": "Y", "StartDate": "2019-06-13", "EndDate": "4712-12-31", "AccountOwnerId": 300100179720554, "Intent": "Supplier", "PersonId": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100179720551/child/accountOwners/300100179720554", "name": "accountOwners", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/externalBankAccounts/300100179720551/child/accountOwners/300100179720554", "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/300100179720554/lov/PartyVVOVA", "name": "PartyVVOVA", "kind": "collection" } ] }