IPPItem.php

Show:

inherited

Classes
- \IPPItem

Table of Contents

Package: Default

\IPPItem
jump to top

Package: Default

Parent(s): \IPPIntuitEntity
Inherited_from: \IPPIntuitEntity
IPPItem: \IPPItem
XmlDefinition: Product: QBO Description: The Item resource represents any product or service that is sold or purchased. Inventory items are not currently supported. Product: QBW Description: An item is a thing that your company buys, sells, or re-sells, such as products, shipping and handling charges, discounts, and sales tax (if applicable). An item is shown as a line on an invoice or other sales form. The Item.Type property, which specifies how the item is used, may have one of the following values: [li]Assembly: The Assembly item allows you combine inventory part items and other assembly items (subassemblies) into a single item by defining a Bill of Materials, that lists the component parts of the assembly item. You can also include the cost of building the assembly item by adding the non-inventory part items, service items, and other charge items to the Bill of Materials. [/li][li] Fixed Asset: The Fixed Asset item represents those business assets that you do not convert to cash one year of normal operation. A fixed asset is usually something that is integral to your business operations. For example, a truck or computer. [/li][li]Group: The Group item helps you to quickly enter a group of individual items that you often purchase or sell together. [li]Inventory: The Inventory item is used to track merchandise which your business purchases, stocks as inventory, and re-sells. QuickBooks tracks the current number of inventory items in stock and the average value of the inventory after the purchase and sale of every item. [/li][li]Other Charge: The Other Charge item is used to charge customers for the mileage expense.[/li] [li]Product The Product item is used to record the sales information of a product. [/li][li]Payment: The Payment item subtracts the amount of a customer payment from the total amount of an invoice or statement. You must create a payment item if you receive payment for an invoice or statement in parts. If you receive full payment at the time of sale, use a sales receipt form instead of an invoice with a payment item.[/li] [li]Service: The Service item is used for the services that you charge on the purchase. For example, including specialized labor, consulting hours, and professional fees. [/li][li]Subtotal: The Subtotal item is used when you want the total of all the items. You can use this item to apply a percentage discount or surcharge.[/li] Business Rules: [li]The item name must be unique. [/li][li]The item type must not be NULL. [/li][li]The item cannot define both unit price and unit price percent simultaneously. [/li][li]For the Service, Product, and Other Charge items, you must specify the ID or name of the expense account or both. [/li][li]If the purchase order cost is specified for the Service, Product, and Other Charge items, you must specify the ID or name of the expense account or both.[/li] For the Inventory and Assembly items, you must specify: [li]the ID or name of the income account or both [/li][li]the ID or name of the cogs account or both [/li][li]the ID or name of the asset account or both [/li][li]For the Group item, you must specify the tax ID or tax name or both.[/li] For the Fixed Asset item, you must: [li]set the asset account type to Asset[/li] [li]specify the purchase date [/li][li]specify the ID or name of the income account or both[/li]
XmlName: IPPItem
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: IntuitEntity

Properties

float $AbatementRate

Details

Type: float
Definition: Product: QBO Description: India sales tax abatement rate.
XmlMinOccurs: 0
XmlName: AbatementRate
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

boolean $Active

Details

Type: boolean
Definition: Product: QBW Description: True if active. Inactive items may be hidden from display and may not be used in financial transactions. Filterable: QBW
XmlMinOccurs: 0
XmlName: Active
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

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

Details

Type: \com\intuit\schema\finance\v3\IPPReferenceType
Definition: Product: ALL Description: Reference to the Inventory Asset account that tracks the current value of the inventory. If the same account is used for all inventory items, the current balance of this account will represent the current total value of the inventory.[br /]Required for the the following item types: Assembly, Inventory. Required: ALL
XmlMinOccurs: 0
XmlName: AssetAccountRef
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

float $AvgCost

Details

Type: float
Definition: Product: ALL Description: Average cost of the item, expressed in the home currency.
XmlMinOccurs: 0
XmlName: AvgCost
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

float $BuildPoint

Details

