GET v1/LedgerAccounts

Description

Retrive list of Ledger Accounts satisfying the input search criteria.

Base Url

https://services.wsoweb.com/


Rest Call Syntax


GET CashManagement/v1/LedgerAccounts

GET CashManagement/v1/LedgerAccounts

Verb

Base Url

URI parameters

 = 

Authentication



Response Format


Headers

Add header


 

Delete




Limitations

There are no limitations specified.




Request Information


Parameters

Name

Description

Type

Additional Information

IsDeleted

This flag will allow the return of deleted portfolios in the search results

LedgerAccountNameExactMatch

The value will allow a ledger account search by ledger account name exact match

string

LedgerAccountNameStartsWith

This value will allow a ledger account search by ledger account name starts with

string

PageNumber

Specified Page number to search

integer

PageSize

Specified Page size to search

integer

PortfolioName

string




Response Information



PagedList Of LedgerAccountListItem

Name

Description

Type

Additional Information

Items

Collection of LedgerAccountListItem

Links

Collection of Link

PagingInformation




Response Body Formats



application/json, text/json

Sample:
{
  "items": [
    {
      "id": 1,
      "ledgerAccountName": "sample string 2",
      "isDeleted": true,
      "accountNumber": "sample string 5",
      "notes": "sample string 6",
      "accountType": "sample string 7",
      "currencyType": "sample string 8",
      "description": "sample string 9",
      "portfolioOverride": 10,
      "companyId": 1,
      "country": {
        "verb": "sample string 1",
        "rel": "sample string 2",
        "uri": "http://webapihelppage3.com"
      },
      "countryId": 11,
      "custodian": {
        "verb": "sample string 1",
        "rel": "sample string 2",
        "uri": "http://webapihelppage3.com"
      },
      "custodianId": 12,
      "addDate": "2024-11-23T01:22:08.0463338-06:00",
      "addId": "sample string 14",
      "addNode": "sample string 15",
      "lastChangeDate": "2024-11-23T01:22:08.0463338-06:00",
      "lastChangeId": "sample string 17",
      "lastChangeNode": "sample string 18",
      "links": [
        {
          "verb": "sample string 1",
          "rel": "sample string 2",
          "uri": "http://webapihelppage3.com"
        },
        {
          "verb": "sample string 1",
          "rel": "sample string 2",
          "uri": "http://webapihelppage3.com"
        }
      ]
    },
    {
      "id": 1,
      "ledgerAccountName": "sample string 2",
      "isDeleted": true,
      "accountNumber": "sample string 5",
      "notes": "sample string 6",
      "accountType": "sample string 7",
      "currencyType": "sample string 8",
      "description": "sample string 9",
      "portfolioOverride": 10,
      "companyId": 1,
      "country": {
        "verb": "sample string 1",
        "rel": "sample string 2",
        "uri": "http://webapihelppage3.com"
      },
      "countryId": 11,
      "custodian": {
        "verb": "sample string 1",
        "rel": "sample string 2",
        "uri": "http://webapihelppage3.com"
      },
      "custodianId": 12,
      "addDate": "2024-11-23T01:22:08.0463338-06:00",
      "addId": "sample string 14",
      "addNode": "sample string 15",
      "lastChangeDate": "2024-11-23T01:22:08.0463338-06:00",
      "lastChangeId": "sample string 17",
      "lastChangeNode": "sample string 18",
      "links": [
        {
          "verb": "sample string 1",
          "rel": "sample string 2",
          "uri": "http://webapihelppage3.com"
        },
        {
          "verb": "sample string 1",
          "rel": "sample string 2",
          "uri": "http://webapihelppage3.com"
        }
      ]
    }
  ],
  "pagingInformation": {
    "totalItems": 1,
    "totalPages": 2,
    "itemsPerPage": 3,
    "currentPage": 4,
    "startRow": 5,
    "endRow": 6
  },
  "links": [
    {
      "verb": "sample string 1",
      "rel": "sample string 2",
      "uri": "http://webapihelppage3.com"
    },
    {
      "verb": "sample string 1",
      "rel": "sample string 2",
      "uri": "http://webapihelppage3.com"
    }
  ]
}

application/xml, text/xml

