|
FUNCTION AddDeposit() |
This function is used by the Business Object Interface users to create deposit record
|
| Returns |
[boolean] True = success, False = failure |
|
|
FUNCTION AddPayment() |
This function is used by the Business Object Interface users to create payment record
|
| Returns |
[boolean] True = success, False = failure |
|
|
FUNCTION AdjustPayment() |
This function adjusts transaction amount in payment records based on net document total
|
| Returns |
[boolean] True = success, False = failure |
|
|
FUNCTION AuthorizedTransactionExists(whatToVoid$) |
This function determines if there are authorized transactions that should be voided
|
| Parameter | Description |
| whatToVoid$ |
[input, string] "OLD" (check cPhysicalFH) "NEW" (check cFH) |
|
| Returns |
[boolean] True = authorized transaction exists, False = no authorized transaction |
|
|
FUNCTION CheckDepositAmount() |
This function checks that credit card deposit amount does not exceed order/invoice total
|
| Returns |
[boolean] True = deposit does not exceed total, False = deposit exceeds total |
|
|
FUNCTION CLEAR() |
This function clears payment records
|
| Returns |
[boolean] True = success, False = failure |
|
|
FUNCTION CommitRow() |
This function commits changes to physical file
|
| Returns |
[boolean] True = success, False = failure |
|
|
FUNCTION CreditCardAuthorized() |
|
FUNCTION CreditCardAuthorized(authOnThisDocOnly) |
Check if any SPS credit card transaction has been authorized
|
| Parameter | Description |
| authOnThisDocOnly |
{optional} [input, boolean] if true, only want to know if authorization occurred on the invoice |
|
| Returns |
[boolean] True = transaction authorized, False = transaction not authorized |
|
|
FUNCTION CreditCardCheckRequired() |
This function validates that all payment records have no missing required fields
|
| Returns |
[boolean] True = success, False = failure |
|
|
FUNCTION CreditCardDelete() |
This function checks if authorized sales transaction exists and voids it
|
| Returns |
[boolean] True = success, False = failure |
|
|
FUNCTION CreditCardPreAccept() |
Credit Card specific pre-BT_Accept validation logic
|
| Returns |
[boolean] True = need to process credit card through Paya Exchange, False = no need to process credit card |
|
|
FUNCTION CreditCardPreWrite() |
|
FUNCTION CreditCardPreWrite(skipProcessCC) |
Pre-Write Credit Card validations
|
| Parameter | Description |
| skipProcessCC |
{optional} [input, boolean] when true, will not process transaction through Paya Exchange |
|
| Returns |
[boolean] True = success, False = failure |
|
|
FUNCTION DefaultCustomerCreditCard(paymentMethod$) |
This function sets or refreshes payment records with the customer's default credit card
|
| Parameter | Description |
| paymentMethod$ |
[input, string] payment method required (A or R) for the default payment |
|
| Returns |
[boolean] True = success, False = failure |
|
|
FUNCTION Delete(key$) |
This function deletes a payment record
|
| Parameter | Description |
| key$ |
[input, string] key of payment record to delete |
|
| Returns |
[boolean] True = success, False = failure |
|
|
FUNCTION DeleteAll() |
This function deletes all payment records for the current document
|
| Returns |
[boolean] True = success, False = failure |
|
|
FUNCTION DepositExists() |
This function determine if deposit record exists
|
| Returns |
[boolean] True = success, False = failure |
|
|
FUNCTION DocumentPreWrite() |
This function validates payment and deposit record before the document is written
|
| Returns |
[boolean] True = success, False = failure |
|
|
FUNCTION GetNextSeqNo$() |
This function returns the next sequence number
|
| Returns |
[string] formatted next sequence number |
|
|
FUNCTION InitPaymentObj() |
Initialize payment object for a document
|
| Returns |
[boolean] True = success |
|
|
FUNCTION MultiCCInUse() |
This function determines if multiple credit cards or multiple deposits or multiple payments exist.
|
| Returns |
[boolean] always return True |
|
|
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 PaymentPreAuthorized() |
This function determines if payment has been pre-authorized
|
| Returns |
[boolean] True = payments pre-authorized, False = payments not pre-authorized |
|
|
FUNCTION ProcessAllCreditCards() |
This function processes all credit card transactions in a document
|
| Returns |
[boolean] True = success, False = failure |
|
|
FUNCTION RecalcCorporateSalesTax() |
This function recalculates corporate sales tax in all records
|
| Returns |
[boolean] True = success, False = failure |
|
|
FUNCTION SetCommonInfo() |
This function gets data from document heaader business object
|
| Returns |
[boolean] True = success, False = failure |
|
|
FUNCTION SetHeaderBusObj(value) |
This function sets the property that contains the handle of the document header business object
|
| Parameter | Description |
| value |
[input, numeric] handle of SO_SalesOrder_bus or SO_Invoice_bus |
|
| Returns |
[boolean] True = success, False = failure |
|
|
FUNCTION SetKey(key$) |
This function sets the key of a record
|
| Parameter | Description |
| key$ |
[input, string] key of the record |
|
| Returns |
[boolean] True = success, False = failure |
|
|
FUNCTION SetPaymentKey(type$) |
This function sets the key of the current record based on payment type
|
| Parameter | Description |
| type$ |
[input, string] "P" or "D" |
|
| Returns |
[boolean] True = success, False = failure |
|
|
FUNCTION SetRecordKey(seqNo$) |
This function sets the key of the current record
|
| Parameter | Description |
| seqNo$ |
[input, string] sequence number of the payment record |
|
| Returns |
[boolean] True = success, False = failure |
|
|
FUNCTION VoidAuthorizedTransaction(whatToVoid$) |
This function voids authorized transactions
|
| Parameter | Description |
| whatToVoid$ |
[input, string] "OLD" or "NEW". Void old transactions or new transactions |
|
| Returns |
[boolean] True = success, False = failure |
|
|
FUNCTION WRITE() |
This function performs pre-write validation and writes a payment record
|
| Returns |
[boolean] True = success, False = failure |
|
|
FUNCTION LOCAL AdjustTransaction(type$, balance, distLimit, ignoreCCAuth) |
This function adjusts transaction amount in payment records based on invoice balance
|
| Parameter | Description |
| type$ |
[input, string] payment type category "D" or "P" |
| balance |
[input, numeric] balance |
| distLimit |
[input, numeric] distribution limit, 0 for no limit |
| ignoreCCAuth |
[input, boolean] ignore credit card authorization |
|
| Returns |
[boolean] True = success, False = failure |
|
|
FUNCTION LOCAL AllowVoid() |
This function determines if user has rights to void credit card or ACH transactions
|
| Returns |
[boolean] True = user has rights, False = user does not have rights |
|
|
FUNCTION LOCAL CheckPaymentMethod(paymentMethod$) |
Check that payment method of Payment ID or Payment Type is valid for deposit
|
| Parameter | Description |
| paymentMethod$ |
[input string] payment method of the Payment ID or Payment Type entered |
|
| Returns |
[boolean] Success or Failure |
|
|
FUNCTION LOCAL GetDepositSalesTax() |
This function gets Corporate Sales Tax in deposit record
|
| Returns |
[numeric] sales tax amount |
|
|
FUNCTION LOCAL InitPreAuthAmtOverrd() |
This function determines if the transaction amount in the payment record has been overridden and sets property cPreAuthAmtOverrd
|
| Returns |
[boolean] True = success |
|
|
FUNCTION LOCAL OneCardRecordsValidation() |
This function validates payment and deposit records and updates header payment fields
|
| Returns |
[boolean] True = success, False = failure |
|
|
FUNCTION LOCAL ProcessCreditCardByCategory(category$) |
This function processes one specific category of Paya Exchange credit card transactions
|
| Parameter | Description |
| category$ |
[input, string] payment type category "P" (payment/preauthorization) or "D" (deposit) |
|
| Returns |
[boolean] True = success, False = failure |
|
|
FUNCTION LOCAL RecalcTax(pmtTypeCat$, remainingTax, remainingBal, limit) |
This function calculates corporate sales tax
|
| Parameter | Description |
| pmtTypeCat$ |
[input, string] payment type category - P or D |
| remainingTax |
[input, numeric] remaining sales tax to distribute to payment records |
| remainingBal |
[input, numeric] remaining balance |
| limit |
[input, numeric] maximum corporate tax allowed, -1 = no limit (used by S/O invoice) |
|
| Returns |
[boolean] True = success, False = failure. |
|
|
FUNCTION LOCAL SetChildColl() |
This function creates child collections
|
| Returns |
[boolean] True = success |
|
|
FUNCTION LOCAL SetCurrentKey(key$) |
This function sets cCurrentKey$ and other properties to the default values
|
| Returns |
[boolean] True = success |
|
|
FUNCTION LOCAL SetDefaults() |
This function sets default values in a payment record
|
| Returns |
[boolean] True = success, False = failure |
|
|
FUNCTION LOCAL ValidateCreditCardAuthorizationNo(value$) |
This function validates credit card authorization number
|
| Parameter | Description |
| value$ |
[input, string] authorization number |
|
| Returns |
[boolean] True = success, False = failure. |
|
|
FUNCTION LOCAL ValidateCreditCardID(value$) |
This function validates credit card ID.
|
| Parameter | Description |
| value$ |
[input, string] Credit Card ID |
|
| Returns |
[boolean] True = success, False = failure. |
|
|
FUNCTION LOCAL ValidateGroupCCLevel3Hdr() |
Credit Card Level 3 Hdr Group Validation, used to ensure AddCorporateCardLevel3$ isYES$ before allowing value to be set
|
| Returns |
[boolean] True = success, False = failure |
|
|
FUNCTION LOCAL ValidatePaymentType(value$) |
This function validates credit card payment type
|
| Parameter | Description |
| value$ |
[input, string] payment type |
|
| Returns |
[boolean] True = success, False = failure. |
|
|
FUNCTION LOCAL ValidatePaymentTypeCategory(value$) |
This function validates credit card payment type category
|
| Parameter | Description |
| value$ |
[input, string] payment type category |
|
| Returns |
[boolean] True = success, False = failure. |
|
|
FUNCTION LOCAL ValidateTransactionAmt(value) |
This function validates transaction amount
|
| Parameter | Description |
| value |
[input, numeric] transaction amount |
|
| Returns |
[boolean] True = success, False = failure. |
|
|
FUNCTION LOCAL ValidateTransAmtCheckDeposit(value) |
This function checks that deposit amount does not exceed document total (used by ValidateTransactionAmt method)
|
| Parameter | Description |
| value |
[input, numeric] deposit amount |
|
| Returns |
[numeric] 1 = success, 0 = failure, -1 = warning |
|