Table: Demo_Recurring_Gift
This multi-instance demo table tracks recurring donation records and amounts. It is used to tie subsequent gifts back to the original donor in iMIS and should not be edited directly except for the RG_ACTIVE flag which can be set to 0 (false) to indicate that the recurring gift was cancelled.
Schema
| Column name | Column type (iMIS) | Column type (SQL) | Description |
|---|---|---|---|
| ID (Created automatically by iMIS) | AUTOMATIC | VARCHAR(10) | iMIS ID field. |
| SEQN (Created automatically by iMIS) | AUTOMATIC | INT | SEQN field. |
| RG_INITIAL_GIFT_DATE | DATETIME | DATETIME | The date of the initial recurring gift / plan start. |
| RG_UNIQUE_ID | CHAR (Length: 20) | VARCHAR(20) | The unique ID for this recurring gift. For BluePay, this is the Rebilling ID. |
| RG_FREQUENCY | CHAR (Length: 20) | VARCHAR(20) | The frequency of the recurring gift, for example, "1 YEAR" or "MONTH" or "7 DAY". |
| RG_TOTAL_OCCURENCES | INT | INT | The total number of expected gifts from this plan. For unlimited recurring plans, this value is always 0. |
| RG_RECURRING_AMOUNT | MONEY | MONEY | The amount of each installment/gift in the plan. |
| RG_TOTAL_AMOUNT_EXPECTED | MONEY | MONEY | The total sum expected from this plan. For unlimited recurring plans, this value is always 0. |
| RG_NUM_GIFTS_GIVEN | INT | INT | The count of gifts given so far in this plan. |
| RG_TOTAL_AMOUNT_GIVEN | MONEY | MONEY | The amount sum given so far in this plan. |
| RG_DISTRIBUTION | CHAR (Length: 31) | VARCHAR(31) | The associated distribution code for this plan. |
| RG_FUND | CHAR (Length: 10) | VARCHAR(10) | The associated fund code for this plan. Derived from the distribution code. |
| RG_CAMPAIGN_CODE | CHAR (Length: 10) | VARCHAR(10) | The campaign code for this plan, or empty string ('') if not set. This value is an override - if blank, the campaign code will be set to the distribution's default campaign code. |
| RG_APPEAL_CODE | CHAR (Length: 40) | VARCHAR(40) | The appeal code for this plan, or empty string ('') if not set. This value is an override - if blank, the appeal code will be set to the distribution's default appeal code. |
| RG_CC_EXP_MONTH | INT | INT | The credit card expiration month, expressed as an integer (e.g. 2, 11). For ACH transactions, this value is always 0. |
| RG_CC_EXP_YEAR | INT | INT | The credit card expiration year, expressed as a two-digit integer (e.g. 19, 22, 25). For ACH transactions, this value is always 0. |
| RG_LAST_RESPONSE_DATE | DATETIME | DATETIME | The date that the last rebill notification was received from BluePay. |
| RG_CONFIRMATION_NUM | CHAR (Length: 32) | VARCHAR(32) | The confirmation number of the recurring plan. For BluePay, this is the Rebilling ID (the same as the RG_UNIQUE_ID field). |
| RG_ACTIVE | CHECKBOX | BIT | 1 for active plans, 0 for cancelled or completed plans. Donate Now - Premium will automatically flip this flag to 0 if a recurring notification is received, and after processing, RG_TOTAL_OCCURRENCES is equal to RG_NUM_GIFTS_GIVEN. |
| RG_LAST_STATUS | CHAR (Length: 255) | VARCHAR(255) | Records the last status received from the payment processor. For BluePay, all statuses begin with BP:. - INITIAL GIFT ENTERED = The status that Donate Now - Premium initially sets when the plan is set up - ACTIVE = The last notification was for a processed payment - EXPIRED = The recurring plan completed / ran out of occurrences - ERROR = BluePay encountered an error while processing the credit card |
| RG_WARNING_FLAG | CHECKBOX | BIT | 1 if there is a potential issue with the recurring plan, or 0 if the plan is operating normally. Must be reset/acknowledged manually by staff – Donate Now - Premium will only ever flip this status from 0 to 1. This flag is only set if an error notification is received from BluePay. This flag is not set if Donate Now - Premium did not receive a notification at all. |
| RG_PLEDGE_TRANS_NUM | INT | INT | The pledge associated with this recurring plan. If set, when the donor is billed, an open pledge installment under this trans number is searched for. If found, the open pledge installment is paid off. Otherwise, a standard gift is written. |
| RG_PLEDGE_LAST_STATUS | CHAR (Length: 255) | VARCHAR(255) | The last status of the pledge installment / payment. Code values include: INITIAL_PAYMENT, SUCCESS, ACTIVITY_NOT_A_PLEDGE, NO_OPEN_INVOICE, SQL_ERROR_CHECK_LOG, MISSING_REQUIRED_INFO, ERROR_CHECK_LOG, and UNKNOWN_RESULT_CODE:X where "X" is a numeric error code. |
Updated 25 days ago
Did this page help you?