Archive

Posts Tagged ‘Reports’

SWS WalkThruList Method

May 23, 2011 Leave a comment

Retrieves the list of all rental items at a site, both rented and available. This will list the items in the order set by the admin as the walk thru order. This is primarily used to inspect the property and add or remove overlocks on units as determined by the delinquency schedule.

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
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.
ATTRIBUTE01 String
Description The textual value for the “Attribute01” custom lookup as defined by the site. See eUnitAttr01 for the available values.
DAYS_LATE String
Description The number of days that the rental item’s payment is past due.
DEL_STEP Decimal
Description The current delinquency step of the rental item.
DIM String
Description The width and depth measurements of the unit.
ORG_NUMBER_XREF String
Description The sites number as assigned by the admin. This is not the site ID.
OVERLOCK_STATUS_VAL String
Description The current overlock status of the rental.
Available values:

  • PO – Pending Overlock
  • O – Overlocked
  • PR – Pending Removal

If the unit is not overlocked this will be null.
PTD DateTime
Description The date the unit is paid thru.
RENT_RATE Decimal
Description The current rent rate of the unit.
RENTAL_ID Long
Description The rental item’s ID number. This is returned when using the MakeReservation method or can be searched for using the SearchBy method.
RENTAL_START_DATE DateTime
Description The date the customer started their rental.
SITE_ID Long
Description The site’s ID number. This can be found using the GetSiteList method.
SITE_NAME String
Description The name of the site to which the unit belongs.
STATUS Integer
Description The status of the rental.
Common values:

  • 0 – Current
  • 1 – Delinquent
  • 100 – In-Process
  • 101 – Reserved
SUM_DAYS_LATE Decimal
Description The number of days that the rental item’s payment is past due.
UNIT_ID Long
Description The unit’s ID number. This is maintained through rentals.
UNIT_NUM_SORT Long
Description The sort order for the rental items at the site.
UNIT_NUMBER String
Description The unit’s number as assigned by the organization. This is not the UnitID.
UNIT_STATUS_VAL Integer
Description The rental status of the unit.
WALK_THRU_ORDER Integer
Description The number indicating what order the unit is, in the list.

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

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

Here is a sample code of the request object:

