IPPTerm.phpView Source

Show: PublicProtectedPrivateinherited
Table of Contents
Package
Default  

\IPPTerm

Package: Default
Parent(s)
\IPPIntuitEntity
Inherited_from
\IPPIntuitEntity  
IPPTerm
\IPPTerm

XmlDefinition
Product: ALL Description: The Term entity represents the terms under which a sale is made, typically expressed in the form of days due after the goods are received. Optionally, a discount of the total amount may be applied if payment is made within a stipulated time. For example, net 30 indicates that payment is due within 30 days. A term of 2%/15 net 60 indicates that payment is due within 60 days, with a discount of 2% if payment is made within 15 days. Term also supports: an absolute due date, a number of days from a start date, a percent discount, or an absolute discount.  
XmlName
IPPTerm  
XmlNamespace
http://schema.intuit.com/finance/v3  
XmlType
IntuitEntity  

Properties

>VPropertypublicboolean $Active
Details
Type
boolean
Definition
Product: ALL Description: If true, this entity is currently enabled for use by QuickBooks. Filterable: ALL Default Value: true  
XmlMinOccurs
0  
XmlName
Active  
XmlNamespace
http://schema.intuit.com/finance/v3  
XmlType
element  
>VPropertypublic\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  
>VPropertypublic\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  
>VPropertypublicinteger $DayOfMonthDue
Details
Type
integer
Definition
Product: ALL Description: Payment must be received by this day of the month. Business Rules: QBO: [li] This value is used only when DueDays is not specified.[/li] [li] Required for the Create request when DueDays is not specified.[/li] ValidRange: QBO: Min=1 Max=31  
XmlMinOccurs
0  
XmlName
DayOfMonthDue  
XmlNamespace
http://schema.intuit.com/finance/v3  
XmlType
element  
>VPropertypublicinteger $DiscountDayOfMonth
Details
Type
integer
Definition
Product: ALL Description: Discount applies if paid before this day of month. Business Rules: QBO: Required for the Create request when DueDays is not specified. ValidRange: QBO: Min=1 Max=31  
XmlMinOccurs
0  
XmlName
DiscountDayOfMonth  
XmlNamespace
http://schema.intuit.com/finance/v3  
XmlType
element  
>VPropertypublicinteger $DiscountDays
Details
Type
integer
Definition
Product: ALL Description: Discount applies if paid within this number of days. Business Rules: [li] This value is used only when DueDays is specified. [/li] ValidRange: QBO: Min=0 Max=999  
XmlMinOccurs
0  
XmlName
DiscountDays  
XmlNamespace
http://schema.intuit.com/finance/v3  
XmlType
element  
>VPropertypublicfloat $DiscountPercent
Details
Type
float
Definition
Product: ALL Description: Discount percentage available against an amount if paid within the days specified by DiscountDays. ValidRange: ALL: Min=0, Max=100  
XmlMinOccurs
0  
XmlName
DiscountPercent  
XmlNamespace
http://schema.intuit.com/finance/v3  
XmlType
element  
>VPropertypublicinteger $DueDays
Details
Type
integer
Definition
Product: ALL Description: Number of days from delivery of goods or services until the payment is due. Business Rules: QBO: [li] This value is required if DayOfMonthDue is not specified. [/li] [li] If DueDays is specified, only DiscountDays and DiscountPercent can be additionally specified.[/li] Required: QBO ValidRange: QBO: Min=0 Max=999  
XmlMinOccurs
0  
XmlName
DueDays  
XmlNamespace
http://schema.intuit.com/finance/v3  
XmlType
element  
>VPropertypublicinteger $DueNextMonthDays
Details
Type
integer
Definition
Product: ALL Description: Payment due next month if issued that many days before the DayOfMonthDue. Business Rules: QBO: [li] Required for the Create request when DueDays is not specified.[/li] ValidRange: QBO: Min=1 Max=999  
XmlMinOccurs
0  
XmlName
DueNextMonthDays  
XmlNamespace
http://schema.intuit.com/finance/v3  
XmlType
element  
>VPropertypublic\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  
>VPropertypublic\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  
>VPropertypublicstring $Name
Details
Type
string
Definition
Product: ALL Description: User recognizable name for the term, for example, "Net 30". ValidRange: QBW: max=31 ValidRange: QBO: Max=31 Required: ALL Filterable: QBO Sortable: ALL  
XmlMinOccurs
0  
XmlName
Name  
XmlNamespace
http://schema.intuit.com/finance/v3  
XmlType
element  
>VPropertypublic\com\intuit\schema\finance\v3\IPPIntuitAnyType $SalesTermEx
Details
Type
\com\intuit\schema\finance\v3\IPPIntuitAnyType
Definition
Product: ALL Description:- Internal use only: extension place holder for SalesTermEx  
XmlMinOccurs
0  
XmlName
SalesTermEx  
XmlNamespace
http://schema.intuit.com/finance/v3  
XmlType
element  
>VPropertypublicstring $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  
>VPropertypublicstring $Type
Details
Type
string
Definition
Product: ALL Description: Type of the Sales Term. Valid values: Standard or DateDriven, as defined by SalesTermTypeEnum. [br /] If dueDays is not null, the Type is Standard else DateDriven. InputType: ALL: ReadOnly  
XmlMinOccurs
0  
XmlName
Type  
XmlNamespace
http://schema.intuit.com/finance/v3  
XmlType
element  
>VPropertypublicstring $domain
Details
Type
string
Definition
Product: ALL Description: Domain in which the entity belongs.  
XmlName
domain  
XmlType
attribute  
>VPropertypublicboolean $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  
>VPropertypublicarray<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

methodpublic__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
NameTypeDescription
$keyValInitializers\dictionary

key/value pairs to be populated into object's properties

$verboseboolean

specifies whether object should echo warnings

methodpublic__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
NameTypeDescription
$keyValInitializers\dictionary

key/value pairs to be populated into object's properties

$verboseboolean

specifies whether object should echo warnings

Documentation was generated by phpDocumentor 2.8.5.