Home > API General, Payments, Rules > SWS GetPartialPayRules Method

SWS GetPartialPayRules Method


Retrieves site rule values that determine if and how partial payments are applied.

Parameters

Name DataType Is Required
SiteID Long Required
Description The site’s ID number. This can be found using the GetSiteList method.

Returned Parameters

Name DataType
AllowsPartialPay String
Description Indicates if the site allows partial payments (“True”) or not (“False”).
AllowsPartialRentPay String
Description Indicates if the site allows partial payment son delinquent rentals (“True”) or not (“False”).
PriorityList ArrayOfString1
Description The order, highest to lowest priority, in which any payment will apply to 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 GetPartialPayRules request object and a GetPartialPayRules response object. We can define and create those like this:

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

Here’s my sample code of the Request object.

// GetPartialPayRules Request
request.SiteID = 123456;

Finally we can call the method and pass across the login object and the request object to get our partial pay rules. 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.GetPartialPayRules(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.

Categories: API General, Payments, Rules Tags: ,
  1. No comments yet.
  1. No trackbacks yet.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google photo

You are commenting using your Google account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s

%d bloggers like this: