Archive

Archive for the ‘References’ Category

SOA_GET_ASSESSMENTS Reference

November 2, 2016 Leave a comment

Reference for methods using the SOA_GET_ASSESSMENTS object.

Name DataType
ACCT_ID Long
Description The account’s ID number. This is returned when you use the CreateNewAccount method or can be retrieved with the SearchBy method.
ASSESS_DATE DateTime
Description The date the assessment occurred.
ASSESS_END DateTime
Description The end date of the assessment period.
ASSESS_ID Long
Description The assessment’s ID number.
ASSESS_START DateTime
Description The start date of the assessment period.
CLASS_REF Integer
Description The GL account’s class reference number.
DESCRIP String
Description A brief description of the assessment type. Max string length 200.
EXTENDED Decimal
Description The total amount of the assessments base cost after quantities have been applied.
FULFILL Decimal
Description The amount that has been paid for the assessment type.
ITEM_PRICE Decimal
Description The amount to be charged for the assessment type.
QTY Decimal
Description The total number of items to be assessed.
REF_TYPE Integer
Description A numeric value for the assessment type.
REF_TYPE_VAL String
Description The assessment type’s value. Max string length of 100.
RENTAL_ID Decimal
Description The rental item’s ID number.
RO_VERSION Decimal
Description The rental items assessment version.
SITE_ID Long
Description The site’s ID number. This can be found using the GetSiteList method.
TAX_DUE Decimal
Description The total amount of tax due on the assessments.
TAX_GROUP_ID Decimal
Description The tax group’s ID number.
VERSION Integer
Description The unit’s version number which serves to prevent duplicate use of the unit.
Categories: API General, References

TRAN_RENTALS Reference

October 28, 2016 Leave a comment

Reference for any method using the TRAN_RENTALS object.

Name DataType
ACCT_ID Long
Description The account’s ID number. This is returned when you use the CreateNewAccount method or can be retrieved with the SearchBy method.
ATD DateTime
Description The assessed-thru-date (ATD) for the rental item.
CREATED DateTime
Description The creation date and time.
CREATED_BY Long
Description The Store user’s ID that created the field.
DAILY_DEL_DATE DateTime
Description Not used.
DB_CREATE Decimal
Description Not used.
DB_UPDATE Decimal
Description Not used.
DEL_EXEMPT Boolean
Description “True” if rental item is exempt from delinquency, “False” if not.
DEL_SCHEDULE Long
Description The site’s delinquency schedule ID number.
DEL_STEP Integer
Description The current delinquency step for the rental item.
EMAIL_CC Boolean
Description “True” if customer wants to receive email notifications, “False” if not.
EMAIL_SERV_ID Long
Description The email service type provided by the organization.
END_DATE DateTime
Description The date to end a process. If start date is provided, then it is the end date of a range of dates. Technically, it’s one day beyond the end date. This defaults to today’s date if left undefined.
LEGACY_REF_ID String
Description The Store 3.1 rental item’s ID number, if it was transferred from Store 3.1.
LTD DateTime
Description The lease-thru-date (LTD).
MAIL_SERV_ID Long
Description The postal service type provided by the organization.
MO_DATE DateTime
Description The scheduled date of the move-out.
MO_NOTICE_DATE DateTime
Description The mailing date of the move-out notice.
OBJECT_ID Long
Description The rental object’s ID number.
OBJECT_TYPE Integer
Description The numeric value for the rental item type.
Most common values:

  • 1 – Rental Object
  • 3 – Insurance
  • 4 – Service
  • 5 – Fee Item
  • 6 – Reservation/Quote Deposit
  • 10 – Retail Item
  • 11 – Tax
OVERLOCK_STATUS Integer
Description The over-lock status number, if the rental item has had or is about to be locked, from customer access.
Available values:

  • 0 – Not Overlocked
  • 1 – Pending Overlock
  • 2 – Overlocked
  • 3 – Pending Lock Removal
