Get all deposit accounts and their associations
get
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAcccountAssociations
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: A unique identifying key for each deposit account.
Finder Variables:- AuthorizedUserId; integer; The unique identifier for the party assigned to the deposit account.
- DepositAccountKey; integer; Finds the deposit account that matches the primary key criteria specified.
- ProjectCode; string; The unique identifier for the project code assigned to the deposit account.
- RecordTypeId; string; The unique identifier for the source application record type assigned to the deposit account.
- SourceRecordKey; integer; The unique identifier for the record key assigned to the deposit account.
- PrimaryKey: A unique identifying key for each deposit account.
-
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 description on the deposit account record.
- AccountStatus; string; The status of the deposit account. Valid values are Active, Inactive, and Closed.
- AccountType; string; The identifier assigned to classify the deposit account.
- AllRecords; string; The value that identifies whether the transaction association applies to all records.
- AuthorizedUserId; integer; The party identifier of the authorized user.
- AuthorizedUserName; string; The name of the user eligible to access a deposit account record.
- AutopayFlag; string; Indicates whether fees can be paid out of the deposit account by the batch autopay process.
- AvailableBalance; number; The value of the balance available in the deposit account.
- Classification; string; The identifier assigned to classify a source record.
- CurrencyCode; string; The currency of deposit account funds.
- DepositAccountKey; integer; The unique identifier of the deposit account record.
- DepositAccountName; string; The unique name of the deposit account that is assigned by the user.
- DepositAccountNumber; string; The unique identifier of the deposit account that is generated using a numbering schema.
- FeeChargeOption; string; The value that identifies the intent of utilization of funds in the deposit account.
- LockAccount; string; Indicates whether the deposit account is locked for update.
- MinimumBalance; number; The minimum balance that must be maintained in the deposit account.
- OwnerName; string; The name of the primary owner on a deposit account owner record.
- 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 set up.
- RecordTypeId; string; The unique identifier of the source record type.
- SourceRecordId; string; The unique identifier of the source record that is generated using a numbering schema.
- SourceRecordKey; integer; The unique identifier of the source record.
- VerificationStatus; string; The status of 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 : publicSectorDepositAcccountAssociations
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 : publicSectorDepositAcccountAssociations-item-response
Type:
Show Source
object
-
AccountDescription: string
Read Only:
true
Maximum Length:360
The description on the deposit account record. -
AccountStatus: string
Read Only:
true
Maximum Length:30
The status of the deposit account. Valid values are Active, Inactive, and Closed. -
AccountType: string
Read Only:
true
Maximum Length:30
The identifier assigned to classify the deposit account. -
AllRecords: string
Read Only:
true
Maximum Length:1
The value that identifies whether the transaction association applies to all records. -
AuthorizedUserId: integer
(int64)
Read Only:
true
The party identifier of the authorized user. -
AuthorizedUserName: string
Read Only:
true
Maximum Length:360
The name of the user eligible to access a deposit account record. -
AutopayFlag: string
Read Only:
true
Maximum Length:1
Indicates whether fees can be paid out of the deposit account by the batch autopay process. -
AvailableBalance: number
Read Only:
true
The value of the balance available in the deposit account. -
Classification: string
Read Only:
true
Maximum Length:3
The identifier assigned to classify a source record. -
CurrencyCode: string
Read Only:
true
Maximum Length:3
The currency of deposit account funds. -
DepositAccountKey: integer
Read Only:
true
The unique identifier of the deposit account record. -
DepositAccountName: string
Read Only:
true
Maximum Length:35
The unique name of the deposit account that is assigned by the user. -
DepositAccountNumber: string
Read Only:
true
Maximum Length:30
The unique identifier of the deposit account that is generated using a numbering schema. -
FeeChargeOption: string
Read Only:
true
Maximum Length:30
The value that identifies the intent of utilization of funds in the deposit account. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LockAccount: string
Read Only:
true
Maximum Length:1
Indicates whether the deposit account is locked for update. -
MinimumBalance: number
Read Only:
true
The minimum balance that must be maintained in the deposit account. -
OwnerName: string
Read Only:
true
Maximum Length:360
The name of the primary owner on a deposit account owner record. -
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 set up. -
RecordTypeId: string
Read Only:
true
Maximum Length:50
The unique identifier of the source record type. -
SourceRecordId: string
Read Only:
true
Maximum Length:50
The unique identifier of the source record that is generated using a numbering schema. -
SourceRecordKey: integer
(int64)
Read Only:
true
The unique identifier of the source record. -
VerificationStatus: string
Read Only:
true
Maximum Length:30
The status of 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.