Jump to

• Request
• Response

Get a deposit account activity data

get

/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountActivities/{DepositActivityKey}

Request

Path Parameters

• DepositActivityKey(required): integer(int64)
  The unique system-generated numeric identifier of an activity recorded for the deposit account.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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