Archive
SWS FIUExport Method
Exports FIU (Financial Integration Utility) data into 3rd party accounting software formats. The data is returned in the XML and can also be saved to the path specified as long as path permissions allow. This SWS method was designed to return the exported financial data in an EXR format and update the flag to indicate the change. It can also save the data to the specified path, if one is defined.
Parameters
| Name | DataType | Is Required |
|---|---|---|
| EndDate | DateTime | Optional |
| Description | The date to end a process. If start date is provided, then it is the end date of a range of dates. Technically, it’s one day beyond the end date. This will default to today’s date undefined. This date cannot be greater than today. | |
| OrgID | Long | Required |
| Description | The organization’s ID number. | |
| Path | String | Optional |
| Description | If entered, the file location where the FIU export data will be saved as a .csv file. Permissions for the directory must be set to allow this to occur. | |
| SiteList | Long | Optional |
| Description | A collection of site IDs. This will return all sites within the organization if left undefined. | |
| StartDate | DateTime | Required |
| Description | The date to start a process. If end date is provided, then it is the start date of a range of dates. | |
Returned Parameters
| Name | DataType |
|---|---|
| TRAN_FIU_EXPORT | TRAN_FIU_DATA |
| Description | The object containing all the data returned in the method. |
Example
As with every method we need to pass in credentials. We do this with the LookupUser request object.
We’ll assume you’ve got a web reference, let’s name it SWS, in your Visual Studio project. At this point we need to our objects. We’ll need the standard service object, a FIU_Request request object and a FIU_Response response object. We can define and create those like this:
// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.FIU_Request request = new SWS.FIU_Request();
SWS.FIU_Response response;
Here’s my sample code of the Request object.
// FIUExport Request
request.OrgID = 123456;
request.SiteList = new long[] { 123456, 456789 };
request.StartDate = DateTime.Today.AddDays(1);
request.EndDate = DateTime.Today;
request.Path = "c:\\directory";
Finally we can call the method and pass across the login object and the request object to export our financial information. It’s a good idea to do this in a Try Catch block.
// Call the method that will load the response object
try
{
response = service.FIUSelect(user_request,request);
}
catch (Exception ex)
{
MessageBox.Show(ex.Message);
}
Note that if something goes wrong the service will respond with an exception. You’ll want to take a look at that message returned in that exception so it can be debugged.
For a full list of methods see SWS Methods.
SWS FIUReInt Method
Resets exported FIU (Financial Integration Utility) data so that it can be re-exported into your accounting software program.
Parameters
| Name | DataType | Is Required |
|---|---|---|
| EndDate | DateTime | Required |
| Description | The date to end a process. If start date is provided, then it is the end date of a range of dates. Technically, it’s one day beyond the end date. This will default to today’s date if left undefined. This date cannot be greater than today. | |
| OrgID | Long | Required |
| Description | The organization’s ID number. | |
| Path | String | Not used in this method. |
| Description | If entered, the file location where the FIU export data will be saved as a .csv file. Permissions for the directory must be set to allow this to occur. | |
| SiteList | Long | Optional |
| Description | A collection of limited site details for a specified site. This will return all sites within the organization if left undefined. | |
| StartDate | DateTime | Required |
| Description | The date to start a process. If end date is provided, then it is the start date of a range of dates. | |
Returned Parameters
| Name | DataType |
|---|---|
| TRAN_FIU_DATA | TRAN_FIU_DATA |
| Description | The object containing all the data returned in the method. |
Example
As with every method we need to pass in credentials. We do this with the LookupUser request object.
We’ll assume you’ve got a web reference, let’s name it SWS, in your Visual Studio project. At this point we need to our objects. We’ll need the standard service object, a FIU_Request request object and a FIU_Response response object. We can define and create those like this:
// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.FIU_Request request = new SWS.FIU_Request();
SWS.FIU_Response response;
Here’s my sample code of the Request object.
// FIUReInt Request
request.OrgID = 123456;
request.SiteList = new long[] { 123456, 456789 };
request.StartDate = DateTime.Today.AddDays(1);
request.EndDate = DateTime.Today;
Finally we can call the method and pass across the login object and the request object to update our previously exported financial information. It’s a good idea to do this in a Try Catch block.
// Call the method that will load the response object
try
{
response = service.FIUReInt(user_request,request);
}
catch (Exception ex)
{
MessageBox.Show(ex.Message);
}
Note that if something goes wrong the service will respond with an exception. You’ll want to take a look at that message returned in that exception so it can be debugged.
For a full list of methods see SWS Methods.
SWS GetAssessments Method
Retrieves assessments (i.e., rent, insurance, fees, etc.) for a specified account, or specified rentals within the account, for a specified set of rental cycles.
Parameters
| Name | DataType | Is Required |
|---|---|---|
| AcctID | Long | Required |
| Description | The account’s ID number. This is returned when you use the CreateNewAccount method or can be retrieved with the SearchBy method. | |
| Cycles | Integer | Optional |
| Description | This is based on the number of rental periods that is requested. If no rental period is entered, a single rental period will be assessed. If a single integer is entered, all rental items will be assessed the same number of rental periods. If an array of integers is requested, they will be matched one-to-one with the array of rental ID numbers requested. If the rental period arrays do not match, an error will occur. The number of rental periods starts from the PTD. The number of rental periods to retrieve is limited, based on the ‘Allowed Number of Days Paid Ahead’ rule for the site. Any services, insurance or protection plans on the account will be assessed equalling the number of months that the rental is assessed. | |
| IsRetail | Boolean | Required |
| Description | Indicates if the payment is for rent only (“False”) or retail only (“True”). Payment cannot be submitted for both at the same time with this setting. | |
| IsRetailAndRental | Boolean | Required |
| Description | Indicates if the payment is for rent and retail (“True”) or if it is for rent only (“False”). Payment should include the entire balance due for this option. | |
| MoveOutDate | DateTime | Optional |
| Description | This is deprecated. See the GetMoveOutInfo SWS method to determine rental amount due prior to termination. | |
| RentalIDs | Long | Required* |
| Description | The rental item ID numbers. An array of rental ID’s from the account. If no ID’s are passed in all rentals on the account are assessed. You can pass in one or more rental ID’s to have the assessment limited to one or more specified rentals. All rentals must belong to the account. This is returned when using the MakeReservation method or can be searched for using the SearchBy method. *Note: This is only required if there is a reservation on the account otherwise it can be left blank. |
|
| SiteID | Long | Required |
| Description | The site’s ID number. This can be found using the GetSiteList method. | |
Returned Parameters
| Name | DataType |
|---|---|
| SOA_GET_ASSESSMENTS | SOA_GET_ASSESSMENTS |
| Description | Object containing all data returned for the method. |
Example
As with every method we need to pass in credentials. We do this with the LookupUser request object.
We’ll assume you’ve got a web reference, let’s name it SWS, in your Visual Studio project. At this point we need to our objects. We’ll need the standard service object, a GetAssessments request object and a GetAssessments response object.
// Create request and response Objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.GetAssessments_Request request = new SWS.GetAssessments_Request();
SWS.GetAssessments_Response response;
Here’s my sample code of the Request object.
// get assessment request for an account with 2 rentals for 1 months rent
request.SiteID = 123456;
request.AcctID = 123456;
request.RentalIDs = new long[] { 123456, 456789 };
request.Cycles = new int[] { 1, 1 };
request.IsRetail = false;
request.IsRetailAndRental = false;
Finally we can call the method and pass across the login object and the request object to get our assessments. It’s a good idea to do this in a Try Catch block.
// Call the method that will load the response object
try
{
response = service.GetAssessments(user_request,request);
}
catch (Exception ex)
{
MessageBox.Show(ex.Message);
}
Note that if something goes wrong the service will respond with an exception. You’ll want to take a look at that message returned in that exception so it can be debugged.
For a full list of methods see SWS Methods.
Daily Accrual Prorating
This is a general run down on how we prorate rent at sites that use daily accrual. This type of proration is a little less intuitive on a day to day basis, but makes sure that the amount from month to month stays the same. The standard per diem for daily accrual is found by dividing the original amount due by 30 and rounding down to the nearest penny. The idea behind this is to treat each month as if it has 30 days in it, and then to adjust later when the month does not.
For example,
If you have a rental that has a rent rate of $100.00 and a rental period that is from January 1st to January 31st; the standard per diem would be $3.33 (100/30 = 3.33…).
Next we need to adjust for the fact that not all months have 30 days. This is easily handled for 31 day months, by not recognizing revenue on the 31st. For February we charge them 3 days revenue on the 28th (or 2 days revenue on the 29th if it is a leap year).
Finally we find the difference between the original amount and the amount given if we assumed standard per diem for the period; this will give us the final day supplement. We then add that amount to the final day of the period that recognizes rent.
So returning to the example above, the per diem for January 30th (January 31st does not recognize revenue) would be as follows:
The original rent $100.00 minus the standard per diem of $3.33 times 30 days in the period equals $0.10. We then add this back into the standard per diem to get January 31st’s per diem of $3.43 ($3.33 + $0.10).
Here are some examples:
(SPD = standard per diem, FDS = final day supplement)
Rental period: January 1st – January 31st (31 days)
SPD = (100/30) = $3.33
FDS = 100 – (3.33 *30) = $0.10
January 1st – January 29th = $3.33
January 30th = $3.43
January 31st = $0.00
Rental period: February 1st – February 28th (28 days)
SPD = (100/30) = $3.33
FDS = 100 – (3.33 *30) = $0.10
February 1st – February 27th= $3.33
February 28th = $10.09
Rental period: April 1st – April 30th (30 days)
SPD = (100/30) = $3.33
FDS = 100 – (3.33 *30) = $0.10
April 1st – April 29th = $3.33
April 30th = $3.43
Rental period: February 15th – March 14th (28 days)
SPD = (100/30) = $3.33
FDS = 100 – (3.33 *30) = $0.10
February 16th – February 27th = $3.33
February 28th = $9.99
March1st – March 14th = $3.33
March 15th = $3.43
Yardi Store Developer eXchange 