This method will return all the collection accounts that have been assigned to the requesting company. Included in the result set will be a listing of lease data as well as the charges that need to be collected.
Parameters
Name | Description | Example | Required |
IntegrationPartnerID | The ID assigned to your company by ResMan | 1000 | Yes |
ApiKey | The API key assigned to your company by ResMan | a5w7d9g2m04… | Yes |
AccountID | The AccountID associated with the property | 400 | Yes |
PropertyID | The PropertyID associated with the property | 07413576-f764-44c6-be35-df4139deec01 | Yes |
StartDate | The starting date for a collections date range. | 2015-11-01 | No* |
EndDate | The ending date for a collections date range. | 2015-11-30 | No* |
*If either the StartDate or EndDate parameter is included in the request, the other is also required.
Request
The following demonstrates one way of submitting a request to the GetCollectionAccounts3_0 method using C#.
NameValueCollection postData = new NameValueCollection();
// Integration Partner values
postData["IntegrationPartnerID"] = "1000";
postData["ApiKey"] = "6aw7y9m3m04849lqld6em9sudl5fg01u";
// Account and property specific data
postData["AccountID"] = "400";
postData["PropertyID"] = "07413576-f764-44c6-be35-df4139deec01";
// Specify a date range for collections
// postData["StartDate"] = "2015-11-01"; // November 1, 2015
// postData["EndDate"] = "2015-11-30"; // November 30, 2015
string url = "https://api.myresman.com/MITS/GetCollectionAccounts3_0";
WebClient client = new WebClient();
byte[] response = client.UploadValues(url, "POST", postData);
string strResponse = System.Text.Encoding.Default.GetString(response);
Response
The returned xml will follow the MITS Collections 3.0 standard. There will be one Summary element and one PropertyFiles element. The PropertyFiles node contains at least one PropertyFile element, each of which contains a Property element and a LeaseFiles element. The LeaseFiles node contains at least one LeaseFile element which contains information about the lease, including the collection status, move-in date, move-out date, lease-begin date, lease-end date, monthly rent amount, the associated tenants, and charges that need to be collected. At the end of the LeaseFile node will be a collection of CustomRecord nodes that will contain links to any files that the property has included with the collections account. The name will contain the name of the document and the Value will contain the url to that document.
<ResMan>
<Status>Success</Status>
<Response>[Encoded MITS Collections 3.0 XML Response]</Response>
</ResMan>
Example MITS Collections 3.0 XML Response
<MITS-Collections>
<Summary>
<MITSDocVersion />
<GenerationTimeStamp>2013-06-09T17:12:22</GenerationTimeStamp>
<SourceOrganization />
<TotalProperties>1</TotalProperties>
<TotalLeaseFiles>2</TotalLeaseFiles>
<TotalTenants>4</TotalTenants>
<TotalOpenAmount>5495.00</TotalOpenAmount>
</Summary>
<PropertyFiles>
<PropertyFile>
<Property>
<Identification>
<IDValue>11111111-1111-1111-1111-111111111111</IDValue>
</Identification>
<MarketingName>Property One</MarketingName>
<LegalName />
<Address AddressType="property">
<Description>PropertyAddress</Description>
<Address>123 Main St</Address>
<City>Denver</City>
<State>CO</State>
<PostalCode>80202</PostalCode>
<Country>USA</Country>
</Address>
</Property>
<LeaseFiles>
<LeaseFile>
<Identification>
<IDValue>101</IDValue>
<OrganizationName>Unit Number</OrganizationName>
</Identification>
<Identification>
<IDValue>cea11ac0-c1d9-4ed3-a0bf-953d1e30a139</IDValue>
<OrganizationName>Lease Identifier</OrganizationName>
</Identification>
<CollectionStatus>true</CollectionStatus>
<CollectionStatusLastChangeDate>2013-08-09</CollectionStatusLastChangeDate>
<MoveInDate>2011-10-01</MoveInDate>
<MoveOutDate>2013-02-28</MoveOutDate>
<NoticeToVacateDate>2013-02-28</NoticeToVacateDate>
<LeaseBegin>2011-10-01</LeaseBegin>
<LeaseEnd>2012-12-31</LeaseEnd>
<MonthlyRentAmount>500.00</MonthlyRentAmount>
<Tenants>
<PersonDetails>
<Identification>
<IDValue>dae38cf0-f496-455d-a0b9-a13808311c0c</IDValue>
<OrganizationName>Person Identifier</OrganizationName>
</Identification>
<Name>
<FirstName>Amy</FirstName>
<LastName>Resident</LastName>
</Name>
<Address AddressType="previous">
<Address>1234 Lincoln St</Address>
<City>Plano</City>
<State>TX</State>
<PostalCode>72526</PostalCode>
</Address>
<Address AddressType="current">
<Address>8973 Main St</Address>
<City>Dallas</City>
<State>TX</State>
<PostalCode>72521</PostalCode>
</Address>
<Phone PhoneType="cell">
<PhoneDescription>Mobile</PhoneDescription>
<PhoneNumber>(801) 555-1234</PhoneNumber>
</Phone>
<Phone PhoneType="home">
<PhoneDescription>Home</PhoneDescription>
<PhoneNumber>(810) 555-9876</PhoneNumber>
</Phone>
</PersonDetails>
<DateOfBirth>1988-08-05</DateOfBirth>
<SSN>123-45-6789</SSN>
<Guarantor>false</Guarantor>
<Employer>
<EmployerDetails>
<Identification>
<IDValue>123 Company</IDValue>
</Identification>
<CompanyName>123 Company</CompanyName>
<Address AddressType="current" />
</EmployerDetails>
<Income>
<IncomeAmount>50000.00</IncomeAmount>
<PaymentPeriod>Annually</PaymentPeriod>
</Income>
<JobTitle>Waiter</JobTitle>
<SupervisorName>Steward Thomas</SupervisorName>
<SupervisorContactNumber PhoneType="office">
<PhoneDescription />
<PhoneNumber>(949) 987-1234</PhoneNumber>
<Extension />
</SupervisorContactNumber>
</Employer>
<Contact>
<Name>
<FirstName>Sara</FirstName>
<LastName>Martinez</LastName>
</Name>
<Address AddressType="current" />
<Phone PhoneType="home">
<PhoneNumber>(943) 555-1234</PhoneNumber>
</Phone>
</Contact>
</Tenants>
<Tenants>
<PersonDetails>
<Identification>
<IDValue>5eb86f74-8a1d-4de6-ad90-80212e00748f</IDValue>
<OrganizationName>Person Identifier</OrganizationName>
</Identification>
<Name>
<FirstName>Larry</FirstName>
<LastName>Resident</LastName>
</Name>
<Address AddressType="previous">
<Address>1234 Lincoln St</Address>
<City>Plano</City>
<State>TX</State>
<PostalCode>72526</PostalCode>
</Address>
<Address AddressType="current">
<Address>8973 Main St</Address>
<City>Dallas</City>
<State>TX</State>
<PostalCode>72521</PostalCode>
</Address>
<Phone PhoneType="cell">
<PhoneDescription>Mobile</PhoneDescription>
<PhoneNumber>(801) 555-4321</PhoneNumber>
</Phone>
<Phone PhoneType="home">
<PhoneDescription>Home</PhoneDescription>
<PhoneNumber>(810) 555-6789</PhoneNumber>
</Phone>
</PersonDetails>
<DateOfBirth>1987-08-05</DateOfBirth>
<SSN>123-49-6789</SSN>
<Guarantor>false</Guarantor>
<Employer>
<EmployerDetails>
<Identification>
<IDValue>ABC Company</IDValue>
</Identification>
<CompanyName>ABC Company</CompanyName>
<Address AddressType="current">
<Address>1234 Main St</Address>
<City>Irvine</City>
<State>CA</State>
<PostalCode>92617</PostalCode>
</Address>
</EmployerDetails>
<Income>
<IncomeAmount>35000.00</IncomeAmount>
<PaymentPeriod>Annually</PaymentPeriod>
</Income>
<JobTitle>Network Analysit</JobTitle>
<SupervisorName>Amy Wilson</SupervisorName>
<SupervisorContactNumber PhoneType="office">
<PhoneDescription />
<PhoneNumber>(801) 123-1234</PhoneNumber>
<Extension />
</SupervisorContactNumber>
</Employer>
</Tenants>
<FileTransactions>
<Identification>
<IDValue>a4f601bb-0d6b-4368-bcf9-4227ce3e436b</IDValue>
</Identification>
<TransDate>2013-07-12</TransDate>
<TransTypeDesc>Resident Damages</TransTypeDesc>
<TransType>Charge</TransType>
<TransAmount>200.00</TransAmount>
<OpenAmount>200.00</OpenAmount>
</FileTransactions>
<FileTransactions>
<Identification>
<IDValue>5541c1f5-0721-4f2b-8621-c179246101e1</IDValue>
</Identification>
<TransDate>2013-07-12</TransDate>
<TransTypeDesc>Resident Damages</TransTypeDesc>
<TransType>Charge</TransType>
<TransAmount>1000.00</TransAmount>
<OpenAmount>900.00</OpenAmount>
</FileTransactions>
<FileTransactions>
<Identification>
<IDValue>d4c81b95-25b3-4d22-af15-fa00518672f5</IDValue>
</Identification>
<TransDate>2013-07-12</TransDate>
<TransTypeDesc>Lease Termination Fee</TransTypeDesc>
<TransType>Charge</TransType>
<TransAmount>845.00</TransAmount>
<OpenAmount>845.00</OpenAmount>
</FileTransactions>
<CustomRecords>
<Record>
<Name>Lease Document.pdf</Name>
<Value>https://api.myresman.com/Documents/View/c9fc189b-c9ee-4e18-9352-54d902055d99? accountID=400&c=27384</Value>
</Record>
<Record>
<Name>Application.pdf</Name>
<Value>https://api.myresman.com/Documents/View/132212B8-50AA-46DD-8DC4-DDB72C052777? accountID=400&c=891462</Value>
</Record>
<Record>
<Name>PreparedTimeStamp</Name>
<Value>2021-12-13 15:37:16</Value>
</Record>
</CustomRecords>
</LeaseFile>
<LeaseFile>
<Identification>
<IDValue>201</IDValue>
<OrganizationName>Unit Number</OrganizationName>
</Identification>
<Identification>
<IDValue>fafab494-88a8-4703-96e5-62123db0bb0d</IDValue>
<OrganizationName>Lease Identifier</OrganizationName>
</Identification>
<CollectionStatus>true</CollectionStatus>
<CollectionStatusLastChangeDate>2013-08-09</CollectionStatusLastChangeDate>
<MoveInDate>2011-11-01</MoveInDate>
<MoveOutDate>2013-02-28</MoveOutDate>
<NoticeToVacateDate>2013-02-28</NoticeToVacateDate>
<LeaseBegin>2011-11-01</LeaseBegin>
<LeaseEnd>2012-12-31</LeaseEnd>
<MonthlyRentAmount>490.00</MonthlyRentAmount>
<Tenants>
<PersonDetails>
<Identification>
<IDValue>af4c2e50-7816-4b18-94ef-5553e5a6f3e4</IDValue>
<OrganizationName>Person Identifier</OrganizationName>
</Identification>
<Name>
<FirstName>Amanda</FirstName>
<LastName>Resident</LastName>
</Name>
<Address AddressType="previous">
<Address>1234 Lincoln St</Address>
<City>Plano</City>
<State>TX</State>
<PostalCode>72526</PostalCode>
</Address>
<Address AddressType="current">
<Address>3242 Main St</Address>
<City>Dallas</City>
<State>TX</State>
<PostalCode>72521</PostalCode>
</Address>
</PersonDetails>
<Guarantor>false</Guarantor>
</Tenants>
<Tenants>
<PersonDetails>
<Identification>
<IDValue>d80ba3c2-8fba-4a28-98da-1566ca277c93</IDValue>
<OrganizationName>Person Identifier</OrganizationName>
</Identification>
<Name>
<FirstName>Harry</FirstName>
<LastName>Resident</LastName>
</Name>
<Address AddressType="current">
<Address>3242 Main St</Address>
<City>Dallas</City>
<State>TX</State>
<PostalCode>72521</PostalCode>
</Address>
</PersonDetails>
<Guarantor>false</Guarantor>
<Income>
<IncomeAmount>1500.00</IncomeAmount>
<PaymentPeriod>Monthly</PaymentPeriod>
</Income>
</Tenants>
<FileTransactions>
<Identification>
<IDValue>c83a78f5-4c6a-4cb1-864a-1113a1e69d46</IDValue>
</Identification>
<TransDate>2013-05-01</TransDate>
<TransTypeDesc>Cleaning Charge</TransTypeDesc>
<TransType>Charge</TransType>
<TransAmount>2000.00</TransAmount>
<OpenAmount>2000.00</OpenAmount>
</FileTransactions>
<FileTransactions>
<Identification>
<IDValue>e1f32dae-7baf-4c2a-b11f-3631d8129bab</IDValue>
</Identification>
<TransDate>2013-05-01</TransDate>
<TransTypeDesc>Resident Damages</TransTypeDesc>
<TransType>Charge</TransType>
<TransAmount>1000.00</TransAmount>
<OpenAmount>1000.00</OpenAmount>
</FileTransactions>
<FileTransactions>
<Identification>
<IDValue>9d6f3220-6005-4d4f-8c25-645fba6b589f</IDValue>
</Identification>
<TransDate>2013-07-12</TransDate>
<TransTypeDesc>Keys & Locks</TransTypeDesc>
<TransType>Charge</TransType>
<TransAmount>50.00</TransAmount>
<OpenAmount>50.00</OpenAmount>
</FileTransactions>
<FileTransactions>
<Identification>
<IDValue>f70669eb-3901-4bbd-9ae4-ef111320b0e0</IDValue>
</Identification>
<TransDate>2013-07-12</TransDate>
<TransTypeDesc>Resident Damages</TransTypeDesc>
<TransType>Charge</TransType>
<TransAmount>500.00</TransAmount>
<OpenAmount>500.00</OpenAmount>
</FileTransactions>
<CustomRecords>
<Record>
<Name>Lease Document.pdf</Name>
<Value>https://api.myresman.com/Documents/View/DA1624F7-6311-43D3-A30B-15EFE3EBA344? accountID=400&c=64774</Value>
</Record>
</CustomRecords>
</LeaseFile>
</LeaseFiles>
</PropertyFile>
</PropertyFiles>
</MITS-Collections>
Regulation F
The <CustomRecords> element contains a node called ‘PreparedTimeStamp’ This date is the timestamp of when the first move-out reconciliation was done.