IPPNameBase.php

Show:

inherited

Classes
- \IPPNameBase

Table of Contents

Package: Default

\IPPNameBase
jump to top

Package: Default

Parent(s): \IPPIntuitEntity
Children: \IPPEmployee; \IPPOtherName; \IPPCustomer; \IPPVendor
Inherited_from: \IPPIntuitEntity
IPPNameBase: \IPPNameBase
XmlDefinition: Product: ALL Description: Describes the base class of name entities (Customer, Employee, Vendor, OtherName)
XmlName: IPPNameBase
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: IntuitEntity

Properties

boolean $Active

Details

Type: boolean
Definition: Product: ALL Description: If true, this entity is currently enabled for use by QuickBooks. The default value is true. Filterable: QBW
XmlMinOccurs: 0
XmlName: Active
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

\com\intuit\schema\finance\v3\IPPTelephoneNumber $AlternatePhone

Details

Type: \com\intuit\schema\finance\v3\IPPTelephoneNumber
Definition: Product: ALL Description: Alternate phone number.
XmlMaxOccurs: 1
XmlMinOccurs: 0
XmlName: AlternatePhone
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

\com\intuit\schema\finance\v3\IPPAttachableRef $AttachableRef

Details

Type: \com\intuit\schema\finance\v3\IPPAttachableRef
Definition: Specifies entity name of the attachment from where the attachment was requested
XmlMaxOccurs: unbounded
XmlMinOccurs: 0
XmlName: AttachableRef
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

string $CompanyName

Details

Type: string
Definition: Product: ALL Description: The name of the company associated with the person or organization.
XmlMinOccurs: 0
XmlName: CompanyName
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

\com\intuit\schema\finance\v3\IPPCustomField $CustomField

Details

Type: \com\intuit\schema\finance\v3\IPPCustomField
Definition: Product: QBW Description: Custom field (or data extension). Filterable: QBW
XmlMaxOccurs: unbounded
XmlMinOccurs: 0
XmlName: CustomField
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

\com\intuit\schema\finance\v3\IPPReferenceType $DefaultTaxCodeRef

Details

Type: \com\intuit\schema\finance\v3\IPPReferenceType
Definition: Product: ALL Description: Reference to the tax code associated with the Customer or Vendor by default for sales or purchase taxes.
XmlMinOccurs: 0
XmlName: DefaultTaxCodeRef
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

string $DisplayName

Details

Type: string
Definition: Product: QBO Description: The name of the person or organization as displayed. If not provided, this is populated from FullName. Product: QBW Description: The name of the person or organization as displayed. Required: ALL Filterable: QBW
XmlMinOccurs: 0
XmlName: DisplayName
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

string $FamilyName

Details

Type: string
Definition: Product: QBW Description: Family name or the last name of the person.[br /]Max. length: 25 characters.[br /]At least one of the name elements is required: Title, GivenName, MiddleName, or FamilyName. Product: QBO Description: Family name or the last name of the person.[br /]Max. length: 15 characters.[br /]At least one of the name elements is required: Title, GivenName, MiddleName, FamilyName, or Suffix. Filterable: ALL Sortable: ALL
XmlMinOccurs: 0
XmlName: FamilyName
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

\com\intuit\schema\finance\v3\IPPTelephoneNumber $Fax

Details

Type: \com\intuit\schema\finance\v3\IPPTelephoneNumber
Definition: Product: ALL Description: Fax number.
XmlMaxOccurs: 1
XmlMinOccurs: 0
XmlName: Fax
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

string $FullyQualifiedName

Details

Type: string
Definition: Product: ALL Description: Fully qualified name of the entity. The fully qualified name prepends the topmost parent, followed by each sub element separated by colons. Takes the form of Parent:Customer:Job:Sub-job. Limited to 5 levels.[br /]Max. length: 41 characters (single name) or 209 characters (fully qualified name).
XmlMinOccurs: 0
XmlName: FullyQualifiedName
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

string $GivenName

Details

Type: string
Definition: Product: QBW Description: Given name or first name of a person.[br /]Max. length: 25 characters.[br /]At least one of the name elements is required: Title, GivenName, MiddleName, or FamilyName. Product: QBO Description: Given name or first name of a person.[br /]Max. length: 25 characters.[br /]At least one of the name elements is required: Title, GivenName, MiddleName, FamilyName, or Suffix. Filterable: ALL Sortable: ALL
XmlMinOccurs: 0
XmlName: GivenName
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

\com\intuit\schema\finance\v3\IPPid $Id

Details

Type: \com\intuit\schema\finance\v3\IPPid
Definition: Product: ALL Description: Unique Identifier for an Intuit entity (object). [br /]Required for the update operation. Required: ALL Filterable: ALL
XmlMinOccurs: 0
XmlName: Id
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

string $IntuitId

Details

Type: string
Definition: Product: QBO Description: IntuitId represents the realm id, authid or an entity id. An entity is a new type of IAM identity that represents a person or a business which has no Intuit authentication context
XmlMinOccurs: 0
XmlName: IntuitId
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

\com\intuit\schema\finance\v3\IPPModificationMetaData $MetaData

Details

Type: \com\intuit\schema\finance\v3\IPPModificationMetaData
Definition: Product: ALL Description: Descriptive information about the entity. The MetaData values are set by Data Services and are read only for all applications.
XmlMinOccurs: 0
XmlName: MetaData
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

string $MiddleName

Details

