Jump to

• Request
• Response

Update a received deposit communication data

patch

/fscmRestApi/resources/11.13.18.05/publicSectorDepositReceivedCommunications/{publicSectorDepositReceivedCommunicationsUniqID}

Request

Path Parameters

• publicSectorDepositReceivedCommunicationsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- DepositActivityKey and TransactionKey ---for the Deposit Received Communications resource and used to uniquely identify an instance of Deposit Received Communications. The client should not generate the hash key value. Instead, the client should query on the Deposit Received Communications collection resource with a filter on the primary key values in order to navigate to a specific instance of Deposit Received Communications.
  
  For example: publicSectorDepositReceivedCommunications?q=DepositActivityKey=<value1>;TransactionKey=<value2>

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 ()

The following table describes the body parameters in the request for this task.

Root Schema : schema

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Back to Top

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.

Body ()

Root Schema : publicSectorDepositReceivedCommunications-item-response

Type: object

Show Source

• Classification: string
  Title: Classification

  Read Only: true

  Maximum Length: 3

  The identifier assigned to classify a transaction associated to the deposit account.
• CurrencyCode: string
  Title: Currency Code

  Read Only: true

  Maximum Length: 3

  The currency of the funds held in the deposit account.
• DepositAccountNumber: string
  Title: Account Number

  Read Only: true

  Maximum Length: 30

  The unique agency-defined alphanumeric identifier of the deposit account.
• DepositActivityKey: integer
  Read Only: true

  The unique system-generated numeric identifier of an activity recorded for the deposit account.
• DepositAmount: number
  Title: Deposit Amount

  Read Only: true

  The amount deposited into the deposit account.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PaymentMethodCode: string
  Title: Payment Method

  Read Only: true

  Maximum Length: 30

  The payment method code associated with the payment.
• PaymentReferenceId: string
  Title: Payment Reference ID

  Read Only: true

  Maximum Length: 50

  The unique reference value created by the payment module to track the payment.
• ProcessId: number
  Title: Process ID

  Read Only: true

  The unique identifier of the workflow process ID of the transaction associated to the deposit account.
• ProjectCode: string
  Title: Project Code

  Read Only: true

  Maximum Length: 30

  The unique identifier of the project associated to the deposit account.
• RecordTypeId: string
  Title: Transaction Type ID

  Read Only: true

  Maximum Length: 30

  The record type identifier of the transaction associated to the deposit account.
• Subclassification: string
  Title: Subclassification

  Read Only: true

  Maximum Length: 10

  The identifier assigned to subclassify a transaction associated to the deposit account.
• TransactionDate: string (date)
  Title: Transaction Date

  Read Only: true

  The date associated with the deposit account activity.
• TransactionId: string
  Title: Transaction ID

  Read Only: true

  Maximum Length: 50

  The unique source application generated identifier of the transaction associated to the deposit account.
• TransactionKey: integer (int64)
  Title: Transaction Key

  Read Only: true

  The unique source application generated numeric key of the transaction associated to deposit account.

{
    "type":"object",
    "properties":{
        "Subclassification":{
            "title":"Subclassification",
            "maxLength":10,
            "type":"string",
            "description":"The identifier assigned to subclassify a transaction associated to the deposit account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DepositActivityKey":{
            "type":"integer",
            "description":"The unique system-generated numeric identifier of an activity recorded for the deposit account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DepositAmount":{
            "title":"Deposit Amount",
            "type":"number",
            "description":"The amount deposited into the deposit account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionKey":{
            "title":"Transaction Key",
            "type":"integer",
            "description":"The unique source application generated numeric key of the transaction associated to deposit account.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PaymentMethodCode":{
            "title":"Payment Method",
            "maxLength":30,
            "type":"string",
            "description":"The payment method code associated with the payment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionId":{
            "title":"Transaction ID",
            "maxLength":50,
            "type":"string",
            "description":"The unique source application generated identifier of the transaction associated to the deposit account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":3,
            "type":"string",
            "description":"The currency of the funds held in the deposit account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentReferenceId":{
            "title":"Payment Reference ID",
            "maxLength":50,
            "type":"string",
            "description":"The unique reference value created by the payment module to track the payment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DepositAccountNumber":{
            "title":"Account Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique agency-defined alphanumeric identifier of the deposit account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Classification":{
            "title":"Classification",
            "maxLength":3,
            "type":"string",
            "description":"The identifier assigned to classify a transaction associated to the deposit account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordTypeId":{
            "title":"Transaction Type ID",
            "maxLength":30,
            "type":"string",
            "description":"The record type identifier of the transaction associated to the deposit account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProjectCode":{
            "title":"Project Code",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the project associated to the deposit account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessId":{
            "title":"Process ID",
            "type":"number",
            "description":"The unique identifier of the workflow process ID of the transaction associated to the deposit account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionDate":{
            "title":"Transaction Date",
            "type":"string",
            "description":"The date associated with the deposit account activity.",
            "format":"date",
            "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