Get a deposit account data

get

/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccounts/{DepositAccountKey}

Request

Path Parameters
Query Parameters
  • 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>
  • 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).
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : publicSectorDepositAccounts-item-response
Type: object
Show Source
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 : publicSectorDepositAccounts-DepositAccountActivities-item-response
Type: object
Show Source
Nested Schema : publicSectorDepositAccounts-DepositAccountFund-item-response
Type: object
Show Source
Nested Schema : publicSectorDepositAccounts-DepositAccountOwner-item-response
Type: object
Show Source
  • Title: Public Unique ID
    Maximum Length: 480
    The unique alphanumeric identifier of the deposit account owner record.
  • Title: Address Line 1
    Maximum Length: 240
    First address line of the owner address assigned to the deposit account.
  • Title: Address Line 2
    Maximum Length: 240
    Second address line of the owner address assigned to the deposit account.
  • Title: Address Line 3
    Maximum Length: 240
    Third address line of the owner address assigned to the deposit account.
  • Title: Address Line 4
    Maximum Length: 240
    Fourth address line of the owner address assigned to the deposit account.
  • Title: City
    Maximum Length: 60
    City of the owner address assigned to the deposit account.
  • Title: Comments
    Maximum Length: 480
    Comments provided by user for change of ownership.
  • Title: Country
    Maximum Length: 3
    Country of the owner address assigned to the deposit account.
  • Title: County
    Maximum Length: 60
    County of the owner address assigned to the deposit account.
  • The unique system generated numeric identifier of the deposit account.
  • Maximum Length: 30
    The unique agency-defined alphanumeric identifier of the deposit account.
  • Maximum Length: 480
    The unique alphanumeric identifier of the deposit account record.
  • Title: Ownership Key
    The unique system-generated numeric identifier of an owner assigned to a deposit account.
  • Title: Email Address
    Maximum Length: 320
    Email identifier of the owner assigned to the deposit account.
  • Title: First Name
    Maximum Length: 150
    First name of the person assigned as owner to the deposit account.
  • Title: Inactive Reason Code
    Maximum Length: 30
    Reason code provided by user for change of ownership.
  • Title: Last Name
    Maximum Length: 150
    Last name of the person assigned as owner to the deposit account.
  • Title: License Holder Name
    Maximum Length: 360
    Name on the license provided to establish a deposit account.
  • Title: License Number
    Maximum Length: 30
    The number of the license provided to establish a deposit account.
  • Title: License Type
    Maximum Length: 30
    The type of the license provided to establish a deposit account.
  • Links
  • Title: Middle Name
    Maximum Length: 60
    Middle name of the person assigned as owner to the deposit account.
  • Title: Migrated Data
    Read Only: true
    Maximum Length: 3
    Default Value: N
    Identifies whether the ownership record is migrated or not.
  • Title: Name
    Maximum Length: 360
    Name of the person or business assigned as owner to the deposit account.
  • Title: Owner Party ID
    Identifier of the party assigned as owner to the deposit account.
  • Title: Account Owner Type
    Maximum Length: 30
    Identifies the type of the party assigned as owner to the deposit account.
  • Title: Phone Area Code
    Maximum Length: 10
    Phone area code of the owner assigned to the deposit account.
  • Title: Phone Country Code
    Maximum Length: 10
    Phone country code of the owner assigned to the deposit account.
  • Title: Phone Extension
    Maximum Length: 20
    Phone extension code of the owner assigned to the deposit account.
  • Title: Phone Number
    Maximum Length: 40
    Phone number of the owner assigned to the deposit account.
  • Title: Postal Code
    Maximum Length: 60
    Postal code of the owner address assigned to the deposit account.
  • Title: Postal Plus4 Code
    Maximum Length: 10
    Extended postal code of the owner address assigned to the deposit account.
  • Title: Primary Owner
    Maximum Length: 1
    Identifies whether the owner is the primary owner or not.
  • Title: Province
    Maximum Length: 60
    Province of the owner address assigned to the deposit account.
  • Title: State
    Maximum Length: 60
    State of the owner address assigned to the deposit account.
  • Title: Valid From
    Identifies the start date of the ownership record.
  • Title: Valid To
    Identifies the end date of the ownership record.
Nested Schema : publicSectorDepositAccounts-DepositAccountProject-item-response
Type: object
Show Source
Nested Schema : publicSectorDepositAccounts-DepositAccountRecord-item-response
Type: object
Show Source
  • Title: All Records
    Maximum Length: 1
    The value that identifies whether the transaction association applies to all records.
  • Read Only: true
    Maximum Length: 80
    Describes the value that identifies whether the transaction association applies to all records.
  • Title: Assign Status
    Maximum Length: 1
    The status of the transaction's assignment to the deposit account.
  • Read Only: true
    Maximum Length: 80
    Describes the status of the transaction's assignment to the deposit account.
  • Title: Classification
    Maximum Length: 3
    The reason code provided by the user for change of ownership.
  • The unique system-generated numeric identifier of the deposit account.
  • Maximum Length: 30
    The unique agency-defined alphanumeric identifier of the deposit account.
  • Title: Transaction Key
    The unique system-generated numeric identifier of a transaction assigned to the deposit account.
  • Links
  • Title: Primary Account
    Maximum Length: 1
    Indicates whether the deposit account is the primary account for the transaction.
  • Read Only: true
    Maximum Length: 80
    Describes whether the deposit account is the primary account for the transaction. The default value is Y.
  • Read Only: true
    Maximum Length: 100
    The unique record type assigned to the deposit account.
  • Title: Transaction Type ID
    Maximum Length: 50
    The unique record type identifier assigned to the deposit account.
  • Title: Transaction ID
    Maximum Length: 50
    The user-friendly record identifier assigned to the deposit account.
  • Title: Source Record Key
    The key of the source record assigned to the deposit account.
Nested Schema : publicSectorDepositAccounts-DepositAccountUser-item-response
Type: object
Show Source
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 : publicSectorDepositAccounts-DepositAccountUser-DepositAccountAccess-item-response
Type: object
Show Source
Nested Schema : publicSectorDepositAccounts-DepositAccountUserInvite-item-response
Type: object
Show Source
Back to Top