class CustomerDelete extends AbstractCustomer

Delete an existing customer record

Traits

Constants

RESTRICTION_TYPE_UNRESTRICTED

RESTRICTION_TYPE_TOPLEVEL

RESTRICTION_TYPE_RESTRICTED

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

array
getCustomFields()

Get custom fields

setCustomFields(array $customFields)

Set custom fields

string
getCustomerId()

Get customer ID

setCustomerId(string $customerId)

Set customer ID

string
getCustomerName()

Get customer name

setCustomerName(string $customerName)

Set customer name

boolean
isOneTime()

Get one time

setOneTime(boolean $oneTime)

Set one time

boolean
isActive()

Get active

setActive(boolean $active)

Set active

string
getLastName()

Get last name

setLastName(string $lastName)

Set last name

string
getFirstName()

Get first name

setFirstName(string $firstName)

Set first name

string
getMiddleName()

Get middle name

setMiddleName(string $middleName)

Set middle name

string
getPrefix()

Get prefix

setPrefix(string $prefix)

Set prefix

string
getCompanyName()

Get company name

setCompanyName(string $companyName)

Set company name

string
getPrintAs()

Get print as

setPrintAs(string $printAs)

Set print as

string
getPrimaryPhoneNo()

Get primary phone number

setPrimaryPhoneNo(string $primaryPhoneNo)

Set primary phone number

string
getSecondaryPhoneNo()

Get secondary phone number

setSecondaryPhoneNo(string $secondaryPhoneNo)

Set secondary phone number

string
getCellularPhoneNo()

Get cellular phone number

setCellularPhoneNo(string $cellularPhoneNo)

Set cellular phone number

string
getPagerNo()

Get pager number

setPagerNo(string $pagerNo)

Set pager number

string
getFaxNo()

Get fax number

setFaxNo(string $faxNo)

Set fax number

string
getPrimaryEmailAddress()

Get primary email address

setPrimaryEmailAddress(string $primaryEmailAddress)

Set primary email address

string
getSecondaryEmailAddress()

Get secondary email address

setSecondaryEmailAddress(string $secondaryEmailAddress)

Set secondary email address

string
getPrimaryUrl()

Get primary URL

setPrimaryUrl(string $primaryUrl)

Set primary URL

string
getSecondaryUrl()

Get secondary URL

setSecondaryUrl(string $secondaryUrl)

Set secondary URL

string
getAddressLine1()

Get address line 1

setAddressLine1(string $addressLine1)

Set address line 1

string
getAddressLine2()

Get address line 2

setAddressLine2(string $addressLine2)

Set address line 2

string
getCity()

Get city

setCity(string $city)

Set city

string
getStateProvince()

Get state/province

setStateProvince(string $stateProvince)

Set state/province

string
getZipPostalCode()

Get zip/postal code

setZipPostalCode(string $zipPostalCode)

Set zip/postal code

string
getCountry()

Get country

setCountry(string $country)

Set country

boolean
isExcludedFromContactList()

Get excluded from contact list

setExcludedFromContactList(boolean $excludedFromContactList)

Set excluded from contact list

string
getCustomerTypeId()

Get customer type ID

setCustomerTypeId(string $customerTypeId)

Set customer type ID

string
getSalesRepEmployeeId()

Get sales representative employee ID

setSalesRepEmployeeId(string $salesRepEmployeeId)

Set sales representative employee ID

string
getParentCustomerId()

Get parent customer ID

setParentCustomerId(string $parentCustomerId)

Set parent customer ID

string
getGlGroupName()

Get GL group name

setGlGroupName(string $glGroupName)

Set GL group name

string
getTerritoryId()

Get territory ID

setTerritoryId(string $territoryId)

Set territory ID

string
getAttachmentsId()

Get attachments ID

setAttachmentsId(string $attachmentsId)

Set attachments ID

string
getPaymentTerm()

