The CSubscription type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
| CalcCashDuesDates |
Calculates the proper values for the Subscription's EffectiveDate, PaidThruDate, and MonthsPaid
| |
| CheckAndModifyEditStatus |
Sets the EditStatus to Modified if it is Unchanged
(Inherited from iboBase.) | |
| Delete |
Marks this object to be deleted when the save is done
(Inherited from iboBase.) | |
| Equals | (Inherited from Object.) | |
| Finalize |
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.) | |
| GetHashCode |
Serves as a hash function for a particular type.
(Inherited from Object.) | |
| GetType |
Gets the Type of the current instance.
(Inherited from Object.) | |
| MemberwiseClone |
Creates a shallow copy of the current Object.
(Inherited from Object.) | |
| PayDues(CContact, CPayment%) |
Pay for any subscriptions that are due for a given contact.
| |
| PayDues(CContact, CPayment%, String) |
Pay for any subscriptions that are due for a given contact.
| |
| PayDues(DataServer, CContact, CPayment%, String) |
Pay for any subscriptions that are due for a given contact.
| |
| PayDues(IiMISUser, array<CSubscription>[]()[][], CPayment%, CBatch) |
Pay for any subscriptions that are due for a given contact.
| |
| PayDues(DataServer, IiMISUser, array<CSubscription>[]()[][], CPayment%, CBatch) |
Pay for any subscriptions that are due for a given contact.
| |
| ToString | (Inherited from Object.) | |
| Validate |
Validates that the Subscription follows the iMIS business rules for Subscriptions of this type
(Overrides iboBase..::..Validate()()()().) |
Fields
| Name | Description | |
|---|---|---|
| BILL_TYPE_ANIVERSARY |
A BILL_TYPE of "anniversary."
| |
| BILL_TYPE_ANNUAL |
A BILL_TYPE of "annual."
| |
| mEditStatus | The edit status (unchanged, modified, etc) of this record. (Inherited from iboBase.) | |
| mErrors | The current list of errors encountered by this class instance during processing. (Inherited from iboBase.) |
Properties
| Name | Description | |
|---|---|---|
| AdjustmentAmount |
Gets or sets the amount of any adjustments applied to this CSubscription instance.
| |
| AmountBilled |
Gets or sets the amount billed against this CSubscription instance in the most recent billing cycle.
| |
| AmountPaid |
Gets or sets the amount paid against this CSubscription instance in the most recent billing cycle.
This amount represents the payment being made right now. In other words, how much the user's credit card should be charged.
| |
| AppealCode |
Gets or sets the key to the Campaign Management Appeal with which this subscription is associated
| |
| Balance |
Gets or sets the current balance owed for this CSubscription instance.
| |
| BeginDate |
Gets or sets the date upon which the current subscription began. This value is predominantly set by iMIS Client/Server,
except in cases where the amount charged for a new subscription is zero.
| |
| BillBeginDate |
Gets or sets the date marking the beginning of a billing cycle for this subscription.
| |
| BillCopies |
Gets or sets the number of copies of this subscription (e.g., for magazines, journals, etc.) that were on the last bill
| |
| BilledContactId |
Gets or sets the ContactId of the Contact that was billed for this subscription
| |
| BilledDate |
Gets or sets the last date this CSubscription instance was billed.
| |
| BillThruDate |
Gets or sets the date marking the end of this CSubscription instance's current billing cycle.
| |
| BillType |
Gets or sets the billing type for this subscription, as set forth in the system configuration - either
Annual or Anniversary ("A" and "M", respectively)
| |
| CampaignCode |
Gets or sets the key to the Campaign Management campaign with which this subscription is associated
| |
| CancelReason |
Gets or sets any reason for subscription cancellation.
| |
| ContinuousSince |
Gets or sets the oldest date since which this subscription had been in effect (active, paid if applicable) without interruption
| |
| Copies |
Gets or sets the number of copies delivered for this subscription
| |
| CopiesPaid |
Gets or sets the number of copies of this subscription that were paid for with the last payment
| |
| CreatedOn |
Gets or sets the date this CSubscription instance was created and saved to the database
| |
| DateSubscribed |
Gets or sets the recorded date upon which the associated contact subscribed to this CSubscription instance.
| |
| DuesProduct |
Gets the dues Product upon which this subscription instance is based
| |
| EditStatus |
Indicates the current edit status of this object, i.e., New, Modified, Deleted, or Unchanged. See EEditStatus (Inherited from iboBase.) | |
| EffectiveDate |
Gets or sets the (calculated) effective date of this CSubscription instance, which forms the basis for establishing the date billing begins.
| |
| Errors |
The collection of CError objects (error and warning messages) associated with this object instance
(Inherited from iboBase.) | |
| ErrorsCount |
Gets the number of error and warning messages that have been set on this object.
(Inherited from iboBase.) | |
| FairMarketValue |
Gets or sets the fair market value of the subscription
| |
| FinancialEntityCode |
Gets or sets the key to the FinancialEntity associated with this Subscription
| |
| Flag |
Gets or sets an indication of additional information related to this item.
| |
| FutureCopies |
Gets or sets the number of copies of the subscription item (e.g., magazine, journal, etc.) that remain to be delivered to satisfy this subscription
| |
| FutureCopiesDate |
Gets or sets the date that the FutureCopies number was determined
| |
| FutureCredits |
Gets or sets the amount of money credited toward future bills for this subscription
| |
| InvoiceLineNumber |
Gets or sets the line number on the Invoice associated with the last payment made on this Subscription
| |
| InvoiceReferenceNumber |
Gets or sets the reference number of the Invoice associated with the last payment made on this Subscription
| |
| IsComplimentary |
Gets or sets an indication of whether this CSubscription instance is considered free of charge (true) or not (false).
| |
| IsDuesSynced |
Gets or sets a indication of whether this CSubscription instance should be included in dues
billing runs (true), or if it should be billed as an optional subscription (false).
| |
| IsFundRaisingItem |
Gets or sets an indication of whether this Subscription is related to fundraising.
| |
| IsPrimary |
Gets an indication of whether this CSubscription instance is the associated contact's primary subscription (true) or not (false)
| |
| IssuesPrinted |
Gets or sets the number of issues (e.g., for magazines, journals, etc.) that were printed for this subscription.
| |
| LastIssue |
Gets or sets the name/title of the last issue associated with this subscription (e.g., for magazines, journals, etc.)
| |
| LastIssueDate |
Gets or sets the date of the last issue associated with this subscription (e.g., for magazines, journals, etc.)
| |
| LastPaidThruDate |
Gets or sets the date through which the subscription was last paid, prior to the current payment.
| |
| LifeToDatePayments |
Gets or sets the total amount of money collected for this subscription for this contact over the life of the subscription.
| |
| MailCode |
Gets or sets the mail code. Also known as "Address Code", setting this on a subscription allows bills for this subscription
to be sorted together
| |
| PaidBeginDate |
Gets or sets the date on which the subscription begins, based on when it was paid.
| |
| PaidThruDate |
Gets or sets the date until which this CSubscription instance is considered current on its payments.
| |
| PaymentDate |
Gets or sets the date signifying the last date upon which payment was made for this CSubscription instance.
| |
| PreferredBillAddressNumber |
Gets or sets the address to use when sending bills for this subscription
| |
| PreferredMailAddressNumber |
Gets or sets the address to use when sending mail about this subscription
| |
| PreviousBalance |
Gets or sets the value of any previous balance carried forward for this CSubscription instance
(maintaining previous balance information must be enabled at the system level).
| |
| PriorActiveYears |
Gets or sets the number of years that this subscription has been active
| |
| ProductCode |
Gets the ProductCode (key to the Product) of the product upon which this subscription instance is based
| |
| ProductTypeCode |
Gets the ProductTypeCode of the product upon which this subscription instance is based
| |
| ReminderCount |
Gets or sets the number of bill reminders sent on this subscription since the last time it was paid
| |
| ReminderDate |
Gets or sets the date that the last bill reminder was sent for this subscription
| |
| RenewMonths |
Gets or sets the default number of months this CSubscription renews for (the default subscription length).
| |
| SourceCode |
Gets or sets the location from which this CSubscription instance originates.
| |
| StatusCode |
Gets or sets the status code of this subscription (e.g., A for Active)
| |
| SubscribedContact |
Gets the Contact that owns this Subscription
| |
| SubscribedContactId |
Gets the Contact ID (key to the Contact) of the Contact that owns this subscription
| |
| TotalPaymentsToDate |
Gets the total amount of all payments made to this CSubscription instance in the current billing cycle.
| |
| UnitPrice |
Gets or sets the amount charged for a single-copy subscription of this CSubscription instance. If set,
it will override the system's prescribed unit price for subscriptions of this type, for this CSubscription instance.
UnitPrice is not available unless Contact is available
| |
| UpdatedBy |
Gets the identity of the last individual or system to update this CSubscription instance.
| |
| UpdatedOn |
Gets the date and time that this Subscription instance was last updated to the database
| |
| YearsActive |
Gets or sets the comma-delimited string that the years that this subscription
was active, (e.g., 1998, 1999, 2000, ...).
|