Docs For Class CustomerAccount

CustomerAccount __construct ([String $code = null], [DateTime $createDate = null], [String $firstName = null], [String $lastName = null], [String $middleName = null], [String $title = null], [String $suffix = null], [String $type = null], [bool $isActive = null], [String $homePhone = null], [String $workPhone = null], [String $cellPhone = null], [String $email = null], [String $street1 = null], [String $street2 = null], [String $city = null], [String $state = null], [String $zipCode = null], [int $balance = null], [String $beneficiaryInfo = null], [int $merchantAccountCode = null], [String $customerAccountGroupCode = null], [bool $isVerified = null], [String $notes = null], [DateTime $lastUpdateDate = null], [DateTime $birthDate = null], [int $id = null])

void addAssetTransaction (AssetTransaction $assetTransaction)

void addPaymentOption (PaymentOption $paymentOption)

void addPaymentPlan (PaymentPlan $paymentPlan)

void addRevenueTransaction (RevenueTransaction $revenueTransaction)

void clear ()

AssetTransaction createAllowance (String $code, int $amount, String $note, String $creatorCode, String $sellerCode, String $shiftCode, String $terminalCode)

AssetTransaction createAllowanceRefund (String $code, int $amount, String $note, String $creatorCode, String $sellerCode, String $shiftCode, String $terminalCode, String $accountNumber, String $accessory)

AssetTransaction createAssetTransaction ([bool $addToCustomerAccount = true])

AssetTransaction createAssetTransactionExtended (String $accountActivityType, String $code, int $amount, String $accountNumber, String $accessory)

PaymentOption createBankAccount (String $code, String $holderName, String $bankNumber, String $routingNumber, bool $isSaving)

PaymentOption createBankAccountExtended (String $code, String $holderName, String $bankNumber, String $routingNumber, String $street1, String $street2, String $city, String $state, String $zipCode, bool $isSaving)

AssetTransaction createCashPayment (int $amount, String $note, String $creatorCode, String $sellerCode, String $shiftCode, String $terminalCode, String $code)

AssetTransaction createCashRefund (int $amount, String $note, String $creatorCode, String $sellerCode, String $shiftCode, String $terminalCode, String $accountNumber, String $accessory, String $code)

AssetTransaction createCheckPayment (int $amount, String $note, String $creatorCode, String $sellerCode, String $shiftCode, String $terminalCode, String $checkNumber, String $code)

RevenueTransaction createCredit ()

PaymentOption createCreditCard (String $code, String $holderName, String $creditCardNumber, String $expirationDate, String $type)

PaymentOption createCreditCardExtended (String $code, String $holderName, String $creditCardNumber, String $expirationDate, String $type, String $street1, String $street2, String $city, String $state, String $zipCode)

AssetTransaction createCreditCardPayment (int $amount, String $note, String $creatorCode, String $sellerCode, String $shiftCode, String $terminalCode, String $creditCardNumber, String $expirationDate, String $transactionType, String $holderName, String $city, String $state, String $street1, String $street2, String $zipCode, String $phone, String $email, String $cvv2, String $code)

AssetTransaction createCreditCardRefund (int $amount, String $note, String $creatorCode, String $sellerCode, String $shiftCode, String $terminalCode, String $creditCardNumber, String $expirationDate, String $transactionType, String $holderName, String $city, String $state, String $street1, String $street2, String $zipCode, String $phone, String $email, String $cvv2, String $code)

RevenueTransaction createCreditExtended (int $amount, String $note, String $creatorCode, String $sellerCode, String $shiftCode, String $terminalCode, DateTime $dueDate, int $taxAmount, String $itemCode)

RevenueTransaction createInvoice (String $type, int $amount, String $note, String $creatorCode, String $sellerCode, String $shiftCode, String $terminalCode, DateTime $dueDate, int $taxAmount, String $itemCode, PaymentOption $paymentOption)

PaymentOption createPaymentOption ([bool $addToCustomerAccount = true])

