Jump to

• Request
• Response

Create a deposit account record data

patch

/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountRecords/{DepositRecordKey}

Request

Path Parameters

• DepositRecordKey(required): integer(int64)
  The unique system-generated numeric identifier of a transaction assigned to the deposit 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AllRecords: string
  Title: All Records

  Maximum Length: 1

  The value that identifies whether the transaction association applies to all records.
• AssignStatus: string
  Title: Assign Status

  Maximum Length: 1

  The status of the transaction's assignment to the deposit account.
• Classification: string
  Title: Classification

  Maximum Length: 3

  The reason code provided by the user for change of ownership.
• PrimaryAccount: string
  Title: Primary Account

  Maximum Length: 1

  Indicates whether the deposit account is the primary account for the transaction.
• RecordTypeId: string
  Title: Transaction Type ID

  Maximum Length: 50

  The unique record type identifier assigned to the deposit account.
• SourceRecordId: string
  Title: Transaction ID

  Maximum Length: 50

  The user-friendly record identifier assigned to the deposit account.

{
    "type":"object",
    "properties":{
        "AllRecords":{
            "title":"All Records",
            "maxLength":"1",
            "type":"string",
            "description":"The value that identifies whether the transaction association applies to all records.",
            "nullable":false
        },
        "Classification":{
            "title":"Classification",
            "maxLength":"3",
            "type":"string",
            "description":"The reason code provided by the user for change of ownership.",
            "nullable":true
        },
        "PrimaryAccount":{
            "title":"Primary Account",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the deposit account is the primary account for the transaction.",
            "nullable":false
        },
        "RecordTypeId":{
            "title":"Transaction Type ID",
            "maxLength":"50",
            "type":"string",
            "description":"The unique record type identifier assigned to the deposit account.",
            "nullable":true
        },
        "SourceRecordId":{
            "title":"Transaction ID",
            "maxLength":"50",
            "type":"string",
            "description":"The user-friendly record identifier assigned to the deposit account.",
            "nullable":true
        },
        "AssignStatus":{
            "title":"Assign Status",
            "maxLength":"1",
            "type":"string",
            "description":"The status of the transaction's assignment to the deposit account.",
            "nullable":false
        }
    }
}

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 : publicSectorDepositAccountRecords-item-response

Type: object

Show Source

• AllRecords: string
  Title: All Records

  Maximum Length: 1

  The value that identifies whether the transaction association applies to all records.
• AllRecordsDesc: string
  Read Only: true

  Maximum Length: 80

  Describes the value that identifies whether the transaction association applies to all records.
• AssignStatus: string
  Title: Assign Status

  Maximum Length: 1

  The status of the transaction's assignment to the deposit account.
• AssignStatusDesc: string
  Read Only: true

  Maximum Length: 80

  Describes the status of the transaction's assignment to the deposit account.
• Classification: string
  Title: Classification

  Maximum Length: 3

  The reason code provided by the user for change of ownership.
• DepositAccountKey: integer (int64)
  The unique system generated numeric identifier of the deposit account.
• DepositAccountNumber: string
  Maximum Length: 30

  The unique agency-defined alphanumeric identifier of the deposit account.
• DepositRecordKey: integer (int64)
  Title: Transaction Key

  The unique system-generated numeric identifier of a transaction assigned to the deposit account.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PrimaryAccount: string
  Title: Primary Account

  Maximum Length: 1

  Indicates whether the deposit account is the primary account for the transaction.
• PrimaryAccountDesc: string
  Read Only: true

  Maximum Length: 80

  Describes whether the deposit account is the primary account for the transaction. The default value is Y.
• RecordType: string
  Read Only: true

  Maximum Length: 100

  The unique record type assigned to the deposit account.
• RecordTypeId: string
  Title: Transaction Type ID

  Maximum Length: 50

  The unique record type identifier assigned to the deposit account.
• SourceRecordId: string
  Title: Transaction ID

  Maximum Length: 50

  The user-friendly record identifier assigned to the deposit account.
• SourceRecordKey: integer (int64)
  Title: Source Record Key

  The key of the source record assigned to the deposit account.

{
    "type":"object",
    "properties":{
        "AllRecords":{
            "title":"All Records",
            "maxLength":"1",
            "type":"string",
            "description":"The value that identifies whether the transaction association applies to all records.",
            "nullable":false,
            "x-queryable":true
        },
        "DepositRecordKey":{
            "title":"Transaction Key",
            "type":"integer",
            "description":"The unique system-generated numeric identifier of a transaction assigned to the deposit account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PrimaryAccount":{
            "title":"Primary Account",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the deposit account is the primary account for the transaction.",
            "nullable":false,
            "x-queryable":true
        },
        "PrimaryAccountDesc":{
            "maxLength":"80",
            "type":"string",
            "description":"Describes whether the deposit account is the primary account for the transaction. The default value is Y.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DepositAccountKey":{
            "type":"integer",
            "description":"The unique system generated numeric identifier of the deposit account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AllRecordsDesc":{
            "maxLength":"80",
            "type":"string",
            "description":"Describes the value that identifies whether the transaction association applies to all records.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceRecordKey":{
            "title":"Source Record Key",
            "type":"integer",
            "description":"The key of the source record assigned to the deposit account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RecordType":{
            "maxLength":"100",
            "type":"string",
            "description":"The unique record type assigned to the deposit account.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DepositAccountNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique agency-defined alphanumeric identifier of the deposit account.",
            "nullable":true,
            "x-queryable":true
        },
        "Classification":{
            "title":"Classification",
            "maxLength":"3",
            "type":"string",
            "description":"The reason code provided by the user for change of ownership.",
            "nullable":true,
            "x-queryable":true
        },
        "AssignStatusDesc":{
            "maxLength":"80",
            "type":"string",
            "description":"Describes the status of the transaction's assignment to the deposit account.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordTypeId":{
            "title":"Transaction Type ID",
            "maxLength":"50",
            "type":"string",
            "description":"The unique record type identifier assigned to the deposit account.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SourceRecordId":{
            "title":"Transaction ID",
            "maxLength":"50",
            "type":"string",
            "description":"The user-friendly record identifier assigned to the deposit account.",
            "nullable":true,
            "x-queryable":true
        },
        "AssignStatus":{
            "title":"Assign Status",
            "maxLength":"1",
            "type":"string",
            "description":"The status of the transaction's assignment to the deposit account.",
            "nullable":false,
            "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