GET v1/Portfolios/{id}

Description

Retrieve a Portfolio with WSO ID of {id}.

Base Url

https://api-agc.wsohosting.com/

Rest Call Syntax


GET Reference/v1/Portfolios/{id}

Execute API

GET Reference/v1/Portfolios/{id}

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

id

WSO ID of Portfolio

integer

Required



Response Information



Portfolio

Name

Description

Type

Additional Information

Abbreviation

The abbreviated name of the portfolio.

string

AddDate

Gets or sets the date that a record was added to the system.

date

AddId

Gets or sets the UserId of the user who added the record.

string

AddNode

Gets or sets the name of the machine where the record was added from.

string

AdjustCapitalizedPIKOnUnsettledTradeUpdates

Gets or sets the is capitalized PIK trade adjustment for the portfolio.

boolean

AllocationsUseParentTradeInfo

Use the parent trade info for allocations

boolean

AllowNegativePositionOnATradeDateBasis

Allow Negative Position

boolean

BaseCurrencyCode

The base currency code for this portfolio

string

ClosingDate

Date the deal closed.

date

CompanyId

Gets or sets the Company related to the Portfolio

integer

ConstantYieldType

The Constant Yield method to use in WSO Reporting.

Contact

The main contact for this portfolio at the associated institution.

ContactId

The id of the main contact for this portfolio at the associated institution.

integer

Country

Gets or sets the country link.

CountryId

Gets or sets the country identifier.

integer

CustodianId

Gets or sets the custodian identifier.

integer

DataFeedId

The name of the external data importing source for this asset.

integer

DataImportSource

The type of the external data importing source for this portfolio.

DealType

Type of the deal.

string

DefaultCashLedgerAccount

The default cash ledger account that cash related to this portfolio should be posted to.

DelayedCompDefaultBehavior

The portfolio's default delayed compensation behavior.

DelayedCompExtendSettleDate

Indicates whether the WSO Delayed Comp Automation job will extend the trade settle date, when calculating Delayed Compensation for this portfolio.

boolean

DelayedCompOverrideId

Delayed Comp Override Id

integer

DelayedCompUpdateWithActivity

Delayed Comp Update With Activity

boolean

EnableTradeHistory

Indicates if trade history is enabled at the portfolio level. This setting is only used if the system is configured to allow fund-level trade history overrides.

boolean

Id

The unique ID for this portfolio.

integer

Institution

The institution that is managing this portfolio

InstitutionId

The institution id that is managing this portfolio

integer

IsActive

This field is not used.

boolean

IsAgentPortfolio

Identifies the Agent portfolio. Can only be one. Only used by WSO Agent system.

boolean

IsDeleted

Has this portfolio been deleted?

boolean

IsErisaFund

Is Erisa Fund

boolean

Issuer

A link to retrieve the Issuer associated with the portfolio.

IssuerId

Issuer associated with the portfolio.

integer

IsThirdPartyFund

Is Third Party Fund

boolean

LastChangeDate

Gets or sets the date when the record was last changed.

date

LastChangeId

Gets or sets the UserId of the user who last changed this record.

string

LastChangeNode

Gets or sets the name of the machine where the record was last changed from.

string

LedgerMapTypeId

The type of ledger account mapping.

integer

Links

The Hateoas links to dividend operations

Collection of Link

MarkitEntityId

The Markit entity Id for this portfolio.

string

Notes

Any notes relating to this portfolio.

string

PaydownUnsettledTradeUpdateDefault

Paydown Unsettled Trade Adjustment Type

PortfolioName

The name of the portfolio (sometimes referred to as the deal).

string

PortfolioType

A pointer to the portfolio type

SendToMEI

Send To MEI

string

Signature1

Signature line 1

string

Signature2

Signature line 2

string

Signature3

Signature line 3

string

Signature4

Signature line 4

string

StampNewTrade

StampNewTrade to be used as the default behavior for stamping trades with global tran id.

boolean

TradeSettlementIntegrationPortfolioId

