Get all deposit account activity data
get
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountActivities
Request
Query Parameters
-
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 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: The unique identifier for the deposit account activities.
Finder Variables:- DepositActivityKey; integer; The unique identifier for the deposit account activities.
- simpleSearchFinder: Finds deposit account activities that match the primary key criteria specified.
Finder Variables:- value; string; Finds deposit account activities that match the primary key criteria specified.
- PrimaryKey: The unique identifier for the deposit account activities.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AccountActvtyPuid; string; The unique alphanumeric identifier of the deposit account activity.
- ActivityStatus; string; The status of the deposit account activity.
- ActivityStatusDesc; string; The descriptive value of the status for the deposit account activity record.
- AgencyId; integer; The unique identifier of the agency associated with the deposit account.
- BankAccountTransferNum; integer; The unique number sequence assigned to the bank account transfer.
- Classification; string; The identifier assigned to classify a source record.
- CurrencyCode; string; The currency for the deposit account activity record.
- DepositAccountKey; integer; The unique system-generated numeric identifier of the deposit account.
- DepositAccountNumber; string; The unique agency-defined alphanumeric identifier of the deposit account.
- DepositAccountPuid; string; The unique alphanumeric public identifier of the deposit account.
- DepositActivityKey; integer; The unique system-generated numeric identifier of an activity recorded for the deposit account.
- DepositActivityOrigin; string; The origin of the deposit account activity.
- DepositActivityReference; string; The unique system-generated alphanumeric identifier of an activity recorded for the deposit account.
- DepositActivityType; string; The type of activity recorded for the deposit account.
- DepositActivityTypeDesc; string; The descriptive value of the account type for the deposit account activity record.
- DepositAmount; number; The amount added to the deposit account.
- FarReceiptStatus; string; The receivable receipt status associated with the deposit account activity.
- FeeItemId; string; The user-friendly fee item identifier associated with the deposit account activity.
- FeeRecordKey; integer; The unique key of the fee record associated with the deposit account activity record.
- MigratedDataFlag; string; A flag to indicate that the data was migrated from another system.
- PartyId; integer; The applicant or contact party identifier for each deposit account activity record.
- PaymentMethodCode; string; The payment method code associated with the deposit account activity.
- PaymentReferenceId; string; The payment reference identifier associated with the deposit account activity.
- ProjectCode; string; The project associated with the deposit account activity.
- ReceiptLineNumber; integer; The line number assigned to each receipt on the cash drawer payment record.
- ReceiptNumber; string; The unique identifier assigned to each receipt on the cash drawer payment record.
- RecordId; string; The user-friendly record identifier associated with the deposit account activity.
- RecordTypeId; string; The unique record type identifier associated with the deposit account activity.
- RefundDate; string; The refund date associated with the deposit account activity.
- RefundMethodCode; string; The refund method identifier associated with the deposit account activity.
- RefundReasonCode; string; The refund reason code associated with the deposit account activity.
- RefundReferenceId; string; The refund reference identifier associated with the deposit account activity.
- SourceRecordKey; integer; The unique key of the source record associated with the deposit account activity record.
- TransactionDate; string; The date associated with the deposit account activity.
- TransferAmount; number; The amount transferred from the bank account.
- TransferCurrency; string; The currency of the amount transferred from the bank account.
- TransferDate; string; The date when a bank transfer was submitted.
- TransferFlag; string; Indicates whether an activity should be included for calculating the bank transfer amount.
- TransferId; integer; The unique identifier of the bank account transfer.
- WithdrawalAmount; number; The amount subtracted from the deposit account.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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 TopResponse
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 : publicSectorDepositAccountActivities
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorDepositAccountActivities-item-response
Type:
Show Source
object
-
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.
-
BankAccountTransferNum: integer
(int64)
The unique number sequence assigned to the bank account transfer.
-
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. -
DepositAccountPuid: string
Maximum Length:
480
The unique alphanumeric public 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. -
MigratedDataFlag: string
Maximum Length:
3
Default Value:N
A flag to indicate that the data was migrated from another system. -
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. -
TransferAmount: number
The amount transferred from the bank account.
-
TransferCurrency: string
Maximum Length:
3
The currency of the amount transferred from the bank account. -
TransferDate: string
(date)
The date when a bank transfer was submitted.
-
TransferFlag: string
Maximum Length:
1
Indicates whether an activity should be included for calculating the bank transfer amount. -
TransferId: integer
(int64)
The unique identifier of the bank account transfer.
-
WithdrawalAmount: number
Title:
Withdrawal Amount
The amount subtracted from 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.