Sage Intacct SDK for PHP
AbstractArPayment Class Reference
Inheritance diagram for AbstractArPayment:
AbstractFunction FunctionInterface ArPaymentApply ArPaymentCreate ArPaymentReverse

Public Member Functions

 getRecordNo ()
 
 setRecordNo ($recordNo)
 
 getPaymentMethod ()
 
 setPaymentMethod ($paymentMethod)
 
 getSummaryRecordNo ()
 
 setSummaryRecordNo ($summaryRecordNo)
 
 getBankAccountId ()
 
 setBankAccountId ($bankAccountId)
 
 getUndepositedFundsGlAccountNo ()
 
 setUndepositedFundsGlAccountNo ($undepositedFundsGlAccountNo)
 
 getTransactionCurrency ()
 
 setTransactionCurrency ($transactionCurrency)
 
 getBaseCurrency ()
 
 setBaseCurrency ($baseCurrency)
 
 getCustomerId ()
 
 setCustomerId ($customerId)
 
 getReceivedDate ()
 
 setReceivedDate ($receivedDate)
 
 getTransactionPaymentAmount ()
 
 setTransactionPaymentAmount ($transactionPaymentAmount)
 
 getBasePaymentAmount ()
 
 setBasePaymentAmount ($basePaymentAmount)
 
 getExchangeRateDate ()
 
 setExchangeRateDate ($exchangeRateDate)
 
 getExchangeRateValue ()
 
 setExchangeRateValue ($exchangeRateValue)
 
 getExchangeRateType ()
 
 setExchangeRateType ($exchangeRateType)
 
 getCreditCardType ()
 
 setCreditCardType ($creditCardType)
 
 getAuthorizationCode ()
 
 setAuthorizationCode ($authorizationCode)
 
 getOverpaymentLocationId ()
 
 setOverpaymentLocationId ($overpaymentLocationId)
 
 getOverpaymentDepartmentId ()
 
 setOverpaymentDepartmentId ($overpaymentDepartmentId)
 
 getReferenceNumber ()
 
 setReferenceNumber ($referenceNumber)
 
 getApplyToTransactions ()
 
 setApplyToTransactions ($applyToTransactions)
 
- Public Member Functions inherited from AbstractFunction
 getControlId ()
 
 setControlId (string $controlId='')
 
 __construct (string $controlId='')
 
 writeXml (XMLWriter &$xml)
 

Data Fields

const PAYMENT_METHOD_CHECK = 'Printed Check'
 
const PAYMENT_METHOD_CASH = 'Cash'
 
const PAYMENT_METHOD_RECORD_TRANSFER = 'EFT'
 
const PAYMENT_METHOD_CREDIT_CARD = 'Credit Card'
 
const PAYMENT_METHOD_ONLINE = 'Online'
 
const PAYMENT_METHOD_ONLINE_CREDIT_CARD = 'Online Charge Card'
 
const PAYMENT_METHOD_ONLINE_ACH_DEBIT = 'Online ACH Debit'
 
const PAYMENT_METHODS
 

Protected Attributes

 $recordNo
 
 $paymentMethod
 
 $summaryRecordNo
 
 $bankAccountId
 
 $undepositedFundsGlAccountNo
 
 $transactionCurrency
 
 $baseCurrency
 
 $customerId
 
 $receivedDate
 
 $transactionPaymentAmount
 
 $basePaymentAmount
 
 $exchangeRateDate
 
 $exchangeRateValue
 
 $exchangeRateType
 
 $creditCardType
 
 $authorizationCode
 
 $overpaymentLocationId
 
 $overpaymentDepartmentId
 
 $referenceNumber
 
 $applyToTransactions = []
 
- Protected Attributes inherited from AbstractFunction
 $controlId = ''
 

Member Function Documentation

◆ getApplyToTransactions()

getApplyToTransactions ( )

Get apply to transactions

Returns
ArPaymentItem[]

◆ getAuthorizationCode()

getAuthorizationCode ( )

Get authorization code

Returns
string

◆ getBankAccountId()

getBankAccountId ( )

Get bank account ID

Returns
string

◆ getBaseCurrency()

getBaseCurrency ( )

Get base currency

Returns
string

◆ getBasePaymentAmount()

getBasePaymentAmount ( )

Get base payment amount

Returns
float|string

◆ getCreditCardType()

getCreditCardType ( )
Returns
string

◆ getCustomerId()

getCustomerId ( )

Get customer ID

Returns
string

◆ getExchangeRateDate()

getExchangeRateDate ( )

Get exchange rate date

Returns
\DateTime

◆ getExchangeRateType()

getExchangeRateType ( )

Get exchange rate type

Returns
string

◆ getExchangeRateValue()

getExchangeRateValue ( )

Get exchange rate value

Returns
float

◆ getOverpaymentDepartmentId()

getOverpaymentDepartmentId ( )

Get overpayment department ID

Returns
string

◆ getOverpaymentLocationId()

getOverpaymentLocationId ( )

Get overpayment location ID

Returns
string

◆ getPaymentMethod()

getPaymentMethod ( )

Get payment method

Returns
string

◆ getReceivedDate()

getReceivedDate ( )

Get received date

Returns
\DateTime

◆ getRecordNo()

getRecordNo ( )

Get record number

Returns
int|string

◆ getReferenceNumber()

getReferenceNumber ( )

Get reference number

Returns
string

◆ getSummaryRecordNo()

getSummaryRecordNo ( )

Get Summary Record No (Batch Key)

Returns
int|string

◆ getTransactionCurrency()

getTransactionCurrency ( )

Get transaction currency

Returns
string

◆ getTransactionPaymentAmount()

getTransactionPaymentAmount ( )

