Account

GetAccountID

This method will return the Account ID and Company Name for the specified subdomain.

Request

Data is requested by performing a HTTP Post to https://api.myresman.com/Account/GetAccountID supplying the listed parameters below in the body of the request. Please refer to the Request Example portion at the beginning of this document for an example on how to make such a request.

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
Subdomain	The Subdomain associated with the management company	abc	Yes

Response

The response will be provided in the format requested based upon the Accept HTTP header; either json or xml. The response will contain information about the method called, the parameters supplied as well as the Account ID and Company Name.

Name	Description
AccountID	The Account associated with the management company
CompanyName	The name of the management company

Below are examples of the response you can expect from this method.

JSON Response

{

"AccountID": 400,

"CompanyName": "ABC Company",

"Subdomain": "abc",

"MethodName": "GetAccountID",

"Status": "Success"

}

XML Response

<ResMan

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<CompanyName>ABC Company</CompanyName>

<MethodName>GetAccountID</MethodName>

<Status>Success</Status>

</ResMan>

GetChartOfAccounts

This method will return the Chart of Accounts available for the specified property. All properties in a given account share the same Chart of Accounts but access to specific accounts can be restricted on a property by property basis. For this reason, we require the Chart of Accounts to be requested for a specific property.

Request

Data is requested by performing a HTTP Post to https://api.myresman.com/Account/GetChartOfAccounts supplying the listed parameters below in the body of the request. Please refer to the Request Example portion at the beginning of this document for an example on how to make such a request.

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 management company	400	Yes
PropertyID	The PropertyID associated with the property	07413576-f764-44c6-be35-df4139deec01	Yes

Response

Name	Description	Data
Number	The GL Account number	string(15)
Name	The GL Account name	string(50)
Description	The GL Account description	string(200)
Type	The GL Account type	Possible Values: Bank, Accounts Receivable, Other Current Asset, Fixed Asset, Other Asset, Accounts Payable, Other Current Liability, Long Term Liability, Equity, Income, Other Income, Expense, Other Expense, Non-Operating Expense

Below are examples of the response you can expect from this method.

JSON Response

