Account Management | Yardi Store Developer eXchange

SWS TerminateServiceV2 Method

September 20, 2012 sutiki 2 comments

Terminates a service for a specified rental item and allows the user to indicate whether any associated, unpaid service assessments should be written off.

Parameters

Name	DataType	Is Required
RemoveUnpaidAssessments	Boolean	Required
Description	Indicates if you wish to write off the already applied service charges (“True”) or if you wish to leave them assessed to the account (“False”.
ServiceRentalID	Long	Required
Description	The rental ID number of the service that will be removed. This is the RENTAL_ID parameter that is returned when using the GetAppliedServices method.
ServiceType	serviceTypeVals	Required
Description	The type of service to be removed. This is the SERVICE_TYPE parameter that is returned when using the GetAppliedServices method. Available values: MAIL_INVOICE GATE_ACCESS OTHER EMAIL_INVOICE
SiteID	Long	Required
Description	The site’s ID number. This can be found using the GetSiteList method.

Returned Parameters

Name	DataType
Succeeded	Boolean
Description	Indicates if the service was removed successfully (“True”) or not (“False”).

Example

As with every method we need to pass in credentials. We do this with the LookupUser request object.

We will assume you have a web reference, let us name it SWS, in your Visual Studio project. At this point we need to define our objects. We will need the standard service object, a TerminateServiceV2 request object, and a TerminateService response object. We can define and create those like this:

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

Here is a sample code of the request object:

// TerminateServiceV2 Request
request.SiteID = 123456;
request.ServiceRentalID = 213456;
request.ServiceType = SWS.serviceTypeVals.GATE_ACCESS;
request.RemoveUnpaidAssessments = false;

Finally we can call the method and pass across the login object and the request object to retrieve our requested 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.TerminateServiceV2(user_request, request);
}
catch (Exception ex)
{
  MessageBox.Show(ex.Message);
}

Note that if something goes wrong the service will respond with an exception. You will want to capture the message in the exception so it can be debugged.

For a full list of methods see SWS Methods.

Categories: Account Management, API General, Services

SWS GetPrimaryRentalInfoV2 Method

September 4, 2012 sutiki 1 comment

Retrieves rental data and tax exempt information for a specified rental or a collection of rental data for a specified contact or account. The return includes the same information as the first version in addition to tax exemption information.

Parameters

Name	DataType	Is Required
AccountID	Long	Optional
Description	The account’s ID number. This is returned when you use the CreateNewAccount method or can be retrieved with the SearchBymethod.
ContactID	Long	Optional
Description	The rental contact’s ID number. This is returned when using the CreateNewAccount or AddNewContact methods or you can search for it using the SearchBy method.
RentalID	Long	Optional
Description	The rental item’s ID number. This is returned when using the MakeReservation method or can be searched for using the SearchBymethod.
SiteID	Long	Required
Description	The site’s ID number. This can be found using the GetSiteList method.

Returned Parameters

Name	DataType
ACCT_ID	Long
Description	The account’s ID number.
ACCT_NAME	String
Description	The name on the account. This may differ from the primary contact’s name in some instances, such as a business account or a guardianship account.
ACCT_TYPE	String
Description	The system-defined account type.
ADDR1	String
Description	The first address line of the account address.
ADDR2	String
Description	The second address line of the account address.
ADDR3	String
Description	The third address line of the account address.
ADDRESS_TYPE	String
Description	The address type of the account address.
ATTRIBUTE01_VAL	String
Description	The textual value for the “Attribute01” custom lookup as defined by the site. See eUnitAttr01 for the available values.
CITY	String
Description	The city of the account address.
CONTACT_ID	Long
Description	The rental contact’s ID number.
CONTACT_TYPE	String
Description	The contact’s type. Available values: Account Manager Account User Account Contact Only Business Contact Record
COUNTRY	String
Description	The country of the account address if one is included.
CURRENTLY_RENTED	String
Description	Indicates if the unit is currently rented (“Y”) or not (“N”).
DEL_EXEMPT	String
Description	Indicates if the rental is exempt from the delinquency schedule (“Y”) or not (“N”).
DEL_STEP	Integer
Description	The current delinquency step for the rental item. If the unit is not rented this will return “0”.
DEPTH	Decimal
Description	The depth measurement of the rental item.
EMAIL	String
Description	The rental contact’s email address. This is also used as the username if the site supports eStore/eCommerce.
FIRST_NAME	String
Description	The given name for the account/rental contact.
KNOWN_AS	String
Description	The alternate or nick name, if there is one, for the rental contact.
LAST_NAME	String
Description	The family name for the rental contact.
LTD	DateTime
Description	The lease-thru-date (LTD).
MO_DATE	DateTime
Description	The scheduled date of the move-out, if it has been provided and documented in the rental details.
OBJ_PERIOD	Long
Description	The number of periods which apply to the UOM (unit of measure).
OBJ_PERIOD_UOM	String
Description	The description of the UOM (unit of measure). This will always be “Month”.
OVERLOCK_STATUS	String
Description	The current overlock status of the rental. Available values: Not Overlocked Pending Overlock Overlocked Pending Lock Removal
PHONE	String
Description	The primary contact’s phone number.
PHONE_TYPE	String
Description	The type of phone number. Available values: Home Office Mobile Fax Other
POSTAL_CODE	String
Description	The postal/ZIP code for the contacts address.
PTD	DateTime
Description	The paid-thru-date (PTD).
RENTAL_ID	Long
Description	The rental item’s ID number.
RENTAL_STATUS	String
Description	The textual value for the “Status” custom lookup as defined by the site. See eUnitStatus for the available values.
SITE_ID	Long
Description	The site’s ID number.
START_DATE	DateTime
Description	The date the rental was first rented.
STATE	String
Description	The state/province for the address.
UNIT_ID	Long
Description	The unit’s ID number. This is maintained through rentals.
UNIT_NUMBER	String
Description	The unit’s number as assigned by the organization. This is not the UnitID.
WIDTH	Decimal
Description	The width measurement of the rental item.
TAX_EXEMPT	String
Description	Indicates if the rental is exempt from taxes (“1”) or not (“0”).
TAX_EXEMPT_EXP	DateTime
Description	The date the tax exempt status expires.
TAX_EXEMPT_INFO	String
Description	The tax exempt ID number.

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

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

