Get all deposit accounts and transactions that the user is authorized to pay
get
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAcccountAuthorizedToPayTransactions
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:- CartRows: Finds transactions for a cart user that matches the specified criteria.
Finder Variables:- cartRecords; string.
- PrimaryKey: Finds a record using the primary key criteria.
Finder Variables:- AttributeCategory; string; The unique identifier associated to the transaction.
- Classification; string; The record classification.
- DepositAccountKey; integer; The unique identifier for the deposit account.
- LnpRecordKey; integer; The unique identifier for the source transaction.
- CartRows: Finds transactions for a cart user that matches the specified criteria.
-
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:- AccountDescription; string; The purpose for which the deposit account is set up.
- AccountType; string; The type of the deposit account.
- AgencyId; integer; The unique identifier for a public sector agency.
- AttributeCategory; string; Indicates the record ID associated with the transaction.
- AuthorizedId; integer; The authorized user's party ID.
- AuthorizedUser; string; The authorized user's name.
- AvailableBalance; number; The available balance in the deposit account.
- Classification; string; The source application's record type.
- CurrencyCode; string; The currency code of the deposit account funds.
- DepositAccountKey; integer; The unique identifying key for each deposit account.
- DepositAccountName; string; The unique name for each deposit account.
- DepositAccountNumber; string; The unique identifier for each deposit account that is generated using a numbering schema.
- FeeChargeOption; string; The options to utilize the money deposited in a deposit account.
- LnpRecordId; string; The unique identifier for a source application record.
- LnpRecordKey; integer; The record key associated with the transaction.
- MinimumBalance; number; The minimum balance that should be held in the deposit account.
- OwnerName; string; The name of the deposit account owner.
- PartyId; number; The party ID associated with the applicant.
- ProjectCode; string; The project code assigned to a deposit account.
- ProjectPrimaryAccount; string; Indicates whether the deposit account is the primary account for the specified project.
- Purpose; string; The purpose for which the deposit account is created.
-
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 : publicSectorDepositAcccountAuthorizedToPayTransactions
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 : publicSectorDepositAcccountAuthorizedToPayTransactions-item-response
Type:
Show Source
object
-
AccountDescription: string
Read Only:
true
Maximum Length:360
The purpose for which the deposit account is set up. -
AccountType: string
Read Only:
true
Maximum Length:30
The type of the deposit account. -
AgencyId: integer
(int32)
Read Only:
true
The unique identifier for a public sector agency. -
AttributeCategory: string
Read Only:
true
Maximum Length:30
Indicates the record ID associated with the transaction. -
AuthorizedId: integer
(int64)
Read Only:
true
The authorized user's party ID. -
AuthorizedUser: string
Read Only:
true
Maximum Length:360
The authorized user's name. -
AvailableBalance: number
Read Only:
true
The available balance in the deposit account. -
Classification: string
Read Only:
true
Maximum Length:3
The source application's record type. -
CurrencyCode: string
Read Only:
true
Maximum Length:3
The currency code of the deposit account funds. -
DepositAccountKey: integer
Read Only:
true
The unique identifying key for each deposit account. -
DepositAccountName: string
Read Only:
true
Maximum Length:35
The unique name for each deposit account. -
DepositAccountNumber: string
Read Only:
true
Maximum Length:30
The unique identifier for each deposit account that is generated using a numbering schema. -
FeeChargeOption: string
Read Only:
true
Maximum Length:30
The options to utilize the money deposited in a deposit account. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpRecordId: string
Read Only:
true
Maximum Length:50
The unique identifier for a source application record. -
LnpRecordKey: integer
(int64)
Read Only:
true
The record key associated with the transaction. -
MinimumBalance: number
Read Only:
true
The minimum balance that should be held in the deposit account. -
OwnerName: string
Read Only:
true
Maximum Length:360
The name of the deposit account owner. -
PartyId: number
Read Only:
true
The party ID associated with the applicant. -
ProjectCode: string
Read Only:
true
Maximum Length:30
The project code assigned to a deposit account. -
ProjectPrimaryAccount: string
Read Only:
true
Maximum Length:1
Indicates whether the deposit account is the primary account for the specified project. -
Purpose: string
Read Only:
true
Maximum Length:30
The purpose for which the deposit account is created.
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.