Jump to

• Request
• Response
• Examples

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "BankPartyId":{
            "title":"Bank ID",
            "type":"integer",
            "description":"The unique identifier of the bank.",
            "format":"int64",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":18
            }
        },
        "BankName":{
            "title":"Bank Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the bank.",
            "nullable":false,
            "x-hints":{
                "controlType":"edit"
            }
        },
        "BankNumber":{
            "title":"Bank Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of the bank.",
            "nullable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":2000,
            "type":"string",
            "description":"The description of the bank.",
            "nullable":true
        },
        "CountryName":{
            "maxLength":80,
            "type":"string",
            "description":"The name of the country where the bank is located.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TaxRegistrationNumber":{
            "title":"Tax Registration Number",
            "maxLength":50,
            "type":"string",
            "description":"The tax registration number of the bank.",
            "nullable":true,
            "x-hints":{
                "controlType":"edit"
            }
        },
        "BankPartyNumber":{
            "title":"Bank Party Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique party identification number of the bank record.",
            "nullable":false,
            "default":"1"
        },
        "BankNameAlt":{
            "title":"Alternate Bank Name",
            "maxLength":360,
            "type":"string",
            "description":"The alternate name of the bank.",
            "nullable":true
        },
        "TaxpayerIdNumber":{
            "title":"Taxpayer ID",
            "maxLength":20,
            "type":"string",
            "description":"The taxpayer identifier number of the bank assigned by a tax authority.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : cashBanks-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the bank record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BankPartyId":{
            "title":"Bank ID",
            "type":"integer",
            "description":"The unique identifier of the bank.",
            "format":"int64",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BankName":{
            "title":"Bank Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the bank.",
            "nullable":false,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the bank record was created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the bank record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":2000,
            "type":"string",
            "description":"The description of the bank.",
            "nullable":true,
            "x-queryable":true
        },
        "CountryName":{
            "maxLength":80,
            "type":"string",
            "description":"The name of the country where the bank is located.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BankNameAlt":{
            "title":"Alternate Bank Name",
            "maxLength":360,
            "type":"string",
            "description":"The alternate name of the bank.",
            "nullable":true,
            "x-queryable":true
        },
        "TaxpayerIdNumber":{
            "title":"Taxpayer ID",
            "maxLength":20,
            "type":"string",
            "description":"The taxpayer identifier number of the bank assigned by a tax authority.",
            "nullable":true,
            "x-queryable":true
        },
        "BankNumber":{
            "title":"Bank Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of the bank.",
            "nullable":true,
            "x-queryable":true
        },
        "TaxRegistrationNumber":{
            "title":"Tax Registration Number",
            "maxLength":50,
            "type":"string",
            "description":"The tax registration number of the bank.",
            "nullable":true,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "BankPartyNumber":{
            "title":"Bank Party Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique party identification number of the bank record.",
            "nullable":false,
            "default":"1",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the bank record was last updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The session login associated with the user who last updated the bank record.",
            "nullable":true,
            "readOnly":true,
            "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."
        }
    }
}

Back to Top

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

Back to Top