Yardi Store Developer eXchange

Retrieves a collection of transaction history for a specified account, rental or transaction, for a given time-frame.

Parameters

Returned Parameters

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 GetRentalLedger request object and a GetRentalLedger response object. We can define and create those like this:

// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.GetRentalLedger_Request request = new SWS.GetRentalLedger_Request();
SWS.GetRentalLedger_Response response;

Here’s my sample code of the Request object.

// GetRentalLedger Request
request.AccountID = 123546;
request.RentalID = 123456;
request.StartDate = DateTime.Today.AddDays(-30);
request.EndDate = DateTime.Now;

Finally we can call the method and pass across the login object and the request object to get our rental ledger 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.GetRentalLedger(user_request, ref 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.