Get payment term

setPaymentTerm(string $paymentTerm)

Set payment term

string
getOffsetArGlAccountNo()

Get offset AR GL account number

setOffsetArGlAccountNo(string $offsetArGlAccountNo)

Set offset AR GL account number

string
getDefaultRevenueGlAccountNo()

Get default revenue GL account number

setDefaultRevenueGlAccountNo(string $defaultRevenueGlAccountNo)

Set default revenue GL account number

string
getShippingMethod()

Get shipping method

setShippingMethod(string $shippingMethod)

Set shipping method

string
getResaleNumber()

Get resale number

setResaleNumber(string $resaleNumber)

Set resale number

boolean
isTaxable()

Get taxable

setTaxable(boolean $taxable)

Set taxable

string
getContactTaxGroupName()

Get contact tax group name

setContactTaxGroupName(string $contactTaxGroupName)

Set contact tax group name

string
getTaxId()

Get tax ID

setTaxId(string $taxId)

Set tax ID

boolean
isOnHold()

Get on hold

setOnHold(boolean $onHold)

Set on hold

float|int|string
getCreditLimit()

Get credit limit

setCreditLimit(float|int|string $creditLimit)

Set credit limit

string|string[]
getDeliveryMethod()

Get delivery method

setDeliveryMethod(string|string[] $deliveryMethod)

Set delivery method

string
getDefaultInvoiceMessage()

Get default invoice message

setDefaultInvoiceMessage(string $defaultInvoiceMessage)

Set default invoice message

string
getComments()

Get comments

setComments(string $comments)

Set comments

string
getDefaultCurrency()

Get default currency

setDefaultCurrency(string $defaultCurrency)

Set default currency

string
getPrintOptionArInvoiceTemplateName()

Get print option AR invoice template name

setPrintOptionArInvoiceTemplateName(string $printOptionArInvoiceTemplateName)

Set print option AR invoice template name

string
getPrintOptionOeQuoteTemplateName()

Get print option OE quote template name

setPrintOptionOeQuoteTemplateName(string $printOptionOeQuoteTemplateName)

Set print option OE quote template name

string
getPrintOptionOeOrderTemplateName()

Get print option OE order template name

setPrintOptionOeOrderTemplateName(string $printOptionOeOrderTemplateName)

Set print option OE order template name

string
getPrintOptionOeListTemplateName()

Get print option OE list template name

setPrintOptionOeListTemplateName(string $printOptionOeListTemplateName)

Set print option OE list template name

string
getPrintOptionOeInvoiceTemplateName()

Get print option OE invoice template name

setPrintOptionOeInvoiceTemplateName(string $printOptionOeInvoiceTemplateName)

Set print option OE invoice template name

string
getPrintOptionOeAdjustmentTemplateName()

Get print option OE adjustment template name

setPrintOptionOeAdjustmentTemplateName(string $printOptionOeAdjustmentTemplateName)

Set print option OE adjustment template name

string
getPrintOptionOeOtherTemplateName()

Get print option OE other template name

setPrintOptionOeOtherTemplateName(string $printOptionOeOtherTemplateName)

Set print option OE other template name

string
getPrimaryContactName()

Get primary contact name

setPrimaryContactName(string $primaryContactName)

Set primary contact name

string
getBillToContactName()

Get bill to contact name

setBillToContactName(string $billToContactName)

Set bill to contact name

string
getShipToContactName()

Get ship to contact name

setShipToContactName(string $shipToContactName)

Set ship to contact name

string
getRestrictionType()

Get restriction type

setRestrictionType(string $restrictionType)

Set restriction type

array
getRestrictedLocations()

Get restricted locations

setRestrictedLocations(array $restrictedLocations)

Set restricted locations

array
getRestrictedDepartments()

Get restricted departments

setRestrictedDepartments(array $restrictedDepartments)

Set restricted departments

writeXmlMailAddress(XMLWriter $xml)