Get transaction payment amount

Returns
float|string

◆ getUndepositedFundsGlAccountNo()

getUndepositedFundsGlAccountNo ( )

Get undeposited funds GL account number

Returns
string

◆ setApplyToTransactions()

setApplyToTransactions (   $applyToTransactions)

Set apply to transactions

Parameters
ArPaymentItem[]$applyToTransactions

◆ setAuthorizationCode()

setAuthorizationCode (   $authorizationCode)

Set authorization code

Parameters
string$authorizationCode

◆ setBankAccountId()

setBankAccountId (   $bankAccountId)

Set bank account ID

Parameters
string$bankAccountId

◆ setBaseCurrency()

setBaseCurrency (   $baseCurrency)

Set base currency

Parameters
string$baseCurrency

◆ setBasePaymentAmount()

setBasePaymentAmount (   $basePaymentAmount)

Set base payment amount

Parameters
float | string$basePaymentAmount

◆ setCreditCardType()

setCreditCardType (   $creditCardType)
Parameters
string$creditCardType

◆ setCustomerId()

setCustomerId (   $customerId)

Set customer ID

Parameters
string$customerId

◆ setExchangeRateDate()

setExchangeRateDate (   $exchangeRateDate)

Set exchange rate date

Parameters
\DateTime$exchangeRateDate

◆ setExchangeRateType()

setExchangeRateType (   $exchangeRateType)

Set exchange rate type

Parameters
string$exchangeRateType

◆ setExchangeRateValue()

setExchangeRateValue (   $exchangeRateValue)

Set exchange rate value

Parameters
float$exchangeRateValue

◆ setOverpaymentDepartmentId()

setOverpaymentDepartmentId (   $overpaymentDepartmentId)

Set overpayment department ID

Parameters
string$overpaymentDepartmentId

◆ setOverpaymentLocationId()

setOverpaymentLocationId (   $overpaymentLocationId)

Set overpayment location ID

Parameters
string$overpaymentLocationId

◆ setPaymentMethod()

setPaymentMethod (   $paymentMethod)

Set payment method

Parameters
string$paymentMethod
Exceptions
InvalidArgumentException

◆ setReceivedDate()

setReceivedDate (   $receivedDate)

Set received date

Parameters
\DateTime$receivedDate

◆ setRecordNo()

setRecordNo (   $recordNo)

Set record number

Parameters
int | string$recordNo

◆ setReferenceNumber()

setReferenceNumber (   $referenceNumber)

Set reference number

Parameters
string$referenceNumber

◆ setSummaryRecordNo()

setSummaryRecordNo (   $summaryRecordNo)

Set Summary Record No (Batch Key)

Parameters
string | int$summaryRecordNo

◆ setTransactionCurrency()

setTransactionCurrency (   $transactionCurrency)

Set transaction currency

Parameters
string$transactionCurrency

◆ setTransactionPaymentAmount()

setTransactionPaymentAmount (   $transactionPaymentAmount)

Set transaction payment amount

Parameters
float | string$transactionPaymentAmount

◆ setUndepositedFundsGlAccountNo()

setUndepositedFundsGlAccountNo (   $undepositedFundsGlAccountNo)

Set undeposited funds GL account number

Parameters
string$undepositedFundsGlAccountNo

Field Documentation

◆ $applyToTransactions

$applyToTransactions = []
protected

◆ $authorizationCode

$authorizationCode
protected

◆ $bankAccountId

$bankAccountId
protected

◆ $baseCurrency

$baseCurrency
protected

◆ $basePaymentAmount

$basePaymentAmount
protected

◆ $creditCardType

$creditCardType
protected

◆ $customerId

$customerId
protected

◆ $exchangeRateDate

$exchangeRateDate
protected

◆ $exchangeRateType

$exchangeRateType
protected

◆ $exchangeRateValue

$exchangeRateValue
protected

◆ $overpaymentDepartmentId

$overpaymentDepartmentId
protected

◆ $overpaymentLocationId

$overpaymentLocationId
protected

◆ $paymentMethod

$paymentMethod
protected

◆ $receivedDate

$receivedDate
protected

◆ $recordNo

$recordNo
protected

◆ $referenceNumber

$referenceNumber
protected

◆ $summaryRecordNo

$summaryRecordNo
protected

◆ $transactionCurrency

$transactionCurrency
protected

◆ $transactionPaymentAmount

$transactionPaymentAmount
protected

◆ $undepositedFundsGlAccountNo

$undepositedFundsGlAccountNo
protected

◆ PAYMENT_METHOD_CASH

const PAYMENT_METHOD_CASH = 'Cash'

◆ PAYMENT_METHOD_CHECK

const PAYMENT_METHOD_CHECK = 'Printed Check'

◆ PAYMENT_METHOD_CREDIT_CARD

const PAYMENT_METHOD_CREDIT_CARD = 'Credit Card'

◆ PAYMENT_METHOD_ONLINE

const PAYMENT_METHOD_ONLINE = 'Online'

◆ PAYMENT_METHOD_ONLINE_ACH_DEBIT

const PAYMENT_METHOD_ONLINE_ACH_DEBIT = 'Online ACH Debit'

◆ PAYMENT_METHOD_ONLINE_CREDIT_CARD

const PAYMENT_METHOD_ONLINE_CREDIT_CARD = 'Online Charge Card'

◆ PAYMENT_METHOD_RECORD_TRANSFER

const PAYMENT_METHOD_RECORD_TRANSFER = 'EFT'

◆ PAYMENT_METHODS

const PAYMENT_METHODS
Initial value:
= [
'Printed Check',
'Cash',
'EFT',
'Credit Card',
'Online',
]