GET Account/Get?accountId={accountId}&custodianId={custodianId}

Gets the specified account.

Request Information

Header Parameters

NameDescriptionTypeAdditional information
Authorization

The authorization token prefixed with 'Bearer'

string

Required

Sample:
Authorization: Bearer gBsdjflsdkj#wsjelKDSDdsdDTjeYYfvikg2cZQIu_ombqpyE7DZgEHClLO06EtHLFV65lelXVwx9JR33gib3nxzzJKLSDFJ-Xrt5ressxjArc3F6hy1J...        

URI Parameters

NameDescriptionTypeAdditional information
accountId

The account identifier.

string

Required

custodianId

The custodian identifier.

integer

Required

Body Parameters

None.

Response Information

Resource Description

Returns account information in an AccountModel object.

Type: AccountModel
NameDescriptionTypeAdditional information
AccountId

Gets or sets the account identifier.

string

None.

CustodialAccountNumber

Gets or sets the custodial account number.

string

None.

Name

Gets or sets the name.

string

None.

AccountType

Gets or sets the type of the account.

string

None.

OpenDate

Gets or sets the open date.

date

None.

ClosedDate

Gets or sets the closed date.

date

None.

Email

Gets or sets the email.

string

None.

IsUMAPrimary

Gets or sets a value indicating whether this instance is uma primary.

boolean

None.

RRId

Gets or sets the rr identifier.

integer

None.

StartDate

Gets or sets the start date.

date

None.

Status

Gets or sets the status.

string

None.

UMAAccountNumber

Gets or sets the uma account number.

string

None.

Title

Gets or sets the title.

string

None.

PortfolioType

Gets or sets the type of the portfolio.

string

None.

Address

Gets or sets the address.

AddressModel

None.

Custodian

Gets or sets the custodian.

CustodianModel

None.

Model

Gets or sets the model.

ModelModel

None.

Households

Gets or sets the households.

Collection of HouseholdModel

None.

InceptionDate

The inception date of the account

date

None.

Response Formats

application/json, text/json

Sample:
{
  "AccountId": "1234567",
  "CustodialAccountNumber": "234567",
  "Name": "Sample Account",
  "AccountType": "IRAA",
  "OpenDate": "2018-07-22T02:15:17.1916418-04:00",
  "ClosedDate": "2020-07-22T02:15:17.1916418-04:00",
  "Email": "sample@portfoliopathway.com",
  "IsUMAPrimary": false,
  "RRId": 12345,
  "StartDate": "2018-07-22T02:15:17.1916418-04:00",
  "Status": "O",
  "UMAAccountNumber": "SAMPLEUMA01",
  "Title": "Sample Account Title",
  "PortfolioType": "TD Ameritrade",
  "Address": {
    "Line1": "123 Main Street",
    "Line2": "Suite 100",
    "City": "Chicago",
    "State": "IL",
    "Zipcode": "12345"
  },
  "Custodian": {
    "Name": "Custodian, Inc.",
    "Id": 234567
  },
  "Model": {
    "Name": "Sample Model",
    "Id": 1
  },
  "Households": [
    {
      "HouseholdId": 1,
      "Name": "Sample Household Name 1",
      "CustomerName": "Sample Customer Name 1",
      "RepresentativeId": "REPID123",
      "Address": {
        "Line1": "321 Elm Street",
        "Line2": "Apt 200",
        "City": "New York City",
        "State": "NY",
        "Zipcode": "54321"
      },
      "Accounts": [],
      "ClientGroups": [
        {
          "ClientGroupId": "GROUP1",
          "Name": "Sample Client Group Name 1",
          "Accounts": []
        },
        {
          "ClientGroupId": "GROUP2",
          "Name": "Sample Client Group Name 2",
          "Accounts": []
        }
      ]
    }
  ],
  "InceptionDate": "2018-06-22T02:15:17.1916418-04:00"
}

application/xml, text/xml

Sample:
<AccountModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PP.Contracts.WebApi.Client">
  <AccountId>1234567</AccountId>
  <AccountType>IRAA</AccountType>
  <Address xmlns:d2p1="http://schemas.datacontract.org/2004/07/PP.Contracts.WebApi">
    <d2p1:City>Chicago</d2p1:City>
    <d2p1:Line1>123 Main Street</d2p1:Line1>
    <d2p1:Line2>Suite 100</d2p1:Line2>
    <d2p1:State>IL</d2p1:State>
    <d2p1:Zipcode>12345</d2p1:Zipcode>
  </Address>
  <ClosedDate>2020-07-22T02:15:17.1916418-04:00</ClosedDate>
  <CustodialAccountNumber>234567</CustodialAccountNumber>
  <Custodian>
    <Id>234567</Id>
    <Name>Custodian, Inc.</Name>
  </Custodian>
  <Email>sample@portfoliopathway.com</Email>
  <Households>
    <HouseholdModel>
      <Accounts />
      <Address xmlns:d4p1="http://schemas.datacontract.org/2004/07/PP.Contracts.WebApi">
        <d4p1:City>New York City</d4p1:City>
        <d4p1:Line1>321 Elm Street</d4p1:Line1>
        <d4p1:Line2>Apt 200</d4p1:Line2>
        <d4p1:State>NY</d4p1:State>
        <d4p1:Zipcode>54321</d4p1:Zipcode>
      </Address>
      <ClientGroups>
        <ClientGroupModel>
          <Accounts />
          <ClientGroupId>GROUP1</ClientGroupId>
          <Name>Sample Client Group Name 1</Name>
        </ClientGroupModel>
        <ClientGroupModel>
          <Accounts />
          <ClientGroupId>GROUP2</ClientGroupId>
          <Name>Sample Client Group Name 2</Name>
        </ClientGroupModel>
      </ClientGroups>
      <CustomerName>Sample Customer Name 1</CustomerName>
      <HouseholdId>1</HouseholdId>
      <Name>Sample Household Name 1</Name>
      <RepresentativeId>REPID123</RepresentativeId>
    </HouseholdModel>
  </Households>
  <InceptionDate>2018-06-22T02:15:17.1916418-04:00</InceptionDate>
  <IsUMAPrimary>false</IsUMAPrimary>
  <Model>
    <Id>1</Id>
    <Name>Sample Model</Name>
  </Model>
  <Name>Sample Account</Name>
  <OpenDate>2018-07-22T02:15:17.1916418-04:00</OpenDate>
  <PortfolioType>TD Ameritrade</PortfolioType>
  <RRId>12345</RRId>
  <StartDate>2018-07-22T02:15:17.1916418-04:00</StartDate>
  <Status>O</Status>
  <Title>Sample Account Title</Title>
  <UMAAccountNumber>SAMPLEUMA01</UMAAccountNumber>
</AccountModel>