Gets or sets the settlement integration portfolio id.

string

TradeSettlementIntegrationPortfolioName

Gets or sets the settlement integration portfolio name.

string

Udfs

Link to Udfs

UsePortfolioDelayedCompOverride

Indicates whether the portfolio overrides the delayed compensation setting.

boolean

UsePortfolioExchangeRates

Has Override currency rate enabled?

boolean



Response Body Formats



application/json, text/json

Sample: 
{
  "id": 1,
  "isDeleted": true,
  "portfolioName": "sample string 3",
  "markitEntityId": "sample string 4",
  "abbreviation": "sample string 5",
  "baseCurrencyCode": "sample string 6",
  "portfolioType": "None",
  "isErisaFund": true,
  "institutionId": 1,
  "institution": {
    "verb": "sample string 1",
    "rel": "sample string 2",
    "uri": "http://webapihelppage3.com"
  },
  "contactId": 1,
  "contact": {
    "verb": "sample string 1",
    "rel": "sample string 2",
    "uri": "http://webapihelppage3.com"
  },
  "notes": "sample string 8",
  "dataImportSource": "None",
  "issuer": {
    "verb": "sample string 1",
    "rel": "sample string 2",
    "uri": "http://webapihelppage3.com"
  },
  "issuerId": 9,
  "dealType": "sample string 10",
  "closingDate": "2024-10-08T05:32:10.1824571-05:00",
  "constantYieldType": "StraightLine",
  "allocationsUseParentTradeInfo": true,
  "tradeSettlementIntegrationPortfolioId": "sample string 13",
  "tradeSettlementIntegrationPortfolioName": "sample string 14",
  "usePortfolioDelayedCompOverride": true,
  "delayedCompDefaultBehavior": "None",
  "delayedCompExtendSettleDate": true,
  "enableTradeHistory": true,
  "defaultCashLedgerAccount": {
    "verb": "sample string 1",
    "rel": "sample string 2",
    "uri": "http://webapihelppage3.com"
  },
  "ledgerMapTypeId": 1,
  "isAgentPortfolio": true,
  "signature1": "sample string 19",
  "signature2": "sample string 20",
  "signature3": "sample string 21",
  "signature4": "sample string 22",
  "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"
    }
  ],
  "udfs": {
    "verb": "sample string 1",
    "rel": "sample string 2",
    "uri": "http://webapihelppage3.com"
  },
  "delayedCompOverrideId": 1,
  "delayedCompUpdateWithActivity": true,
  "adjustCapitalizedPIKOnUnsettledTradeUpdates": true,
  "dataFeedId": 1,
  "addDate": "2024-10-08T05:32:10.1824571-05:00",
  "addId": "sample string 26",
  "addNode": "sample string 27",
  "lastChangeDate": "2024-10-08T05:32:10.1824571-05:00",
  "lastChangeId": "sample string 29",
  "lastChangeNode": "sample string 30",
  "isThirdPartyFund": true,
  "sendToMEI": "sample string 32",
  "allowNegativePositionOnATradeDateBasis": true,
  "countryId": 34,
  "country": {
    "verb": "sample string 1",
    "rel": "sample string 2",
    "uri": "http://webapihelppage3.com"
  },
  "custodianId": 35,
  "stampNewTrade": true,
  "isActive": true,
  "companyId": 1,
  "usePortfolioExchangeRates": true,
  "paydownUnsettledTradeUpdateDefault": "NoChange"
}

application/xml, text/xml

