Get all deposit account data
get
/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccounts
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 accounts.
Finder Variables:- DepositAccountKey; integer; The unique identifier for the deposit accounts.
- simpleSearchFinder: Finds deposit accounts that match the primary key criteria specified.
Finder Variables:- value; string; Finds deposit accounts that match the primary key criteria specified.
- PrimaryKey: The unique identifier for the deposit accounts.
-
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; Indicates the user defined text for the deposit account.
- AccountStatus; string; Indicates the status of the deposit account.
- AccountType; string; Indicates the type of deposit account.
- AutopayFlag; boolean; Indicates whether fees can be paid out of the deposit account by the batch auto-pay process.
- AvailableBalance; number; Indicates the balance of funds in the deposit account that are available for use.
- CurrencyCode; string; Indicates the currency of the funds held in the deposit account.
- DepositAccountKey; integer; The unique system generated numeric identifier of the deposit account.
- DepositAccountName; string; The unique user-defined alphanumeric identifier of the deposit account.
- DepositAccountNumber; string; The unique agency-defined alphanumeric identifier of the deposit account.
- DepositAccountPuid; string; The unique alphanumeric identifier of the deposit account.
- FeeChargeOption; string; The code that identifies the intent of utilization of funds in the deposit account.
- InitialDeposit; number; Indicates the initial amount that should be deposited when the deposit account is created.
- LockAccount; string; Indicates whether the deposit account is locked for update.
- MigratedDataFlag; string; Indicates whether the deposit account was migrated from an external application or entered by a user.
- MinimumBalance; number; Indicates the minimum balance that should be maintained in the deposit account.
- MinimumDeposit; number; Indicates the minimum amount acceptable for deposits made after the initial deposit.
- Purpose; string; Agency-defined attribute that indicates what the deposit account is used for.
- VerificationStatus; string; Indicates the stage of verification 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 : publicSectorDepositAccounts
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 : publicSectorDepositAccounts-item-response
Type:
Show Source
object
-
AccountDescription: string
Title:
Account Description
Maximum Length:360
Indicates the user defined text for the deposit account. -
AccountStatus: string
Title:
Account Status
Maximum Length:30
Indicates the status of the deposit account. -
AccountType: string
Title:
Account Type
Maximum Length:30
Indicates the type of deposit account. -
AutopayFlag: boolean
Title:
Allow Auto-Pay
Maximum Length:1
Indicates whether fees can be paid out of the deposit account by the batch auto-pay process. -
AvailableBalance: number
Title:
Available Balance
Default Value:0
Indicates the balance of funds in the deposit account that are available for use. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:3
Indicates the currency of the funds held in the deposit account. -
DepositAccountActivities: array
Deposit Account Activities
Title:
Deposit Account Activities
The deposit account activities resource is used to list activities for a deposit account. -
DepositAccountFund: array
Deposit Account Funds
Title:
Deposit Account Funds
The deposit account funds resource is used to assign fund information to a deposit account. -
DepositAccountKey: integer
(int64)
Title:
Deposit Account Key
Read Only:true
The unique system generated numeric identifier of the deposit account. -
DepositAccountName: string
Title:
Name
Maximum Length:35
The unique user-defined alphanumeric identifier of the deposit account. -
DepositAccountNumber: string
Title:
Account Number
Maximum Length:30
The unique agency-defined alphanumeric identifier of the deposit account. -
DepositAccountOwner: array
Deposit Account Owners
Title:
Deposit Account Owners
The deposit account owners resource is used to assign owners to a deposit account. -
DepositAccountProject: array
Deposit Account Projects
Title:
Deposit Account Projects
The deposit account projects resource is used to assign projects to a deposit account. -
DepositAccountPuid: string
Title:
Public Unique ID
Maximum Length:480
The unique alphanumeric identifier of the deposit account. -
DepositAccountRecord: array
Deposit Account Records
Title:
Deposit Account Records
The deposit account records resource is used to assign transactions to a deposit account. -
DepositAccountUser: array
Deposit Account Users
Title:
Deposit Account Users
The deposit account users resource is used to assign users to a deposit account. -
DepositAccountUserInvite: array
Deposit Account User Invites
Title:
Deposit Account User Invites
The deposit account authorized user invites resource is used to get list of invited users. -
FeeChargeOption: string
Title:
Access Type
Maximum Length:30
The code that identifies the intent of utilization of funds in the deposit account. -
InitialDeposit: number
Title:
Initial Deposit
Default Value:0
Indicates the initial amount that should be deposited when the deposit account is created. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LockAccount: string
Title:
Account Lock
Maximum Length:1
Default Value:N
Indicates whether the deposit account is locked for update. -
MigratedDataFlag: string
Title:
Migrated Data
Read Only:true
Maximum Length:3
Default Value:N
Indicates whether the deposit account was migrated from an external application or entered by a user. -
MinimumBalance: number
Title:
Minimum Balance
Default Value:0
Indicates the minimum balance that should be maintained in the deposit account. -
MinimumDeposit: number
Title:
Minimum Deposit
Default Value:0
Indicates the minimum amount acceptable for deposits made after the initial deposit. -
Purpose: string
Title:
Purpose
Maximum Length:30
Agency-defined attribute that indicates what the deposit account is used for. -
VerificationStatus: string
Title:
Verification Status
Maximum Length:30
Indicates the stage of verification of the deposit account.
Nested Schema : Deposit Account Activities
Type:
array
Title:
Deposit Account Activities
The deposit account activities resource is used to list activities for a deposit account.
Show Source
Nested Schema : Deposit Account Funds
Type:
array
Title:
Deposit Account Funds
The deposit account funds resource is used to assign fund information to a deposit account.
Show Source
Nested Schema : Deposit Account Owners
Type:
array
Title:
Deposit Account Owners
The deposit account owners resource is used to assign owners to a deposit account.
Show Source
Nested Schema : Deposit Account Projects
Type:
array
Title:
Deposit Account Projects
The deposit account projects resource is used to assign projects to a deposit account.
Show Source
Nested Schema : Deposit Account Records
Type:
array
Title:
Deposit Account Records
The deposit account records resource is used to assign transactions to a deposit account.
Show Source
Nested Schema : Deposit Account Users
Type:
array
Title:
Deposit Account Users
The deposit account users resource is used to assign users to a deposit account.
Show Source
Nested Schema : Deposit Account User Invites
Type:
array
Title:
Deposit Account User Invites
The deposit account authorized user invites resource is used to get list of invited users.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorDepositAccounts-DepositAccountActivities-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
Indicates 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 value of currency for 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
Indicates 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
Indicates 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
Indicates the amount added to the deposit account. -
FarReceiptStatus: string
Maximum Length:
30
Indicates the receivable receipt status associated with the deposit account activity. -
FeeItemId: string
Title:
Fee Item ID
Maximum Length:30
Indicates 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
Indicates the applicant or contact party ID for each deposit account activity record. -
PaymentMethodCode: string
Maximum Length:
30
Indicates the payment method code associated with the deposit account activity. -
PaymentReferenceId: string
Title:
Payment Reference ID
Maximum Length:50
Indicates the payment reference ID associated with the deposit account activity. -
ProjectCode: string
Title:
Project
Maximum Length:30
Indicates 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
Indicates 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
Indicates the refund date associated with the deposit account activity. -
RefundMethodCode: string
Title:
Refund Method
Maximum Length:30
Indicates the refund method ID associated with the deposit account activity. -
RefundReasonCode: string
Title:
Refund Reason
Maximum Length:30
Indicates the refund reason code associated with the deposit account activity. -
RefundReferenceId: string
Title:
Refund Reference
Maximum Length:50
Indicates the refund reference ID 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
Indicates the date associated with the deposit account activity. -
TransferAmount: number
The amount transferred from bank account.
-
TransferCurrency: string
Maximum Length:
3
The currency of the amount transferred from 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 bank transfer amount. -
TransferId: integer
(int64)
The unique identifier of the bank account transfer.
-
WithdrawalAmount: number
Title:
Withdrawal Amount
Indicates 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.
Nested Schema : publicSectorDepositAccounts-DepositAccountFund-item-response
Type:
Show Source
object
-
AssetAccountCombination: integer
(int64)
The cash general ledger account code combination to be populated on the external transaction.
-
BusinessUnitName: string
Maximum Length:
360
The business unit associated to the bank account. -
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. -
DepositBankAccountName: string
Title:
Deposit Bank Account Name
Maximum Length:360
The name of the bank account in which the funds associated with the deposit account are held. -
DepositFundKey: integer
(int64)
Title:
Deposit Account Fund Key
The unique record key assigned to the deposit account fund record. -
LetterOfCreditAmount: number
Title:
Amount
The amount on the letter of credit. -
LetterOfCreditCurrency: string
Title:
Currency
Maximum Length:3
The currency of the amount on the letter of credit. -
LetterOfCreditExpirationDate: string
(date)
Title:
Expiration Date
The date on which the letter of credit expires. -
LetterOfCreditIssuerAddress: string
Title:
Issuer Address
Maximum Length:240
The address of the organization who issued the letter of credit. -
LetterOfCreditIssuerName: string
Title:
Issuer Name
Maximum Length:100
The name of the organization who issued the letter of credit. -
LetterOfCreditNumber: string
Title:
Number
Maximum Length:50
The number assigned to the letter of credit. -
LetterOfCreditRenewFlag: boolean
Title:
Renewable
Maximum Length:1
Indicates whether a letter of credit is renewable upon expiration. -
LetterOfCreditStartDate: string
(date)
Title:
Start Date
The date from which the letter of credit is effective. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OffsetAccountCombination: integer
(int64)
The offset general ledger account code combination to be populated on the external transaction.
-
SecurityType: string
Title:
Funding Type
Maximum Length:30
Indicates the type of funding provided for the deposit account. -
SecurityTypeDesc: string
Read Only:
true
Maximum Length:80
Describes the type of funding provided for the deposit account.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorDepositAccounts-DepositAccountOwner-item-response
Type:
Show Source
object
-
AccountOwnerPuid: string
Title:
Public Unique ID
Maximum Length:480
The unique alphanumeric identifier of the deposit account owner record. -
Address1: string
Title:
Address Line 1
Maximum Length:240
First address line of the owner address assigned to the deposit account. -
Address2: string
Title:
Address Line 2
Maximum Length:240
Second address line of the owner address assigned to the deposit account. -
Address3: string
Title:
Address Line 3
Maximum Length:240
Third address line of the owner address assigned to the deposit account. -
Address4: string
Title:
Address Line 4
Maximum Length:240
Fourth address line of the owner address assigned to the deposit account. -
City: string
Title:
City
Maximum Length:60
City of the owner address assigned to the deposit account. -
Comments: string
Title:
Comments
Maximum Length:480
Comments provided by user for change of ownership. -
Country: string
Title:
Country
Maximum Length:3
Country of the owner address assigned to the deposit account. -
County: string
Title:
County
Maximum Length:60
County of the owner address assigned to the deposit account. -
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 identifier of the deposit account record. -
DepositOwnershipKey: integer
(int64)
Title:
Ownership Key
The unique system-generated numeric identifier of an owner assigned to a deposit account. -
EmailAddress: string
Title:
Email Address
Maximum Length:320
Email identifier of the owner assigned to the deposit account. -
FirstName: string
Title:
First Name
Maximum Length:150
First name of the person assigned as owner to the deposit account. -
InactiveReasonCode: string
Title:
Inactive Reason Code
Maximum Length:30
Reason code provided by user for change of ownership. -
LastName: string
Title:
Last Name
Maximum Length:150
Last name of the person assigned as owner to the deposit account. -
LicenseHolderName: string
Title:
License Holder Name
Maximum Length:360
Name on the license provided to establish a deposit account. -
LicenseNumber: string
Title:
License Number
Maximum Length:30
The number of the license provided to establish a deposit account. -
LicenseType: string
Title:
License Type
Maximum Length:30
The type of the license provided to establish a deposit account. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MiddleName: string
Title:
Middle Name
Maximum Length:60
Middle name of the person assigned as owner to the deposit account. -
MigratedDataFlag: string
Title:
Migrated Data
Read Only:true
Maximum Length:3
Default Value:N
Identifies whether the ownership record is migrated or not. -
OwnerName: string
Title:
Name
Maximum Length:360
Name of the person or business assigned as owner to the deposit account. -
PartyId: integer
(int64)
Title:
Owner Party ID
Identifier of the party assigned as owner to the deposit account. -
PartyType: string
Title:
Account Owner Type
Maximum Length:30
Identifies the type of the party assigned as owner to the deposit account. -
PhoneAreaCode: string
Title:
Phone Area Code
Maximum Length:10
Phone area code of the owner assigned to the deposit account. -
PhoneCountryCode: string
Title:
Phone Country Code
Maximum Length:10
Phone country code of the owner assigned to the deposit account. -
PhoneExtention: string
Title:
Phone Extension
Maximum Length:20
Phone extension code of the owner assigned to the deposit account. -
PhoneNumber: string
Title:
Phone Number
Maximum Length:40
Phone number of the owner assigned to the deposit account. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
Postal code of the owner address assigned to the deposit account. -
PostalPlus4Code: string
Title:
Postal Plus4 Code
Maximum Length:10
Extended postal code of the owner address assigned to the deposit account. -
PrimaryOwner: boolean
Title:
Primary Owner
Maximum Length:1
Identifies whether the owner is the primary owner or not. -
Province: string
Title:
Province
Maximum Length:60
Province of the owner address assigned to the deposit account. -
State: string
Title:
State
Maximum Length:60
State of the owner address assigned to the deposit account. -
ValidFromDate: string
(date-time)
Title:
Valid From
Identifies the start date of the ownership record. -
ValidToDate: string
(date-time)
Title:
Valid To
Identifies the end date of the ownership record.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorDepositAccounts-DepositAccountProject-item-response
Type:
Show Source
object
-
AssignStatus: string
Title:
Assign Status
Maximum Length:1
Status of the project assignment. -
DepositAccountKey: integer
(int64)
Unique system-generated numeric identifier of the deposit account.
-
DepositAccountNumber: string
Maximum Length:
30
Unique agency-defined alphanumeric identifier of the deposit account. -
DepositProjectKey: integer
(int64)
Title:
Project Key
Unique system-generated numeric identifier of a project assigned to a deposit account. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PrimaryAccountFlag: string
Maximum Length:
1
Default Value:N
Indicates whether the deposit account is the primary account for the specified project. -
ProjectCode: string
Title:
Project Code
Maximum Length:30
Unique agency-defined alphanumeric identifier of a project assigned to a deposit account.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorDepositAccounts-DepositAccountRecord-item-response
Type:
Show Source
object
-
AllRecords: string
Title:
All Records
Maximum Length:1
The value that identifies whether the transaction association applies to all records. -
AllRecordsDesc: string
Read Only:
true
Maximum Length:80
Describes the value that identifies whether the transaction association applies to all records. -
AssignStatus: string
Title:
Assign Status
Maximum Length:1
The status of the transaction's assignment to the deposit account. -
AssignStatusDesc: string
Read Only:
true
Maximum Length:80
Describes the status of the transaction's assignment to the deposit account. -
Classification: string
Title:
Classification
Maximum Length:3
The reason code provided by the user for change of ownership. -
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. -
DepositRecordKey: integer
(int64)
Title:
Transaction Key
The unique system-generated numeric identifier of a transaction assigned to the deposit account. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PrimaryAccount: string
Title:
Primary Account
Maximum Length:1
Indicates whether the deposit account is the primary account for the transaction. -
PrimaryAccountDesc: string
Read Only:
true
Maximum Length:80
Describes whether the deposit account is the primary account for the transaction. The default value is Y. -
RecordType: string
Read Only:
true
Maximum Length:100
The unique record type assigned to the deposit account. -
RecordTypeId: string
Title:
Transaction Type ID
Maximum Length:50
The unique record type identifier assigned to the deposit account. -
SourceRecordId: string
Title:
Transaction ID
Maximum Length:50
The user-friendly record identifier assigned to the deposit account. -
SourceRecordKey: integer
(int64)
Title:
Source Record Key
The key of the source record assigned to the deposit account.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorDepositAccounts-DepositAccountUser-item-response
Type:
Show Source
object
-
AssignStatus: string
Title:
Status
Maximum Length:1
Indicates the status of the authorized user's assignment. -
DepositAccountAccess: array
Deposit Account Access
Title:
Deposit Account Access
The deposit account access resource is used to grant access to users for a deposit account. -
DepositAccountKey: integer
(int64)
Unique system-generated numeric identifier of the deposit account.
-
DepositAccountNumber: string
Maximum Length:
30
Unique agency-defined alphanumeric identifier of the deposit account. -
DepositApplicantKey: integer
(int64)
Unique system-generated numeric identifier of the deposit account authorized user.
-
EmailAddress: string
Title:
Email Address
Maximum Length:320
Indicates the authorized user's email address. -
InvitedBy: string
Maximum Length:
30
Default Value:ORA_NONE
Indicates whether a person was invited by an owner or agency staff. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OwnerFlag: string
Maximum Length:
1
Default Value:N
Indicates whether authorized user is owner of the deposit account. -
PartyId: integer
(int64)
Title:
Authorized User Party ID
Indicates the authorized user's party ID. -
UserName: string
Title:
Name
Maximum Length:360
The name of the user eligible to access a deposit account record.
Nested Schema : Deposit Account Access
Type:
array
Title:
Deposit Account Access
The deposit account access resource is used to grant access to users for a deposit account.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorDepositAccounts-DepositAccountUser-DepositAccountAccess-item-response
Type:
Show Source
object
-
AccessCode: string
Title:
Access Code
Maximum Length:30
Indicates an action the authorized user can perform for the deposit account. -
DepositAccountKey: integer
(int64)
Unique system generated numeric identifier of the deposit account.
-
DepositAccountNumber: string
Maximum Length:
30
Unique agency-defined alphanumeric identifier of the deposit account. -
DepositApplicantKey: integer
(int64)
Unique system-generated numeric identifier of the deposit account authorized user.
-
DepositPermissionKey: integer
(int64)
Unique system-generated numeric identifier of the deposit account permission.
-
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Indicates whether an action is enabled for the authorized user for the deposit account. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartyId: integer
(int64)
The party identifier of the authorized user.
-
UserName: string
Title:
Name
Maximum Length:360
The name of the user eligible to perform an action for a deposit account record.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorDepositAccounts-DepositAccountUserInvite-item-response
Type:
Show Source
object
-
DepositAccountKey: integer
(int64)
The unique system-generated numeric identifier of the deposit account.
-
DepositAccountNumber: string
Title:
Account Number
Maximum Length:30
The unique agency-defined alphanumeric identifier of the deposit account. -
EmailAddress: string
Title:
Email Address
Maximum Length:320
The email address of the user invited to be an authorized user. -
InvitedBy: string
Title:
Invitation Source
Maximum Length:20
Indicates whether an authorized user was invited by an owner or agency staff. -
InviteKey: integer
(int64)
Title:
Invite Key
The unique system-generated numeric identifier of the deposit account user invite. -
InviteStatus: string
Title:
Invite Status
Maximum Length:30
The status of the invite sent to authorize users. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
UserAccess: string
Title:
User Access
Maximum Length:1000
The user access provided to the invited user. -
UserName: string
Title:
User Name
Maximum Length:360
The name of the user invited to be an authorized user.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source