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
Root Schema : schema
Type:
Show Source
object
-
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.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : publicSectorDepositAccountRecords-item-response
Type:
Show Source
object
-
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.
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.