// WalkThruList Request
request.SiteID = 123546;

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.WalkThruList(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: API General, Reports, Site Administration Tags:

SWS GetRetailReceiptItems Method

May 23, 2011 Leave a comment

Retrieves the list of assessments for a specific transaction ID for retail sales only.

Parameters

Name Data Type Is Required
SiteID  Long  Required
Description  The site’s ID. This can be found using the GetSiteList method.
TransactionID  Long Required
Description The transaction’s ID number. Transaction IDs are system generated for each payment transaction that occurs in the system. If there is no transaction ID the transaction failed. The transaction ID is returned when any MakePayment method is used.

Returned Parameters

 Name Data Type
TNX_ID Long
Description The transaction’s ID number. Transaction IDs are system generated for each payment transaction that occurs in the system. A null or “0” response indicates the transaction failed.
SITE_ID Long
Description The site’s ID number.
ACCT_ID Long
Description The account’s ID associated with the transaction.
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 Integer
Description A numerical value identifying the type of account.
Available values:

  • 1 – Personal
  • 2 – Business
RETAIL_ID Long
Description The ID of the retail item.
TNX_DETAIL_ID Long
Description The ID of the transaction detail
RETAIL_OBJECT_ID Long
Description The ID of the individual retail object.
TNX_DATE DateTime
Description The date of the transaction.
AMT Decimal
Description The amount of the transaction.
ITEM_PRICE Decimal
Description The price of the item.
TAX_CHARGED String
Description Indicates if tax was charged (“Y”) or not (“N”). Default is “Y”.
TAX Decimal
Description The amount of tax that was charged.
EXTENDED Decimal
Description The extended amount.
FULFILLED Decimal
Description The fulfilled amount.
ASS_ID Long
Description The assessment ID.
ASS_REF Long
Description The assessment reference number.
ICON String
Description The processed function for the transaction.
CLASS_DESC String
Description The description of the retail class.
ITEM_NAME String
Description The name of the item.
DESCRIPTION String
Description The description of the item sold.
QTY Decimal
Description The quantity of the item sold.
RETURNED Decimal
Description A numerical value displaying whether the item is returned.
PART_NUMBER String
Description The part number of the item.
SKU String
Description The individual SKU of the item sold.
BARCODE String
Description A numerical value assigned for an item type.
ITEM_TYPE Integer
Description The ID assigned to the tax group.
TAX_GROUP_ID Decimal
Description The ID for the tax group applicable to the retail revenue class.
STATUS Integer
Description A numerical value for the status of the transaction.

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

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

Here’s my sample code of the Request object.

// GetRetailReceiptItems Request
request.SiteID = 123456;
request.TransactionID = 123456;

Finally we can call the method and pass across the login object and the request object to get items for our retail receipt. 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.GetRetailReceiptItems(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, Receipts, Reports, Retail/Merchandise Tags: ,

SWS GetRentalLedger Method

May 23, 2011 1 comment

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

Parameters

Name DataType Is Required
AccountID Long Required
Description The account’s ID for which you wish to retrieve the data. This is returned when you use the CreateNewAccount method or can be retrieved with the SearchBy method.
EndDate DateTime Optional
Description The end date of the date range for which you wish to retrieve the data. This will default to today if left undefined.
RentalID Long Optional
Description The rental item’s ID number. This will allow you to specify which rental if the account has more than one rental. This is returned when using the MakeReservation method or can be searched for using the SearchBy method.
StartDate DateTime Optional
Description The start date of the date range for which you wish to retrieve the data. This will default to today if left undefined.
TransactionID Long Optional
Description The transaction’s ID number. Transaction IDs are system generated for each payment transaction that occurs in the system. If there is no transaction ID the transaction failed. The transaction ID is returned when any MakePayment method is used.

Returned Parameters

Name DataType
ACCT_ID Long
Description The account’s ID number.
ADDR_ID String
Description The rental contact’s address ID number.
ASS_DATE DateTime
Description The date and time the assessment was applied to the account.
ASS_ID Decimal
Description The assessment’s ID number.
CHILD_RENTAL_ID String
Description The rental ID for the service or insurance assessment that belongs to this rental.
CLASS_REF Decimal
Description The GL account’s class reference number.
CONTACT_ID String
Description The rental contact’s ID number.
CREATED DateTime
Description The date the ledger item was created.
CREATED_BY Long
Description The user’s ID number that created the ledger item.
CREATED_NAME String
Description The name of the person who created the ledger item. This is the textual value of the CREATED_BY data.
DESCRIP String
Description A description of the ledger item.
EXTENDED Decimal
Description The total amount of the assessment after quantities have been applied.
GL Decimal
Description The GL account’s reference number.
GL_DESC String
Description The GL account’s name.
GL_MAP String
Description The GL account’s reference number.
ITEM_PRICE Decimal
Description The amount to be charged for the assessment.
LASTFOUR String
Description The last four digits of the credit card number if the transaction was a credit card payment.
OBJ_NAME String
Description The name of the item assessed to the account.
PARENT_ASS_ID Decimal
Description The rental ID for the rental that owns this assessment.
PAY_AMT Decimal
Description The portion of the payment that was applied to the specific rental’s ledger.
PAY_REF String
Description The payment type payment type, if transaction is a payment.
QTY Decimal
Description The total number of items that were assessed.
REF_TYPE Integer
Description The numeric value for the assessment type.
RENTAL_ID Decimal
Description The rental item’s ID number.
SITE_ID Long
Description The site’s ID number.
STATUS Integer
Description The numeric value of the transaction’s status.
STATUS_VAL String
Description The alpha-numeric description of the transaction’s status.
TAX Decimal
Description The required tax amount, if the ledger item is not tax exempt.
TNX_DATE DateTime
Description The date the transaction occurred.
TNX_DETAIL_ID Decimal
Description The ID number for the transaction’s detail row.
TNX_ID Decimal
Description The transaction’s ID number. Transaction IDs are system generated for each payment transaction that occurs in the system. A null or “0” response indicates the transaction failed.
TRAN_TYPE_VALUE Decimal
Description The numeric value of the transaction type.
TRANSACTION_TYPE String
Description The textual value of the transaction type.
VOIDSTAT String
Description Indicates if the assessment can still be voided. This is only applicable to fees, insurance and services. Taxes will show as “Pending” (eligible for voiding) but are not voidable. A tax exempt number must be applied to the rental.

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.

Categories: Accounting, API General, Payments, Rental/Reservation, Reports Tags: , , ,