Jump to

• Request
• Response

Create a set of deposit account activity data

post

/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountActivities

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:
  When set to true, the server will perform an Upsert operation instead of a Create. In an Upsert operation the server attempts to find an existing resource that matches the payload. If found, the server updates the existing resource instead of creating a new one. If not found, or when set to false (the default), a Create is performed.

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

• AccountActvtyPuid: string
  Title: Public Unique ID

  Maximum Length: 480

  The unique alphanumeric identifier of the deposit account activity.
• ActivityStatus: string
  Title: Status

  Maximum Length: 30

  The status of the deposit account activity.
• AgencyId: integer (int32)
  The unique identifier of the agency associated with the deposit account.
• Classification: string
  Title: Classification

  Maximum Length: 3

  The identifier assigned to classify a source record.
• CurrencyCode: string
  Title: Currency Code

  Maximum Length: 3

  The currency for the deposit account activity record.
• 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.
• DepositActivityKey: integer (int64)
  Title: Activity Key

  The unique system-generated numeric identifier of an activity recorded for the deposit account.
• DepositActivityOrigin: string
  Title: Activity Origin

  Maximum Length: 30

  The origin of the deposit account activity.
• DepositActivityReference: string
  Title: Payment Reference

  Maximum Length: 50

  The unique system-generated alphanumeric identifier of an activity recorded for the deposit account.
• DepositActivityType: string
  Title: Activity

  Maximum Length: 30

  The type of activity recorded for the deposit account.
• DepositAmount: number
  Title: Deposit Amount

  The amount added to the deposit account.
• FarReceiptStatus: string
  Maximum Length: 30

  The receivable receipt status associated with the deposit account activity.
• FeeItemId: string
  Title: Fee Item ID

  Maximum Length: 30

  The user-friendly fee item identifier associated with the deposit account activity.
• FeeRecordKey: integer (int64)
  Title: Fee Record Key

  The unique key of the fee record associated with the deposit account activity record.
• PartyId: integer (int64)
  Title: Party ID

  The applicant or contact party identifier for each deposit account activity record.
• PaymentMethodCode: string
  Maximum Length: 30

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

  Maximum Length: 50

  The payment reference identifier associated with the deposit account activity.
• ProjectCode: string
  Title: Project

  Maximum Length: 30

  The project associated with the deposit account activity.
• ReceiptLineNumber: integer (int32)
  The line number assigned to each receipt on the cash drawer payment record.
• ReceiptNumber: string
  Maximum Length: 50

  The unique identifier assigned to each receipt on the cash drawer payment record.
• RecordId: string
  Title: Transaction ID

  Maximum Length: 50

  The user-friendly record identifier associated with the deposit account activity.
• RecordTypeId: string
  Title: Transaction Type ID

  Maximum Length: 50

  The unique record type identifier associated with the deposit account activity.
• RefundDate: string (date)
  Title: Refund Date

  The refund date associated with the deposit account activity.
• RefundMethodCode: string
  Title: Refund Method

  Maximum Length: 30

  The refund method identifier associated with the deposit account activity.
• RefundReasonCode: string
  Title: Refund Reason

  Maximum Length: 30

  The refund reason code associated with the deposit account activity.
• RefundReferenceId: string
  Title: Refund Reference

  Maximum Length: 50

  The refund reference identifier associated with the deposit account activity.
• SourceRecordKey: integer (int64)
  Title: Source Record Key

  The unique key of the source record associated with the deposit account activity record.
• TransactionDate: string (date)
  Title: Transaction Date

  The date associated with the deposit account activity.
• WithdrawalAmount: number
  Title: Withdrawal Amount

  The amount subtracted from the deposit account.