Type: float
Definition: Product: ALL Description: Assembly item QuantityOnHand threshold below which more assemblies should be built.[br /]Applicable to the Assembly Item type only.[br /]When he quantity of the assembly item gets below the BuildPoint number, QuickBooks will remind the user to build more.
XmlMinOccurs: 0
XmlName: BuildPoint
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

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

Details

Type: \com\intuit\schema\finance\v3\IPPReferenceType
Definition: Product: ALL Description: Reference to the Cost of Goods Sold account for the inventory item.[br /]Required for the the following item types: Assembly, Inventory. Required: ALL
XmlMinOccurs: 0
XmlName: COGSAccountRef
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 $DepositToAccountRef

Details

Type: \com\intuit\schema\finance\v3\IPPReferenceType
Definition: Product: ALL Description: Optional reference to the account in which the payment money is deposited.[br /]If not specified, the Undeposited Funds account will be used. Applicable to the Payment item type only.
XmlMinOccurs: 0
XmlName: DepositToAccountRef
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

string $Description

Details

Type: string
Definition: Product: QBW Description: User entered description for the item that describes the details of the service or product.[br /]Max. length: 4000 characters. Product: QBO Description: User entered description for the item that describes the details of the service or product.[br /]Max. length: 4000 characters. Filterable: QBO Sortable: QBO
XmlMinOccurs: 0
XmlName: Description
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

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

Details

Type: \com\intuit\schema\finance\v3\IPPReferenceType
Definition: Product: ALL Description: Reference to the expense account used to pay the vendor for this item.[br /]Note: for a service item, this may also be an equity account to record a draw against the company equity to pay for the service.[br /]If the Purchase information (PurchaseDesc, PurchaseTaxIncluded, PurchaseCost, etc.) is provided, this account is required for the the following item types: Other Charge, Product, Service. Required: ALL
XmlMinOccurs: 0
XmlName: ExpenseAccountRef
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: [br /] Parent:Customer:Job:Sub-job [br /] Limited to 5 levels. 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

\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

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

Details

Type: \com\intuit\schema\finance\v3\IPPReferenceType
Definition: Product: ALL Description: Reference to the posting account, that is, the account that records the proceeds from the sale of this item.[br /]Required for the the following types: Assembly, Inventory, Other Charge, Product, Service. Required: ALL
XmlMinOccurs: 0
XmlName: IncomeAccountRef
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

string $InvStartDate

Details

Type: string
Definition: Product: ALL Description: Date of the opening balance for the inventory transaction. QuickBooks creates the Opening Balance inventory transaction as of the given date, and calculates the total value by multiplying the cost by the quantity on hand.[br /]Applies to the Quantity On Hand and Total Value.[br /]Applicable to the Inventory and Assembly item types only.
XmlMinOccurs: 0
XmlName: InvStartDate
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

\com\intuit\schema\finance\v3\IPPItemAssemblyDetail $ItemAssemblyDetail

Details

Type: \com\intuit\schema\finance\v3\IPPItemAssemblyDetail
Definition: Product: ALL Description: Contains the detailed inventory parts used when the assembly is built. Applicable to an inventory assembly item only.
XmlMinOccurs: 0
XmlName: ItemAssemblyDetail
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

string $ItemCategoryType

Details

Type: string
Definition: Product: QBO Description: Categorizes the given item as a product or a service. The applicable values are those exposed through the ItemCategoryTypeEnum. This is currently applicable only in FR region.
XmlMinOccurs: 0
XmlName: ItemCategoryType
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

\com\intuit\schema\finance\v3\IPPIntuitAnyType $ItemEx

Details

Type: \com\intuit\schema\finance\v3\IPPIntuitAnyType
Definition: Internal use only: extension place holder for Item
XmlMinOccurs: 0
XmlName: ItemEx
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

\com\intuit\schema\finance\v3\IPPItemGroupDetail $ItemGroupDetail

Details

Type: \com\intuit\schema\finance\v3\IPPItemGroupDetail
Definition: Product: ALL Description: Contains the detailed components of the group. Applicable to a group item only.
XmlMinOccurs: 0
XmlName: ItemGroupDetail
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

