Home > API General, Assessments, Credits, Payments, Promotions (PCD) > SWS ApplyCreditToAssessments Method

SWS ApplyCreditToAssessments Method


Applies an already created Manager’s Credits to currently due assessments (non-volatile) or future assessments (volatile) that are within 30 days of being due. Manager’s Credits must have been added to the account using the AddUpdatePCD SWS method or through the application. Note: promotions, discounts and rate modications are not used with this SWS method.

Parameters

Name DataType Is Required
AssessId Long Required
Description The assessment’s ID number. This is retrieved using the GetAssessments method.
AssessVersion Integer Required
Description The assessment’s version number. This is retrieved using the GetAssessments method.
ApplyAmt Decimal Required
Description The amount to apply to the specified assessment. This can be all or only a portion of the available manager’s credit.
OrgID Long Required
Description The organization’s ID number.
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
Successful Boolean
Description Indicates that the application of the manager’s credit was successful (“True”) or not (“False”).

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

 // Create request and response objects and assessment info object
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.ApplyCreditToAssessments_Request request = new SWS.ApplyCreditToAssessments_Request();
SWS.ApplyCreditToAssessments_Response response;

SWS.AssessInfo assess_data = new SWS.AssessInfo();

Here’s my sample code of the Request objects.

//Create assessment info object
assess_data.AssessId = 123456;
assess_data.AssessVersion = 3;
assess_data.ApplyAmt = 10.50m;

//Applies the credit to the assessment
request.OrgID = 123456;
request.SiteID = 123456;
request.RentalID = 123456;
request.AssessmentInfo = new SWS.AssessInfo[] { assess_data };

We can call the method and pass across the login object and the request object for applying credits to assessments. It’s a good idea to do this in a Try Catch block.

try
{
   // Call the method that will load the response object
   response = service.ApplyCreditToAssessments(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.

  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: