Create a bank
post
/fscmRestApi/resources/11.13.18.05/cashBanks
Request
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
-
BankName: string
Title:
Bank Name
Maximum Length:360
The name of the bank. -
BankNameAlt: string
Title:
Alternate Bank Name
Maximum Length:360
The alternate name of the bank. -
BankNumber: string
Title:
Bank Code
Maximum Length:30
The code of the bank. -
BankPartyId: integer
(int64)
Title:
Bank ID
Default Value:1
The unique identifier of the bank. -
BankPartyNumber: string
Title:
Bank Party Number
Maximum Length:30
Default Value:1
The unique party identification number of the bank record. -
CountryName: string
Maximum Length:
80
The name of the country where the bank is located. -
Description: string
Title:
Description
Maximum Length:2000
The description of the bank. -
TaxpayerIdNumber: string
Title:
Taxpayer ID
Maximum Length:20
The taxpayer identifier number of the bank assigned by a tax authority. -
TaxRegistrationNumber: string
Title:
Tax Registration Number
Maximum Length:50
The tax registration number of the bank.
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 : cashBanks-item-response
Type:
Show Source
object
-
BankName: string
Title:
Bank Name
Maximum Length:360
The name of the bank. -
BankNameAlt: string
Title:
Alternate Bank Name
Maximum Length:360
The alternate name of the bank. -
BankNumber: string
Title:
Bank Code
Maximum Length:30
The code of the bank. -
BankPartyId: integer
(int64)
Title:
Bank ID
Default Value:1
The unique identifier of the bank. -
BankPartyNumber: string
Title:
Bank Party Number
Maximum Length:30
Default Value:1
The unique party identification number of the bank record. -
CountryName: string
Maximum Length:
80
The name of the country where the bank is located. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the bank record. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the bank record was created. -
Description: string
Title:
Description
Maximum Length:2000
The description of the bank. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the bank record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the bank record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The session login associated with the user who last updated the bank record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TaxpayerIdNumber: string
Title:
Taxpayer ID
Maximum Length:20
The taxpayer identifier number of the bank assigned by a tax authority. -
TaxRegistrationNumber: string
Title:
Tax Registration Number
Maximum Length:50
The tax registration number of the bank.
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 a bank 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/cashBanks
Example Request Payload
The following example shows the contents of the request body in JSON format:
{ "CountryName": "United States", "BankName": "REST_CE_Bank_01", "BankNumber": 87698001, "BankNameAlt": "REST_CE_Bank_01_Alt", "Description": "REST CE Bank 01 Description", "TaxpayerIdNumber": "11121" }
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "BankPartyId" : 300100188229410, "BankName" : "REST_CE_Bank_01", "BankNameAlt" : "REST_CE_Bank_01_Alt", "BankNumber" : "87698001", "Description" : "REST CE Bank 01 Description", "TaxpayerIdNumber" : "11121", "TaxRegistrationNumber" : null, "CreatedBy" : "CASH_MANAGER", "CreationDate" : "2019-01-15T22:10:20+00:00", "LastUpdateDate" : "2019-01-15T22:10:20.841+00:00", "LastUpdateLogin" : "7F32B30B1EFA1CF8E0538C96F40AAFB6", "LastUpdatedBy" : "CASH_MANAGER", "BankPartyNumber" : "CDRM_768527", "CountryName" : "United States", "links" : [ { "rel" : "self", "href" : "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashBanks/300100188229410", "name" : "cashBanks", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel" : "canonical", "href" : "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashBanks/300100188229410", "name" : "cashBanks", "kind" : "item" }, ... ] }