Home > Accounting, API General, Revenue Classes, Site Administration > SWS GetMiscRevenueClassData Method

SWS GetMiscRevenueClassData Method


Retrieves a collection of miscellaneous revenue class data for making miscellaneous payments.

Parameters

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

Returned Parameters

Name Data Type
ClassID Long
Description The system generated ID for the revenue class.
MiscClassID Long
Description The system generated ID for the miscellaneous class of the organization.
Description String
Description The name of the revenue class.
ClassRef Long
Description The indicator of what type of revenue class this is.
TaxGroupID Long
Description If the revenue class is taxed this indicates which tax group is used.

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

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

Here’s my sample code of the Request object.

// GetMiscRevenueClassData Request
request.SiteID = 123456;

Finally we can call the method and pass across the login object and the request object to get our misc revenue class 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.GetMiscRevenueClassData(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: