The
GetInvtMaturityDate method retrieves all investment positions that will mature within a specified date range for all contacts assigned to a particular SmartOffice user.
The
GetInvtMaturityDate method is invoked using the
MethodOperation.
This method returns the following data:
- Contact names
- Account types, names and numbers
- Position names, holding types, maturity dates and maturity values
Parameters
Name |
Type |
Description |
UserID |
String |
Required. This is the object ID of the user account. |
FromDate |
String |
Required. This is the first date in the date range. |
ToDate |
String |
Required. This is the last date in the date range. |
Examples
The following example retrieves data about all positions maturing between Jan. 1, 2015, and December 31, 2015, for contacts assigned to the user whose object ID is User.1.2. In this example, one record is returned.
<request version='1.0'>
<header>
<office>myoffice</office>
<user>jdoe</user>
<password>password</password>
</header>
<method>
<GetInvtMaturityDate>
<UserID>User.1.2</UserID>
<FromDate>2015-01-01</FromDate>
<ToDate>2015-12-31</ToDate>
</GetInvtMaturityDate>
</method>
</request>
Response XML
<response version="1.0">
<header>
<sessionClosed/>
</header>
<method>
<GetInvtMaturityDate>
<Contact id="Contact.1.72" _type="obj">
<FirstName>Flora</FirstName>
<LastName>Cannon</LastName>
<AcctMasters _type="objs">
<AcctMaster id="AcctMaster.1.11" _type="obj">
<AcctNumber>34534534534</AcctNumber>
<AcctName>Scottrade Brokerage</AcctName>
<AcctType>Individual</AcctType>
<Positions _type="objs">
<Position id="Position.1.26" _type="obj">
<InvestName>RESERVE PRIMARY FUND CL 25</InvestName>
<HoldingType>Cash and Equivalents</HoldingType>
<MaturityDate>2015-10-29</MaturityDate>
<MaturityValue>1000</MaturityValue>
</Position>
</Positions>
</AcctMaster>
</AcctMasters>
</Contact>
</GetInvtMaturityDate>
</method>
<_status>OK</_status>
<_systime>2015-10-20T23:03:05</_systime>
<!--Cost 39 mill seconds.-->
</response>