inc/rentchrg.i

   1 &ANALYZE-SUSPEND _VERSION-NUMBER UIB_v8r12
   2 &ANALYZE-RESUME
   3 &ANALYZE-SUSPEND _UIB-CODE-BLOCK _CUSTOM _DEFINITIONS Method-Library
   4 /*--------------------------------------------------------------------------
   5     File        : inc/rentchrg.i
   6     Purpose     : Common functions for handling rent charge structures
   7
   8     Person              Date    Change
   9     ======           =========  ============================================
  10     Tyrone McAuley   5/12/1997  Written
  11     Andrew McMillan  15/5/1998  Severely hacked until it actually works!
  12     Andrew McMillan  16/7/1998  Added RentCharge-Outgoings functionality for AmTrust
  13     Andrew McMillan  9/9/1998   Added 'rent-charge-one-period' option which is used
  14                                 by some callers to tell the program to charge a single
  15                                 month ignoring whether it's already charged.
  16     Andrew McMillan  12/4/2000  Added 'show-override-descriptions' option which is
  17                                 used by the rental advice program to get all descriptions.
  18     Andrew McMillan  12/4/2000  Added 'use-past-charges' option which lets you calculate
  19                                 charges as they were As At some time past.
  20   ------------------------------------------------------------------------*/
  21
  22 DEF VAR annual-outgoings-charges AS DEC NO-UNDO.
  23 DEF VAR rent-charge-one-period AS LOGI NO-UNDO INITIAL No.
  24 DEF VAR allow-past-leases AS LOGI NO-UNDO INITIAL No.
  25 DEF VAR show-override-descriptions AS LOGI NO-UNDO INITIAL No.
  26 DEF VAR check-lease-inclusion AS LOGI NO-UNDO INITIAL No.
  27 DEF VAR use-past-charges AS LOGI NO-UNDO INITIAL No.
  28
  29 DEF TEMP-TABLE ChargeDetail NO-UNDO
  30   FIELD Sequence      AS INT
  31   FIELD TenantCode    LIKE Tenant.TenantCode
  32   FIELD ChargeType    LIKE RentChargeType.RentChargeType
  33   FIELD Description   LIKE RentCharge.Description
  34   FIELD ChargeSeq     LIKE RentCharge.Sequence
  35   FIELD ChargeStart   LIKE RentChargeLine.StartDate
  36   FIELD ChargeAmount  LIKE RentChargeLine.Amount
  37   FIELD AnnualAmount  LIKE RentChargeLine.Amount
  38   FIELD PeriodFraction  AS DECIMAL
  39   FIELD TaxableAmount LIKE RentChargeLine.Amount
  40   FIELD EntityType    LIKE AcctTran.EntityType
  41   FIELD EntityCode    LIKE AcctTran.EntityCode
  42   FIELD AccountCode   LIKE AcctTran.AccountCode
  43   FIELD AreaDescription LIKE TenancyLease.AreaDescription
  44   FIELD TenancyLeaseCode LIKE TenancyLease.TenancyLeaseCode
  45   FIELD ChargedFrom   AS DATE
  46   FIELD ChargedUpTo   AS DATE
  47   FIELD ChargeEnd     LIKE RentChargeLine.EndDate
  48
  49   INDEX ChargeDetail IS PRIMARY
  50     TenantCode
  51     TenancyLeaseCode
  52     ChargeType
  53     EntityType
  54     EntityCode
  55     AccountCode
  56     Sequence /*
  57   INDEX XAKRentCharge IS UNIQUE
  58     TenancyLeaseCode
  59     ChargeSeq */ .
  60
  61 DEF VAR charge-detail-seq AS INT NO-UNDO.
  62
  63 {inc/ofc-this.i}
  64 {inc/ofc-set.i "RentCharge-Outgoings" "og-method"}
  65 IF NOT AVAILABLE(OfficeSetting) THEN og-method = "".
  66 {inc/ofc-set.i "RentCharge-OG-By-Lease" "charge-og-lease"}
  67 IF NOT AVAILABLE(OfficeSetting) THEN charge-og-lease = "Yes".
  68 IF NOT AVAILABLE(OfficeSetting) THEN og-method = "".
  69 {inc/ofc-set-l.i "RentCharge-PartMonth-Annual" "part-month-annual"}
  70 IF NOT AVAILABLE(OfficeSetting) THEN part-month-annual = Yes.
  71
  72 {inc/ofc-set.i "GST-Types-Never" "gst-types-never"}
  73 {inc/ofc-set.i "GST-Types-Always" "gst-types-always"}
  74
  75 /* _UIB-CODE-BLOCK-END */
  76 &ANALYZE-RESUME
  77
  78
  79 &ANALYZE-SUSPEND _UIB-PREPROCESSOR-BLOCK
  80
  81 /* ********************  Preprocessor Definitions  ******************** */
  82
  83 &Scoped-define PROCEDURE-TYPE Method-Library
  84 &Scoped-define DB-AWARE no
  85
  86
  87
  88 /* _UIB-PREPROCESSOR-BLOCK-END */
  89 &ANALYZE-RESUME
  90
  91
  92 /* ************************  Function Prototypes ********************** */
  93
  94 &IF DEFINED(EXCLUDE-can-commit-charge) = 0 &THEN
  95
  96 &ANALYZE-SUSPEND _UIB-CODE-BLOCK _FUNCTION-FORWARD can-commit-charge Method-Library
  97 FUNCTION can-commit-charge RETURNS LOGICAL
  98   ( INPUT lease-code AS INT, INPUT sequence-code AS INT, INPUT start-date AS DATE )  FORWARD.
  99
 100 /* _UIB-CODE-BLOCK-END */
 101 &ANALYZE-RESUME
 102
 103 &ENDIF
 104
 105 &IF DEFINED(EXCLUDE-get-annual-outgoings) = 0 &THEN
 106
 107 &ANALYZE-SUSPEND _UIB-CODE-BLOCK _FUNCTION-FORWARD get-annual-outgoings Method-Library
 108 FUNCTION get-annual-outgoings RETURNS DECIMAL
 109   ( INPUT lease-code AS INT )  FORWARD.
 110
 111 /* _UIB-CODE-BLOCK-END */
 112 &ANALYZE-RESUME
 113
 114 &ENDIF
 115
 116 &IF DEFINED(EXCLUDE-not-can-action-rent-review) = 0 &THEN
 117
 118 &ANALYZE-SUSPEND _UIB-CODE-BLOCK _FUNCTION-FORWARD not-can-action-rent-review Method-Library
 119 FUNCTION not-can-action-rent-review RETURNS LOGICAL
 120   ( INPUT lease-code AS INT, INPUT sequence-code AS INT, INPUT start-date AS DATE )  FORWARD.
 121
 122 /* _UIB-CODE-BLOCK-END */
 123 &ANALYZE-RESUME
 124
 125 &ENDIF
 126
 127
 128 /* *********************** Procedure Settings ************************ */
 129
 130 &ANALYZE-SUSPEND _PROCEDURE-SETTINGS
 131 /* Settings for THIS-PROCEDURE
 132    Type: Method-Library
 133    Allow:
 134    Frames: 0
 135    Add Fields to: Neither
 136    Other Settings: CODE-ONLY
 137  */
 138 &ANALYZE-RESUME _END-PROCEDURE-SETTINGS
 139
 140 /* *************************  Create Window  ************************** */
 141
 142 &ANALYZE-SUSPEND _CREATE-WINDOW
 143 /* DESIGN Window definition (used by the UIB)
 144   CREATE WINDOW Method-Library ASSIGN
 145          HEIGHT             = 20.45
 146          WIDTH              = 35.57.
 147 /* END WINDOW DEFINITION */
 148                                                                         */
 149 &ANALYZE-RESUME
 150
 151 &ANALYZE-SUSPEND _UIB-CODE-BLOCK _CUSTOM _INCLUDED-LIB Method-Library
 152 /* ************************* Included-Libraries *********************** */
 153
 154 {inc/date.i}
 155
 156 /* _UIB-CODE-BLOCK-END */
 157 &ANALYZE-RESUME
 158
 159
 160
 161
 162
 163 &ANALYZE-SUSPEND _UIB-CODE-BLOCK _CUSTOM _MAIN-BLOCK Method-Library
 164
 165
 166 /* ***************************  Main Block  *************************** */
 167
 168 /* _UIB-CODE-BLOCK-END */
 169 &ANALYZE-RESUME
 170
 171
 172 /* **********************  Internal Procedures  *********************** */
 173
 174 &IF DEFINED(EXCLUDE-add-charge-detail) = 0 &THEN
 175
 176 &ANALYZE-SUSPEND _UIB-CODE-BLOCK _PROCEDURE add-charge-detail Method-Library
 177 PROCEDURE add-charge-detail :
 178 /*------------------------------------------------------------------------------
 179   Purpose:
 180 ------------------------------------------------------------------------------*/
 181 DEF INPUT PARAMETER tenant-code    LIKE Tenant.TenantCode             NO-UNDO.
 182 DEF INPUT PARAMETER charge-type    LIKE RentChargeType.RentChargeType NO-UNDO.
 183 DEF INPUT PARAMETER entity-type    LIKE AcctTran.EntityType           NO-UNDO.
 184 DEF INPUT PARAMETER entity-code    LIKE AcctTran.EntityCode           NO-UNDO.
 185 DEF INPUT PARAMETER account-code   LIKE AcctTran.AccountCode          NO-UNDO.
 186 DEF INPUT PARAMETER description    LIKE RentCharge.Description        NO-UNDO.
 187 DEF INPUT PARAMETER lease-code     LIKE TenancyLease.TenancyLeaseCode NO-UNDO.
 188 DEF INPUT PARAMETER area-description LIKE RentCharge.Description      NO-UNDO.
 189 DEF INPUT PARAMETER charge-fraction AS DECIMAL                        NO-UNDO.
 190 DEF INPUT PARAMETER taxable         AS LOGICAL                        NO-UNDO.
 191 DEF INPUT PARAMETER charged-from   AS DATE                            NO-UNDO.
 192 DEF INPUT PARAMETER charged-to     AS DATE                            NO-UNDO.
 193 DEF INPUT PARAMETER freq-units     AS DEC                             NO-UNDO.
 194 DEF INPUT PARAMETER freq-type      AS CHAR                            NO-UNDO.
 195
 196 DEF VAR annual-amount AS DEC NO-UNDO.
 197 DEF VAR period-amount AS DEC NO-UNDO.
 198
 199   IF show-override-descriptions AND AVAILABLE(RentCharge) THEN DO:
 200     IF RentCharge.Description <> "" AND RentCharge.Description <> ? THEN
 201       description = /* RentChargeType.Description + " - " + */ RentCharge.Description.
 202   END.
 203   IF CAN-DO( gst-types-always, charge-type ) THEN taxable = YES.
 204   ELSE IF CAN-DO( gst-types-never, charge-type ) THEN taxable = NO.
 205
 206   IF og-method <> "" AND og-method = RentCharge.RentChargeType
 207                      AND charge-og-lease <> "Charge"
 208   THEN ASSIGN
 209     annual-amount = annual-outgoings-charges
 210     period-amount = ((annual-amount * freq-units) / (IF freq-type = "D" THEN 365 ELSE 12)).
 211   ELSE ASSIGN
 212     period-amount = RentChargeLine.Amount
 213     annual-amount = ((period-amount / freq-units) * (IF freq-type = "D" THEN 365 ELSE 12)).
 214
 215   CREATE  ChargeDetail.
 216   ASSIGN  ChargeDetail.Sequence    = charge-detail-seq
 217           ChargeDetail.TenantCode  = tenant-code
 218           ChargeDetail.ChargeType  = charge-type
 219           ChargeDetail.ChargeSeq   = RentCharge.Sequence
 220           ChargeDetail.ChargeStart = RentChargeLine.StartDate
 221           ChargeDetail.Description = description
 222           ChargeDetail.AreaDescription = area-description
 223           ChargeDetail.EntityType  = entity-type
 224           ChargeDetail.EntityCode  = entity-code
 225           ChargeDetail.AccountCode = account-code
 226           ChargeDetail.TenancyLeaseCode = lease-code
 227           ChargeDetail.ChargeAmount  = ROUND( charge-fraction * period-amount, 2)
 228           ChargeDetail.TaxableAmount = (IF taxable THEN ChargeDetail.ChargeAmount ELSE 0)
 229           ChargeDetail.PeriodFraction= charge-fraction
 230           ChargeDetail.AnnualAmount  = annual-amount
 231           ChargeDetail.ChargedFrom   = charged-from
 232           ChargeDetail.ChargedUpTo   = charged-to
 233           ChargeDetail.ChargeEnd     = RentChargeLine.EndDate.
 234
 235   charge-detail-seq = charge-detail-seq + 1.
 236 END PROCEDURE.
 237
 238 /* _UIB-CODE-BLOCK-END */
 239 &ANALYZE-RESUME
 240
 241 &ENDIF
 242
 243 &IF DEFINED(EXCLUDE-build-daily-charges) = 0 &THEN
 244
 245 &ANALYZE-SUSPEND _UIB-CODE-BLOCK _PROCEDURE build-daily-charges Method-Library
 246 PROCEDURE build-daily-charges :
 247 /*------------------------------------------------------------------------------
 248   Purpose:
 249   Parameters:  <none>
 250   Notes:
 251 ------------------------------------------------------------------------------*/
 252 DEF INPUT PARAMETER tenant-code AS INT NO-UNDO.
 253 DEF INPUT PARAMETER tenant-et AS CHAR NO-UNDO.
 254 DEF INPUT PARAMETER tenant-ec AS INT NO-UNDO.
 255 DEF INPUT PARAMETER lease-code AS INT NO-UNDO.
 256 DEF INPUT PARAMETER lease-desc AS CHAR NO-UNDO.
 257 DEF INPUT PARAMETER lease-tax AS LOGI NO-UNDO.
 258 DEF INPUT PARAMETER start-day AS DATE NO-UNDO.
 259 DEF INPUT PARAMETER stop-day  AS DATE NO-UNDO.
 260
 261 DEF VAR period-fraction  AS DEC NO-UNDO.
 262 DEF VAR taxable-amount AS DEC NO-UNDO.
 263 DEF VAR rent-end-day  AS DATE NO-UNDO.
 264 DEF VAR freq-units AS INT  NO-UNDO.
 265 DEF VAR paid-up-to AS DATE NO-UNDO.
 266 DEF VAR this-pay-date AS DATE NO-UNDO.
 267 DEF VAR next-pay-date AS DATE NO-UNDO.
 268 DEF VAR amount-multiplier AS INT NO-UNDO    INITIAL 1.
 269
 270   freq-units = get-freq-days( RentChargeLine.FrequencyCode ).
 271   IF start-day > stop-day THEN DO:
 272     /* rent-end-day is used as temp variable, but later it's value is correct! */
 273     rent-end-day = start-day.
 274     start-day = stop-day.
 275     stop-day = rent-end-day.
 276     amount-multiplier = -1.
 277   END.
 278   ELSE
 279     rent-end-day = (IF RentChargeLine.EndDate = ? THEN TODAY + 1000000 ELSE RentChargeLine.EndDate).
 280
 281   this-pay-date = start-day.
 282   DO WHILE this-pay-date <= stop-day:
 283     next-pay-date = next-date-after( RentChargeLine.StartDate, this-pay-date + 1, "D", freq-units ).
 284     paid-up-to = MINIMUM( next-pay-date - 1, rent-end-day).
 285
 286     /* This should work right for part-period charges */
 287     period-fraction = (((paid-up-to - this-pay-date) + 1) / freq-units).
 288
 289     RUN add-charge-detail( tenant-code, RentCharge.RentChargeType,
 290             (IF RentCharge.EntityType <> "" THEN RentCharge.EntityType ELSE tenant-et ),
 291             (IF RentCharge.EntityType <> "" THEN RentCharge.EntityCode ELSE tenant-ec ),
 292             (IF CAN-FIND( FIRST ChartOfAccount OF RentCharge ) THEN RentCharge.AccountCode ELSE RentChargeType.AccountCode),
 293             (IF RentCharge.RentChargeType <> "S" THEN RentChargeType.Description ELSE RentCharge.Description ),
 294             lease-code, lease-desc, amount-multiplier * period-fraction,
 295             lease-tax, this-pay-date, paid-up-to, freq-units, "D" ).
 296
 297     this-pay-date = next-pay-date.
 298
 299     IF rent-charge-one-period THEN this-pay-date = stop-day + 1.
 300   END.
 301
 302 END PROCEDURE.
 303
 304 /* _UIB-CODE-BLOCK-END */
 305 &ANALYZE-RESUME
 306
 307 &ENDIF
 308
 309 &IF DEFINED(EXCLUDE-build-monthly-charges) = 0 &THEN
 310
 311 &ANALYZE-SUSPEND _UIB-CODE-BLOCK _PROCEDURE build-monthly-charges Method-Library
 312 PROCEDURE build-monthly-charges :
 313 /*------------------------------------------------------------------------------
 314   Purpose:  Build monthly charges
 315 ------------------------------------------------------------------------------*/
 316 DEF INPUT PARAMETER tenant-code AS INT NO-UNDO.
 317 DEF INPUT PARAMETER tenant-et AS CHAR NO-UNDO.
 318 DEF INPUT PARAMETER tenant-ec AS INT NO-UNDO.
 319 DEF INPUT PARAMETER lease-code AS INT NO-UNDO.
 320 DEF INPUT PARAMETER lease-desc AS CHAR NO-UNDO.
 321 DEF INPUT PARAMETER lease-tax AS LOGI NO-UNDO.
 322 DEF INPUT PARAMETER start-day AS DATE NO-UNDO.
 323 DEF INPUT PARAMETER stop-day  AS DATE NO-UNDO.
 324
 325 DEF VAR period-fraction AS DEC NO-UNDO.
 326 DEF VAR taxable-amount AS DEC NO-UNDO.
 327 DEF VAR rent-end-day  AS DATE NO-UNDO.
 328 DEF VAR freq-units AS INT  NO-UNDO.
 329 DEF VAR description AS CHAR NO-UNDO.
 330 DEF VAR paid-up-to AS DATE NO-UNDO.
 331 DEF VAR this-pay-date AS DATE NO-UNDO.
 332 DEF VAR next-pay-date AS DATE NO-UNDO.
 333 DEF VAR amount-multiplier AS INT NO-UNDO    INITIAL 1.
 334
 335   freq-units = get-freq-months( RentChargeLine.FrequencyCode ).
 336   IF start-day > stop-day THEN DO:
 337     /* rent-end-day is used as temp variable, but later it's value is correct! */
 338     rent-end-day = start-day.
 339     start-day = stop-day.
 340     stop-day = rent-end-day.
 341     amount-multiplier = -1.
 342   END.
 343   ELSE
 344     rent-end-day = (IF RentChargeLine.EndDate = ? THEN TODAY + 1000000 ELSE RentChargeLine.EndDate).
 345
 346   this-pay-date = start-day.
 347   DO WHILE this-pay-date <= stop-day:
 348     IF freq-units = 1 THEN
 349       next-pay-date = next-date-after( DATE(MONTH(this-pay-date), 1, YEAR(this-pay-date)), this-pay-date + 1, "M", freq-units ).
 350     ELSE
 351       next-pay-date = next-date-after( this-pay-date, this-pay-date + 1, "M", freq-units ).
 352
 353     paid-up-to = MINIMUM( next-pay-date - 1, rent-end-day).
 354
 355     IF part-month-annual THEN
 356       period-fraction = ((paid-up-to - this-pay-date + 1) / 365 ) * 12.
 357     ELSE
 358       period-fraction = ((paid-up-to - this-pay-date + 1) / month-days(paid-up-to) ).
 359
 360     IF period-fraction < 0 THEN        period-fraction = 0.
 361     ELSE IF period-fraction > 1 THEN   period-fraction = 1.
 362     IF DAY(this-pay-date) = 1 AND paid-up-to = last-of-month(paid-up-to) THEN period-fraction = 1.
 363
 364     IF freq-units > 1 THEN DO:
 365       period-fraction = 1.
 366     END.
 367     ELSE IF period-fraction <> 1 AND freq-units > 1 AND freq-units < 12 THEN DO:
 368 /* NOTE: We are trying to handle a part-period correctly where the   */
 369 /* frequency is non-monthly.  It should work out the number of whole */
 370 /* months and charge a monthly amount for each, then work out the    */
 371 /* part month charge as a fraction of that month.                    */
 372     DEF VAR date-m1 AS DATE NO-UNDO.
 373     DEF VAR date-m2 AS DATE NO-UNDO.
 374
 375       period-fraction = 0.
 376       date-m1 = this-pay-date.
 377       DO WHILE date-m1 < paid-up-to:
 378         date-m2 = next-date-after( this-pay-date, date-m1 + 1, "M", 1).
 379         IF date-m2 > paid-up-to THEN DO:
 380           period-fraction = period-fraction + ((paid-up-to - date-m1 + 1) / (date-m2 - date-m1)).
 381         END.
 382         ELSE
 383           period-fraction = period-fraction + 1 .
 384         date-m1 = date-m2.
 385       END.
 386       period-fraction = period-fraction / freq-units.
 387     END.
 388 /*
 389     MESSAGE start-day stop-day rent-end-day SKIP
 390             period-fraction RentChargeLine.Amount
 391             VIEW-AS ALERT-BOX .
 392 */
 393   description = (IF RentCharge.RentChargeType <> "S" THEN RentChargeType.Description ELSE RentCharge.Description).
 394
 395     RUN add-charge-detail( tenant-code, RentCharge.RentChargeType,
 396             (IF RentCharge.EntityType <> "" THEN RentCharge.EntityType ELSE tenant-et ),
 397             (IF RentCharge.EntityType <> "" THEN RentCharge.EntityCode ELSE tenant-ec ),
 398             (IF CAN-FIND( FIRST ChartOfAccount OF RentCharge ) THEN RentCharge.AccountCode ELSE RentChargeType.AccountCode),
 399             description,
 400             lease-code, lease-desc, amount-multiplier * period-fraction,
 401             lease-tax, this-pay-date, paid-up-to, freq-units, "M" ).
 402     this-pay-date = next-pay-date.
 403
 404     IF rent-charge-one-period THEN this-pay-date = stop-day + 1.
 405   END.
 406
 407 END PROCEDURE.
 408
 409 /* _UIB-CODE-BLOCK-END */
 410 &ANALYZE-RESUME
 411
 412 &ENDIF
 413
 414 &IF DEFINED(EXCLUDE-build-tenant-charges) = 0 &THEN
 415
 416 &ANALYZE-SUSPEND _UIB-CODE-BLOCK _PROCEDURE build-tenant-charges Method-Library
 417 PROCEDURE build-tenant-charges :
 418 /*------------------------------------------------------------------------------
 419   Purpose:     Build a list of the current tenant rental charges.
 420                The list ( a temp table ) can be processed in a second pass
 421                for charging to several accounts or a single account and/or
 422                for reporting purposes.
 423   Parameters:
 424   Notes:
 425 ------------------------------------------------------------------------------*/
 426 DEF INPUT PARAMETER tenant-code LIKE Tenant.TenantCode NO-UNDO.
 427 DEF INPUT PARAMETER period-start-date AS DATE NO-UNDO.
 428 DEF INPUT PARAMETER period-end-date AS DATE NO-UNDO.
 429
 430 DEF BUFFER Lease FOR TenancyLease.
 431 DEF BUFFER L-Tenant FOR Tenant.
 432 DEF BUFFER OtherLine FOR RentChargeLine.
 433
 434   RUN clear-charge-details.
 435
 436 /* First pass - accumulate payable charegs into buckets */
 437 DEF VAR start-day AS DATE NO-UNDO.
 438 DEF VAR stop-day  AS DATE NO-UNDO.
 439 DEF VAR rent-end-day  AS DATE NO-UNDO.
 440
 441   FIND L-Tenant WHERE L-Tenant.TenantCode = tenant-code NO-LOCK NO-ERROR.
 442   IF NOT AVAILABLE(L-Tenant) THEN DO:
 443     MESSAGE "Could not find tenant " + STRING(tenant-code).
 444     RETURN.
 445   END.
 446   IF L-Tenant.EntityType <> "P" THEN RETURN.
 447   FOR EACH Lease NO-LOCK WHERE Lease.PropertyCode = L-Tenant.EntityCode
 448                            AND Lease.TenantCode = tenant-code
 449                            AND (Lease.LeaseStatus <> "PAST" OR allow-past-leases):
 450
 451     IF check-lease-inclusion THEN
 452       IF NOT include-lease(Lease.TenancyLeaseCode) THEN NEXT.
 453
 454     IF og-method = "" OR charge-og-lease = "Charge" THEN
 455       annual-outgoings-charges = 0.
 456     ELSE
 457       annual-outgoings-charges = get-annual-outgoings(Lease.TenancyLeaseCode).
 458
 459 rent-charge-loop:
 460     FOR EACH RentCharge OF Lease NO-LOCK:
 461
 462       FIND RentChargeType OF RentCharge NO-LOCK NO-ERROR.
 463       IF NOT AVAILABLE(RentChargeType) THEN DO:
 464         MESSAGE "Tenant" Lease.TenantCode "has a rent charge of type ~"" RentCharge.RentChargeType "~" which is not set up properly - ignored".
 465         NEXT rent-charge-loop.
 466       END.
 467
 468       /* Calculate the current charges payable for the period */
 469 rent-charge-line-loop:
 470       FOR EACH RentChargeLine OF RentCharge NO-LOCK
 471         WHERE RentChargeLine.StartDate <= period-end-date:
 472
 473         IF use-past-charges THEN DO:
 474           IF RentChargeLine.EndDate < period-start-date THEN NEXT rent-charge-line-loop.
 475           /* IF RentChargeLine.StartDate > period-end-date THEN NEXT rent-charge-line-loop. */
 476           IF RentChargeLine.RentChargeLineStatus <> "C"
 477                       AND RentChargeLine.RentChargeLineStatus <> "P" THEN
 478             NEXT rent-charge-line-loop.
 479         END.
 480         ELSE IF RentChargeLine.RentChargeLineStatus <> "C" THEN
 481           NEXT rent-charge-line-loop.
 482
 483         IF NOT(rent-charge-one-period) THEN DO:
 484           IF RentChargeLine.LastChargedDate <> ?
 485               AND RentChargeLine.LastChargedDate = RentChargeLine.EndDate THEN DO:
 486             IF NOT( CAN-FIND( FIRST OtherLine OF RentCharge WHERE OtherLine.RentChargeLineStatus = "C"
 487                                     AND OtherLine.StartDate <= period-end-date
 488                                     AND RECID(OtherLine) <> RECID(RentChargeLine) ))
 489             THEN NEXT rent-charge-line-loop.
 490           END.
 491
 492           IF RentChargeLine.EndDate = ? AND RentChargeLine.LastChargedDate <> ?
 493                 AND RentChargeLine.LastChargedDate >= period-end-date THEN DO:
 494             NEXT rent-charge-line-loop.
 495           END.
 496
 497           IF RentChargeLine.EndDate <> ? THEN DO:
 498             IF RentChargeLine.EndDate < period-start-date
 499                   AND RentChargeLine.LastChargedDate < period-start-date THEN
 500               NEXT rent-charge-line-loop.
 501             IF RentChargeLine.EndDate >= period-end-date
 502                   AND RentChargeLine.LastChargedDate >= period-end-date THEN
 503               NEXT rent-charge-line-loop.
 504           END.
 505         END.
 506
 507         start-day = period-start-date.
 508         stop-day  = period-end-date.
 509         IF RentChargeLine.StartDate       <> ? THEN start-day = MAXIMUM( start-day, RentChargeLine.StartDate ).
 510
 511         IF RentChargeLine.LastChargedDate <> ? THEN start-day = MAXIMUM( start-day, (RentChargeLine.LastChargedDate + 1) ).
 512         ELSE IF RentChargeLine.StartDate  <> ? THEN start-day = MINIMUM( start-day, RentChargeLine.StartDate ).
 513
 514         IF RentChargeLine.EndDate         <> ? THEN ASSIGN
 515           stop-day  = MINIMUM( stop-day,  RentChargeLine.EndDate ).
 516
 517         IF RentChargeLine.EndDate < RentChargeLine.LastChargedDate THEN DO:
 518           /* This means that something that was charged should be part credited */
 519           stop-day = RentChargeLine.EndDate + 1.
 520           start-day = RentChargeLine.LastChargedDate.
 521 /*           MESSAGE "Start:" start-day " to " stop-day RentChargeLine.Amount RentChargeLine.StartDate RentChargeLine.LastChargedDate RentChargeLine.EndDate. */
 522         END.
 523         ELSE DO:
 524           IF start-day = stop-day THEN NEXT rent-charge-line-loop.
 525         END.
 526
 527         IF rent-charge-one-period THEN DO:
 528           IF RentChargeLine.EndDate <> ? AND RentChargeLine.EndDate < period-end-date
 529                 AND CAN-FIND( LAST OtherLine OF RentCharge WHERE OtherLine.RentChargeLineStatus = "C"
 530                                   AND OtherLine.StartDate <= period-end-date
 531                                   AND OtherLine.EndDate >= period-end-date )
 532           THEN NEXT rent-charge-line-loop.
 533           start-day = period-start-date.
 534           stop-day = period-end-date.
 535         END.
 536
 537         IF get-freq-months( RentChargeLine.FrequencyCode ) <> ? THEN
 538           RUN build-monthly-charges( tenant-code, L-Tenant.EntityType, L-Tenant.EntityCode,
 539                                     Lease.TenancyLeaseCode, Lease.AreaDescription, Lease.TaxApplies,
 540                                     start-day, stop-day ).
 541         ELSE IF get-freq-days( RentChargeLine.FrequencyCode ) <> ? THEN
 542           RUN build-daily-charges( tenant-code, L-Tenant.EntityType, L-Tenant.EntityCode,
 543                                     Lease.TenancyLeaseCode, Lease.AreaDescription, Lease.TaxApplies,
 544                                     start-day, stop-day ).
 545         ELSE
 546           MESSAGE "Bad frequency" RentChargeLine.FrequencyCode.
 547
 548       END.  /* Each Rent Charge Line */
 549     END.    /* Each Rent Charge */
 550   END.      /* Each Lease */
 551
 552 END PROCEDURE.
 553
 554 /* _UIB-CODE-BLOCK-END */
 555 &ANALYZE-RESUME
 556
 557 &ENDIF
 558
 559 &IF DEFINED(EXCLUDE-clear-charge-details) = 0 &THEN
 560
 561 &ANALYZE-SUSPEND _UIB-CODE-BLOCK _PROCEDURE clear-charge-details Method-Library
 562 PROCEDURE clear-charge-details :
 563 /*------------------------------------------------------------------------------
 564   Purpose:
 565   Parameters:  <none>
 566   Notes:
 567 ------------------------------------------------------------------------------*/
 568
 569   FOR EACH ChargeDetail: DELETE ChargeDetail. END.
 570   charge-detail-seq = 0.
 571 END PROCEDURE.
 572
 573 /* _UIB-CODE-BLOCK-END */
 574 &ANALYZE-RESUME
 575
 576 &ENDIF
 577
 578 &IF DEFINED(EXCLUDE-commit-charge-entry) = 0 &THEN
 579
 580 &ANALYZE-SUSPEND _UIB-CODE-BLOCK _PROCEDURE commit-charge-entry Method-Library
 581 PROCEDURE commit-charge-entry :
 582 /*------------------------------------------------------------------------------
 583   Purpose:     Commits a charge entry for charging:
 584                  RentChargeLineStatus = C - Chargeable
 585   Notes:
 586 ------------------------------------------------------------------------------*/
 587
 588   DEF INPUT PARAMETER lease-code    LIKE RentChargeLine.TenancyLeaseCode NO-UNDO.
 589   DEF INPUT PARAMETER sequence-code LIKE RentChargeLine.SequenceCode     NO-UNDO.
 590   DEF INPUT PARAMETER start-date    LIKE RentChargeLine.StartDate        NO-UNDO.
 591
 592   DEF BUFFER ThisChargeEntry FOR RentChargeLine.
 593   DEF BUFFER LastChargeEntry FOR RentChargeLine.
 594
 595   IF NOT can-commit-charge( lease-code, sequence-code, start-date ) THEN RETURN "FAIL".
 596
 597   FIND ThisChargeEntry
 598   WHERE ThisChargeEntry.TenancyLeaseCode = lease-code
 599     AND ThisChargeEntry.SequenceCode     = sequence-code
 600     AND ThisChargeEntry.StartDate        = start-date
 601     EXCLUSIVE-LOCK NO-ERROR.
 602   IF NOT AVAILABLE ThisChargeEntry THEN RETURN "FAIL".
 603
 604   /* Set the end date of the last existing chargeable line */
 605
 606   FIND FIRST LastChargeEntry
 607   WHERE LastChargeEntry.TenancyLeaseCode = lease-code
 608     AND LastChargeEntry.SequenceCode     = sequence-code
 609     AND LastChargeEntry.RentChargeLineStatus = "C"
 610     AND LastChargeEntry.EndDate = ?
 611     AND ROWID( LastChargeEntry ) <> ROWID( ThisChargeEntry )
 612     EXCLUSIVE-LOCK NO-ERROR.
 613
 614   IF AVAILABLE LastChargeEntry THEN DO:
 615
 616     IF ThisChargeEntry.StartDate > LastChargeEntry.StartDate THEN DO:
 617       ASSIGN LastChargeEntry.EndDate =
 618         MAXIMUM( LastChargeEntry.StartDate, ThisChargeEntry.StartDate - 1 ).
 619     END.
 620     ELSE DO:
 621       IF ThisChargeEntry.EndDate = ? THEN DO:
 622         IF LastChargeEntry.LastChargedDate = ? THEN
 623           ASSIGN LastChargeEntry.RentChargeLineStatus = "A". /* Aborted */
 624         ELSE
 625           ASSIGN
 626             LastChargeEntry.EndDate = LastChargeEntry.LastChargedDate.
 627       END.
 628       ELSE DO:
 629         /* Nothing */
 630       END.
 631     END.
 632   END.
 633
 634   ASSIGN
 635     ThisChargeEntry.DateCommitted = TODAY
 636     ThisChargeEntry.RentChargeLineStatus = "C".
 637
 638 END PROCEDURE.
 639
 640 /* _UIB-CODE-BLOCK-END */
 641 &ANALYZE-RESUME
 642
 643 &ENDIF
 644
 645 &IF DEFINED(EXCLUDE-create-charge-entry) = 0 &THEN
 646
 647 &ANALYZE-SUSPEND _UIB-CODE-BLOCK _PROCEDURE create-charge-entry Method-Library
 648 PROCEDURE create-charge-entry :
 649 /*------------------------------------------------------------------------------
 650   Purpose:     Schedule a charging entry for the given charge
 651 ------------------------------------------------------------------------------*/
 652
 653   DEF INPUT PARAMETER lease-code    LIKE RentChargeLine.TenancyLeaseCode NO-UNDO.
 654   DEF INPUT PARAMETER sequence-code LIKE RentChargeLine.SequenceCode NO-UNDO.
 655
 656   DEF INPUT PARAMETER start-date    LIKE RentChargeLine.StartDate NO-UNDO.
 657   DEF INPUT PARAMETER end-date      LIKE RentChargeLine.EndDate NO-UNDO.
 658   DEF INPUT PARAMETER freq-code     LIKE RentChargeLine.FrequencyCode NO-UNDO.
 659   DEF INPUT PARAMETER charge-amount LIKE RentChargeLine.Amount NO-UNDO.
 660
 661   FIND TenancyLease WHERE TenancyLease.TenancyLeaseCode = lease-code
 662     NO-LOCK NO-ERROR.
 663   IF NOT AVAILABLE TenancyLease THEN RETURN.
 664
 665   FIND RentCharge
 666   WHERE RentCharge.TenancyLeaseCode = lease-code
 667     AND RentCharge.SequenceCode     = sequence-code
 668     NO-LOCK NO-ERROR.
 669
 670   IF NOT AVAILABLE RentCharge THEN RETURN "FAIL".
 671
 672   CREATE RentChargeLine.
 673   ASSIGN
 674     RentChargeLine.TenancyLeaseCode     = lease-code
 675     RentChargeLine.SequenceCode         = sequence-code
 676     RentChargeLine.RentChargeLineStatus = "I"
 677     RentChargeLine.StartDate            = start-date
 678     RentChargeLine.EndDate              = end-date
 679     RentChargeLine.FrequencyCode  =
 680       IF freq-code <> ?         THEN freq-code ELSE
 681       IF AVAILABLE TenancyLease THEN TenancyLease.PaymentFrequency
 682          ELSE "MNTH"
 683     RentChargeLine.Amount           = charge-amount.
 684
 685 END PROCEDURE.
 686
 687 /* _UIB-CODE-BLOCK-END */
 688 &ANALYZE-RESUME
 689
 690 &ENDIF
 691
 692 &IF DEFINED(EXCLUDE-make-blurb) = 0 &THEN
 693
 694 &ANALYZE-SUSPEND _UIB-CODE-BLOCK _PROCEDURE make-blurb Method-Library
 695 PROCEDURE make-blurb :
 696 /*------------------------------------------------------------------------------
 697   Purpose:
 698 ------------------------------------------------------------------------------*/
 699 DEF INPUT PARAMETER descriptive-word AS CHAR NO-UNDO.
 700 DEF INPUT PARAMETER period-d1 AS DATE NO-UNDO.
 701 DEF INPUT PARAMETER period-dn AS DATE NO-UNDO.
 702 DEF OUTPUT PARAMETER inv-blurb AS CHAR NO-UNDO.
 703 DEF OUTPUT PARAMETER inv-amount AS DEC NO-UNDO.
 704 DEF OUTPUT PARAMETER inv-tax AS DEC NO-UNDO.
 705 DEF OUTPUT PARAMETER inv-total AS DEC NO-UNDO.
 706
 707   inv-blurb = "Rental " + descriptive-word
 708                 + " for the period from " + STRING( period-d1, "99/99/9999")
 709                 + " to " + STRING( period-dn, "99/99/9999") + "~n".
 710
 711   inv-total = 0.
 712   inv-tax   = 0.
 713   FOR EACH ChargeDetail:
 714     inv-total = inv-total + ChargeDetail.ChargeAmount.
 715     inv-tax   = inv-tax   + ChargeDetail.TaxableAmount.
 716     inv-blurb = inv-blurb + "~n"
 717                   + SUBSTR( STRING( ChargeDetail.ChargedFrom, "99/99/9999"), 1, 5)
 718                   + " - "
 719                   + SUBSTR( STRING( ChargeDetail.ChargedUpTo, "99/99/9999"), 1, 5) + " "
 720                   + STRING( ChargeDetail.AreaDescription, "X(33)") + " "
 721                   + STRING( (IF ChargeDetail.PeriodFraction < 0 THEN "Reverse " ELSE "")
 722                             + ChargeDetail.Description
 723                             + " " + "@ "
 724                             + TRIM(STRING( ChargeDetail.AnnualAmount, ">>>,>>>,>>9.99CR" ))
 725                             + " p.a.", "X(35)")
 726                   + STRING( ChargeDetail.ChargeAmount, "(>,>>>,>>9.99)" ).
 727   END.
 728
 729   inv-tax    = inv-tax * (Office.GST / 100).
 730   inv-amount = inv-total + inv-tax.
 731   inv-blurb = inv-blurb + "~n~n~n".
 732
 733 END PROCEDURE.
 734
 735 /* _UIB-CODE-BLOCK-END */
 736 &ANALYZE-RESUME
 737
 738 &ENDIF
 739
 740 /* ************************  Function Implementations ***************** */
 741
 742 &IF DEFINED(EXCLUDE-can-commit-charge) = 0 &THEN
 743
 744 &ANALYZE-SUSPEND _UIB-CODE-BLOCK _FUNCTION can-commit-charge Method-Library
 745 FUNCTION can-commit-charge RETURNS LOGICAL
 746   ( INPUT lease-code AS INT, INPUT sequence-code AS INT, INPUT start-date AS DATE ) :
 747 /*------------------------------------------------------------------------------
 748   Purpose:  Detremines whether or not a charge entry can be committed for
 749             charging
 750     Notes:
 751 ------------------------------------------------------------------------------*/
 752
 753   IF start-date = ? THEN RETURN No.
 754
 755   DEF BUFFER ChargeEntry FOR RentChargeLine.
 756
 757   FIND ChargeEntry WHERE ChargeEntry.TenancyLeaseCode = lease-code
 758                      AND ChargeEntry.SequenceCode     = sequence-code
 759                      AND ChargeEntry.StartDate        = start-date
 760                      NO-LOCK NO-ERROR.
 761   IF NOT AVAILABLE ChargeEntry THEN RETURN No.
 762
 763   RETURN( ChargeEntry.Amount <> 0 AND ChargeEntry.FrequencyCode <> "" ).
 764
 765 END FUNCTION.
 766
 767 /* _UIB-CODE-BLOCK-END */
 768 &ANALYZE-RESUME
 769
 770 &ENDIF
 771
 772 &IF DEFINED(EXCLUDE-get-annual-outgoings) = 0 &THEN
 773
 774 &ANALYZE-SUSPEND _UIB-CODE-BLOCK _FUNCTION get-annual-outgoings Method-Library
 775 FUNCTION get-annual-outgoings RETURNS DECIMAL
 776   ( INPUT lease-code AS INT ) :
 777 /*------------------------------------------------------------------------------
 778   Purpose:  Calculate the estimated annual outgoings charges
 779     Notes:
 780 ------------------------------------------------------------------------------*/
 781 DEF BUFFER Lse FOR TenancyLease.
 782 DEF BUFFER Prp FOR Property.
 783 DEF BUFFER Pog FOR PropertyOutgoing.
 784 DEF BUFFER Tnt FOR Tenant.
 785 DEF BUFFER Tog FOR TenancyOutgoing.
 786
 787   IF og-method = "" THEN RETURN 0.0.
 788   FIND Lse WHERE Lse.TenancyLeaseCode = lease-code NO-LOCK NO-ERROR.
 789   IF NOT AVAILABLE(Lse) THEN DO:
 790     MESSAGE "Lease " + STRING(lease-code) + " not on file." .
 791     RETURN ?.
 792   END.
 793
 794   IF charge-og-lease BEGINS "Y" THEN RETURN Lse.OutgoingsBudget.
 795   ELSE IF Lse.RecoveryType = "F" THEN RETURN Lse.OutgoingsBudget.
 796   ELSE IF Lse.RecoveryType = "A" THEN RETURN 0.0 .
 797   ELSE IF Lse.RecoveryType <> "B" THEN DO:
 798     MESSAGE "Invalid recovery type '" Lse.RecoveryType "'for lease " + STRING(lease-code).
 799     RETURN 0.0 .
 800   END.
 801
 802 DEF VAR fixed AS DEC NO-UNDO.
 803 DEF VAR percent AS DEC NO-UNDO.
 804 DEF VAR amount AS DEC NO-UNDO   INITIAL 0.0 .
 805   FOR EACH Pog WHERE Pog.PropertyCode = Lse.PropertyCode NO-LOCK:
 806     FIND Tog WHERE Tog.TenancyLeaseCode = lease-code
 807                 AND Tog.AccountCode = Pog.AccountCode NO-LOCK NO-ERROR.
 808     percent = 0.
 809     fixed = 0.
 810     IF AVAILABLE(Tog) THEN DO:
 811       IF Tog.FixedAmount > 0 THEN
 812         fixed = ROUND(Tog.FixedAmount / 12, 2).
 813       ELSE
 814         percent = Tog.Percentage.
 815     END.
 816     ELSE
 817       percent = Lse.OutgoingsRate.
 818
 819     IF percent = ? THEN percent = 0.
 820     IF Pog.BudgetAmount = ? THEN DO:
 821       MESSAGE Pog.BudgetAmount "is not a valid budget!".
 822       NEXT.
 823     END.
 824     amount = amount + fixed + ROUND((percent * Pog.BudgetAmount) / 1200, 2).
 825   END.
 826
 827   FOR EACH Tog WHERE Tog.TenancyLeaseCode = lease-code
 828                  AND Tog.FixedAmount > 0
 829                  AND NOT CAN-FIND( Pog WHERE Pog.PropertyCode = Lse.PropertyCode
 830                                          AND Tog.AccountCode = Pog.AccountCode )
 831                  NO-LOCK:
 832     fixed = ROUND(Tog.FixedAmount / 12, 2).
 833     amount = amount + fixed.
 834   END.
 835
 836   RETURN amount * 12.
 837
 838 END FUNCTION.
 839
 840 /* _UIB-CODE-BLOCK-END */
 841 &ANALYZE-RESUME
 842
 843 &ENDIF
 844
 845 &IF DEFINED(EXCLUDE-not-can-action-rent-review) = 0 &THEN
 846
 847 &ANALYZE-SUSPEND _UIB-CODE-BLOCK _FUNCTION not-can-action-rent-review Method-Library
 848 FUNCTION not-can-action-rent-review RETURNS LOGICAL
 849   ( INPUT lease-code AS INT, INPUT sequence-code AS INT, INPUT start-date AS DATE ) :
 850 /*------------------------------------------------------------------------------
 851   Purpose:  Detremines whether or not a rent review can be committed for
 852             charging
 853     Notes:
 854 ------------------------------------------------------------------------------*/
 855
 856   IF start-date = ? THEN RETURN No.
 857
 858   DEF BUFFER Review FOR RentReview.
 859
 860   FIND Review
 861   WHERE Review.TenancyLeaseCode = lease-code
 862 /*    AND Review.SequenceCode     = sequence-code */
 863 /*    AND Review.StartDate        = start-date */
 864     NO-LOCK NO-ERROR.
 865   IF NOT AVAILABLE Review THEN RETURN No.
 866
 867   RETURN(
 868 /*    Review.Amount <> 0 AND */
 869 /*    Review.DateCommitted = ? AND */
 870     Review.DateComplete <> ? AND
 871     Review.EstimateBasis <> "" AND
 872 /*    Review.FrequencyCode <> "" AND */
 873 /*     Review.LastChargedDate = ? AND */
 874     Review.ReviewStatus <> "C" AND
 875     Review.ReviewStatus <> "" AND
 876     Review.ReviewType <> ""
 877
 878 /*  Review.DateDue <> ?
 879     Review.Latest
 880     Review.Earliest */
 881
 882   ).
 883
 884 END FUNCTION.
 885
 886 /* _UIB-CODE-BLOCK-END */
 887 &ANALYZE-RESUME
 888
 889 &ENDIF
 890