Class AR_CreditCardCommonEntry

Properties

PROPERTY SYS_CreditCardBatchAuthTrans$   * Read Only *

Process in Batch Default (retrieved from SY_Company.CreditCardBatchAuthTrans$ column value).

PROPERTY AllowChangeAfterProcessing   * Read Only *
Allow change to the document after credit card has been processed. It is also used in CI_CreditCardID_val.
PROPERTY AR_SalesTaxReporting$   * Read Only *
PROPERTY oCustomerChild   * Read Only *
oCustomerChild - handle to AR CustomerNo child object
PROPERTY CreditCardIdentifierCol$   * Read Only *
Column to use when determining if a credit card transaction type applies in the current record
PROPERTY CreditCardImpliedWrite  
Boolean property that when true indicates the record has just been written by CreditCardImpliedWrite and security access will not be changed to ViewOnly just yet
PROPERTY ProcessInBatch$  
Yes / No property that stores the current Process in Batch option for the current record (default value = SY_Company.CreditCardBatchAuthTrans$ column value).
PROPERTY SwipeCard  
Boolean property that when true indicates the Swipe Card check box has been selected in the credit card UI object. (This property always defaults to false.)
PROPERTY CorporateID$   * Read Only *
Returns CorporateCustIDPurchOrder$, used by detail busObj to determine whether to add-in or back-out CorporateSalesTax (when CorporateSalesTax has not been overridded by user, CorporateTaxOverrd$ = "Y")
PROPERTY CCTransExistsInBatch   * Read Only *
Boolean property that when true indicates a record exists in the batch that contains an authorized credit card transaction tied to a payment type setup to process credit card transactions via SPS Exchange.
PROPERTY ACHTransExistsInBatch   * Read Only *
Boolean property that when true indicates a record exists in the batch that contains an authorized ACH transaction tied to a payment type setup to process ACH transactions via SPS Exchange.
PROPERTY CreditCardIDCols$   * Read Only *
CreditCardID destination ("MAIN") columns included in CreditCardID child collection mappings
PROPERTY CreditCardAddressCols$   * Read Only *
CreditCard Address destination ("MAIN") columns included in CreditCardID collection mappings
PROPERTY CustomerAddressCols$   * Read Only *
CustomerAddress source columns ("CustomerNo") used to default credit card address column from customer child collection mappings
PROPERTY VaultOnly  
Boolean property to indicate that we only want to access the Sage Exchange vault
PROPERTY InFixMode  
Boolean property to indicate that user clicked Fix button to enter authorization info. Some validation rules will be skipped.
PROPERTY SaveVaultRecOnly  
Boolean property to indicate that only expiration date, card type, and Last 4 digits should be updated to customer credit card record
PROPERTY CreditCardDefaultErrorNum$  
Property to identify when default credit card could not be set due to invalid expiration date error. When applicable, it will be set with the message library entry to use to display a warning message.
PROPERTY SE_ARAllowAddEditCreditCards   * Read Only *
Flag set for value of the Allow Access to add/edit credit card module option
PROPERTY SE_ARAllowAddEditACH   * Read Only *
Flag set for value of the Allow Access to add/edit ACH module option

Methods

retFAILURE (0) transaction found and user has no right to void retWARNING (-1) transaction found and user has right to void

FUNCTION BatchPreDelete(tmpBatchNo$)  

Standard method called from SY_BatchManagerSelect_UI'BT_Delete() via coBusiness'PreDelete() to perform pre-Delete logic

ParameterDescription
tmpBatchNo$ [input, string] Batch number to cycle thru
Returns [boolean] always True = success
FUNCTION CheckDeleteSecurity(tmpBatchNo$)  

Standard method in SY_BatchManagerSelect_UI used to determine if selected batch can be deleted, overridden to check for credit card transactions and if the user has sufficient rights to void credit card transactions and delete records with them

ParameterDescription
tmpBatchNo$ [input, string] Batch number to cycle thru
Returns [boolean] True = Batch can be deleted, False = User does not have sufficient rights to delete
FUNCTION CheckRequired()  
FUNCTION CheckRequired(columns$)  
FUNCTION CheckRequired(columns$, expression)  
FUNCTION CheckRequired(columns$, expression, fromBT_Creditcard)  

Verify required columns have been set

ParameterDescription
columns$ {optional} [input, string] comma separated list of columns to verify, when null credit card 'write' column requirements will be tested.
expression {optional} [input, boolean] when true execute EVS(cols$) to arrive at columns list to verify
fromBT_Creditcard {optional} [input, boolean] when true adjust column list (when NUL(column$) to allow for columns to be set on return of SPS Exchange transaction or vault.
Returns [boolean] True = success, False = failure
FUNCTION CreditCardPreClear()  

Pre Clear credit card validation

Returns [boolean] True = success the record can be cleared, False = failure the record cannot be cleared
FUNCTION CreditCardPreDelete()  

Determines if document has authorized SPS credit card transaction that needs to be voided

Returns [numeric] retSUCCESS (1) no transaction found
FUNCTION CreditCardPreWrite()  
FUNCTION CreditCardPreWrite(skipProcessCC)  

Pre-Write Credit Card validations

ParameterDescription
skipProcessCC {optional} [input, boolean] when true, will not process transaction through Sage Exchange
Returns [boolean] True = success, False = failure
FUNCTION CreditCardSetDocumentDefaults()  

Set default values of document level properties

Returns [boolean] True = success
FUNCTION DefaultSalesTaxInfo()  

Set Corporate Sales Tax Specific columns to their default values

Returns [boolean] True = success
FUNCTION LOCAL CCTransInBatch(tmpBatchNo$)  

Cycle thru entries in a batch and set CCTransExistsInBatch and ACHTransExistsInBatch properties to true when CC authorized vis SPS Exchange exists

ParameterDescription
tmpBatchNo$ [input, string] Batch number to cycle thru
Returns [boolean] always True = success
FUNCTION LOCAL CheckForCCPayments(invoiceNo$, invoiceType$, defaultCC, includeACH)  

This function finds all on-file SPS credit cards used in payment history (cPmtHistCreditCardIDList$) and calculates the maximum credit allowed on credit card (cMaxCCPaymentToApply). This function defaults credit card ID from payment history if defaultCC is set to 1

ParameterDescription
invoiceNo$ [input, string]
invoiceType$ [input, string]
defaultCC [input, boolean]
includeACH [input, boolean] True = Include ACH from payment history (for debit memo)
Returns [boolean] True = success.
FUNCTION LOCAL CleanUpVault()  

Clean-up Vault for GUID's generated not retained and not in AR_CustomerCreditCard

Returns [boolean] always True = success
FUNCTION LOCAL CreditCardPostClear()  

Clears credit card properties

Returns [boolean] True = success
FUNCTION LOCAL CreditCardPostDelete()  

Post Delete credit card validation

Returns [boolean] True = success, False = failure (post write failures are converted to warnings in base class PostDeleteRec()).
FUNCTION LOCAL CreditCardPostWrite()  
FUNCTION LOCAL CreditCardPostWrite(skipCleanUpVault)  

Post-Write Credit Card updates

ParameterDescription
skipCleanUpValue {optional} [input, boolean] when true, will not remove credit card GUIDs from vault
Returns [boolean] True = success, False = failure (post write failures are converted to warnings in base class PostWriteRec()).
FUNCTION LOCAL CreditCardTransAmt()  

Calculates credit card transaction amount

Returns [numeric] credit card transaction amount
FUNCTION LOCAL GetARSalesTax(salesTax)  

Retrieve pro rata sales tax amount outstanding on invoices paid by credit card in cash receipts entry

ParameterDescription
salesTax [output, numeric] pro rata sales tax amount outstanding calculated on invoices paid on this cash receipts deposit entry
Returns [boolean] True = success
FUNCTION LOCAL IsCreditCardAuthorized()  
FUNCTION LOCAL IsCreditCardAuthorized(authOnThisDocOnly)  

Determine if a SPS credit card has been authorized

ParameterDescription
authOnThisDocOnly {optional} [input, boolean] if true, only want to know if authorization occurred on the invoice
Returns [boolean] True = credit card authorized, False = credit card not authorized
FUNCTION LOCAL IsCreditCardGUIDOnFile(guid$, pmtType$)  

This function checks if a credit card GUID exists in customer credit card file or related data entry file. It is used to determine if GUID can be removed from vault.

ParameterDescription
guid$ [input, string] Credit Card GUID
pmtType$ [input, string] Payment Type
Returns [boolean] True = credit card GUID exists, False = credit card GUID does not exist
FUNCTION LOCAL SetCurrentKey(key$)  

Set Current Key - executed after successful SetKey() on all records, used to reset ProcessInBatch$ property to the proper default value

ParameterDescription
key$ [input, string] current header record key value
Returns [boolean] always True = success
FUNCTION LOCAL SetDefaults()  
FUNCTION LOCAL SetDefaults(paymentMethod$)  

Set Defaults - Set column default values on new records not set via dictionary defaults

Returns [boolean] True = success
FUNCTION LOCAL ValidateAuthorizationTime(value$)  
FUNCTION LOCAL ValidateCorporateCustIDPurchOrder(value$)  
FUNCTION LOCAL ValidateCorporateSalesTax(value)  
FUNCTION LOCAL ValidateCorporateTaxOverrd(value$)  
FUNCTION LOCAL ValidateCreditCardAuthorizationNo(value$)  
FUNCTION LOCAL ValidateCreditCardTransactionID(value$)  
FUNCTION LOCAL ValidateExpirationDateMonth(value$)  
FUNCTION LOCAL ValidateExpirationDateYear(value$)  
FUNCTION LOCAL ValidateGroupACH()  

ACH Group Validation, used to insure ACH columns are only set when an ACH payment is being entered

Returns [boolean] True = success, False = failure
FUNCTION LOCAL ValidateGroupCreditCard()  

Credit Card Group Validation, used to insure credit card columns are only set when a credit card payment is being entered

Returns [boolean] True = success, False = failure
FUNCTION LOCAL ValidateGroupPayment()  

Payment Group Validation, used to insure columns are only set when a credit card or ACH payment is being entered

Returns [boolean] True = success, False = failure
FUNCTION LOCAL ValidatePaymentType(value$)  
FUNCTION LOCAL ValidateSaveCreditCard(value$)  

Validates SaveCreditCard

ParameterDescription
value$ [input, string] SaveCreditCard
Returns [boolean] True = success, False = failure

Properties inherited from: AR_CreditCardCommon

cARDivisionNoCol$, cCustomerNoCol$, ccpNOTSUPPLIED$, ARCreditCard, AllowCreditCard, AllowCreditCardVoidReAuth, AllowACHVoidReAuth, AllowOverrideCCOnCM, PaymentTypeMethod$, AllowCorporateCard, ShowCorporateCCLevel3, AddCorporateCardLevel3$, SPSPaymentType, SPSEnabled, CreditCardUI, Source$, Request_v1, SOIntegrated, ITIntegrated, LastPaymentEMVReceipt$, LastDepositEMVReceipt$

Properties inherited from: CI_CreditCardGUID_val

cARDivisionNoCol$, cCustomerNoCol$, AllowCreditCard, AllowACH

Properties inherited from: CI_CreditCardID_val

cARDivisionNoCol$, cCustomerNoCol$, IgnoreNOF, SkipClearCCInfo

Methods inherited from: AR_CreditCardCommon

AddNewCreditCard(), CheckCreditCardTrackingID(), ClearCreditCardInfo(), GetNextCreditCardID(), GetPrimaryCreditCard(), ProcessCCVoid(), ProcessCreditCard(), ProcessVault(), SkipCCVoid(), AddLevel3LineItem(), AddLevel3LineItems(), CheckAmount(), CreditCardSubmit(), GetCardIDTables(), GetPaymentTypeProperties(), PostCreditCardSubmit(), PreCreditCardSubmit(), ResolveAVSState(), SetSource(), SetSourceInfo(), SetUIOptions(), TranslateDateTime(), TranslateTime()

Methods inherited from: CI_Country_val

ClassValidateCountry()

Methods inherited from: CI_CreditCardGUID_val

ClassValidateCreditCardGUID()

Methods inherited from: CI_CreditCardID_val

CardIDOnFile(), ClassValidateCreditCardID()

Methods inherited from: CI_PaymentType_Val

ClassValidatePaymentType()

Methods inherited from: CI_ZipCode_val

ClassValidateZIPCode()