IPPTaxRate.phpView Source

Show: PublicProtectedPrivateinherited
Table of Contents
Package
Default  

\IPPTaxRate

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

XmlDefinition
Product: ALL Description: A sales tax rate specifies the tax rate for the specific TaxCode.[br]See [a href="http://ipp.developer.intuit.com/0010_Intuit_Partner_Platform/0060_Financial_Management_Services_(v3)/01100_Global_Tax_Model"]Global Tax Model[/a].  
XmlName
IPPTaxRate  
XmlNamespace
http://schema.intuit.com/finance/v3  
XmlType
IntuitEntity  

Properties

>VPropertypublicboolean $Active
Details
Type
boolean
Definition
Product: QBW Description: False or null if inactive. Inactive sales rate codes may be hidden from display and may not be used on financial transactions. Filterable: QBW  
XmlMinOccurs
0  
XmlName
Active  
XmlNamespace
http://schema.intuit.com/finance/v3  
XmlType
element  
>VPropertypublic\com\intuit\schema\finance\v3\IPPReferenceType $AgencyRef
Details
Type
\com\intuit\schema\finance\v3\IPPReferenceType
Definition
Product: ALL Description: Represents Agency Reference, Vendor Reference in case of QBW, Agency in case of QBO.  
XmlMinOccurs
0  
XmlName
AgencyRef  
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  
>VPropertypublicstring $Description
Details
Type
string
Definition
Product: QBW Description: User entered description for the tax rate.[br /]Max Length: 4000 characters. ValidRange: QBW: Max=4000  
XmlMinOccurs
0  
XmlName
Description  
XmlNamespace
http://schema.intuit.com/finance/v3  
XmlType
element  
>VPropertypublic\com\intuit\schema\finance\v3\IPPTaxRateDisplayTypeEnum $DisplayType
Details
Type
\com\intuit\schema\finance\v3\IPPTaxRateDisplayTypeEnum
Definition
Product: QBO Description: DisplayType of a tax rate, configuration of editability and display on forms  
XmlMinOccurs
0  
XmlName
DisplayType  
XmlNamespace
http://schema.intuit.com/finance/v3  
XmlType
element  
>VPropertypublic\com\intuit\schema\finance\v3\IPPEffectiveTaxRate $EffectiveTaxRate
Details
Type
\com\intuit\schema\finance\v3\IPPEffectiveTaxRate
Definition
Product: QBO Description: Effective list rates for different date ranges  
XmlMaxOccurs
unbounded  
XmlMinOccurs
0  
XmlName
EffectiveTaxRate  
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: QBW Description: User recognizable name for the tax rate.[br /]Max. Length: 31 characters.[br /]Required for the Create request. Required: QBW ValidRange: QBW: Max=31 Filterable: QBW  
XmlMinOccurs
0  
XmlName
Name  
XmlNamespace
http://schema.intuit.com/finance/v3  
XmlType
element  
>VPropertypublicfloat $RateValue
Details
Type
float
Definition
Product: ALL Description: Represents rate value. Filterable: QBW  
XmlMinOccurs
0  
XmlName
RateValue  
XmlNamespace
http://schema.intuit.com/finance/v3  
XmlType
element  
>VPropertypublic\com\intuit\schema\finance\v3\IPPSpecialTaxTypeEnum $SpecialTaxType
Details
Type
\com\intuit\schema\finance\v3\IPPSpecialTaxTypeEnum
Definition
Product: QBO Description: Used for Zero rates for EC VAT. How it is used: VAT registered Businesses who receive goods/services (acquisitions) from other EU countries, will need to calculate the VAT due, but not paid, on these acquisitions. The rate of VAT payable is the same that would have been paid if the goods had been supplied by a UK supplier.  
XmlMinOccurs
0  
XmlName
SpecialTaxType  
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  
>VPropertypublic\com\intuit\schema\finance\v3\IPPIntuitAnyType $TaxRateEx
Details
Type
\com\intuit\schema\finance\v3\IPPIntuitAnyType
Definition
Product: ALL Description: Internal use only: extension place holder for TaxRate  
XmlMinOccurs
0  
XmlName
TaxRateEx  
XmlNamespace
http://schema.intuit.com/finance/v3  
XmlType
element  
>VPropertypublic\com\intuit\schema\finance\v3\IPPReferenceType $TaxReturnLineRef
Details
Type
\com\intuit\schema\finance\v3\IPPReferenceType
Definition
Product: ALL Description: TaxReturnLine is representative of SalesTaxReturnLine reference  
XmlMinOccurs
0  
XmlName
TaxReturnLineRef  
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.