{
    "type":"object",
    "properties":{
        "ActivityStatus":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the deposit account activity.",
            "nullable":false
        },
        "RefundMethodCode":{
            "title":"Refund Method",
            "maxLength":30,
            "type":"string",
            "description":"The refund method identifier associated with the deposit account activity.",
            "nullable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency associated with the deposit account.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":8
            }
        },
        "DepositActivityReference":{
            "title":"Payment Reference",
            "maxLength":50,
            "type":"string",
            "description":"The unique system-generated alphanumeric identifier of an activity recorded for the deposit account.",
            "nullable":false
        },
        "DepositAccountKey":{
            "type":"integer",
            "description":"The unique system-generated numeric identifier of the deposit account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "FarReceiptStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The receivable receipt status associated with the deposit account activity.",
            "nullable":false
        },
        "ReceiptLineNumber":{
            "type":"integer",
            "description":"The line number assigned to each receipt on the cash drawer payment record.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":3
            }
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":3,
            "type":"string",
            "description":"The currency for the deposit account activity record.",
            "nullable":false
        },
        "PaymentReferenceId":{
            "title":"Payment Reference ID",
            "maxLength":50,
            "type":"string",
            "description":"The payment reference identifier associated with the deposit account activity.",
            "nullable":true
        },
        "FeeItemId":{
            "title":"Fee Item ID",
            "maxLength":30,
            "type":"string",
            "description":"The user-friendly fee item identifier associated with the deposit account activity.",
            "nullable":true
        },
        "Classification":{
            "title":"Classification",
            "maxLength":3,
            "type":"string",
            "description":"The identifier assigned to classify a source record.",
            "nullable":true
        },
        "RecordTypeId":{
            "title":"Transaction Type ID",
            "maxLength":50,
            "type":"string",
            "description":"The unique record type identifier associated with the deposit account activity.",
            "nullable":true
        },
        "RefundReasonCode":{
            "title":"Refund Reason",
            "maxLength":30,
            "type":"string",
            "description":"The refund reason code associated with the deposit account activity.",
            "nullable":true
        },
        "DepositActivityOrigin":{
            "title":"Activity Origin",
            "maxLength":30,
            "type":"string",
            "description":"The origin of the deposit account activity.",
            "nullable":false
        },
        "ProjectCode":{
            "title":"Project",
            "maxLength":30,
            "type":"string",
            "description":"The project associated with the deposit account activity.",
            "nullable":true
        },
        "RecordId":{
            "title":"Transaction ID",
            "maxLength":50,
            "type":"string",
            "description":"The user-friendly record identifier associated with the deposit account activity.",
            "nullable":true
        },
        "TransactionDate":{
            "title":"Transaction Date",
            "type":"string",
            "description":"The date associated with the deposit account activity.",
            "format":"date",
            "nullable":false
        },
        "ReceiptNumber":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier assigned to each receipt on the cash drawer payment record.",
            "nullable":true
        },
        "DepositActivityKey":{
            "title":"Activity Key",
            "type":"integer",
            "description":"The unique system-generated numeric identifier of an activity recorded for the deposit account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "DepositAmount":{
            "title":"Deposit Amount",
            "type":"number",
            "description":"The amount added to the deposit account.",
            "nullable":false
        },
        "RefundDate":{
            "title":"Refund Date",
            "type":"string",
            "description":"The refund date associated with the deposit account activity.",
            "format":"date",
            "nullable":true
        },
        "RefundReferenceId":{
            "title":"Refund Reference",
            "maxLength":50,
            "type":"string",
            "description":"The refund reference identifier associated with the deposit account activity.",
            "nullable":true
        },
        "PaymentMethodCode":{
            "maxLength":30,
            "type":"string",
            "description":"The payment method code associated with the deposit account activity.",
            "nullable":true
        },
        "DepositActivityType":{
            "title":"Activity",
            "maxLength":30,
            "type":"string",
            "description":"The type of activity recorded for the deposit account.",
            "nullable":false
        },
        "WithdrawalAmount":{
            "title":"Withdrawal Amount",
            "type":"number",
            "description":"The amount subtracted from the deposit account.",
            "nullable":false
        },
        "SourceRecordKey":{
            "title":"Source Record Key",
            "type":"integer",
            "description":"The unique key of the source record associated with the deposit account activity record.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The applicant or contact party identifier for each deposit account activity record.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "DepositAccountNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The unique agency-defined alphanumeric identifier of the deposit account.",
            "nullable":true
        },
        "FeeRecordKey":{
            "title":"Fee Record Key",
            "type":"integer",
            "description":"The unique key of the fee record associated with the deposit account activity record.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AccountActvtyPuid":{
            "title":"Public Unique ID",
            "maxLength":480,
            "type":"string",
            "description":"The unique alphanumeric identifier of the deposit account activity.",
            "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(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 : publicSectorDepositAccountActivities-item-response

Type: object

Show Source

• AccountActvtyPuid: string
  Title: Public Unique ID

  Maximum Length: 480

  The unique alphanumeric identifier of the deposit account activity.
• ActivityStatus: string
  Title: Status

  Maximum Length: 30

  The status of the deposit account activity.
• ActivityStatusDesc: string
  Read Only: true

  Maximum Length: 80

  The descriptive value of the status for the deposit account activity record.
• AgencyId: integer (int32)
  The unique identifier of the agency associated with the deposit account.
• Classification: string
  Title: Classification

  Maximum Length: 3

  The identifier assigned to classify a source record.
• CurrencyCode: string
  Title: Currency Code

  Maximum Length: 3

  The currency for the deposit account activity record.
• 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.
• DepositActivityKey: integer (int64)
  Title: Activity Key

  The unique system-generated numeric identifier of an activity recorded for the deposit account.
• DepositActivityOrigin: string
  Title: Activity Origin

  Maximum Length: 30

  The origin of the deposit account activity.
• DepositActivityReference: string
  Title: Payment Reference

  Maximum Length: 50

  The unique system-generated alphanumeric identifier of an activity recorded for the deposit account.
• DepositActivityType: string
  Title: Activity

  Maximum Length: 30

  The type of activity recorded for the deposit account.
• DepositActivityTypeDesc: string
  Read Only: true

  Maximum Length: 80

  The descriptive value of the account type for the deposit account activity record.
• DepositAmount: number
  Title: Deposit Amount

  The amount added to the deposit account.
• FarReceiptStatus: string
  Maximum Length: 30

  The receivable receipt status associated with the deposit account activity.
• FeeItemId: string
  Title: Fee Item ID

  Maximum Length: 30

  The user-friendly fee item identifier associated with the deposit account activity.
• FeeRecordKey: integer (int64)
  Title: Fee Record Key

  The unique key of the fee record associated with the deposit account activity record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PartyId: integer (int64)
  Title: Party ID

  The applicant or contact party identifier for each deposit account activity record.
• PaymentMethodCode: string
  Maximum Length: 30

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

  Maximum Length: 50

  The payment reference identifier associated with the deposit account activity.
• ProjectCode: string
  Title: Project

  Maximum Length: 30

  The project associated with the deposit account activity.
• ReceiptLineNumber: integer (int32)
  The line number assigned to each receipt on the cash drawer payment record.
• ReceiptNumber: string
  Maximum Length: 50

  The unique identifier assigned to each receipt on the cash drawer payment record.
• RecordId: string
  Title: Transaction ID

  Maximum Length: 50

  The user-friendly record identifier associated with the deposit account activity.
• RecordTypeId: string
  Title: Transaction Type ID

  Maximum Length: 50

  The unique record type identifier associated with the deposit account activity.
• RefundDate: string (date)
  Title: Refund Date

  The refund date associated with the deposit account activity.
• RefundMethodCode: string
  Title: Refund Method

  Maximum Length: 30

  The refund method identifier associated with the deposit account activity.
• RefundReasonCode: string
  Title: Refund Reason

  Maximum Length: 30

  The refund reason code associated with the deposit account activity.
• RefundReferenceId: string
  Title: Refund Reference

  Maximum Length: 50

  The refund reference identifier associated with the deposit account activity.
• SourceRecordKey: integer (int64)
  Title: Source Record Key

  The unique key of the source record associated with the deposit account activity record.
• TransactionDate: string (date)
  Title: Transaction Date

  The date associated with the deposit account activity.
• WithdrawalAmount: number
  Title: Withdrawal Amount

  The amount subtracted from the deposit account.

{
    "type":"object",
    "properties":{
        "ActivityStatus":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the deposit account activity.",
            "nullable":false,
            "x-queryable":true
        },
        "RefundMethodCode":{
            "title":"Refund Method",
            "maxLength":30,
            "type":"string",
            "description":"The refund method identifier associated with the deposit account activity.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency associated with the deposit account.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "ActivityStatusDesc":{
            "maxLength":80,
            "type":"string",
            "description":"The descriptive value of the status for the deposit account activity record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DepositActivityReference":{
            "title":"Payment Reference",
            "maxLength":50,
            "type":"string",
            "description":"The unique system-generated alphanumeric identifier of an activity recorded for the deposit account.",
            "nullable":false,
            "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
        },
        "FarReceiptStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The receivable receipt status associated with the deposit account activity.",
            "nullable":false,
            "x-queryable":true
        },
        "ReceiptLineNumber":{
            "type":"integer",
            "description":"The line number assigned to each receipt on the cash drawer payment record.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":3,
            "type":"string",
            "description":"The currency for the deposit account activity record.",
            "nullable":false,
            "x-queryable":true
        },
        "PaymentReferenceId":{
            "title":"Payment Reference ID",
            "maxLength":50,
            "type":"string",
            "description":"The payment reference identifier associated with the deposit account activity.",
            "nullable":true,
            "x-queryable":true
        },
        "FeeItemId":{
            "title":"Fee Item ID",
            "maxLength":30,
            "type":"string",
            "description":"The user-friendly fee item identifier associated with the deposit account activity.",
            "nullable":true,
            "x-queryable":true
        },
        "Classification":{
            "title":"Classification",
            "maxLength":3,
            "type":"string",
            "description":"The identifier assigned to classify a source record.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordTypeId":{
            "title":"Transaction Type ID",
            "maxLength":50,
            "type":"string",
            "description":"The unique record type identifier associated with the deposit account activity.",
            "nullable":true,
            "x-queryable":true
        },
        "RefundReasonCode":{
            "title":"Refund Reason",
            "maxLength":30,
            "type":"string",
            "description":"The refund reason code associated with the deposit account activity.",
            "nullable":true,
            "x-queryable":true
        },
        "DepositActivityOrigin":{
            "title":"Activity Origin",
            "maxLength":30,
            "type":"string",
            "description":"The origin of the deposit account activity.",
            "nullable":false,
            "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",
            "maxLength":30,
            "type":"string",
            "description":"The project associated with the deposit account activity.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordId":{
            "title":"Transaction ID",
            "maxLength":50,
            "type":"string",
            "description":"The user-friendly record identifier associated with the deposit account activity.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionDate":{
            "title":"Transaction Date",
            "type":"string",
            "description":"The date associated with the deposit account activity.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "ReceiptNumber":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier assigned to each receipt on the cash drawer payment record.",
            "nullable":true,
            "x-queryable":true
        },
        "DepositActivityKey":{
            "title":"Activity Key",
            "type":"integer",
            "description":"The unique system-generated numeric identifier of an activity recorded for the deposit account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DepositAmount":{
            "title":"Deposit Amount",
            "type":"number",
            "description":"The amount added to the deposit account.",
            "nullable":false,
            "x-queryable":true
        },
        "DepositActivityTypeDesc":{
            "maxLength":80,
            "type":"string",
            "description":"The descriptive value of the account type for the deposit account activity record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RefundDate":{
            "title":"Refund Date",
            "type":"string",
            "description":"The refund date associated with the deposit account activity.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "RefundReferenceId":{
            "title":"Refund Reference",
            "maxLength":50,
            "type":"string",
            "description":"The refund reference identifier associated with the deposit account activity.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentMethodCode":{
            "maxLength":30,
            "type":"string",
            "description":"The payment method code associated with the deposit account activity.",
            "nullable":true,
            "x-queryable":true
        },
        "DepositActivityType":{
            "title":"Activity",
            "maxLength":30,
            "type":"string",
            "description":"The type of activity recorded for the deposit account.",
            "nullable":false,
            "x-queryable":true
        },
        "WithdrawalAmount":{
            "title":"Withdrawal Amount",
            "type":"number",
            "description":"The amount subtracted from the deposit account.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceRecordKey":{
            "title":"Source Record Key",
            "type":"integer",
            "description":"The unique key of the source record associated with the deposit account activity record.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The applicant or contact party identifier for each deposit account activity record.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DepositAccountNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The unique agency-defined alphanumeric identifier of the deposit account.",
            "nullable":true,
            "x-queryable":true
        },
        "FeeRecordKey":{
            "title":"Fee Record Key",
            "type":"integer",
            "description":"The unique key of the fee record associated with the deposit account activity record.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AccountActvtyPuid":{
            "title":"Public Unique ID",
            "maxLength":480,
            "type":"string",
            "description":"The unique alphanumeric identifier of the deposit account activity.",
            "nullable":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