Archive
Archive for the ‘References’ Category
PCDItem Reference
November 4, 2016
Leave a comment
Reference for any method using the PCDItem object. This is separate from NewPCDItem
| Name | DataType | Is Required |
|---|---|---|
| PCD | APPL_BEST_PCD | Required |
| Description | Array of information that is used to determine the best PCD to apply to the unit. | |
| Type | Integer | Required |
| Description | The type of PCD being applied to the rental. Available values:
|
|
| Discount | Decimal | Required |
| Description | The amount of the discount. | |
| IsDeepest | Boolean | Optional |
| Description | “Y” if it is the best available discount for the unit, “N” if it is not. | |
| CompatPCDs | APPL_PCD_COMPAT | Not currently used |
| Description | The object giving details about the promotion. | |
Categories: API General, References
APPL_BEST_PCD Reference
November 4, 2016
Leave a comment
Reference for any method using the APPL_BEST_PCD object.
| Name | DataType |
|---|---|
| ALL_SITES | String |
| Description | Indicates if a PCD will apply to all sites at the organization (“Y”) or only to specific sites (“N”). Default value is “Y”. |
| AMT_TYPE | Integer |
| Description | The numeric value that represents the type of discount. |
| AMT_TYPE_VAL | String |
| Description | The PCD amount type. Max string length of 100. |
| BARCODE | Long |
| Description | The barcode value’s number for a PCD coupon. By default this is undefined. |
| COUPON_CODE | String |
| Description | The coupon code for the PCD to store it for newspaper, magazine and promotional pieces. Max string length of 50. |
| CREDIT_LEVEL | Integer |
| Description | The discount’s credit level numeric value that the Store user must have to apply the discount to a rental. Available values:
(These are customized by the organization/site. Contact the site for additional information.) |
| CREDIT_LEVEL_VAL | String |
| Description | The credit level required of the Store user to have in order to grant the discount to a rental item. Max string length of 50. |
| DELINQUENCY_LIMIT | Integer |
| Description | The maximum number of rental cycle periods an account can be delinquent and still receive the discount. |
| EXPIRES | DateTime |
| Description | The date to end a PCD. |
| LIMIT_ACTION | Integer |
| Description | Not used. |
| LIMIT_ACTION_VAL | String |
| Description | Not used. |
| LIMIT_TYPE | Integer |
| Description | Not used. |
| LIMIT_TYPE_VAL | String |
| Description | Not used. |
| LOS_PENALTY | Decimal |
| Description | The numeric value to indicate the amount or percentage penalty to be assessed if the minimum length of stay (LOS) is not met. |
| LOS_PENALTY_TYPE | Integer |
| Description | The numeric value to indication the penalty type, if the minimum length of stay requirement is not met. |
| LOS_PENALTY_TYPE_VAL | String |
| Description | The penalty type if the minimum length of stay requirement is not met. Max string length of 100. |
| LOS_PREPAID | Decimal |
| Description | The numeric value to indicate whether a full or partial pre-payment is required. |
| LOS_REQ | Decimal |
| Description | The minimum number of rental cycle periods that must be paid for to qualify for the discount. |
| ORG_ID | Long |
| Description | The organization’s ID number. |
| PAYMENT_REQUIRED | String |
| Description | Indicates if a payment is required immediately for the promotion to apply (“Y”) or not (“N”). |
| PCD_AMT_DEFAULT | Decimal |
| Description | The default value of the discount, if no alternate is specified. |
| PCD_AMT_MAX | Decimal |
| Description | The maximum discount value that can be applied. |
| PCD_AMT_MIN | Decimal |
| Description | The minimum discount value that can be applied. |
| PCD_CLASS | Integer |
| Description | The numeric value that represents the PCD class. Available values:
|
| PCD_CLASS_VAL | String |
| Description | The PCD class type value. Available values:
|
| PCD_DESC | String |
| Description | The description of the discount as defined by the organization. Max string length of 50. |
| PCD_ID | Long |
| Description | The PCD item’s ID number. |
| PCD_NAME | String |
| Description | The name of the discount as defined by the organization. Max string length of 100. |
| PCD_PERIODS | Integer |
| Description | The number of rental periods the credit is available to be applied. |
| PCD_PRIORITY | Integer |
| Description | The priority level for the discount, if multiple discounts are available for a rental item. For example, the discount with the lowest numeric value will be returned, regardless of the monetary incentive to the customer. |
| PCD_REV_CAT | Integer |
| Description | The numeric value that represents the revenue category. Available values:
Currently no other revenue categories are available for discounts. |
| PCD_REV_CAT_VAL | String |
| Description | The revenue category the PCD applies to. Max string length of 100. |
| STARTS | DateTime |
| Description | The date to start a process. If end date is provided, then it is the start date of a range of dates. |
| TRANSFERABLE | String |
| Description | Indicates if the PCD can apply to the new unit of a rental transfer (“Y”) or only to the original rental (“N”). Default value is “Y”. |
Categories: API General, References
NewPCDItem Reference
November 4, 2016
Leave a comment
Reference for any method using the PCDItem object.
| Name | DataType | Required |
|---|---|---|
| PCD_ID | Long | Required |
| Description | The system generated ID of the PCD you are applying. | |
| EffDate | dateTime | Optional |
| Description | The date the PCD starts. | |
| EndDate | dateTime | Optional |
| Description | The date the PCD ends. | |
| DiscountAmount | Decimal | Required |
| Description | The amount of the PCD that will be applied. | |
| ReasonCode | Integer | Required |
| Description |
The reason codes will always be 1 unless otherwise specified by the organization. |
|
| ReasonDescription | String | Optional |
| Description | The description of the ReasonCode value. | |
| RevenueCategory | Integer | Required |
| Description | The revenue class to which the PCD will apply. Currently the only option is RentalItem which is 1. | |
| IsPromoDiscCredit | PCDType | Required |
| Description | The type of PCD that is being applied. Available values:
|
|
Categories: API General, References
Autopay Payment Information Reference
November 3, 2016
Leave a comment
Reference for any method using the APCreditCardData or APACHData objects.
APACHData
| Name | DataType | Is Required |
|---|---|---|
| AccountNumber | Long | Required |
| Description | The account number for the ACH payment. Will be masked if it is a returned item. Max length of 50. | |
| RoutingNumber | String | Required |
| Description | The ACH account routing number. Routing number must be 9 digits long. | |
APCreditCardData
| Name | DataType | Is Required |
|---|---|---|
| CardHolderName | String | Required |
| Description | The credit cardholder’s name as it appears on the card. Max string length of 50. | |
| CardNumber | String | Required |
| Description | The credit card’s account number. It will be masked if it is a returned item. Max String length of 25. | |
| CVV2 | String | Required |
| Description | The credit card’s Card Verification Value (CVV). Max string length of 10. | |
| Exp | String | Required |
| Description | The expiration date of the card in the format of MM/YYYY. | |
Categories: API General, References
Yardi Store Developer eXchange 