Sample: 
<Portfolio xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Abbreviation>sample string 5</Abbreviation>
  <AddDate>2024-10-08T05:32:10.1824571-05:00</AddDate>
  <AddId>sample string 26</AddId>
  <AddNode>sample string 27</AddNode>
  <AdjustCapitalizedPIKOnUnsettledTradeUpdates>true</AdjustCapitalizedPIKOnUnsettledTradeUpdates>
  <AllocationsUseParentTradeInfo>true</AllocationsUseParentTradeInfo>
  <AllowNegativePositionOnATradeDateBasis>true</AllowNegativePositionOnATradeDateBasis>
  <BaseCurrencyCode>sample string 6</BaseCurrencyCode>
  <ClosingDate>2024-10-08T05:32:10.1824571-05:00</ClosingDate>
  <CompanyId>1</CompanyId>
  <ConstantYieldType>StraightLine</ConstantYieldType>
  <Contact>
    <Rel>sample string 2</Rel>
    <Uri>http://webapihelppage3.com/</Uri>
    <Verb>sample string 1</Verb>
  </Contact>
  <ContactId>1</ContactId>
  <Country>
    <Rel>sample string 2</Rel>
    <Uri>http://webapihelppage3.com/</Uri>
    <Verb>sample string 1</Verb>
  </Country>
  <CountryId>34</CountryId>
  <CustodianId>35</CustodianId>
  <DataFeedId>1</DataFeedId>
  <DataImportSource>None</DataImportSource>
  <DealType>sample string 10</DealType>
  <DefaultCashLedgerAccount>
    <Rel>sample string 2</Rel>
    <Uri>http://webapihelppage3.com/</Uri>
    <Verb>sample string 1</Verb>
  </DefaultCashLedgerAccount>
  <DelayedCompDefaultBehavior>None</DelayedCompDefaultBehavior>
  <DelayedCompExtendSettleDate>true</DelayedCompExtendSettleDate>
  <DelayedCompOverrideId>1</DelayedCompOverrideId>
  <DelayedCompUpdateWithActivity>true</DelayedCompUpdateWithActivity>
  <EnableTradeHistory>true</EnableTradeHistory>
  <Id>1</Id>
  <Institution>
    <Rel>sample string 2</Rel>
    <Uri>http://webapihelppage3.com/</Uri>
    <Verb>sample string 1</Verb>
  </Institution>
  <InstitutionId>1</InstitutionId>
  <IsActive>true</IsActive>
  <IsAgentPortfolio>true</IsAgentPortfolio>
  <IsDeleted>true</IsDeleted>
  <IsErisaFund>true</IsErisaFund>
  <IsThirdPartyFund>true</IsThirdPartyFund>
  <Issuer>
    <Rel>sample string 2</Rel>
    <Uri>http://webapihelppage3.com/</Uri>
    <Verb>sample string 1</Verb>
  </Issuer>
  <IssuerId>9</IssuerId>
  <LastChangeDate>2024-10-08T05:32:10.1824571-05:00</LastChangeDate>
  <LastChangeId>sample string 29</LastChangeId>
  <LastChangeNode>sample string 30</LastChangeNode>
  <LedgerMapTypeId>1</LedgerMapTypeId>
  <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>
  <MarkitEntityId>sample string 4</MarkitEntityId>
  <Notes>sample string 8</Notes>
  <PaydownUnsettledTradeUpdateDefault>NoChange</PaydownUnsettledTradeUpdateDefault>
  <PortfolioName>sample string 3</PortfolioName>
  <PortfolioType>None</PortfolioType>
  <SendToMEI>sample string 32</SendToMEI>
  <Signature1>sample string 19</Signature1>
  <Signature2>sample string 20</Signature2>
  <Signature3>sample string 21</Signature3>
  <Signature4>sample string 22</Signature4>
  <StampNewTrade>true</StampNewTrade>
  <TradeSettlementIntegrationPortfolioId>sample string 13</TradeSettlementIntegrationPortfolioId>
  <TradeSettlementIntegrationPortfolioName>sample string 14</TradeSettlementIntegrationPortfolioName>
  <Udfs>
    <Rel>sample string 2</Rel>
    <Uri>http://webapihelppage3.com/</Uri>
    <Verb>sample string 1</Verb>
  </Udfs>
  <UsePortfolioDelayedCompOverride>true</UsePortfolioDelayedCompOverride>
  <UsePortfolioExchangeRates>true</UsePortfolioExchangeRates>
</Portfolio>


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.