{

"ChartOfAccounts": [

{

"Number": "1100",

"Name": "Undeposited Funds",

"Description": "For Undeposited Funds",

"Type": "Other Current Asset"

{

"Number": "1110",

"Name": "Cash - Petty Cash",

"Description": "For Petty Cash",

"Type": "Bank"

{

"Number": "1205",

"Name": "Accounts Receivable - Delinquents",

"Description": "For Delinquents",

"Type": "Accounts Receivable"

}

"MethodName": "ChartOfAccounts",

"Status": "Success",

"AccountID": 400,

"PropertyID": "07413576-f764-44c6-be35-df4139deec01",

}

XML Response

<ResMan

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<MethodName>ChartOfAccounts</MethodName>

<Status>Success</Status>

<Name>Undeposited Funds</Name>

<Description>For Undeposited Funds</Description>

<Type>Other Current Asset</Type>

</GLAccount>

<Name>Cash - Petty Cash</Name>

<Description>For Petty Cash</Description>

</GLAccount>

<Name>Accounts Receivable - Delinquents</Name>

<Description>For Delinquents</Description>

<Type>Accounts Receivable</Type>

</GLAccount>

</ChartOfAccounts>

</ResMan>

GetProperties

This method will return information about integrated properties for the specified account.

Request

Data is requested by performing a HTTP Post to https://api.myresman.com/Account/GetProperties supplying the listed parameters below in the body of the request. Please refer to the Request Example portion at the beginning of this document for an example on how to make such a request.

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 management company	400	Yes

Response

Name	Description
PropertyID	The ID of the property
Name	The name of the property
StreetAddress	The street address of the property
City	The city of property
State	The state of the property
Zip	The zip code of the property
Phone	The phone number of the property
Email	The email address of the property
Manager	The name of the property manager

Below are examples of the response you can expect from this method.

JSON Response

{

"Properties": [

{

"PropertyID": "11111111-1111-1111-1111-111111111111",

"Name": "Property One",

"StreetAddress": "123 Main St",

"City": "Denver",

"State": "CO",

"Zip": "80202",

"Phone": "(123) 456-7890",

"Email": "donotreply@prop1.com",

"Manager": "John Manager"

{

"PropertyID": "22222222-2222-2222-2222-222222222222",

"Name": "Property Two",

"StreetAddress": "832 Town Ln",

"City": "Irvine",

"State": "CA",

"Zip": "92617",

"Email": "donotreply@prop2.com"

{

"PropertyID": "33333333-3333-3333-3333-333333333333",

"Name": "Property Three",

"StreetAddress": "320 E 400 N",

"City": "Provo",

"State": "UT",

"Zip": "84601",

"Email": "donotreply@prop3.com"

}

"MethodName": "GetProperties",

"Status": "Success",

"AccountID": 400

}

XML Response

<ResMan

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<MethodName>GetProperties</MethodName>

<Status>Success</Status>

<Name>Property One</Name>

<City>Denver</City>

<Email>donotreply@prop1.com</Email>

<Manager>John Manager</Manager>

</Property>

<Name>Property Two</Name>

<City>Irvine</City>

<Email>donotreply@prop2.com</Email>

</Property>

<Name>Property Three</Name>

<City>Provo</City>

<Email>donotreply@prop3.com</Email>

</Property>

</Properties>

</ResMan>

GetSecurityGroups

This method will return information about the defined security groups for the specified account.

Request

Data is requested by performing a HTTP Post to https://api.myresman.com/Account/GetSecurityGroups supplying the listed parameters below in the body of the request. Please refer to the Request Example portion at the beginning of this document for an example on how to make such a request.

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 management company	400	Yes

Response

Name	Description
SecurityGroupID	The ID of the Security Group
Name	The name of the Security Group
Description	The description of the Security Group
Type	A type used to identify the people in the security group. Will be one of: Accountant, Administrator, Affordable Operations, Assistant Manager, Compliance, Executive, Leasing Agent, Maintenance, Marketing, Owner, Payables, Property Manager, Regional Manager, Other
Users	A collection of active users associated with the Security Group
- UserID	The ID of the user
- Username	The username of the user
- Email	The email address of the user
- FirstName	The first name of the user
- LastName	The last name of the user

Below are examples of the response you can expect from this method.

JSON Response

{

"Groups": [

{

"SecurityGroupID": "069fdf92-2903-4261-ba76-2095800be514",

"Name": "Managers",

"Description": null,

"Type": "Property Manager",

"Users": [

{

"UserID": "d86fb60d-2a5a-4b62-9bdc-1d1e45042b1a",

"Username": "amy.manager",

"Email": "amy@abcmanagement.com",

"FirstName": "Amy",

"LastName": "Manager"

{

"UserID": "0abb6d28-68ec-487b-b10a-3e778cdc7f0a",

"Username": "willy.wonderson",

"Email": "willy@abcmanagemement.com",

"FirstName": "Willy",

"LastName": "Wonderson"

}

]

{

"SecurityGroupID": "4265b362-4afe-401d-98a0-3a4742a3ca21",

"Name": "Leasing",

"Description": null,

"Type": "Leasing Agent",

"Users": [

{

"UserID": "bf2078f0-2011-463d-944d-d4d86fea95d9",

"Username": "roger.honger",

"Email": "roger@abcmanagement.com",

"FirstName": "Roger",

"LastName": "Honger"

}

]

}

"MethodName": "GetSecurityGroups",

"ErrorDescription": null,

"Status": "Success",

"AccountID": 1000

}

XML Response

<MethodName>GetSecurityGroups</MethodName>

<Status>Success</Status>

<Group>

<Name>Managers</Name>

<Type>Property Manager</Type>

<Users>

<User>

<Username>amy.manager</Username>

<Email>amy@abcmanagement.com</Email>

<LastName>Manager</LastName>

</User>

<User>

<Username>willy.wonderson</Username>

<Email>willy@abcmanagement.com</Email>

<FirstName>Willy</FirstName>

<LastName>Wonderson</LastName>

</User>

</Users>

</Group>

<Group>

<Name>Leasing</Name>

<Type>Leasing Agent</Type>

<Users>

<User>

<Username>roger.honger</Username>

<Email>roger@abcmanagement.com</Email>

<FirstName>Roger</FirstName>

<LastName>Honger</LastName>

</User>

</Users>

</Group>

</Groups>

</ResMan>