Type: string
Definition: Product: QBW Description: Middle name of the person. The person can have zero or more middle names.[br /]Max. length: 5 characters.[br /]At least one of the name elements is required: Title, GivenName, MiddleName, or FamilyName. Product: QBO Description: Middle name of the person. The person can have zero or more middle names.[br /]Max. length: 15 characters.[br /]At least one of the name elements is required: Title, GivenName, MiddleName, FamilyName, or Suffix. Filterable: ALL Sortable: ALL
XmlMinOccurs: 0
XmlName: MiddleName
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

\com\intuit\schema\finance\v3\IPPTelephoneNumber $Mobile

Details

Type: \com\intuit\schema\finance\v3\IPPTelephoneNumber
Definition: Product: ALL Description: Mobile phone number.
XmlMaxOccurs: 1
XmlMinOccurs: 0
XmlName: Mobile
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

boolean $Organization

Details

Type: boolean
Definition: Product: QBW Description: True if the entity represents an organization; otherwise the entity represents a person. Default is NULL or False, representing a person.
XmlMinOccurs: 0
XmlName: Organization
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

\com\intuit\schema\finance\v3\IPPContactInfo $OtherContactInfo

Details

Type: \com\intuit\schema\finance\v3\IPPContactInfo
Definition: Product: QBW Description: List of ContactInfo entities of any contact info type. The ContactInfo Type values are defined in the ContactTypeEnum.
XmlMaxOccurs: unbounded
XmlMinOccurs: 0
XmlName: OtherContactInfo
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

\com\intuit\schema\finance\v3\IPPEmailAddress $PrimaryEmailAddr

Details

Type: \com\intuit\schema\finance\v3\IPPEmailAddress
Definition: Product: ALL Description: Primary email address.
XmlMaxOccurs: 1
XmlMinOccurs: 0
XmlName: PrimaryEmailAddr
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

\com\intuit\schema\finance\v3\IPPTelephoneNumber $PrimaryPhone

Details

Type: \com\intuit\schema\finance\v3\IPPTelephoneNumber
Definition: Product: ALL Description: Primary phone number.
XmlMaxOccurs: 1
XmlMinOccurs: 0
XmlName: PrimaryPhone
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

string $PrintOnCheckName

Details

Type: string
Definition: Product: ALL Description: Name of the person or organization as printed on a check. If not provided, this is populated from FullName.
XmlMinOccurs: 0
XmlName: PrintOnCheckName
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

string $Suffix

Details

Type: string
Definition: Product: QBO Description: Suffix appended to the name of a person. For example, Senior, Junior, etc. QBO only field.[br /]Max. length: 15 characters.[br /]At least one of the name elements is required: Title, GivenName, MiddleName, FamilyName, or Suffix.
XmlMinOccurs: 0
XmlName: Suffix
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

string $SyncToken

Details

Type: string
Definition: Product: ALL Description: Version number of the entity. The SyncToken is used to lock the entity for use by one application at a time. As soon as an application modifies an entity, its SyncToken is incremented; another application's request to modify the entity with the same SyncToken will fail. Only the latest version of the entity is maintained by Data Services. An attempt to modify an entity specifying an older SyncToken will fail. [br /]Required for the update operation. Required: ALL
XmlMinOccurs: 0
XmlName: SyncToken
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

string $Title

Details

Type: string
Definition: Product: ALL Description: QBW: Title of the person. The person can have zero or more titles. Description: QBO: Title of the person. The person can have zero or more titles. InputType: ReadWrite ValidRange: QBW: Min=0, Max=15 ValidationRules: QBW: At least one of the name elements is required: Title, GivenName, MiddleName, or FamilyName. ValidationRules: QBO: At least one of the name elements is required: Title, GivenName, MiddleName, FamilyName, or Suffix. I18n: ALL
XmlMinOccurs: 0
XmlName: Title
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

string $UserId

Details

Type: string
Definition: Product: QBW Description: The ID of the Intuit user associated with this name. Note: this is NOT the Intuit AuthID of the user.
XmlMinOccurs: 0
XmlName: UserId
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

\com\intuit\schema\finance\v3\IPPWebSiteAddress $WebAddr

Details

Type: \com\intuit\schema\finance\v3\IPPWebSiteAddress
Definition: Product: ALL Description: Website address (URI).
XmlMaxOccurs: 1
XmlMinOccurs: 0
XmlName: WebAddr
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

string $domain

Details

Type: string
Definition: Product: ALL Description: Domain in which the entity belongs.
XmlName: domain
XmlType: attribute

boolean $sparse

Details

Type: boolean
Definition: Product: ALL Description: True if the entity representation has a partial set of elements. Output only field.
XmlName: sparse
XmlType: attribute

array<mixed,\EntityStatusEnum> $status

Details

Type: array<mixed,\EntityStatusEnum>
Definition: Product: ALL Description: System status of the entity. Output only field.[br /] Filterable: ALL
XmlName: status
XmlType: attribute

Methods

__construct(\dictionary $keyValInitializers = array(), boolean $verbose = FALSE) : void

Initializes this object, optionally with pre-defined property values

Initializes this object and it's property members, using the dictionary of key/value pairs passed as an optional argument.

Parameters

Name	Type	Description
$keyValInitializers	\dictionary	key/value pairs to be populated into object's properties
$verbose	boolean	specifies whether object should echo warnings

__construct(\dictionary $keyValInitializers = array(), boolean $verbose = FALSE) : void

inherited

Initializes this object, optionally with pre-defined property values

Inherited from:

Initializes this object and it's property members, using the dictionary of key/value pairs passed as an optional argument.

Parameters

Name	Type	Description
$keyValInitializers	\dictionary	key/value pairs to be populated into object's properties
$verbose	boolean	specifies whether object should echo warnings

IPPNameBase.php

\IPPNameBasejump to top

Properties

Methods

\IPPNameBase
jump to top