AMOUNT_TYPE and AMOUNT

These two columns record how the payment amount is generated. They are only updated through the UI and are used by back-end jobs to calculate how much to pay. The valid values of AMOUNT_TYPE are:

• Fixed amount. Pay a fixed amount and the amount value is specified by AMOUNT column.
• Amount due. Pay amount due on the bill and, AMOUNT column is not used (null).
• Minimal due. Pay minimum amount due on the bill and AMOUNT column is not used (null).
• Less due. Pay the amount due if it is less than the value of the AMOUNT column. Otherwise, pay nothing and send a notification.
• Upto amount. Pay the amount due if it is less than the value of the AMOUNT column. Otherwise, pay the value of AMOUNT and send a notification.

PAY_INTERVAL DAY_OF_PAY_INTERVAL

MONTH_OF_PAY_INTERVAL

These three columns record how the payment date is generated. They are only updated through the UI, and are used by back-end jobs to calculate when to pay. Valid PAY_INTERVAL values are:

• Weekly. User-specified to make payments weekly. The day of week is specified by DAY_OF_PAY_INTERVAL. The MONTH_OF_PAY_INTERVAL is irrelevant.
• Monthly. User-specified to make payments monthly. The day of month is specified by DAY_OF_PAY_INTERVAL. The MONTH_OF_PAY_INTERVAL is irrelevant.
• Quarterly. User-specified to make payments quarterly. The day of month is specified by DAY_OF_PAY_INTERVAL. The month of quarter is specified by MONTH_OF_PAY_INTERVAL (one of 1,2 or 3).

START_DATE

END_DATE

CURR_NUM_PAYMENTS

MAX_NUM_PAYMENTS

STATUS

These columns determine when to start the recurring payment and when to stop it. START_DATE, END_DATE and MAX_NUM_PAYMENTS can only be updated through the UI.

START_DATE is required, but you set only one of the END_DATE (end by that date) or MAX_NUM_PAYMENTS (end when this number of payments is made).

The recurring payment STATUS is active when it is created and it has not reached either END_DATE or MAX_NUM_PAYMENTS. When one of them is reached, the STATUS is changed to inactive and the recurring payment will never take effect again.

If END_DATE is chosen, if the pay date for the next bill to be paid is later than or the same as the start date, and sooner or the same as the end date, then the bill will be paid. The STATUS is set to inactive if the next pay date is later than the end date.

If MAX_NUM_PAYMENTS is chosen, then the STATUS is changed to inactive when CURR_NUM_PAYMENTS reaches MAX_NUM_PAYMENTS.

LAST_PAY_DATE

This is the pay date of the last bill. It is set to 01/07/1970 when recurring payment is created to indicate that there is valid information.

NEXT_PAY_DATE

This is the pay date of the next bill. When the recurring payment job runs, it schedules a payment with a pay date of NEXT_PAY_DATE. Note, NEXT_PAY_DATE is calculated based on LAST_PAY_DATE and PAY_INTERNAL.