Here’s my sample code of the Request object using the RentalID.

// GetPrimaryRentalInfoV2 Request
request.SiteID = 123456;
request.RentalID = 123456;

Finally we can call the method and pass across the login object and the request object to get our primary rental info. 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.GetPrimaryRentalInfoV2(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: Account Management, API General, Contacts, Delinquency

SWS UpdateRentalSettingsV2 Method

September 4, 2012 sutiki 1 comment

Provides all of the same functionality as the UpdateRentalSettings method and additionally provides the ability to set the tax exempt expiration date of a rental.

Parameters

Name	DataType	Is Required
DelExempt	Boolean	Optional
Description	Indicates if the rental should be included in the delinquency processing (“False”) or if it should be exempt from the delinquency processing (“True”). The default is “False”.
DelScheduleID	Long	Optional
Description	Changes the delinquency schedule that is assigned to the unit. You can get the ID, name and description using the GetDelinqSchedule method.
DelStep	Integer	Optional
Description	Set the delinquency step number of the unit. This is the level of delinquency that applies to the unit’s delinquency status. This cannot be a negative number.
OverlockStatus	OverlockStatus	Optional
Description	Sets the overlock status of the rental. Available values: NOT_OVERLOCKED PENDING_OVERLOCK OVERLOCKED PENDING_LOCK_REMOVAL
PrimaryContact	Long	Optional
Description	Assigns an existing contact as the primary rental contact to the rental via the contact ID.
PrimaryContactAddressID	Long	Optional
Description	The address’s ID number for the address that should be assigned to the new primary contact. This is required if the PrimaryContact parameter is used.
PrimaryContactPhoneID	Long	Optional
Description	The ID of the phone number you wish to add to the primary contact. This is required if the PrimaryContact parameter is used.
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.
SecondaryContact	Long	Optional
Description	Assigns an existing contact as the secondary rental contact to the rental via the contact ID.
SecondaryContactAddressID	Long	Optional
Description	The address’s ID number for the address that should be assigned to the secondary contact. This is required if the SecondaryContact parameter is used.
SecondaryContactPhoneID	Long	Optional
Description	The ID of the phone number you wish to add to the secondary contact. This is required if the SecondaryContact parameter is used.
TaxExempt	Boolean	Optional
Description	Indicates if the rental assessments should be taxed (“False”) or if it should be exempt from taxation (“True”). The default is “False”.
TaxInfo	String	Optional
Description	The tax id if the rental should be tax exempt. This is required if you use the TaxExempt parameter.
TaxExemptExpiration	DateTime	Optional
Description	The date that the tax exempt status expires.

Returned Parameters

Name	DataType
AccountID	Long
Description	The account’s ID number.
DelExempt	Boolean
Description	Indicates if the rental will be included in the delinquency processing (“False”) or if it will be exempt from the delinquency processing (“True”). The default is “False”.
DelSchedule	Long
Description	The delinquency schedule’s ID number.
DelStep	Integer
Description	The current step number within the delinquency schedule that applies to the unit’s delinquency status. This cannot be a negative number.
EndDate	DateTime
Description	The date the rental was terminated and the customer moved out.
LTD	DateTime
Description	The date that the customer has leased
MoveOutDate	DateTime
Description	The date the customer vacated the rental.
OverlockStatus	OverlockStatus
Description	The current overlock status of the rental. Available values: NOT_OVERLOCKED PENDING_OVERLOCK OVERLOCKED PENDING_LOCK_REMOVAL
PrimaryContactUpdated	Boolean
Description	Indicates if the primary contact was updated successfully (“True”) or if the update was unsuccessful (“False”).
PTD	DateTime
Description	The date through which the customer has paid on their rental.
RentalID	Long
Description	The rental item’s ID number.
SecondaryContactUpdated	Boolean
Description	Indicates if the secondary contact was updated successfully (“True”) or if the update was unsuccessful (“False”).
StartDate	DateTime
Description	The date the customer first moved into the unit.
TaxExempt	Boolean
Description	Indicates if the rental assessments will be taxed (“False”) or if it will be exempt from taxation (“True”). The default is “False”.
TaxExemptInfo	String
Description	The tax ID number if the rental is tax exempt.

Example

As with every method we need to pass in credentials. We do this with the LookupUser request object.

We will assume you have a web reference, let us name it SWS, in your Visual Studio project. At this point we need to define our objects. We will need the standard service object, an UpdateRentalSettingsV2 request object, and an UpdateRentalSettings response object. We can define and create those like this:

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

Here is a sample code of the request object:

// UpdateRentalSettingsV2_Request
request.RentalId = 123546;
request.TaxExempt = true;
request.TaxInfo = "123456789";
request.TaxExemptExpiration = new DateTime(2020, 9 ,1);

Finally we can call the method and pass across the login object and the request object to retrieve our requested 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.UpdateRentalSettingsV2(user_request, request);
}
catch (Exception ex)
{
  MessageBox.Show(ex.Message);
}