No description

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 CustomFieldsTrait at line line 33
array getCustomFields()

Get custom fields

Return Value

array

in CustomFieldsTrait at line line 43
setCustomFields(array $customFields)

Set custom fields

Parameters

array $customFields

in AbstractCustomer at line line 225
string getCustomerId()

Get customer ID

Return Value

string

in AbstractCustomer at line line 235
setCustomerId(string $customerId)

Set customer ID

Parameters

string $customerId

in AbstractCustomer at line line 245
string getCustomerName()

Get customer name

Return Value

string

in AbstractCustomer at line line 255
setCustomerName(string $customerName)

Set customer name

Parameters

string $customerName

in AbstractCustomer at line line 265
boolean isOneTime()

Get one time

Return Value

boolean

in AbstractCustomer at line line 275
setOneTime(boolean $oneTime)

Set one time

Parameters

boolean $oneTime

in AbstractCustomer at line line 285
boolean isActive()

Get active

Return Value

boolean

in AbstractCustomer at line line 295
setActive(boolean $active)

Set active

Parameters

boolean $active

in AbstractCustomer at line line 305
string getLastName()

Get last name

Return Value

string

in AbstractCustomer at line line 315
setLastName(string $lastName)

Set last name

Parameters

string $lastName

in AbstractCustomer at line line 325
string getFirstName()

Get first name

Return Value

string

in AbstractCustomer at line line 335
setFirstName(string $firstName)

Set first name

Parameters

string $firstName

in AbstractCustomer at line line 345
string getMiddleName()

Get middle name

Return Value

string

in AbstractCustomer at line line 355
setMiddleName(string $middleName)

Set middle name

Parameters

string $middleName

in AbstractCustomer at line line 365
string getPrefix()

Get prefix

Return Value

string

in AbstractCustomer at line line 375
setPrefix(string $prefix)

Set prefix

Parameters

string $prefix

in AbstractCustomer at line line 385
string getCompanyName()

Get company name

Return Value

string

in AbstractCustomer at line line 395
setCompanyName(string $companyName)

Set company name

Parameters

string $companyName

in AbstractCustomer at line line 405
string getPrintAs()

Get print as

Return Value

string

in AbstractCustomer at line line 415
setPrintAs(string $printAs)

Set print as

Parameters

string $printAs

in AbstractCustomer at line line 425
string getPrimaryPhoneNo()

Get primary phone number

Return Value

string

in AbstractCustomer at line line 435
setPrimaryPhoneNo(string $primaryPhoneNo)

Set primary phone number

Parameters

string $primaryPhoneNo

in AbstractCustomer at line line 445
string getSecondaryPhoneNo()

Get secondary phone number

Return Value

string

in AbstractCustomer at line line 455
setSecondaryPhoneNo(string $secondaryPhoneNo)

Set secondary phone number

Parameters

string $secondaryPhoneNo

in AbstractCustomer at line line 465
string getCellularPhoneNo()

Get cellular phone number

Return Value

string

in AbstractCustomer at line line 475
setCellularPhoneNo(string $cellularPhoneNo)

Set cellular phone number

Parameters

string $cellularPhoneNo

in AbstractCustomer at line line 485
string getPagerNo()

Get pager number

Return Value

string

in AbstractCustomer at line line 495
setPagerNo(string $pagerNo)

Set pager number

Parameters

string $pagerNo

in AbstractCustomer at line line 505
string getFaxNo()

Get fax number

Return Value

string

in AbstractCustomer at line line 515
setFaxNo(string $faxNo)

Set fax number

Parameters

string $faxNo

in AbstractCustomer at line line 525
string getPrimaryEmailAddress()

Get primary email address

Return Value

string

in AbstractCustomer at line line 535
setPrimaryEmailAddress(string $primaryEmailAddress)

Set primary email address

Parameters

string $primaryEmailAddress

