FinancialScheduledTransaction
FinancialScheduledTransaction Logic
AdditionalLavaFields | |
Attributes | |
AttributeValueDefaults | |
AttributeValues | |
AuthorizedPersonAlias | Gets or sets the authorized PersonAlias. |
AuthorizedPersonAliasId | Gets or sets the authorized person alias identifier. |
AvailableKeys | |
CardReminderDate | Gets or sets the date to remind user to update scheduled transaction. |
ContextKey | |
CreatedByPersonAlias | |
CreatedByPersonAliasId | |
CreatedByPersonId | |
CreatedByPersonName | |
CreatedDateTime | |
CustomSortValue | |
EncryptedKey | |
EndDate | Gets or sets the end date for this transaction schedule. Transactions will cease to occur on or before this date. This property is nullable for ongoing schedules or for schedules that will end after a specified number of payments/transaction occur (in the NumberOfPayments property). |
EntityStringValue | |
FinancialGateway | Gets or sets the gateway. |
FinancialGatewayId | Gets or sets the gateway identifier. |
FinancialPaymentDetail | Gets or sets the FinancialPaymentDetail. |
FinancialPaymentDetailId | Gets or sets the financial payment detail identifier. |
ForeignCurrencyCodeValue | Gets or sets the foreign currency code type DefinedValue indicating where the transaction originated from; the source of the transaction. |
ForeignCurrencyCodeValueId | Gets or sets the foreign currency code value identifier. These are found in the "Currency Code" Defined Type. Show Values 6165 = AED | United Arab Emirates Dirham | 6166 = AFN | Afghanistan Afghani | 6167 = ALL | Albania Lek | 6168 = AMD | Armenia Dram | 6169 = ANG | Netherlands Antilled Guilder | 6170 = AOA | Angola Kwanza | 6171 = ARS | Argentina Peso | 6172 = AUD | Australia Dollar | 6173 = AWG | Aruba Guilder | 6174 = AZN | Azerbaijan Manat | 6175 = BAM | Bosnia and Herzegovina Convertible Mark | 6176 = BBD | Barbados Dollar | 6177 = BDT | Bangladesh Taka | 6178 = BGN | Bulgaria Lev | 6179 = BIF | Bahrain Dinar | 6180 = BMD | Burundi Franc | 6181 = BND | Bermuda Dollar | 6182 = BOB | Bolivia Boliviano | 6183 = BRL | Brazil Real | 6184 = BSD | Bahamas Dollar | 6185 = BWP | Botswana Pula | 6186 = BZD | Belize Dollar | 6187 = CAD | Canada Dollar | 6188 = CDF | Congo/Kinshasa Franc | 6189 = CHF | Switzerland Franc | 6190 = CLP | Chile Peso | 6191 = CNY | China Yuan Renminbi | 6192 = COP | Colombia Peso | 6193 = CRC | Costa Rica Colon | 6194 = CVE | Cape Verde Escudo | 6195 = CZK | Czech Republic Koruna | 6196 = DJF | Djibouti Franc | 6197 = DKK | Denmark Krone | 6198 = DOP | Dominican Republic Peso | 6199 = DZD | Algeria Dinar | 6200 = EGP | Egypt Pound | 6201 = ETB | Ethiopia Birr | 6202 = EUR | Euro Member Countries | 6203 = FJD | Fiji Dollar | 6204 = FKP | Falkland Islands (Malvinas) Pound | 6205 = GBP | United Kingdom Pound | 6206 = GEL | Georgia Lari | 6207 = GIP | Gibraltar Pound | 6208 = GMD | Gambia Dalasi | 6209 = GNF | Guinea Franc | 6210 = GTQ | Guatemala Quetzal | 6211 = GYD | Guyana Dollar | 6212 = HKD | Hong Kong Dollar | 6213 = HNL | Honduras Lempira | 6214 = HRK | Croatia Dollar | 6215 = HTG | Haiti Gourde | 6216 = HUF | Hungary Forint | 6217 = IDR | Indonesia Rupiah | 6218 = ILS | Israel Shekel | 6219 = INR | India Rupee | 6220 = ISK | Iceland Krona | 6221 = JMD | Jamaica Dollar | 6222 = JPY | Japan Yen | 6223 = KES | Kenya Shilling | 6224 = KGS | Kyrgyzstan Som | 6225 = KHR | Cambodia Riel | 6226 = KMF | Comorian Franc | 6227 = KRW | Korea (South) Won | 6228 = KYD | Cayman Islands Dollar | 6229 = KZT | Kazakhstan Tenge | 6230 = LAK | Laos Kip | 6231 = LBP | Lebanon Pound | 6232 = LKR | Sri Lanka Rupee | 6233 = LRD | Liberia Dollar | 6234 = LSL | Lesotho Loti | 6235 = MAD | Morocco Dirham | 6236 = MDL | Moldova Leu | 6237 = MGA | Madagascar Ariary | 6238 = MKD | Macedonia Denar | 6239 = MMK | Myanmar (Burma) Kyat | 6240 = MNT | Mongolia Tughrik | 6241 = MOP | Macau Pataca | 6242 = MRU | Mauritania Ouguiya | 6243 = MUR | Mauritius Rupee | 6244 = MVR | Maldives (Maldive Islands) Rufiyaa | 6245 = MWK | Malawi Kwacha | 6246 = MXN | Mexico Kwacha | 6247 = MYR | Malaysia Ringgit | 6248 = MZN | Mozambiqui Metical | 6249 = NAD | Namibia Dollar | 6250 = NGN | Nigeria Naira | 6251 = NIO | Nicaragua Cordoba | 6252 = NOK | Norway Krone | 6253 = NPR | Nepal Rupee | 6254 = NZD | New Zealand Dollar | 6255 = PAB | Panama Balboa | 6256 = PEN | Peru Sol | 6257 = PGK | Paupa New Guinea Kina | 6258 = PHP | Philippines Peso | 6259 = PKR | Pakistan Rupee | 6260 = PLN | Poland Zloty | 6261 = PYG | Paraguay Guarani | 6262 = QAR | Qatar Riyal | 6263 = RON | Romania Leu | 6264 = RSD | Serbia Dinar | 6265 = RUB | Russia Ruble | 6266 = RWF | Rwanda Franc | 6267 = SAR | Saudi Arabia Riyal | 6268 = SBD | Solomon Islands Dollar | 6269 = SCR | Seychelles Rupee | 6270 = SEK | Sweden Krona | 6271 = SGD | Singapore Dollar | 6272 = SHP | Saint Helena Pound | 6273 = SLL | Sierra Leone Leone | 6274 = SOS | Somalia Shilling | 6275 = SRD | Suriname Dollar | 6276 = STN | Sao Tome and Principe Dobra | 6277 = SZL | eSwatini Lilageni | 6278 = THB | Thailand Baht | 6279 = TJS | Tajikistan Somoni | 6280 = TOP | Tonga Pa'anga | 6281 = TRY | Turkey Lira | 6282 = TTD | Trinidad and Tobago Dollar | 6283 = TWD | Taiwan New Dollar | 6284 = TZS | Tanzania Shilling | 6285 = UAH | Ukraine Hryvnia | 6286 = UGX | Uganda Shilling | 6287 = USD | United States Dollar | 6288 = UYU | Uruguay Peso | 6289 = UZS | Uzbekistan Som | 6290 = VND | Viet Nam Dong | 6291 = VUV | Vanuatu Vatu | 6292 = WST | Samoa Tala | 6293 = XAF | Communaute Financiere Africaine (BEAC) CFA Franc | 6294 = XCD | East Caribbean Dollar | 6295 = XOF | Communaute Financiere Africaine (BCEAO) Franc | 6296 = XPF | Comptoirs Francais du Pacifique (CFP) Franc | 6297 = YER | Yemen Rial | 6298 = ZAR | South Africa Rand | 6299 = ZMW | Zambia Kwacha |
|
ForeignGuid | |
ForeignId | |
ForeignKey | |
GatewayScheduleId | Gets or sets the payment gateway's payment schedule key/identifier. This is the value that uniquely identifies the payment schedule on with the payment gateway. |
Guid | |
HistoryChangeList | [Obsoleted in v14] Does nothing. No longer needed. We replaced this with a private property under the SaveHook class for this entity. Gets or sets the history change list. |
Id | |
IdKey | |
InactivateDateTime | Gets or sets the inactivate date time. |
IsActive | Gets or sets a flag indicating if this scheduled transaction is active. |
IsValid | |
Item | |
LastRemindedDate | Gets or sets the date that user was last reminded to update scheduled transaction. |
LastStatusUpdateDateTime | Gets or sets the date and time of the last status update. In other words, the date and time the gateway was last queried for the status of the scheduled profile/transaction. |
ModifiedAuditValuesAlreadyUpdated | |
ModifiedByPersonAlias | |
ModifiedByPersonAliasId | |
ModifiedByPersonId | |
ModifiedByPersonName | |
ModifiedDateTime | |
NextPaymentDate | Gets or sets the date of the next payment in this schedule. |
NumberOfPayments | Gets or sets the maximum number of times that this payment should repeat in this schedule. If there is not a set number of payments, this value will be null. This property is overridden by the schedule's EndDate . |
ParentAuthority | |
ParentAuthorityPre | |
PaymentPlan | |
PreviousGatewayScheduleIds | This will be any previous GatewayScheduleId that this FinancialScheduledTransaction has had. This might be used in a case where a GatewayComponent may have changed what schedule id it used. |
PreviousGatewayScheduleIdsJson | The JSON for PreviousGatewayScheduleIds . If this is null, there are no PreviousGatewayScheduleIds. |
ScheduledTransactionDetails | Gets or sets the transaction details for this scheduled transaction. |
SourceTypeValue | Gets or sets the source type DefinedValue indicating where the transaction originated from; the source of the transaction. |
SourceTypeValueId | Gets or sets the source type value identifier. These are found in the "Transaction Source" Defined Type. Show Values 10 = Website | Transactions that originated from the website | 520 = Kiosk | Transactions that originated from a kiosk | 521 = Mobile Application | Transactions that originated from a mobile application | 522 = On-Site | Transactions that were collected on-site | 532 = Rock Website | | 565 = Paypal | Spark's Paypal Account | 5371 = SMS Gift | A payment made through text-to-give | 615 = Bank Checks | Transactions that originated from a bank's bill pay system | 701 = Pushpay | Transactions downloaded from Pushpay |
|
StartDate | Gets or sets the start date for this schedule. The first transaction will occur on or after this date. |
Status | The status of the scheduled transactions provided by the payment gateway (i.e. Active, Cancelled, etc). If the gateway doesn't have a status field, this will be null; The payment gateway component maps this based on the StatusMessage . |
StatusMessage | Gets or sets the raw scheduled transaction status message returned from the Gateway If the gateway doesn't have a status field, this will be null; |
Summary | Gets or sets a summary of the scheduled transaction. This would store any comments made. |
SupportedActions | |
TotalAmount | Gets the total amount. |
TransactionCode | Gets or sets the transaction code used for this scheduled transaction. |
TransactionFrequencyValue | Gets or sets the DefinedValue representing the payment frequency associated with this scheduled transaction. |
TransactionFrequencyValueId | Gets or sets the DefinedValueId of the transaction frequency DefinedValue that represents the frequency that this transaction will occur. These are found in the "Recurring Transaction Frequency" Defined Type. Show Values 130 = One-Time | One Time | 132 = Weekly | Every Week | 133 = Bi-Weekly | Every Two Weeks | 5662 = 1st and 15th | 1st and 15th | 134 = Twice a Month | Twice a Month | 135 = Monthly | Once a Month | 153 = Quarterly | Every Quarter | 154 = Twice a Year | Every Six Months | 155 = Yearly | Every Year |
|
Transactions | Gets or sets FinancialTransactions that have been processed and have cleared for this scheduled transaction profile. |
TransactionTypeValue | Gets or sets the transaction type DefinedValue indicating the type of transaction that occurred. |
TransactionTypeValueId | Gets or sets the transaction type value identifier. These are found in the "Transaction Type" Defined Type. Show Values 53 = Contribution | A Contribution Transaction | 54 = Event Registration | An Event Registration Transaction | 562 = Rock Shop Purchase | Purchase from Rock Shop | 4815 = Spark Data Purchase | Purchase from Spark Data |
|
TypeId | |
TypeName | |
UrlEncodedKey | |
ValidationResults | |