RULE_VALUES Reference
Reference for methods using the RULE_VALUES object.
| Name | DataType |
|---|---|
| ABLE_INVOKED | String |
| Description | “Y” if the invoked icon should show next to the rule in the Org rules form in Store, “N” if it should not. |
| ACTIVE | String |
| Description | “Y” if the rule is currently “Active”, “N” if it is not. |
| CLASS_VALUE | String |
| Description | The type of object the rule applies to. |
| CONFIG_ID | Decimal |
| Description | The rule value’s ID number. |
| CREATED_BY | Long |
| Description | The Store user’s ID that created the field. |
| DEP_RULE_ID | Decimal |
| Description | The dependent rule’s ID number. For example, if the Auto-Reconcile Cash rule is set to “True”, there are three child rules that are ignored. |
| DEP_VALUE | String |
| Description | The parent rule’s name, if applicable. |
| DESCRIPTION | String |
| Description | A brief description of the item type. |
| DISP_ORDER | Integer |
| Description | The numeric value of the display order for the end rental rules. |
| DISPLAY | String |
| Description | The rule’s display values. |
| ENTITY_NAME | String |
| Description | The org or site name, depending on whether the rule is an Org or Site level rule. |
| LOOKUP_IS_VIRTUAL | Boolean |
| Description | “True” if the lookup is a virtual lookup, “False” if not. |
| LOOKUP_SET | Decimal |
| Description | The lookup ID number. |
| LOOKUP_USED | Boolean |
| Description | “True” if the values are lookups from the cfg_lookups table, “False” if not. |
| NEG_ONE_MEANING | String |
| Description | The value to display in the default value field if no default value is set. |
| PARENT_ID | Long |
| Description | The parent ID number of the site or organization owning the rule. |
| RULE_CLASS | Decimal |
| Description | The numeric value for the category the rule belongs to. |
| RULE_ID | Long |
| Description | The rule’s ID number. |
| RULE_LEVEL | String |
| Description | “Org” or “Site” to indicate what level the rule originates. |
| RULE_NAME | String |
| Description | The rule’s name. |
| RULE_TYPE | Integer |
| Description | The rule type. |
| SITE_VALUE | String |
| Description | The numeric value assigned to the rule. |
| SITE_VALUE_MEANING | String |
| Description | The textual value, if different from the actual value. (I.E., A site has a penalty for vacating without notification. A SITE_VALUE of 4 would indicate that the customer would have a ‘percentage’ penalty of their rent for vacating without notice. The SITE_VALUE would be 4, the SITE_VALUE_MEANING would be ‘% of Refund Penalty’.) |
| UPDATED_BY | Long |
| Description | The Store user’s ID number that last updated the field. |
| VALUE_DATATYPE | Integer |
| Description | A numeric value for the data type of the rule. |
| VALUE_DEFAULT | String |
| Description | The default value of the rule. |
| VALUE_DEFAULT_MEANING | String |
| Description | A textual description of the default value rule. |
| VALUE_IS_REFERENCE | Boolean |
| Description | “True” if the value is a reference to another rental item, “False” if not. |
| VALUE_LEN | Integer |
| Description | The maximum number of characters allowed, if the is a string. |
| VALUE_MAX | Decimal |
| Description | The maximum amount of the value if the value is numeric. |
| VALUE_MIN | Decimal |
| Description | The minimum amount of the value if the value is numeric. |
| RULE_VALUES | RULE_VALUES |
| Description | The rule display. If there is a subset of a rule, this will populate the rule values of that subset. |
Categories: API General, Lookups, Rules
Comments (0)
Trackbacks (0)
Leave a comment
Trackback
Yardi Store Developer eXchange 