PaymentOption createPaymentOptionExtended (String $street1, String $street2, String $city, String $state, String $zipCode)

PaymentPlan createPaymentPlan ([bool $addToCustomerAccount = true])

PaymentPlan createPaymentPlanBasic (String $code, int $amount, String $billingCycleCode, DateTime $firstBillingDate, int $length, String $type)

PaymentPlan createPaymentPlanExtended (String $code, String $sellerCode, int $amount, String $groupCode1, String $groupCode2, String $groupCode3, String $groupCode4, String $groupCode5, String $groupCode6, String $groupCode7, String $groupCode8, String $itemCode, String $taxCode, PaymentOption $paymentOption, int $length, String $billingCycleCode, DateTime $firstBillingDate, String $type)

AssetTransaction createRefund ()

RevenueTransaction createRevenueTransaction ([bool $addToCustomerAccount = true])

RevenueTransaction createRevenueTransactionExtended (String $accountActivityType, String $code, int $amount, int $taxAmount, bool $isComplimantary)

ArrayList getAssetTransactions ()

int getBalance ()

String getBeneficiaryInfo ()

DateTime getBirthDate ()

String getCellPhone ()

String getCity ()

String getCustomerAccountGroupCode ()

String getEmail ()

String getFirstName ()

String getHomePhone ()

bool getIsActive ()

bool getIsVerified ()

String getLastName ()

DateTime getLastUpdateDate ()

String getMiddleName ()

String getName ()

String getNotes ()

ArrayList getPaymentOptions ()

ArrayList getPaymentPlans ()

ArrayList getRevenueTransactions ()

String getState ()

String getStreet1 ()

String getStreet2 ()

String getSuffix ()

String getTitle ()

String getType ()

String getWorkPhone ()

String getZipCode ()

void removeAssetTransaction (AssetTransaction $assetTransaction)

void removePaymentOption (PaymentOption $paymentOption)

void removePaymentPlan (PaymentPlan $paymentPlan)

void removeRevenueTransaction (RevenueTransaction $revenueTransaction)

RevenueTransaction reverseInvoice (RevenueTransaction $revenueTransaction)

RevenueTransaction reverseInvoiceExtended (RevenueTransaction $revenueTransaction, String $code, String $note)

AssetTransaction reversePayment (AssetTransaction $assetTransaction)

AssetTransaction reversePaymentExtended (AssetTransaction $assetTransaction, String $code, String $note)

void setBalance (int $balance)

void setBeneficiaryInfo (String $beneficiaryInfo)

void setBirthDate (DateTime $birthDate)

void setCellPhone (String $cellPhone)

void setCity (String $city)

void setCustomerAccountGroupCode (String $customerAccountGroupCode)

void setEmail (String $email)

void setFirstName (String $firstName)

void setHomePhone (String $homePhone)

void setIsActive (bool $isActive)

void setLastName (String $lastName)

void setMerchantAccountCode ( $merchantAccountCode)

void setMiddleName (String $middleName)

void setNotes (String $notes)

void setState (String $state)

void setStreet1 (String $street1)

void setStreet2 (String $street2)

void setSuffix (String $suffix)

void setTitle (String $title)

void setType (String $type)

void setWorkPhone (String $workPhone)

void setZipCode (String $zipCode)

void type ()

void validateFirstBillingDate (DateTime $firstBillingDate, String $billingCycleCode, String $code)

Variables

ArrayList $assetTransactions (line 120)

var: List of AssetTransctions associated with this CustomerAccount.
access: private

int $balance (line 78)

var: Current balance on the account.
access: private

String $beneficiaryInfo (line 83)

var: Buyer's information (if somebody else is responsible for payments). Contains full name and contact info
access: private

DateTime $birthDate (line 104)

var: If person - date of birth, not used otherwise.
access: private

ArrayList $captureInfoes (line 116)

var: List of CaptureInfo objects associated with this CustomerAccount.
access: private

String $cellPhone (line 50)

var: Cell phone number.
access: private

String $city (line 66)