Note that if something goes wrong the service will respond with an exception. You will want to capture the message in the exception so it can be debugged.

For a full list of methods see SWS Methods.

Categories: Account Management, API General, Contacts, Delinquency

SWS GetRefundDetail Method

August 8, 2012 sutiki 3 comments

Retrieves a collection of submitted refunds, with categorized amounts, for specified site(s), for a given time-frame.

Parameters

Name	DataType	Is Required
SiteList	Long	Required
Description	An array of sites from which to retrieve the data, if left undefined it will default to all sites at the organization.
OrgID	Long	Required
Description	The organization’s ID number.
RefundStatusFilter	Integer	Optional
Description	Allows you to filter the return for the types of refunds given. Available values: 1 – Pending Approval 2 – Approved 3 – Denied 4 – Processed 5 – Reset 6 – Credit Fail 7 – System Refund 99 – Cancelled
StartDate	DateTime	Optional
Description	The start date for the date range from which you wish to retrieve the refund details.
EndDate	DateTime	Optional
Description	The end date for the date range from which you wish to retrieve the refund details.

Returned Parameters

Name	DataType
RefundDetail	RefundDetail
Description	The object containing on the details of the refund.

Example

As with every method we need to pass in credentials. We do this with the LookupUser request object.

We’ll assume you have a web reference, let’s name it SWS, in your Visual Studio project. At this point we need to define the objects. We’ll need the standard service object, a Refund request object, and a RefundDetail response object. We can define and create those like this:

// Create request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.Refund_Request request = new SWS.Refund_Request();
SWS.RefundDetail_Response response;

Here’s a sample code of the Request object (including optional parameters):

// GetRefundDetail Request
request.OrgID = 123456;
request.SiteList = new long[] { 123456, 456789 };
request.StartDate = DateTime.Today.AddDays(-1);
request.RefundStatusFilter = new int[] { 1, 2 };

Finally we can call the method and pass across the login object and the request object to retrieve the specified refunds. 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.GetRefundDetail(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 capture the message returned in that exception so it can be debugged.

For a full list of methods see SWS Methods.

Categories: Account Management, API General, Refunds

Newer Entries Older Entries

Yardi Store Developer eXchange

Archive

SWS TerminateServiceV2 Method

Parameters

Returned Parameters

Example

SWS GetPrimaryRentalInfoV2 Method

Parameters

Returned Parameters

Example

SWS UpdateRentalSettingsV2 Method

Parameters

Returned Parameters

Example

SWS GetRefundDetail Method

Parameters

Returned Parameters

Example

Helpful Links

Meta

Tags