Request
Data is requested by performing a HTTP Post to https://api.myresman.com/Accounting/GetBudgetAndActual 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 |
StartMonth | The starting month of periods to return | 2015-08-01 | Yes |
EndMonth | The ending month of periods to return | 2015-09-01 | 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 a list of permitted GL Accounts.
Each GLAccount node contains a Type value which indicates the type of GL Account being returned. This node will contain one of the following 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
{
"GLAccounts": [
{
"Name": "Gross Potential Rent",
"Number": "4100",
"Type": "Income",
"AccountingType": "Cash",
"Periods": [
{
"Month": 1,
"Year": 2016,
"Actual": 100000,
"Budget": 100000
},
{
"Month": 2,
"Year": 2016,
"Actual": 100000,
"Budget": 100000
},
{
"Month": 3,
"Year": 2016,
"Actual": 84612.91,
"Budget": 100000
},
{
"Month": 4,
"Year": 2016,
"Actual": 0,
"Budget": 100000
},
{
"Month": 5,
"Year": 2016,
"Actual": 0,
"Budget": 100000
},
{
"Month": 6,
"Year": 2016,
"Actual": 0,
"Budget": 100000
},
{
"Month": 7,
"Year": 2016,
"Actual": 0,
"Budget": 100000
},
{
"Month": 8,
"Year": 2016,
"Actual": 0,
"Budget": 100000
},
{
"Month": 9,
"Year": 2016,
"Actual": 0,
"Budget": 100000
},
{
"Month": 10,
"Year": 2016,
"Actual": 0,
"Budget": 100000
},
{
"Month": 11,
"Year": 2016,
"Actual": 0,
"Budget": 100000
},
{
"Month": 12,
"Year": 2016,
"Actual": 0,
"Budget": 100000
}
]
},
{
"Name": "Rent Concessions",
"Number": "4210",
"Type": "Income",
"AccountingType": "Cash",
"Periods": [
{
"Month": 1,
"Year": 2016,
"Actual": -1580.64,
"Budget": -1600
},
{
"Month": 2,
"Year": 2016,
"Actual": -1200,
"Budget": -1600
},
{
"Month": 3,
"Year": 2016,
"Actual": -1500,
"Budget": -1600
},
{
"Month": 4,
"Year": 2016,
"Actual": 0,
"Budget": -1600
},
{
"Month": 5,
"Year": 2016,
"Actual": 0,
"Budget": -1600
},
{
"Month": 6,
"Year": 2016,
"Actual": 0,
"Budget": -1600
},
{
"Month": 7,
"Year": 2016,
"Actual": 0,
"Budget": -1600
},
{
"Month": 8,
"Year": 2016,
"Actual": 0,
"Budget": -1600
},
{
"Month": 9,
"Year": 2016,
"Actual": 0,
"Budget": -1600
},
{
"Month": 10,
"Year": 2016,
"Actual": 0,
"Budget": -1600
},
{
"Month": 11,
"Year": 2016,
"Actual": 0,
"Budget": -1600
},
{
"Month": 12,
"Year": 2016,
"Actual": 0,
"Budget": -1600
}
]
}
],
"MethodName": "GetBudgetAndActual",
"Status": "Success",
"AccountID": 502,
"PropertyID": "4fb18691-c894-4b84-805b-c62da481ca63"
}
XML Response
<ResMan xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<MethodName>GetBudgetAndActual</MethodName>
<Status>Success</Status>
<AccountID>502</AccountID>
<PropertyID>4fb18691-c894-4b84-805b-c62da481ca63</PropertyID>
<GLAccounts>
<GLAccount>
<Name>Gross Potential Rent</Name>
<Number>4100</Number>
<Type>Income</Type>
<AccountingType>Cash</AccountingType>
<Period>
<Month>1</Month>
<Year>2016</Year>
<Actual>100000.0000</Actual>
<Budget>100000.0000</Budget>
</Period>
<Period>
<Month>2</Month>
<Year>2016</Year>
<Actual>100000.0000</Actual>
<Budget>100000.0000</Budget>
</Period>
<Period>
<Month>3</Month>
<Year>2016</Year>
<Actual>84612.9100</Actual>
<Budget>100000.0000</Budget>
</Period>
<Period>
<Month>4</Month>
<Year>2016</Year>
<Actual>0.0000</Actual>
<Budget>100000.0000</Budget>
</Period>
<Period>
<Month>5</Month>
<Year>2016</Year>
<Actual>0.0000</Actual>
<Budget>100000.0000</Budget>
</Period>
<Period>
<Month>6</Month>
<Year>2016</Year>
<Actual>0.0000</Actual>
<Budget>100000.0000</Budget>
</Period>
<Period>
<Month>7</Month>
<Year>2016</Year>
<Actual>0.0000</Actual>
<Budget>100000.0000</Budget>
</Period>
<Period>
<Month>8</Month>
<Year>2016</Year>
<Actual>0.0000</Actual>
<Budget>100000.0000</Budget>
</Period>
<Period>
<Month>9</Month>
<Year>2016</Year>
<Actual>0.0000</Actual>
<Budget>100000.0000</Budget>
</Period>
<Period>
<Month>10</Month>
<Year>2016</Year>
<Actual>0.0000</Actual>
<Budget>100000.0000</Budget>
</Period>
<Period>
<Month>11</Month>
<Year>2016</Year>
<Actual>0.0000</Actual>
<Budget>100000.0000</Budget>
</Period>
<Period>
<Month>12</Month>
<Year>2016</Year>
<Actual>0.0000</Actual>
<Budget>100000.0000</Budget>
</Period>
</GLAccount>
<GLAccount>
<Name>Rent Concessions</Name>
<Number>4210</Number>
<Type>Income</Type>
<AccountingType>Cash</AccountingType>
<Period>
<Month>1</Month>
<Year>2016</Year>
<Actual>-1580.6400</Actual>
<Budget>-1600.0000</Budget>
</Period>
<Period>
<Month>2</Month>
<Year>2016</Year>
<Actual>-1200.0000</Actual>
<Budget>-1600.0000</Budget>
</Period>
<Period>
<Month>3</Month>
<Year>2016</Year>
<Actual>-1500.0000</Actual>
<Budget>-1600.0000</Budget>
</Period>
<Period>
<Month>4</Month>
<Year>2016</Year>
<Actual>0.0000</Actual>
<Budget>-1600.0000</Budget>
</Period>
<Period>
<Month>5</Month>
<Year>2016</Year>
<Actual>0.0000</Actual>
<Budget>-1600.0000</Budget>
</Period>
<Period>
<Month>6</Month>
<Year>2016</Year>
<Actual>0.0000</Actual>
<Budget>-1600.0000</Budget>
</Period>
<Period>
<Month>7</Month>
<Year>2016</Year>
<Actual>0.0000</Actual>
<Budget>-1600.0000</Budget>
</Period>
<Period>
<Month>8</Month>
<Year>2016</Year>
<Actual>0.0000</Actual>
<Budget>-1600.0000</Budget>
</Period>
<Period>
<Month>9</Month>
<Year>2016</Year>
<Actual>0.0000</Actual>
<Budget>-1600.0000</Budget>
</Period>
<Period>
<Month>10</Month>
<Year>2016</Year>
<Actual>0.0000</Actual>
<Budget>-1600.0000</Budget>
</Period>
<Period>
<Month>11</Month>
<Year>2016</Year>
<Actual>0.0000</Actual>
<Budget>-1600.0000</Budget>
</Period>
<Period>
<Month>12</Month>
<Year>2016</Year>
<Actual>0.0000</Actual>
<Budget>-1600.0000</Budget>
</Period>
</GLAccount>
<GLAccount>
<Name>Vacancy Loss</Name>
<Number>4260</Number>
<Type>Income</Type>
<Period>
<Month>1</Month>
<Year>2016</Year>
<Actual>-13419.3500</Actual>
<Budget>-14000.0000</Budget>
</Period>
<Period>
<Month>2</Month>
<Year>2016</Year>
<Actual>-13241.3800</Actual>
<Budget>-14000.0000</Budget>
</Period>
<Period>
<Month>3</Month>
<Year>2016</Year>
<Actual>0.0000</Actual>
<Budget>-14000.0000</Budget>
</Period>
<Period>
<Month>4</Month>
<Year>2016</Year>
<Actual>0.0000</Actual>
<Budget>-14000.0000</Budget>
</Period>
<Period>
<Month>5</Month>
<Year>2016</Year>
<Actual>0.0000</Actual>
<Budget>-14000.0000</Budget>
</Period>
<Period>
<Month>6</Month>
<Year>2016</Year>
<Actual>0.0000</Actual>
<Budget>-14000.0000</Budget>
</Period>
<Period>
<Month>7</Month>
<Year>2016</Year>
<Actual>0.0000</Actual>
<Budget>-14000.0000</Budget>
</Period>
<Period>
<Month>8</Month>
<Year>2016</Year>
<Actual>0.0000</Actual>
<Budget>-14000.0000</Budget>
</Period>
<Period>
<Month>9</Month>
<Year>2016</Year>
<Actual>0.0000</Actual>
<Budget>-14000.0000</Budget>
</Period>
<Period>
<Month>10</Month>
<Year>2016</Year>
<Actual>0.0000</Actual>
<Budget>-14000.0000</Budget>
</Period>
<Period>
<Month>11</Month>
<Year>2016</Year>
<Actual>0.0000</Actual>
<Budget>-14000.0000</Budget>
</Period>
<Period>
<Month>12</Month>
<Year>2016</Year>
<Actual>0.0000</Actual>
<Budget>-14000.0000</Budget>
</Period>
</GLAccount>
</GLAccounts>
</ResMan>