class ApPaymentRequestDelete extends AbstractApPaymentRequest

Delete an existing AP payment request record

Constants

PAYMENT_METHODS

PAYMENT_METHOD_CHECK

PAYMENT_METHOD_CASH

PAYMENT_METHOD_RECORD_TRANSFER

PAYMENT_METHOD_CHARGE_CARD

PAYMENT_METHOD_ACH

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 function block 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
getChargeCardId()

Get charge card ID

setChargeCardId(string $chargeCardId)

Set charge card ID

string
getVendorId()

Get vendor ID

setVendorId(string $vendorId)

Set vendor ID

string
getMergeOption()

Get merge option

setMergeOption(string $mergeOption)

Set merge option

boolean
isGroupPayments()

Get group payments

setGroupPayments(boolean $groupPayments)

Set group payments

setPaymentDate(DateType $paymentDate)

Set payment date

float|string
getTransactionAmount()

Get transaction amount

setTransactionAmount(float|string $transactionAmount)

Set transaction amount

string
getDocumentNo()

Get document number

setDocumentNo(string $documentNo)

Set document number

string
getMemo()

Get memo

setMemo(string $memo)

Set memo

string
getNotificationContactName()

Get notification contact name

setNotificationContactName(string $notificationContactName)

Set notification contact name

setApplyToTransactions(ApPaymentRequestItem[] $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

at line line 35
writeXml(XMLWriter $xml)

Write the function block XML

Parameters

XMLWriter $xml

in AbstractApPaymentRequest at line line 96
int|string getRecordNo()

Get record number

Return Value

int|string

in AbstractApPaymentRequest at line line 106
setRecordNo(int|string $recordNo)

Set record number

Parameters

int|string $recordNo

in AbstractApPaymentRequest at line line 116
string getPaymentMethod()

Get payment method

Return Value

string

in AbstractApPaymentRequest at line line 127
setPaymentMethod(string $paymentMethod)

Set payment method

Parameters

string $paymentMethod

Exceptions

InvalidArgumentException

in AbstractApPaymentRequest at line line 140
string getBankAccountId()

Get bank account ID

Return Value

string

in AbstractApPaymentRequest at line line 150
setBankAccountId(string $bankAccountId)

Set bank account ID

Parameters

string $bankAccountId

in AbstractApPaymentRequest at line line 160
string getChargeCardId()

Get charge card ID

Return Value

string

in AbstractApPaymentRequest at line line 170
setChargeCardId(string $chargeCardId)

Set charge card ID

Parameters

string $chargeCardId

in AbstractApPaymentRequest at line line 180
string getVendorId()

Get vendor ID

Return Value

string

in AbstractApPaymentRequest at line line 190
setVendorId(string $vendorId)

Set vendor ID

Parameters

string $vendorId

in AbstractApPaymentRequest at line line 200
string getMergeOption()

Get merge option

Return Value

string

in AbstractApPaymentRequest at line line 211
setMergeOption(string $mergeOption)

Set merge option

Parameters

string $mergeOption

in AbstractApPaymentRequest at line line 221
boolean isGroupPayments()

Get group payments

Return Value

boolean

in AbstractApPaymentRequest at line line 231
setGroupPayments(boolean $groupPayments)

Set group payments

Parameters

boolean $groupPayments

in AbstractApPaymentRequest at line line 241
DateType getPaymentDate()

Get payment date

Return Value

DateType

in AbstractApPaymentRequest at line line 251
setPaymentDate(DateType $paymentDate)

Set payment date

Parameters

DateType $paymentDate

in AbstractApPaymentRequest at line line 261
float|string getTransactionAmount()

Get transaction amount

Return Value

float|string

in AbstractApPaymentRequest at line line 271
setTransactionAmount(float|string $transactionAmount)

Set transaction amount

Parameters

float|string $transactionAmount

in AbstractApPaymentRequest at line line 281
string getDocumentNo()

Get document number

Return Value

string

in AbstractApPaymentRequest at line line 291
setDocumentNo(string $documentNo)

Set document number

Parameters

string $documentNo

in AbstractApPaymentRequest at line line 301
string getMemo()

Get memo

Return Value

string

in AbstractApPaymentRequest at line line 311
setMemo(string $memo)

Set memo

Parameters

string $memo

in AbstractApPaymentRequest at line line 321
string getNotificationContactName()

Get notification contact name

Return Value

string

in AbstractApPaymentRequest at line line 331
setNotificationContactName(string $notificationContactName)

Set notification contact name

Parameters

string $notificationContactName

in AbstractApPaymentRequest at line line 341
ApPaymentRequestItem[] getApplyToTransactions()

Get apply to transactions

Return Value

ApPaymentRequestItem[]

in AbstractApPaymentRequest at line line 351
setApplyToTransactions(ApPaymentRequestItem[] $applyToTransactions)

Set apply to transactions

Parameters

ApPaymentRequestItem[] $applyToTransactions