var: City of the address.
access: private

String $customerAccountGroupCode (line 88)

var: Predefined classification code for this account (to simplify searching/reporting).
access: private

String $email (line 54)

var: Contact e-mail.
access: private

String $firstName (line 14)

var: If person - first name, not used otherwise.
access: private

String $homePhone (line 42)

var: Home phone number.
access: private

bool $isActive (line 38)

var: If false, account has no active payment option or payment plans.
access: private

bool $isVerified (line 92)

var: Not Used. Reserved for future use.
access: private

String $lastName (line 18)

var: If person - last name, if organization - organization's name.
access: private

DateTime $lastUpdateDate (line 100)

var: Last time the account was updated.
access: private

String $middleName (line 22)

var: If person - middle name, not used otherwise.
access: private

String $notes (line 96)

var: Any notes associated with the account.
access: private

ArrayList $paymentOptions (line 108)

var: List of payment options associated with this CustomerAccount.
access: private

ArrayList $paymentPlans (line 124)

var: List of PaymentPlans associated with this CustomerAccount.
access: private

ArrayList $revenueTransactions (line 112)

var: List of RevenueTransactions associated with this CustomerAccount.
access: private

String $state (line 70)

var: State of the address.
access: private

String $street1 (line 58)

var: Street1 of the address.
access: private

String $street2 (line 62)

var: Street2 of the address.
access: private

String $suffix (line 30)

var: If person - suffix, not used otherwise.
access: private

String $title (line 26)

var: If person - title, not used otherwise.
access: private

String $type (line 34)

var: Type of the account.
access: private

String $workPhone (line 46)

var: Work phone number/contact number if organization.
access: private

String $zipCode (line 74)

var: Zip code of the address.
access: private

Inherited Variables

Inherited from ClientObject

ClientObject::$code
ClientObject::$createDate
ClientObject::$id
ClientObject::$merchantAccountCode
ClientObject::$_hashCode

Methods

Constructor __construct (line 156)

Instantiates a new customer account.

String $code: code the code
DateTime $createDate: createDate the create date
String $firstName: firstName the first name
String $lastName: lastName the last name
String $middleName: middleName the middle name
String $title: title the title
String $suffix: suffix the suffix
String $type: type the type
bool $isActive: isActive the is active
String $homePhone: homePhone the home phone
String $workPhone: workPhone the work phone
String $cellPhone: cellPhone the cell phone
String $email: email the email
String $street1: street1 the street1
String $street2: street2 the street2
String $city: city the city
String $state: state the state
String $zipCode: zipCode the zip code
int $balance: balance the balance
String $beneficiaryInfo: beneficiaryInfo the beneficiary info
int $merchantAccountCode: merchantAccountCode the merchant account code
String $customerAccountGroupCode: customerAccountGroupCode the customer account group code
bool $isVerified: isVerified the is verified
String $notes: notes the notes
DateTime $lastUpdateDate: lastUpdateDate the last update date
DateTime $birthDate: birthDate the birth date
int $id: id the id

addAssetTransaction (line 559)

Adds the asset transaction.

access: public

void addAssetTransaction (AssetTransaction $assetTransaction)

AssetTransaction $assetTransaction: assetTransaction the asset transaction

addPaymentOption (line 501)

Adds the payment option.

access: public

void addPaymentOption (PaymentOption $paymentOption)

PaymentOption $paymentOption: paymentOption the payment option

addPaymentPlan (line 588)

Adds the payment plan.

access: public

void addPaymentPlan (PaymentPlan $paymentPlan)

PaymentPlan $paymentPlan: paymentPlan the payment plan

addRevenueTransaction (line 530)

Adds the revenue transaction.

access: public

void addRevenueTransaction (RevenueTransaction $revenueTransaction)

RevenueTransaction $revenueTransaction: revenueTransaction the revenue transaction

clear (line 607)

Clears all associated collections of objects: PaymentOptions, RevenueTransactions, CaptureInfo, AssetTransactions and PaymentPlans.

access: public

void clear ()

createAllowance (line 1320)

createAllowance method.

return: the asset transaction
access: public

AssetTransaction createAllowance (String $code, int $amount, String $note, String $creatorCode, String $sellerCode, String $shiftCode, String $terminalCode)

String $code: code TODO
int $amount: amount the amount
String $note: note the note
String $creatorCode: creatorCode the creator code
String $sellerCode: sellerCode the seller code
String $shiftCode: shiftCode the shift code
String $terminalCode: terminalCode the terminal code

createAllowanceRefund (line 1350)

createAllowanceRefund method.

return: the asset transaction
access: public

String $code: code TODO
int $amount: amount the amount
String $note: note the note
String $creatorCode: creatorCode the creator code
String $sellerCode: sellerCode the seller code
String $shiftCode: shiftCode the shift code
String $terminalCode: terminalCode the terminal code
String $accountNumber: accountNumber the account number
String $accessory: accessory the accessory

createAssetTransaction (line 1271)

createAssetTransaction method.

return: the asset transaction
access: public

AssetTransaction createAssetTransaction ([bool $addToCustomerAccount = true])

bool $addToCustomerAccount: addToCustomerAccount the add to customer account

createAssetTransactionExtended (line 1297)

createAssetTransaction method.

return: the asset transaction
access: public

AssetTransaction createAssetTransactionExtended (String $accountActivityType, String $code, int $amount, String $accountNumber, String $accessory)

String $accountActivityType: accountActivityType the account activity type
String $code: code the code
int $amount: amount the amount
String $accountNumber: accountNumber the account number
String $accessory: accessory the accessory

createBankAccount (line 670)

createBankAccount method.

return: the payment option
access: public

PaymentOption createBankAccount (String $code, String $holderName, String $bankNumber, String $routingNumber, bool $isSaving)

String $code: code the code
String $holderName: holderName the holder name
String $bankNumber: bankNumber the bank number
String $routingNumber: routingNumber the routing number
bool $isSaving: isSaving the is saving

createBankAccountExtended (line 753)

createBankAccount method.

return: the payment option
access: public

String $code: code the code
String $holderName: holderName the holder name
String $bankNumber: bankNumber the bank number
String $routingNumber: routingNumber the routing number
String $street1: street1 the street1
String $street2: street2 the street2
String $city: city the city
String $state: state the state
String $zipCode: zipCode the zip code
bool $isSaving: isSaving the is saving

createCashPayment (line 1053)

createCashPayment method.

return: the asset transaction
access: public

AssetTransaction createCashPayment (int $amount, String $note, String $creatorCode, String $sellerCode, String $shiftCode, String $terminalCode, String $code)

int $amount: amount the amount
String $note: note the note
String $creatorCode: creatorCode the creator code
String $sellerCode: sellerCode the seller code
String $shiftCode: shiftCode the shift code
String $terminalCode: terminalCode the terminal code
String $code: code the code

createCashRefund (line 1163)

createCashRefund method.

return: the asset transaction
access: public

AssetTransaction createCashRefund (int $amount, String $note, String $creatorCode, String $sellerCode, String $shiftCode, String $terminalCode, String $accountNumber, String $accessory, String $code)

int $amount: amount the amount
String $note: note the note
String $creatorCode: creatorCode the creator code
String $sellerCode: sellerCode the seller code
String $shiftCode: shiftCode the shift code
String $terminalCode: terminalCode the terminal code
String $accountNumber: accountNumber the account number
String $accessory: accessory the accessory
String $code: code the code

createCheckPayment (line 1082)

createCheckPayment method.

return: the asset transaction
access: public

AssetTransaction createCheckPayment (int $amount, String $note, String $creatorCode, String $sellerCode, String $shiftCode, String $terminalCode, String $checkNumber, String $code)

int $amount: amount the amount
String $note: note the note
String $creatorCode: creatorCode the creator code
String $sellerCode: sellerCode the seller code
String $shiftCode: shiftCode the shift code
String $terminalCode: terminalCode the terminal code
String $checkNumber: checkNumber the check number
String $code: code the code

createCredit (line 1535)

createCredit method.

return: the revenue transaction
access: public

RevenueTransaction createCredit ()

createCreditCard (line 644)

createCreditCard method.

return: the payment option
access: public

PaymentOption createCreditCard (String $code, String $holderName, String $creditCardNumber, String $expirationDate, String $type)

String $code: code the code
String $holderName: holderName the holder name
String $creditCardNumber: creditCardNumber the credit card number
String $expirationDate: expirationDate the expiration date
String $type: type the type

createCreditCardExtended (line 722)

createCreditCard method.

return: the payment option
access: public

String $code: code the code
String $holderName: holderName the holder name
String $creditCardNumber: creditCardNumber the credit card number
String $expirationDate: expirationDate the expiration date
String $type: type the type
String $street1: street1 the street1
String $street2: street2 the street2
String $city: city the city
String $state: state the state
String $zipCode: zipCode the zip code

createCreditCardPayment (line 1123)

createCreditCardPayment method.

return: the asset transaction
access: public

int $amount: amount the amount
String $note: note the note
String $creatorCode: creatorCode the creator code
String $sellerCode: sellerCode the seller code
String $shiftCode: shiftCode the shift code
String $terminalCode: terminalCode the terminal code
String $creditCardNumber: creditCardNumber the credit card number
String $expirationDate: expirationDate the expiration date
String $transactionType: transactionType the transaction type
String $holderName: holderName the holder name
String $city: city the city
String $state: state the state
String $street1: street1 the street1
String $street2: street2 the street2
String $zipCode: zipCode the zip code
String $phone: phone the phone
String $email: email the email
String $cvv2: cvv2 the cvv2
String $code: code the code

createCreditCardRefund (line 1202)

createCredit�ardRefund method.

return: the asset transaction
access: public

int $amount: amount the amount
String $note: note the note
String $creatorCode: creatorCode the creator code
String $sellerCode: sellerCode the seller code
String $shiftCode: shiftCode the shift code
String $terminalCode: terminalCode the terminal code
String $creditCardNumber: creditCardNumber the credit card number
String $expirationDate: expirationDate the expiration date
String $transactionType: transactionType the transaction type
String $holderName: holderName the holder name
String $city: city the city
String $state: state the state
String $street1: street1 the street1
String $street2: street2 the street2
String $zipCode: zipCode the zip code
String $phone: phone the phone
String $email: email the email
String $cvv2: cvv2 the cvv2
String $code: code the code

createCreditExtended (line 911)

Creates the credit extended.

return: the revenue transaction
access: public

int $amount: amount the amount
String $note: note the note
String $creatorCode: creatorCode the creator code
String $sellerCode: sellerCode the seller code
String $shiftCode: shiftCode the shift code
String $terminalCode: terminalCode the terminal code
DateTime $dueDate: dueDate the due date
int $taxAmount: taxAmount the tax amount
String $itemCode: itemCode the item code

createInvoice (line 880)

createInvoice method.

return: the revenue transaction
access: public

String $type: type the type
int $amount: amount the amount
String $note: note the note
String $creatorCode: creatorCode the creator code
String $sellerCode: sellerCode the seller code
String $shiftCode: shiftCode the shift code
String $terminalCode: terminalCode the terminal code
DateTime $dueDate: dueDate the due date
int $taxAmount: taxAmount the tax amount
String $itemCode: itemCode the item code
PaymentOption $paymentOption: paymentOption the payment option

createPaymentOption (line 622)

Creates PaymentOption.

return: the payment option
access: public

PaymentOption createPaymentOption ([bool $addToCustomerAccount = true])

bool $addToCustomerAccount: addToCustomerAccount if true, adds payment option to the CustomerAccount; if false,

createPaymentOptionExtended (line 696)

createPaymentOption method.

return: the payment option
access: public

PaymentOption createPaymentOptionExtended (String $street1, String $street2, String $city, String $state, String $zipCode)

String $street1: street1 the street1
String $street2: street2 the street2
String $city: city the city
String $state: state the state
String $zipCode: zipCode the zip code

createPaymentPlan (line 775)

createPaymentPlan method.

return: the payment plan
access: public

PaymentPlan createPaymentPlan ([bool $addToCustomerAccount = true])

bool $addToCustomerAccount: addToCustomerAccount the add to customer account

createPaymentPlanBasic (line 797)

createPaymentPlan method.

return: the payment plan
access: public

PaymentPlan createPaymentPlanBasic (String $code, int $amount, String $billingCycleCode, DateTime $firstBillingDate, int $length, String $type)

String $code: code the code
int $amount: amount the amount
String $billingCycleCode: billingCycleCode the billing cycle code
DateTime $firstBillingDate: firstBillingDate the first billing date
int $length: length the length
String $type: type the type

createPaymentPlanExtended (line 836)

createPaymentPlan method.

return: the payment plan
access: public

String $code: code the code
String $sellerCode: sellerCode the seller code
int $amount: amount the amount
String $groupCode1: groupCode1 the group code1
String $groupCode2: groupCode2 the group code2
String $groupCode3: groupCode3 the group code3
String $groupCode4: groupCode4 the group code4
String $groupCode5: groupCode5 the group code5
String $groupCode6: groupCode6 the group code6
String $groupCode7: groupCode7 the group code7
String $groupCode8: groupCode8 the group code8
String $itemCode: itemCode the item code
String $taxCode: taxCode the tax code
PaymentOption $paymentOption: paymentOption the payment option
int $length: length the length
String $billingCycleCode: billingCycleCode the billing cycle code
DateTime $firstBillingDate: firstBillingDate the first billing date
String $type: type the type

createRefund (line 1524)

Creates the refund.

return: the asset transaction
access: public

AssetTransaction createRefund ()

createRevenueTransaction (line 1233)

createRevenueTransaction method.

return: the revenue transaction
access: public

RevenueTransaction createRevenueTransaction ([bool $addToCustomerAccount = true])

bool $addToCustomerAccount: addToCustomerAccount the add to customer account

createRevenueTransactionExtended (line 1254)

createRevenueTransaction method.

return: the revenue transaction
access: public

RevenueTransaction createRevenueTransactionExtended (String $accountActivityType, String $code, int $amount, int $taxAmount, bool $isComplimantary)

String $accountActivityType: accountActivityType the account activity type
String $code: code the code
int $amount: amount the amount
int $taxAmount: taxAmount the tax amount
bool $isComplimantary: isComplimantary the is complimantary

getAssetTransactions (line 550)

Gets the asset transactions.

return: the asset transactions
access: public

ArrayList getAssetTransactions ()

getBalance (line 384)

Gets the balance.

return: Returns the balance
access: public

int getBalance ()

getBeneficiaryInfo (line 402)

Gets the beneficiary info.

return: Returns the beneficiaryInfo
access: public

String getBeneficiaryInfo ()

getBirthDate (line 456)

Gets the birth date.

return: Returns the birthDate
access: public

DateTime getBirthDate ()

getCellPhone (line 276)

Gets the cell phone.

return: Returns the cellPhone
access: public

String getCellPhone ()

getCity (line 330)

Gets the city.

return: Returns the city
access: public

String getCity ()

getCustomerAccountGroupCode (line 420)

Gets the customer account group code.

return: Returns the customerAccountGroupCode
access: public

String getCustomerAccountGroupCode ()

getEmail (line 294)

Gets the email.

return: Returns the email
access: public

String getEmail ()

getFirstName (line 1397)

Gets the first name.

return: the first name
access: public

String getFirstName ()

getHomePhone (line 240)

Gets the home phone.

return: Returns the homePhone
access: public

String getHomePhone ()

getIsActive (line 222)

Gets the is active.

return: Returns the isActive
access: public

bool getIsActive ()

getIsVerified (line 474)

Gets the is verified.

return: Returns the isAccountVerified
access: public

bool getIsVerified ()

getLastName (line 1415)

Gets the last name.

return: the last name
access: public

String getLastName ()

getLastUpdateDate (line 483)

Gets the last update date.

return: Returns the lastUpdateDate
access: public

DateTime getLastUpdateDate ()

getMiddleName (line 1433)

Gets the middle name.

return: the middle name
access: public

String getMiddleName ()

getName (line 1487)

Gets the name.

return: the name
access: public

String getName ()

getNotes (line 438)

Gets the notes.

return: Returns the notes
access: public

String getNotes ()

getPaymentOptions (line 492)

Gets the payment options.

return: the payment options
access: public

ArrayList getPaymentOptions ()

getPaymentPlans (line 579)

Gets the payment plans.

return: the payment plans
access: public

ArrayList getPaymentPlans ()

getRevenueTransactions (line 521)

Gets the revenue transactions.

return: the revenue transactions
access: public

ArrayList getRevenueTransactions ()

getState (line 348)

Gets the state.

return: Returns the state
access: public

String getState ()

getStreet1 (line 312)

Gets the street1.

return: Returns the street
access: public

String getStreet1 ()

getStreet2 (line 1506)

Gets the street2.

return: the street2
access: public

String getStreet2 ()

getSuffix (line 1469)

Gets the suffix.

return: the suffix
access: public

String getSuffix ()

getTitle (line 1451)

Gets the title.

return: the title
access: public

String getTitle ()

getType (line 204)

Gets the type.

return: Returns the type
access: public

String getType ()

getWorkPhone (line 258)

Gets the work phone.

return: Returns the workPhone
access: public

String getWorkPhone ()

getZipCode (line 366)

Gets the zip code.

return: Returns the zipCode
access: public

String getZipCode ()

removeAssetTransaction (line 570)

Removes the asset transaction.

access: public

void removeAssetTransaction (AssetTransaction $assetTransaction)

AssetTransaction $assetTransaction: assetTransaction the asset transaction

removePaymentOption (line 512)

Removes the payment option.

access: public

void removePaymentOption (PaymentOption $paymentOption)

PaymentOption $paymentOption: paymentOption the payment option

removePaymentPlan (line 599)

Removes the payment plan.

access: public

void removePaymentPlan (PaymentPlan $paymentPlan)

PaymentPlan $paymentPlan: paymentPlan the payment plan

removeRevenueTransaction (line 541)

Removes the revenue transaction.

access: public

void removeRevenueTransaction (RevenueTransaction $revenueTransaction)

RevenueTransaction $revenueTransaction: revenueTransaction the revenue transaction

reverseInvoice (line 932)

voidInvoice method.

return: the revenue transaction
access: public

RevenueTransaction reverseInvoice (RevenueTransaction $revenueTransaction)

RevenueTransaction $revenueTransaction: revenueTransaction the revenue transaction

reverseInvoiceExtended (line 969)

voidInvoice method.

return: the revenue transaction
access: public

RevenueTransaction reverseInvoiceExtended (RevenueTransaction $revenueTransaction, String $code, String $note)

RevenueTransaction $revenueTransaction: revenueTransaction the revenue transaction
String $code: code the code
String $note: note the note

reversePayment (line 983)

voidPayment method.

return: the asset transaction
access: public

AssetTransaction reversePayment (AssetTransaction $assetTransaction)

AssetTransaction $assetTransaction: assetTransaction the asset transaction

reversePaymentExtended (line 1033)

Reverse payment extended.

return: the asset transaction
access: public

AssetTransaction reversePaymentExtended (AssetTransaction $assetTransaction, String $code, String $note)

AssetTransaction $assetTransaction: assetTransaction the asset transaction
String $code: code the code
String $note: note the note

setBalance (line 393)

Set a value to balance.

void setBalance (int $balance)

int $balance: balance the balance

setBeneficiaryInfo (line 411)

Set a value to beneficiaryInfo.