integer $Level

Details

Type: integer
Definition: Product: ALL Description: Specifies the level of the item, 0 if top level parent, otherwise specifies the depth from the top parent.
XmlMinOccurs: 0
XmlName: Level
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

string $ManPartNum

Details

Type: string
Definition: Product: ALL Description: Identifier provided by manufacturer for the Item, for example, the model number.[br /]Applicable for the the following item types: Inventory, Product.
XmlMinOccurs: 0
XmlName: ManPartNum
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 $Name

Details

Type: string
Definition: Product: QBW Description: User recognizable name for the Item.[br /]Max. length: 31 characters. Product: QBO Description: User recognizable name for the Item.[br /]Max. length: 100 characters. Filterable: ALL Sortable: ALL Required: QBW
XmlMinOccurs: 0
XmlName: Name
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

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

Details

Type: \com\intuit\schema\finance\v3\IPPReferenceType
Definition: Product: ALL Description: Reference to the item's parent entity.
XmlMinOccurs: 0
XmlName: ParentRef
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

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

Details

Type: \com\intuit\schema\finance\v3\IPPReferenceType
Definition: Product: ALL Description: Reference to a PaymentMethod for an item of type Payment.
XmlMinOccurs: 0
XmlName: PaymentMethodRef
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

boolean $PercentBased

Details

Type: boolean
Definition: Product: ALL Description: True if the tax amount is percentage based.
XmlMaxOccurs: 1
XmlMinOccurs: 0
XmlName: PercentBased
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

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

Details

Type: \com\intuit\schema\finance\v3\IPPReferenceType
Definition: Product: ALL Description: Reference to the preferred vendor of this item.
XmlMinOccurs: 0
XmlName: PrefVendorRef
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

boolean $PrintGroupedItems

Details

Type: boolean
Definition: Product: QBW Description: Lets us know if the user wants to display the subitems as a group. Applicable to items of Group type only. Filterable: QBW
XmlMinOccurs: 0
XmlName: PrintGroupedItems
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

float $PurchaseCost

Details

Type: float
Definition: Product: ALL Description: Amount paid when buying or ordering the item, as expressed in the home currency.
XmlMinOccurs: 0
XmlName: PurchaseCost
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

string $PurchaseDesc

Details

Type: string
Definition: Product: ALL Description: User entered purchase description for the item.
XmlMinOccurs: 0
XmlName: PurchaseDesc
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

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

Details

Type: \com\intuit\schema\finance\v3\IPPReferenceType
Definition: Product: ALL Description: Reference to the purchase tax code for the item.[br /]Applicable to the Service, Other Charge, and Part (Non-Inventory) item types.
XmlMinOccurs: 0
XmlName: PurchaseTaxCodeRef
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

boolean $PurchaseTaxIncluded

Details

Type: boolean
Definition: Product: ALL Description: True if the purchase tax is included in the item amount, and therefore is not calculated for the transaction.
XmlMinOccurs: 0
XmlName: PurchaseTaxIncluded
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

float $QtyOnHand

Details

Type: float
Definition: Product: ALL Description: Current quantity of the inventory items available for sale. Sortable: QBW
XmlMinOccurs: 0
XmlName: QtyOnHand
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

float $QtyOnPurchaseOrder

Details

Type: float
Definition: Product: ALL Description: Quantity of the inventory item being ordered, for which there is a purchase order issued.
XmlMinOccurs: 0
XmlName: QtyOnPurchaseOrder
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

float $QtyOnSalesOrder

Details

Type: float
Definition: Product: ALL Description: Quantity of the inventory item that is placed on sales orders.
XmlMinOccurs: 0
XmlName: QtyOnSalesOrder
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

float $RatePercent

Details

Type: float
Definition: Product: ALL Description: The tax amount expressed as a percent of charges entered in the current transaction. To enter a rate of 10% use 10.0, not 0.01.[br /]Applicable to the Service, OtherCharge or Part (Non-Inventory) item types only, and only if the Purchase part of the item does not exist, that is, the item is not used as a reimbursable item, or as a part in assemblies.
XmlMinOccurs: 0
XmlName: RatePercent
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

