swsLtrParams Reference
Reference for any method using the swsLtrParams object.
Parameters
| Name | DataType | Is Required |
|---|---|---|
| siteId | Long | Required |
| Description | The sites id number. This can be found using the GetSiteList method. | |
| acctId | Long | Optional* |
| Description | The accounts ID number. This is returned when you use the CreateNewAccount method or can be retrieved with the SearchBy method. *Either account ID or rental ID is required. |
|
| rentalId | Long | Optional* |
| Description | The rentals ID number. This is returned when using the MakeReservation method or can be searched for using the SearchBy method. *Either account ID or rental ID is required. |
|
| unitNum | String | Optional |
| Description | The unit’s number as assigned by the organization. This is not the UnitID. This can be found using any version of GetSiteUnitData method or if it is an already rented item from the GetRentalInfo method. | |
| ltrTypeId | Long | Required |
| Description | The system generated id for the letter you wish to generate. This can be retrieved with the getLetterTemplateInfo method. | |
| siteLtrRule | String | Optional |
| Description | Tells the system to what letter template group the letter belongs. Available values:
|
|
| isMailLocal | Boolean | Optional |
| Description | Indicates if the letter will be printed and mailed by the site (“True”) or if will be processed through centralized mail (“False”). | |
| isCOM | Boolean | Optional |
| Description | Indicates if this is Certificate of Mail or not. Please see the USPS website for information regarding Certified mail vs. Certificate of mail. |
|
| certifiedType | String | Optional |
| Description | Indicates to the system if this is a Certified letter and if you want it with a receipt number or not. Available values:
Please see the USPS website for information regarding Certified Mail vs. Certificate of Mail. |
|
| contactType | String | Optional |
| Description | Indicates which contact on the account, the letter is to be sent. Available values:
|
|
| contactOrAddrId | Long | Optional |
| Description | Indicates the address id or the contact id to which you wish to send the letter. | |
Categories: API General, References
Comments (0)
Trackbacks (0)
Leave a comment
Trackback
Yardi Store Developer eXchange 