PARENT_RENTAL_ID Long
Description The rental item’s ID number.
PER_END_DAY Integer
Description The rental period’s end day.
PTD DateTime
Description The paid-thru-date (PTD).
RENTAL_ID Long
Description The rental item’s ID number.
START_DATE DateTime
Description The date to start a process. If end date is provided, then it is the start date of a range of dates.
STATUS Integer
Description The numeric value for the “Status” custom look up as defined by the site. See eUnitStatus for the available values.
TAX_EXEMPT Integer
Description “1” if rental item is exempt from tax, “0” if not.
TAX_EXEMPT_INFO String
Description The tax exempt ID number and other data related to the tax exempt status.
TRANSFER_TO_ID Long
Description The rental item’s ID number that was transferred into.
UPDATED DateTime
Description The updated date and time.
UPDATED_BY Long
Description The Store user’s ID number that last updated the field.
VERSION Integer
Description The unit’s version number which serves to prevent duplicate use of the unit.
Categories: API General, References

TRAN_FIU_DATA Reference

October 28, 2016 Leave a comment

Reference for any method returning the TRAN_FIU_DATA object.

Name DataType
ABBREVIATED_NAME String
Description The site’s abbreviated name.
BATCH_ID Long
Description The FIU batch ID number for resetting the GL data, if necessary.
CLASS_REF Integer
Description The GL account’s class reference number.
CR Decimal
Description The credit amount to the GL account.
CREATED_BY Long
Description The Store user’s username that created the field.
DR Decimal
Description The debit amount to the GL account.
GL Integer
Description Store’s GL account’s reference number.
GL_MAP String
Description The site’s GL account’s reference number.
INT_FLAG Integer
Description The flag integer indicating the GL account’s posting status.
INT_VALUE String
Description The flag integer value indicating the GL account’s posting status.
ORG_ID Long
Description The organization’s ID number.
ORG_NUMBER_XREF String
Description The site number.
POST_DATE DateTime
Description The posting date of the FIU transaction.
POST_ID Long
Description The FIU grid list’s ID number.
SITE_DESC String
Description The site’s description of the GL account.
SITE_ID Long
Description The site’s ID number.
SOURCE_REF Integer
Description The GL posting’s source reference number.
SOURCE_VALUE String
Description The GL account’s source value.
UPDATED DateTime
Description The updated date and time.
UPDATED_BY Long
Description The Store user’s ID number that last updated the field.
Categories: API General, References

RefundDetail Reference

October 27, 2016 Leave a comment
Name DataType
SiteNumber String
Description The site’s number as defined by the site administrator. This is not the site ID number.
AccountName 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.
AccountNumber Long
Description The AutoPay, debit/credit card, ACH, checking or savings account number. This is required for new AutoPay ACH setups.
PhoneNumber String
Description The phone number.
PhoneType String
Description The type of phone number.
Available values:

  • HOME
  • OFFICE
  • MOBILE
  • FAX
  • OTHER
Address1 String
Description The first line of the address.
Address2 String
Description The second line of the address.
Address3 String
Description The third line of the address.
City String
Description The city for the address.
PostalCode String
Description The postal/ZIP code for the address.
State String
Description The state/province for the address.
ApprovedDate DateTime
Description The date the refund was approved.
InsuranceRefund Decimal
Description The rental insurance refund amount that was overpaid due to vacating the rental earlier than expected.
OtherRefund Decimal
Description The refund amount that does not fall under any other category and was overpaid due to vacating the rental earlier than expected.
RefundNotes String
Description The free text refund note, usually created by the site manager that approves refunds.
RegionalApprovedBy String
Description The Store user’s name that approved the refund.
RentRefund Decimal
Description The rental item’s refund amount that was overpaid due to vacating the rental item (unit) earlier than expected.
RetailRefund Decimal
Description The retail refund amount that was associated with the rental payment, if applicable.
ServiceRefund Decimal
Description The rental services refund amount that was overpaid due to vacating the rental item (unit) earlier than expected.
SitePerson String
Description The Store user’s name that initiated the refund process.
TaxRefund Decimal
Description The rental taxes refund amount that was overpaid due to vacating the rental item (unit) earlier than expected.
TodaysDate DateTime
Description The current date.
TotalRefundAmount Decimal
Description The refund amount is automatically calculated by the Store application, based on the Refund rules for the site. This is from the CancelReservation SWS method.
TransactionNumber Long
Description The transaction’s ID number.Transaction IDs are system generated for each payment transaction that occurs in the system.
Units String
Description The unit’s number as assigned by the organization associated with the refund. This is not the UnitID.
VacateDate DateTime
Description The date the rental item was vacated.
Categories: API General, References