Class SO_InvoicePayment_bus

Properties

LOCAL cMainTable$="SO_InvoicePayment"  

Name of payment table

LOCAL cDisplayedKey$="InvoiceNo$"  
Key to display in messages
LOCAL cDocumentKey$="InvoiceNo$"  
Document key field
PROPERTY DepositProcessedInSO   * Read Only *
Boolean property. If true, sps deposit transaction was authorized on sales order
PROPERTY MaxCCPaymentToApply   * Read Only *
Maximum credit allowed on a credit card for credit memo
PROPERTY PreAuthProcessedInSO   * Read Only *
Boolean property. If true, sps preauthorization transaction was authorized on sales order
PROPERTY SOAuthorizationExpired   * Read Only *
Boolean property. If true, preauthorization on sales order has expired or has not been authorized
PROPERTY SOCreditCardExpired   * Read Only *
Boolean property. If true, credit card on sales order has expired
PROPERTY TransactionVoided  
Boolean property. If true, a credit transaction or post authorization has been voided
PROPERTY CreditCardVoidReqd   * Read Only *
Boolean property, when true a Credit card transaction processed exists that requires a void when deleted

Methods

FUNCTION AdjustPayment()  
FUNCTION AdjustPayment(applyAllSODeposit)  

This function adjusts transaction amount in payment and deposit records based on net invoice total

ParameterDescription
applyAllSODeposit {optional} [input, boolean] if true, apply entire sales order deposit to invoice
Returns [boolean] True = success, False = failure
FUNCTION CheckDepositAmount()  

This function checks that credit card deposit amount does not exceed order/invoice total and credit memo authorization amount does not exceed credit card payment from history for certain users and credit memo authorization does not exceed credit memo total

Returns [boolean] True = deposit/authorization amount is valid, False = deposit/authorization amount is invalid
FUNCTION CheckForCCPayments(invoiceNo$, invoiceType$, defaultCC)  

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]
Returns [boolean] True = success.
FUNCTION CheckSalesOrderTransactions()  

Determine if a SPS credit card has been authorized on sales order, if preauthorization amount was overridden (SPS and non-SPS), and if preauthorization has expired (SPS and non-SPS)

Returns [boolean] True = credit card authorized on sales order, False = credit card not authorized on sales order
FUNCTION CLEAR()  

This function clears payment records

Returns [boolean] True = success, False = failure
FUNCTION CopyOrderPayment(appliedSO$)  
FUNCTION CopyOrderPayment()  

This function copies payment records from a sales order

ParameterDescription
appliedSO$ {optional} [input, string] applied sales order number to copy payment records from
Returns [boolean] True = success, False = failure
FUNCTION DepositAuthorized()  
FUNCTION DepositAuthorized(authOnThisDocOnly)  

This function determines if deposit has been authorized

ParameterDescription
authOnThisDocOnly {optional} [input, boolean] if true, only want to know if authorization occurred on the invoice
Returns [boolean] True = deposit authorized, False = deposit not authorized
FUNCTION DepositChangedOnInvoice()  

This function determines if authorized deposit on invoice is different than the deposit on sales order

Returns [boolean] True = they are different, False = they are the same
FUNCTION GetContext$(destTable$)  

This function returns data source contexts

ParameterDescription
destTable$ {optional} [input, string] name of destination table
Returns [string] list of contexts separated by SEP
FUNCTION GetContextSourceTables$(context$)  

This function returns data source table for a given context

ParameterDescription
context$ [input, string] name of context
Returns [string] name of source table
FUNCTION InitPaymentObj()  

Initialize payment object for a document

Returns [boolean] True = success
FUNCTION NoValidationWrite()  

This function writes a payment record without performing pre-write validation. It is used by sales order entry credit card panel to write un-finished record.

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

This function determines if credit card payment has been post-authorized or ACH payment has been authorized

Returns [boolean] True = payments post-authorized, False = payments not post-authorized
FUNCTION SetBatchDelete(value)  

This function sets cBatchDelete

ParameterDescription
value [input, boolean] cBatchDelete
Returns [boolean] True = success
FUNCTION SetCommonInfo()  

This function gets data from document heaader business object

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

This function voids post-authorization transaction because invoice total has changed

Returns [boolean] True = success, False = failure

Properties inherited from: SO_CommonPayment_bus

cIsSysDB, AllowCashCustomer, OneCardDepositSeqNo$, OneCardPaymentSeqNo$, MultiCC, CommonInfoIOL$, BillToSvcObj, NetDocumentTotal, DocumentTotal, InHeaderDocTotalCalc

Properties inherited from: SY_Customization

cDummyIol$

Methods inherited from: SO_CommonPayment_bus

AddDeposit(), AddPayment(), AdjustPayment(), AuthorizedTransactionExists(), CheckDepositAmount(), CLEAR(), CommitRow(), CreditCardAuthorized(), CreditCardCheckRequired(), CreditCardDelete(), CreditCardPreAccept(), CreditCardPreWrite(), DefaultCustomerCreditCard(), DeleteAll(), DepositExists(), DocumentPreWrite(), GetNextSeqNo$(), InitPaymentObj(), MultiCCInUse(), NoValidationWrite(), PaymentPreAuthorized(), ProcessAllCreditCards(), RecalcCorporateSalesTax(), SetCommonInfo(), SetHeaderBusObj(), SetKey(), SetPaymentKey(), SetRecordKey(), VoidAuthorizedTransaction(), WRITE(), AdjustTransaction(), AllowVoid(), CheckPaymentMethod(), GetDepositSalesTax(), InitPreAuthAmtOverrd(), OneCardRecordsValidation(), ProcessCreditCardByCategory(), RecalcTax(), SetChildColl(), SetCurrentKey(), SetDefaults(), ValidateCreditCardAuthorizationNo(), ValidateCreditCardID(), ValidateGroupCCLevel3Hdr(), ValidatePaymentType(), ValidatePaymentTypeCategory(), ValidateTransactionAmt(), ValidateTransAmtCheckDeposit()

Methods inherited from: SY_Customization

GetCustomizations(), PostTableRead(), PreNextRecord(), PreTableWrite()