in AbstractCustomer at line line 548
string getSecondaryEmailAddress()

Get secondary email address

Return Value

string

in AbstractCustomer at line line 558
setSecondaryEmailAddress(string $secondaryEmailAddress)

Set secondary email address

Parameters

string $secondaryEmailAddress

in AbstractCustomer at line line 571
string getPrimaryUrl()

Get primary URL

Return Value

string

in AbstractCustomer at line line 581
setPrimaryUrl(string $primaryUrl)

Set primary URL

Parameters

string $primaryUrl

in AbstractCustomer at line line 591
string getSecondaryUrl()

Get secondary URL

Return Value

string

in AbstractCustomer at line line 601
setSecondaryUrl(string $secondaryUrl)

Set secondary URL

Parameters

string $secondaryUrl

in AbstractCustomer at line line 611
string getAddressLine1()

Get address line 1

Return Value

string

in AbstractCustomer at line line 621
setAddressLine1(string $addressLine1)

Set address line 1

Parameters

string $addressLine1

in AbstractCustomer at line line 631
string getAddressLine2()

Get address line 2

Return Value

string

in AbstractCustomer at line line 641
setAddressLine2(string $addressLine2)

Set address line 2

Parameters

string $addressLine2

in AbstractCustomer at line line 651
string getCity()

Get city

Return Value

string

in AbstractCustomer at line line 661
setCity(string $city)

Set city

Parameters

string $city

in AbstractCustomer at line line 671
string getStateProvince()

Get state/province

Return Value

string

in AbstractCustomer at line line 681
setStateProvince(string $stateProvince)

Set state/province

Parameters

string $stateProvince

in AbstractCustomer at line line 691
string getZipPostalCode()

Get zip/postal code

Return Value

string

in AbstractCustomer at line line 701
setZipPostalCode(string $zipPostalCode)

Set zip/postal code

Parameters

string $zipPostalCode

in AbstractCustomer at line line 711
string getCountry()

Get country

Return Value

string

in AbstractCustomer at line line 721
setCountry(string $country)

Set country

Parameters

string $country

in AbstractCustomer at line line 731
boolean isExcludedFromContactList()

Get excluded from contact list

Return Value

boolean

in AbstractCustomer at line line 741
setExcludedFromContactList(boolean $excludedFromContactList)

Set excluded from contact list

Parameters

boolean $excludedFromContactList

in AbstractCustomer at line line 751
string getCustomerTypeId()

Get customer type ID

Return Value

string

in AbstractCustomer at line line 761
setCustomerTypeId(string $customerTypeId)

Set customer type ID

Parameters

string $customerTypeId

in AbstractCustomer at line line 771
string getSalesRepEmployeeId()

Get sales representative employee ID

Return Value

string

in AbstractCustomer at line line 781
setSalesRepEmployeeId(string $salesRepEmployeeId)

Set sales representative employee ID

Parameters

string $salesRepEmployeeId

in AbstractCustomer at line line 791
string getParentCustomerId()

Get parent customer ID

Return Value

string

in AbstractCustomer at line line 801
setParentCustomerId(string $parentCustomerId)

Set parent customer ID

Parameters

string $parentCustomerId

in AbstractCustomer at line line 811
string getGlGroupName()

Get GL group name

Return Value

string

in AbstractCustomer at line line 821
setGlGroupName(string $glGroupName)

Set GL group name

Parameters

string $glGroupName

in AbstractCustomer at line line 831
string getTerritoryId()

Get territory ID

Return Value

string

in AbstractCustomer at line line 841
setTerritoryId(string $territoryId)

Set territory ID

Parameters

string $territoryId

in AbstractCustomer at line line 851
string getAttachmentsId()

Get attachments ID

Return Value

string

in AbstractCustomer at line line 861
setAttachmentsId(string $attachmentsId)

Set attachments ID

Parameters

string $attachmentsId

in AbstractCustomer at line line 871
string getPaymentTerm()

Get payment term

Return Value

string

in AbstractCustomer at line line 881
setPaymentTerm(string $paymentTerm)

Set payment term

Parameters

string $paymentTerm

in AbstractCustomer at line line 891
string getOffsetArGlAccountNo()

Get offset AR GL account number

Return Value

string

in AbstractCustomer at line line 901
setOffsetArGlAccountNo(string $offsetArGlAccountNo)

Set offset AR GL account number

Parameters

string $offsetArGlAccountNo

in AbstractCustomer at line line 910
string getDefaultRevenueGlAccountNo()

Get default revenue GL account number

Return Value

string

in AbstractCustomer at line line 920
setDefaultRevenueGlAccountNo(string $defaultRevenueGlAccountNo)

Set default revenue GL account number

Parameters

string $defaultRevenueGlAccountNo

in AbstractCustomer at line line 930
string getShippingMethod()

Get shipping method

Return Value

string

in AbstractCustomer at line line 940
setShippingMethod(string $shippingMethod)

Set shipping method

Parameters

string $shippingMethod

in AbstractCustomer at line line 950
string getResaleNumber()

Get resale number

Return Value

string

in AbstractCustomer at line line 960
setResaleNumber(string $resaleNumber)

Set resale number

Parameters

string $resaleNumber

in AbstractCustomer at line line 970
boolean isTaxable()

Get taxable

Return Value

boolean

in AbstractCustomer at line line 980
setTaxable(boolean $taxable)

Set taxable

Parameters

boolean $taxable

in AbstractCustomer at line line 990
string getContactTaxGroupName()

Get contact tax group name

Return Value

string

in AbstractCustomer at line line 1000
setContactTaxGroupName(string $contactTaxGroupName)

Set contact tax group name

Parameters

string $contactTaxGroupName

in AbstractCustomer at line line 1010
string getTaxId()

Get tax ID

Return Value

string

in AbstractCustomer at line line 1020
setTaxId(string $taxId)

Set tax ID

Parameters

string $taxId

in AbstractCustomer at line line 1030
boolean isOnHold()

Get on hold

Return Value

boolean

in AbstractCustomer at line line 1040
setOnHold(boolean $onHold)

Set on hold

Parameters

boolean $onHold

in AbstractCustomer at line line 1050
float|int|string getCreditLimit()

Get credit limit

Return Value

float|int|string

in AbstractCustomer at line line 1060
setCreditLimit(float|int|string $creditLimit)

Set credit limit

Parameters

float|int|string $creditLimit

in AbstractCustomer at line line 1070
string|string[] getDeliveryMethod()

Get delivery method

Return Value

string|string[]

in AbstractCustomer at line line 1080
setDeliveryMethod(string|string[] $deliveryMethod)

Set delivery method

Parameters

string|string[] $deliveryMethod

in AbstractCustomer at line line 1090
string getDefaultInvoiceMessage()

Get default invoice message

Return Value

string

in AbstractCustomer at line line 1100
setDefaultInvoiceMessage(string $defaultInvoiceMessage)

Set default invoice message

Parameters

string $defaultInvoiceMessage

in AbstractCustomer at line line 1110
string getComments()

Get comments

Return Value

string

in AbstractCustomer at line line 1120
setComments(string $comments)

Set comments

Parameters

string $comments

in AbstractCustomer at line line 1130
string getDefaultCurrency()

Get default currency

Return Value

string

in AbstractCustomer at line line 1140
setDefaultCurrency(string $defaultCurrency)

Set default currency

Parameters

string $defaultCurrency

in AbstractCustomer at line line 1150
string getPrintOptionArInvoiceTemplateName()

Get print option AR invoice template name

Return Value

string

in AbstractCustomer at line line 1160
setPrintOptionArInvoiceTemplateName(string $printOptionArInvoiceTemplateName)

Set print option AR invoice template name

Parameters

string $printOptionArInvoiceTemplateName

in AbstractCustomer at line line 1172
string getPrintOptionOeQuoteTemplateName()

Get print option OE quote template name

Return Value

string

in AbstractCustomer at line line 1182
setPrintOptionOeQuoteTemplateName(string $printOptionOeQuoteTemplateName)

Set print option OE quote template name

Parameters

string $printOptionOeQuoteTemplateName

in AbstractCustomer at line line 1193
string getPrintOptionOeOrderTemplateName()

Get print option OE order template name

Return Value

string

in AbstractCustomer at line line 1203
setPrintOptionOeOrderTemplateName(string $printOptionOeOrderTemplateName)

Set print option OE order template name

Parameters

string $printOptionOeOrderTemplateName

in AbstractCustomer at line line 1214
string getPrintOptionOeListTemplateName()

Get print option OE list template name

Return Value

string

in AbstractCustomer at line line 1224
setPrintOptionOeListTemplateName(string $printOptionOeListTemplateName)

Set print option OE list template name

Parameters

string $printOptionOeListTemplateName

in AbstractCustomer at line line 1235
string getPrintOptionOeInvoiceTemplateName()

Get print option OE invoice template name

Return Value

string

in AbstractCustomer at line line 1245
setPrintOptionOeInvoiceTemplateName(string $printOptionOeInvoiceTemplateName)

Set print option OE invoice template name

Parameters

string $printOptionOeInvoiceTemplateName

in AbstractCustomer at line line 1257
string getPrintOptionOeAdjustmentTemplateName()

Get print option OE adjustment template name

Return Value

string

in AbstractCustomer at line line 1267
setPrintOptionOeAdjustmentTemplateName(string $printOptionOeAdjustmentTemplateName)

Set print option OE adjustment template name

Parameters

string $printOptionOeAdjustmentTemplateName

in AbstractCustomer at line line 1278
string getPrintOptionOeOtherTemplateName()

Get print option OE other template name

Return Value

string

in AbstractCustomer at line line 1288
setPrintOptionOeOtherTemplateName(string $printOptionOeOtherTemplateName)

Set print option OE other template name

Parameters

string $printOptionOeOtherTemplateName

in AbstractCustomer at line line 1299
string getPrimaryContactName()

Get primary contact name

Return Value

string

in AbstractCustomer at line line 1309
setPrimaryContactName(string $primaryContactName)

Set primary contact name

Parameters

string $primaryContactName

in AbstractCustomer at line line 1319
string getBillToContactName()

Get bill to contact name

Return Value

string

in AbstractCustomer at line line 1329
setBillToContactName(string $billToContactName)

Set bill to contact name

Parameters

string $billToContactName

in AbstractCustomer at line line 1339
string getShipToContactName()

Get ship to contact name

Return Value

string

in AbstractCustomer at line line 1349
setShipToContactName(string $shipToContactName)

Set ship to contact name

Parameters

string $shipToContactName

in AbstractCustomer at line line 1359
string getRestrictionType()

Get restriction type

Return Value

string

in AbstractCustomer at line line 1369
setRestrictionType(string $restrictionType)

Set restriction type

Parameters

string $restrictionType

in AbstractCustomer at line line 1387
array getRestrictedLocations()

Get restricted locations

Return Value

array

in AbstractCustomer at line line 1397
setRestrictedLocations(array $restrictedLocations)

Set restricted locations

Parameters

array $restrictedLocations

in AbstractCustomer at line line 1407
array getRestrictedDepartments()

Get restricted departments

Return Value

array

in AbstractCustomer at line line 1417
setRestrictedDepartments(array $restrictedDepartments)

Set restricted departments

Parameters

array $restrictedDepartments

in AbstractCustomer at line line 1425
writeXmlMailAddress(XMLWriter $xml)

Parameters

XMLWriter $xml