class AbstractArPayment extends AbstractFunction

Constants

PAYMENT_METHOD_CHECK

PAYMENT_METHOD_CASH

PAYMENT_METHOD_RECORD_TRANSFER

PAYMENT_METHOD_CREDIT_CARD

PAYMENT_METHOD_ONLINE

PAYMENT_METHOD_ONLINE_CREDIT_CARD

PAYMENT_METHOD_ONLINE_ACH_DEBIT

PAYMENT_METHODS

Methods

getControlId()

Get control ID

setControlId($controlId = null)

Set control ID

__construct(string $controlId = null)

Initializes the class with the given parameters.

writeXml(XMLWriter $xml)

Write the XML

int|string
getRecordNo()

Get record number

setRecordNo(int|string $recordNo)

Set record number

string
getPaymentMethod()

Get payment method

setPaymentMethod(string $paymentMethod)

Set payment method

string
getBankAccountId()

Get bank account ID

setBankAccountId(string $bankAccountId)

Set bank account ID

string
getUndepositedFundsGlAccountNo()

Get undeposited funds GL account number

setUndepositedFundsGlAccountNo(string $undepositedFundsGlAccountNo)

Set undeposited funds GL account number

string
getTransactionCurrency()

Get transaction currency

setTransactionCurrency(string $transactionCurrency)

Set transaction currency

string
getBaseCurrency()

Get base currency

setBaseCurrency(string $baseCurrency)

Set base currency

string
getCustomerId()

Get customer ID

setCustomerId(string $customerId)

Set customer ID

getReceivedDate()

Get received date

setReceivedDate(DateType $receivedDate)

Set received date

float|string
getTransactionPaymentAmount()

Get transaction payment amount

setTransactionPaymentAmount(float|string $transactionPaymentAmount)

Set transaction payment amount

float|string
getBasePaymentAmount()

Get base payment amount

setBasePaymentAmount(float|string $basePaymentAmount)

Set base payment amount

getExchangeRateDate()

Get exchange rate date

setExchangeRateDate(DateType $exchangeRateDate)

Set exchange rate date

float
getExchangeRateValue()

Get exchange rate value

setExchangeRateValue(float $exchangeRateValue)

Set exchange rate value

string
getExchangeRateType()

Get exchange rate type

setExchangeRateType(string $exchangeRateType)

Set exchange rate type

string
getCreditCardType()

No description

setCreditCardType(string $creditCardType)

No description

string
getAuthorizationCode()

Get authorization code

setAuthorizationCode(string $authorizationCode)

Set authorization code

string
getOverpaymentLocationId()

Get overpayment location ID

setOverpaymentLocationId(string $overpaymentLocationId)

Set overpayment location ID

string
getOverpaymentDepartmentId()

Get overpayment department ID

setOverpaymentDepartmentId(string $overpaymentDepartmentId)

Set overpayment department ID

string
getReferenceNumber()

Get reference number

setReferenceNumber(string $referenceNumber)

Set reference number

getApplyToTransactions()

Get apply to transactions

setApplyToTransactions(ArPaymentItem[] $applyToTransactions)

Set apply to transactions

Details

in AbstractFunction at line line 35
getControlId()

Get control ID

in AbstractFunction at line line 46
setControlId($controlId = null)

Set control ID

Parameters

$controlId

Exceptions

InvalidArgumentException

in AbstractFunction at line line 67
__construct(string $controlId = null)

Initializes the class with the given parameters.

Parameters

string $controlId Control ID, default=random UUID

in AbstractFunction at line line 72
abstract writeXml(XMLWriter $xml)

Write the XML

Parameters

XMLWriter $xml

at line line 121
int|string getRecordNo()

Get record number

Return Value

int|string

at line line 131
setRecordNo(int|string $recordNo)

Set record number

Parameters

int|string $recordNo

at line line 141
string getPaymentMethod()

Get payment method

Return Value

string

at line line 152
setPaymentMethod(string $paymentMethod)

Set payment method

Parameters

string $paymentMethod

Exceptions

InvalidArgumentException

at line line 165
string getBankAccountId()

Get bank account ID

Return Value

string

at line line 175
setBankAccountId(string $bankAccountId)

Set bank account ID

Parameters

string $bankAccountId

at line line 185
string getUndepositedFundsGlAccountNo()

Get undeposited funds GL account number

Return Value

string

at line line 195
setUndepositedFundsGlAccountNo(string $undepositedFundsGlAccountNo)

Set undeposited funds GL account number

Parameters

string $undepositedFundsGlAccountNo

at line line 205
string getTransactionCurrency()

Get transaction currency

Return Value

string

at line line 215
setTransactionCurrency(string $transactionCurrency)

Set transaction currency

Parameters

string $transactionCurrency

at line line 225
string getBaseCurrency()

Get base currency

Return Value

string

at line line 235
setBaseCurrency(string $baseCurrency)

Set base currency

Parameters

string $baseCurrency

at line line 245
string getCustomerId()

Get customer ID

Return Value

string

at line line 255
setCustomerId(string $customerId)

Set customer ID

Parameters

string $customerId

at line line 265
DateType getReceivedDate()

Get received date

Return Value

DateType

at line line 275
setReceivedDate(DateType $receivedDate)

Set received date

Parameters

DateType $receivedDate

at line line 285
float|string getTransactionPaymentAmount()

Get transaction payment amount

Return Value

float|string

at line line 295
setTransactionPaymentAmount(float|string $transactionPaymentAmount)

Set transaction payment amount

Parameters

float|string $transactionPaymentAmount

at line line 305
float|string getBasePaymentAmount()

Get base payment amount

Return Value

float|string

at line line 315
setBasePaymentAmount(float|string $basePaymentAmount)

Set base payment amount

Parameters

float|string $basePaymentAmount

at line line 325
DateType getExchangeRateDate()

Get exchange rate date

Return Value

DateType

at line line 335
setExchangeRateDate(DateType $exchangeRateDate)

Set exchange rate date

Parameters

DateType $exchangeRateDate

at line line 345
float getExchangeRateValue()

Get exchange rate value

Return Value

float

at line line 355
setExchangeRateValue(float $exchangeRateValue)

Set exchange rate value

Parameters

float $exchangeRateValue

at line line 365
string getExchangeRateType()

Get exchange rate type

Return Value

string

at line line 375
setExchangeRateType(string $exchangeRateType)

Set exchange rate type

Parameters

string $exchangeRateType

at line line 383
string getCreditCardType()

Return Value

string

at line line 391
setCreditCardType(string $creditCardType)

Parameters

string $creditCardType

at line line 401
string getAuthorizationCode()

Get authorization code

Return Value

string

at line line 411
setAuthorizationCode(string $authorizationCode)

Set authorization code

Parameters

string $authorizationCode

at line line 421
string getOverpaymentLocationId()

Get overpayment location ID

Return Value

string

at line line 431
setOverpaymentLocationId(string $overpaymentLocationId)

Set overpayment location ID

Parameters

string $overpaymentLocationId

at line line 441
string getOverpaymentDepartmentId()

Get overpayment department ID

Return Value

string

at line line 451
setOverpaymentDepartmentId(string $overpaymentDepartmentId)

Set overpayment department ID

Parameters

string $overpaymentDepartmentId

at line line 461
string getReferenceNumber()

Get reference number

Return Value

string

at line line 471
setReferenceNumber(string $referenceNumber)

Set reference number

Parameters

string $referenceNumber

at line line 481
ArPaymentItem[] getApplyToTransactions()

Get apply to transactions

Return Value

ArPaymentItem[]

at line line 491
setApplyToTransactions(ArPaymentItem[] $applyToTransactions)

Set apply to transactions

Parameters

ArPaymentItem[] $applyToTransactions