SWS GetTotalDue Method
Retrieves the total amount due for specified rental items for an account and can expand the amount to cover future cycles. This will always include at least 1 rental period assessment. This will include all fees and services applicable to the requested time period.
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 | The number of rental periods for which to calculate the total. If no cycle is passed in, it is assumed only one cycle should be used. If a single integer is passed in, it is assumed that all account rentals will be included for the number of cycles indicated. If an array of integers is passed in, it is assumed they match one to one with the array of rental ID’s passed in. If the arrays are of different sizes, an error will occur. The number of cycles starts from the PTD for each rental. You are limited to the number of cycles you can retrieve based on the “Allowed Number of Days Paid Ahead” rule for the site. The rule information can be retrieved using the GetSiteRules and GetSiteRulesValue methods. | |
| IsRetail | Boolean | Required |
| Description | Indicates that the total retrieved should be for retail assessment only (“True”) or if it should be for the rental assessments only (“False”). | |
| IsRetailAndRental | Boolean | Required |
| Description | Indicates that the total retrieved should be for both the retail and the rental assessments on the account (“True”) or only for the rental assessments (“False”). | |
| MoveOutDate | DateTime | Ignored |
| Description | (Deprecated) The date the customer has indicated they will be moving out. | |
| RentalID | Long | Optional |
| Description | The rental item’s ID number. Use an array to choose which rentals will be included in the response. If no rental ID is indicated it will default to all rentals on the account. All rentals must belong to the account. This is returned when using the MakeReservation method or can be searched for using the SearchBy method. | |
| SiteID | Long | Required |
| Description | The site’s ID number. This can be found using the GetSiteList method. | |
Returned Parameters
| Name | DataType |
|---|---|
| Details | Decimal |
| Description | The total amount due for the applied assessments. |
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 GetTotalDue request object and a GetTotalDue response object. We can define and create those like this:
// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.GetTotalDue_Request request = new SWS.GetTotalDue_Request();
SWS.GetTotalDue_Response response;
Here’s my sample code of the Request object using a single rental from the account and requesting the oldest cycle’s total due.
// GetTotalDue Request
request.SiteID = 123456;
request.AcctID = 123456;
request.RentalID = new long[] { 123456 };
request.Cycles = new int[] { 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 total due. 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.GetTotalDue(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.
Yardi Store Developer eXchange 