access: public

void setBeneficiaryInfo (String $beneficiaryInfo)

String $beneficiaryInfo: beneficiaryInfo the beneficiary info

setBirthDate (line 465)

Set a value to birthDate.

access: public

void setBirthDate (DateTime $birthDate)

DateTime $birthDate: birthDate The birthDate to set.

setCellPhone (line 285)

Set a value to cellPhone.

access: public

void setCellPhone (String $cellPhone)

String $cellPhone: cellPhone the cell phone

setCity (line 339)

Set a value to city.

access: public

void setCity (String $city)

String $city: city the city

setCustomerAccountGroupCode (line 429)

Set a value to merchantAccountCode.

access: public

void setCustomerAccountGroupCode (String $customerAccountGroupCode)

String $customerAccountGroupCode: customerAccountGroupCode The customerAccountGroupCode to set.

setEmail (line 303)

Set a value to email.

access: public

void setEmail (String $email)

String $email: email the email

setFirstName (line 1406)

Sets the first name.

access: public

void setFirstName (String $firstName)

String $firstName: firstName the new first name

setHomePhone (line 249)

Set a value to homePhone.

access: public

void setHomePhone (String $homePhone)

String $homePhone: homePhone the home phone

setIsActive (line 231)

Set a value to isActive.

access: public

void setIsActive (bool $isActive)

bool $isActive: isActive the is active

setLastName (line 1424)

Sets the last name.

access: public

void setLastName (String $lastName)

String $lastName: lastName the new last name

setMerchantAccountCode (line 195)

access: public

void setMerchantAccountCode ( $merchantAccountCode)

$merchantAccountCode

Redefinition of:

ClientObject::setMerchantAccountCode(): Set a value to merchantAccountCode.

setMiddleName (line 1442)

Sets the middle name.

access: public

void setMiddleName (String $middleName)

String $middleName: middleName the new middle name

setNotes (line 447)

Set a value to notes.

access: public

void setNotes (String $notes)

String $notes: notes The notes to set.

setState (line 357)

Set a value to state.

access: public

void setState (String $state)

String $state: state the state

setStreet1 (line 321)

Set a value to street1.

access: public

void setStreet1 (String $street1)

String $street1: street1 the street1

setStreet2 (line 1515)

Sets the street2.

access: public

void setStreet2 (String $street2)

String $street2: street2 the new street2

setSuffix (line 1478)

Sets the suffix.

access: public

void setSuffix (String $suffix)

String $suffix: suffix the new suffix

setTitle (line 1460)

Sets the title.

access: public

void setTitle (String $title)

String $title: title the new title

setType (line 213)

Set a value to type.

access: public

void setType (String $type)

String $type: type the type

setWorkPhone (line 267)

Set a value to workPhone.

access: public

void setWorkPhone (String $workPhone)

String $workPhone: workPhone the work phone

setZipCode (line 375)

Set a value to zipCode.

access: public

void setZipCode (String $zipCode)

String $zipCode: zipCode the zip code

type (line 1365)

access: public

void type ()

Redefinition of:

ClientObject::type(): Returns the type of the object instance using library's terminology In most cases it will match ClassName, but when a single class may represent multiple conceptual objects, the value will differ.

validateFirstBillingDate (line 1386)

Validate first billing date.

access: private

void validateFirstBillingDate (DateTime $firstBillingDate, String $billingCycleCode, String $code)

DateTime $firstBillingDate: firstBillingDate the first billing date
String $billingCycleCode: billingCycleCode the billing cycle code
String $code: code the code

Inherited Methods

Inherited From ClientObject

ClientObject::getCode()
ClientObject::getCreateDate()
ClientObject::getId()
ClientObject::getMerchantAccountCode()
ClientObject::hashCode()
ClientObject::setCode()
ClientObject::setId()
ClientObject::setMerchantAccountCode()
ClientObject::type()

Documentation generated on Thu, 20 Mar 2008 16:22:16 -0400 by phpDocumentor 1.4.0