Sample:
<PagedListOfLedgerAccountListItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Items>
    <LedgerAccountListItem>
      <AccountNumber>sample string 5</AccountNumber>
      <AccountType>sample string 7</AccountType>
      <AddDate>2024-11-23T01:22:08.0463338-06:00</AddDate>
      <AddId>sample string 14</AddId>
      <AddNode>sample string 15</AddNode>
      <CompanyId>1</CompanyId>
      <Country>
        <Rel>sample string 2</Rel>
        <Uri>http://webapihelppage3.com/</Uri>
        <Verb>sample string 1</Verb>
      </Country>
      <CountryId>11</CountryId>
      <CurrencyType>sample string 8</CurrencyType>
      <Custodian>
        <Rel>sample string 2</Rel>
        <Uri>http://webapihelppage3.com/</Uri>
        <Verb>sample string 1</Verb>
      </Custodian>
      <CustodianId>12</CustodianId>
      <Description>sample string 9</Description>
      <Id>1</Id>
      <IsDeleted>true</IsDeleted>
      <LastChangeDate>2024-11-23T01:22:08.0463338-06:00</LastChangeDate>
      <LastChangeId>sample string 17</LastChangeId>
      <LastChangeNode>sample string 18</LastChangeNode>
      <LedgerAccountName>sample string 2</LedgerAccountName>
      <Links>
        <Link>
          <Rel>sample string 2</Rel>
          <Uri>http://webapihelppage3.com/</Uri>
          <Verb>sample string 1</Verb>
        </Link>
        <Link>
          <Rel>sample string 2</Rel>
          <Uri>http://webapihelppage3.com/</Uri>
          <Verb>sample string 1</Verb>
        </Link>
      </Links>
      <Notes>sample string 6</Notes>
      <PortfolioOverride>10</PortfolioOverride>
    </LedgerAccountListItem>
    <LedgerAccountListItem>
      <AccountNumber>sample string 5</AccountNumber>
      <AccountType>sample string 7</AccountType>
      <AddDate>2024-11-23T01:22:08.0463338-06:00</AddDate>
      <AddId>sample string 14</AddId>
      <AddNode>sample string 15</AddNode>
      <CompanyId>1</CompanyId>
      <Country>
        <Rel>sample string 2</Rel>
        <Uri>http://webapihelppage3.com/</Uri>
        <Verb>sample string 1</Verb>
      </Country>
      <CountryId>11</CountryId>
      <CurrencyType>sample string 8</CurrencyType>
      <Custodian>
        <Rel>sample string 2</Rel>
        <Uri>http://webapihelppage3.com/</Uri>
        <Verb>sample string 1</Verb>
      </Custodian>
      <CustodianId>12</CustodianId>
      <Description>sample string 9</Description>
      <Id>1</Id>
      <IsDeleted>true</IsDeleted>
      <LastChangeDate>2024-11-23T01:22:08.0463338-06:00</LastChangeDate>
      <LastChangeId>sample string 17</LastChangeId>
      <LastChangeNode>sample string 18</LastChangeNode>
      <LedgerAccountName>sample string 2</LedgerAccountName>
      <Links>
        <Link>
          <Rel>sample string 2</Rel>
          <Uri>http://webapihelppage3.com/</Uri>
          <Verb>sample string 1</Verb>
        </Link>
        <Link>
          <Rel>sample string 2</Rel>
          <Uri>http://webapihelppage3.com/</Uri>
          <Verb>sample string 1</Verb>
        </Link>
      </Links>
      <Notes>sample string 6</Notes>
      <PortfolioOverride>10</PortfolioOverride>
    </LedgerAccountListItem>
  </Items>
  <Links>
    <Link>
      <Rel>sample string 2</Rel>
      <Uri>http://webapihelppage3.com/</Uri>
      <Verb>sample string 1</Verb>
    </Link>
    <Link>
      <Rel>sample string 2</Rel>
      <Uri>http://webapihelppage3.com/</Uri>
      <Verb>sample string 1</Verb>
    </Link>
  </Links>
  <PagingInformation>
    <CurrentPage>4</CurrentPage>
    <EndRow>6</EndRow>
    <ItemsPerPage>3</ItemsPerPage>
    <StartRow>5</StartRow>
    <TotalItems>1</TotalItems>
    <TotalPages>2</TotalPages>
  </PagingInformation>
</PagedListOfLedgerAccountListItem>



Feedback



(0 out of 1500 characters used)
Feedback has been submitted. Thank you for your feedback.
Automatic feedback submission has been turned off by your system administrator. Your feedback has been logged to the exceptions table. Please contact support to find out how to manually send in your feedback. Thank you.