SWS GetTotalDuePastDue Method
Retrieves the total amount due and the past due amount for a rental item, including the number of cycles past due. It works the same as the GetTotalDue SWS method with the exception that it requires each rental ID that you wish to include in the total. This will include all fees and services for the applicable past due and future amounts.
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 used to calculate the amount. If no cycle is passed in, it is assumed only one cycle should be included. The number of cycles starts from the PTD of the 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 | Optional |
| 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 | Optional |
| 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 | Required |
| Description | The rental item’s ID number. 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 |
|---|---|
| PastDueCycles | Decimal |
| Description | The number of rental periods that must be paid to bring the account current. |
| PastDueTotal | Decimal |
| Description | The total amount due to bring the account current. |
| RequestedTotalDue | Decimal |
| Description | The total amount due for the requested number of rental periods. |
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 GetTotalDuePastDue 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.GetTotalDuePastDue_Response response;
Here’s my sample code of the Request object.
// GetTotalDuePastDue 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 retrieve the data. 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.GetTotalDuePastDue(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 