float $ReorderPoint

Details

Type: float
Definition: Product: ALL Description: Quantity on hand threshold below which a purchase order against this inventory item should be issued. When the QtyOnHand is less than the ReorderPoint, the QuickBooks purchase order system will prompt the user to reorder.
XmlMinOccurs: 0
XmlName: ReorderPoint
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

float $ReverseChargeRate

Details

Type: float
Definition: Product: QBO Description: India sales tax reverse charge rate.
XmlMinOccurs: 0
XmlName: ReverseChargeRate
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

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

Details

Type: \com\intuit\schema\finance\v3\IPPReferenceType
Definition: Product: ALL Description: Reference to the sales tax code for the item.[br /]Applicable to the Service, Other Charge, Part (Non-Inventory), Inventory and Assembly item types only.
XmlMinOccurs: 0
XmlName: SalesTaxCodeRef
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

boolean $SalesTaxIncluded

Details

Type: boolean
Definition: Product: ALL Description: True if the sales tax is included in the item amount, and therefore is not calculated for the transaction.
XmlMinOccurs: 0
XmlName: SalesTaxIncluded
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

string $ServiceType

Details

Type: string
Definition: Product: QBO Description: India sales tax service type, see ServiceTypeEnum for values.
XmlMinOccurs: 0
XmlName: ServiceType
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

string $Sku

Details

Type: string
Definition: Product: QBO Description: Stock Keeping Unit - User entered item identifier that identifies an item uniquely [br /]Max. length: 100 characters. Filterable: ALL Sortable: ALL
XmlMinOccurs: 0
XmlName: Sku
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

boolean $SpecialItem

Details

Type: boolean
Definition: Product: ALL Description: True if this is a special item used by QuickBooks in certain accounting functions, including miscellaneous charges that do not fall into the categories of service, labor, materials, or parts. Examples include delivery charges, setup fees, and service charges.
XmlMinOccurs: 0
XmlName: SpecialItem
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

\com\intuit\schema\finance\v3\IPPSpecialItemTypeEnum $SpecialItemType

Details

Type: \com\intuit\schema\finance\v3\IPPSpecialItemTypeEnum
Definition: Product: ALL Description Type of special item, if SpecialItem is true.[br /]
XmlMinOccurs: 0
XmlName: SpecialItemType
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

boolean $SubItem

Details

Type: boolean
Definition: Product: ALL Description: True if the item is a subitem; false or null indicates a top-level item.
XmlMinOccurs: 0
XmlName: SubItem
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

boolean $Taxable

Details

Type: boolean
Definition: Product: ALL Description: True if the item is subject to tax.
XmlMinOccurs: 0
XmlName: Taxable
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

boolean $TrackQtyOnHand

Details

Type: boolean
Definition: Product: QBO Description: Quantity on hand to be tracked.
XmlMinOccurs: 0
XmlName: TrackQtyOnHand
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

\com\intuit\schema\finance\v3\IPPItemTypeEnum $Type

Details

Type: \com\intuit\schema\finance\v3\IPPItemTypeEnum
Definition: Product: ALL Description: Classification that specifies the use of this item. See the description at the top of the Item entity page for details. [br /] Filterable: ALL
XmlMinOccurs: 0
XmlName: Type
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

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

Details

Type: \com\intuit\schema\finance\v3\IPPReferenceType
Definition: Product: ALL Description: Reference to the unit of measure set (UOM) entity used by this item.
XmlMinOccurs: 0
XmlName: UOMSetRef
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

float $UnitPrice

Details

Type: float
Definition: Product: ALL Description: Monetary value of the service or product, as expressed in the home currency. Filterable: QBW Sortable: QBW
XmlMinOccurs: 0
XmlName: UnitPrice
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

IPPItem.php

\IPPItemjump to top

Properties

Methods

\IPPItem
jump to top