Jump to

• Request
• Response
• Examples

Create a bank statement transaction creation rule for a bank account

post

/fscmRestApi/resources/11.13.18.05/cashBankAccounts/{BankAccountId}/child/bankAccountTransactionCreationRules

Request

Path Parameters

• BankAccountId(required): integer(int64)
  The unique identifier of the 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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AccountTrxCreationRuleId: integer (int64)
  The unique identifier of the bank statement transaction creation rule.
• RuleName: string
  Title: Rule

  Maximum Length: 50

  The bank statement transaction creation rule name associated to the bank account.
• SequenceNumber: integer (int64)
  Title: Sequence

  The option that indicates the sequence number in which the bank statement transaction creation rule will be processed during the external cash transaction creation.

{
    "type":"object",
    "properties":{
        "SequenceNumber":{
            "title":"Sequence",
            "type":"integer",
            "description":"The option that indicates the sequence number in which the bank statement transaction creation rule will be processed during the external cash transaction creation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RuleName":{
            "title":"Rule",
            "maxLength":50,
            "type":"string",
            "description":"The bank statement transaction creation rule name associated to the bank account.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AccountTrxCreationRuleId":{
            "type":"integer",
            "description":"The unique identifier of the bank statement transaction creation rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"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 : cashBankAccounts-bankAccountTransactionCreationRules-item-response

Type: object

Show Source

• AccountTrxCreationRuleId: integer (int64)
  The unique identifier of the bank statement transaction creation rule.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the record was created.
• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 255

  The description of the bank statement transaction creation rule associated to the bank account.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The session login associated to the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RuleName: string
  Title: Rule

  Maximum Length: 50

  The bank statement transaction creation rule name associated to the bank account.
• SequenceNumber: integer (int64)
  Title: Sequence

  The option that indicates the sequence number in which the bank statement transaction creation rule will be processed during the external cash transaction creation.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the bank statement transaction creation rule associated to the bank account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SequenceNumber":{
            "title":"Sequence",
            "type":"integer",
            "description":"The option that indicates the sequence number in which the bank statement transaction creation rule will be processed during the external cash transaction creation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RuleName":{
            "title":"Rule",
            "maxLength":50,
            "type":"string",
            "description":"The bank statement transaction creation rule name associated to the bank account.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The session login associated to the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountTrxCreationRuleId":{
            "type":"integer",
            "description":"The unique identifier of the bank statement transaction creation rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"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 account transaction creation rule for a 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://fuscdrmsmc79-fa-ext.us2.oracle.com:443/fscmRestApi/resources/11.13.0.0/cashBankAccounts/300100196526495/child/bankAccountTransactionCreationRules

Example Request Payload

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

{
"RuleName": "100-ADD-1"
}

Example Response Body

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

{

  "AccountTrxCreationRuleId": 300100196596724,
  "CreatedBy": "CASH_MANAGER",
  "CreationDate": "2020-04-21T02:52:51.018+00:00",
  "LastUpdateDate": "2020-04-21T02:52:51.178+00:00",
  "LastUpdateLogin": "A38FEA9E660574ADE053D713F50A815E",
  "LastUpdatedBy": "CASH_MANAGER",
  "SequenceNumber": 3,
  "RuleName": "100-ADD-1",
  "Description": "100-ADD-1",
  "links": [
    {
      "rel": "self",
      "href": "https://fuscdrmsmc79-fa-ext.us2.oracle.com:443/fscmRestApi/resources/11.13.0.0/cashBankAccounts/300100196526495/child/bankAccountTransactionCreationRules/300100196596724",
      "name": "bankAccountTransactionCreationRules",
      "kind": "item",
      "properties": {
        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
      }
    },
    {
      "rel": "canonical",
      "href": "https://fuscdrmsmc79-fa-ext.us2.oracle.com:443/fscmRestApi/resources/11.13.0.0/cashBankAccounts/300100196526495/child/bankAccountTransactionCreationRules/300100196596724",
      "name": "bankAccountTransactionCreationRules",
      "kind": "item"
    },
    {
      "rel": "parent",
      "href": "https://fuscdrmsmc79-fa-ext.us2.oracle.com:443/fscmRestApi/resources/11.13.0.0/cashBankAccounts/300100196526495",
      "name": "cashBankAccounts",
      "kind": "item"
    },
    {
      "rel": "lov",
      "href": "https://fuscdrmsmc79-fa-ext.us2.oracle.com:443/fscmRestApi/resources/11.13.0.0/cashBankAccounts/300100196526495/child/bankAccountTransactionCreationRules/300100196596724/lov/BankStmtTrxCreationRulePVOVA",
      "name": "BankStmtTrxCreationRulePVOVA",
      "kind": "collection"
    }
  ]
}

Back to Top