QuickBooks Integrator 2020 Kotlin Edition

Questions / Feedback?

StandardItem Type

A single standard line item.

Remarks

This type of line item is used by the Bill, CCCharge, CCCredit, Check, VendorCredit, and ItemReceipt components.

Fields

Aggregate
String?

Contains an XML aggregate of the line item. If the line item has not been modified since receiving a response from QuickBooks, the exact LineRet aggregate that QuickBooks returned will be contained in this XML aggregate. However, if you have made changes to the this line item's fields the Aggregate field will re-generate the line item XML with the new data.

If you set the other line item fields and then query the Aggregate, a LineRet aggregate will be generated from the currently set fields.

You may set this field with raw xml. So long as you do not modify any other fields (forcing the line item to regenerate based on new changes), the xml will be sent as-is to the QuickBooks request processor. It is essential that you properly format the XML that you place in this field. When setting this field manually, the component will send exactly what you have set. You must ensure your xml is appropriate for the action you are attempting. For instance, if you are Adding an Invoice, you must ensure the outer tags are "InvoiceLineAdd". If Modifying an Invoice, the outer tags must be "InvoiceLineMod".

If you do not expressly set the Aggregate field with your own custom XML, all of this will be taken care of you automatically by the component.

Amount
String?

Line item field: the total amount of this item.

This field represents the total amount of a transaction line. If Rate, Cost and/or Quantity are specified the Amount will be automatically computed by QuickBooks.

Whether Rate or Cost is used will depend on the transaction type. Rate is available for CreditMemo, Estimate, Invoice, PurchaseOrder, SalesOrder, and SalesReceipt transactions while Cost is available for Bill, CCCharge, CCCredit, Check, ItemReceipt, and VendorCredit transactions.

The amount should be formatted as a string in dollars.

BillableStatus
BillableStatus

Line item field: Billing status of this item.

The billing status of this line item. If the billing status is empty (that is, if no billing status appears in QuickBooks), then no BillableStatus value will be returned.

Values:

  • bsEmpty (0)
  • bsBillable (1)
  • bsNotBillable (2)
  • bsHasBeenBilled (3)

ClassId
String?

Line item field: Reference to the class of the item.

A reference to the class of this item.

Id/Name Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined.

Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined.

Setting the value of this property will set the corresponding Name property to an empty string.

ClassName
String?

Line item field: Reference to the class of the item.

Name/Id Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its full Name (this property) or its Id, for which a corresponding property is defined. If Name is used, it must contain the full name of the object referred to, as generated by QuickBooks. For hierarchically defined objects, such as Customers, this includes the names of parent objects, and the full name can be determined by reading the FullName special field.

Setting the value of this property will set the corresponding Id property to an empty string.

Cost
String?

Line item field: Unit cost for item.

The unit cost for this item.

If Amount is specified, then Cost will be calculated automatically and should not be specified.

The amount should be formatted as a string in dollars.

CustomerId
String?

Line item property: A reference to customer for whom the item was ordered.

A reference to a Customer for whom this item was ordered.

If this field is set, the expense will be set as billable to the Customer referenced.

Id/Name Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined.

Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined.

Setting the value of this property will set the corresponding Name property to an empty string.

CustomerName
String?

Line item field: A reference to customer for whom the item was ordered.

A reference to a Customer for whom this item was ordered.

If this field is set, the expense will be set as billable to the Customer referenced.

Name/Id Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its full Name (this property) or its Id, for which a corresponding property is defined. If Name is used, it must contain the full name of the object referred to, as generated by QuickBooks. For hierarchically defined objects, such as Customers, this includes the names of parent objects, and the full name can be determined by reading the FullName special field.

Setting the value of this property will set the corresponding Id property to an empty string.

Description
String?

Line item field: Description of item.

A string description of the Item specified by ItemName or ItemId.

GroupId
String?

Reference to a group of line items.

Line item groups represent sets of items that are grouped together. A line item group is a predefined shortcut within QuickBooks. For example, a "Cheeseburger Meal" might consist of a cheeseburger, an order of french fries, and a soft drink. To include an item group in a transaction one should simply set the value of ItemGroup, and optionally, of ItemQuantity. QuickBooks will automatically expand the group into its constituent items. This will send an ItemGroup instead of a regular Item on for this index.

When an ItemGroup is returned from QuickBooks it contains xml aggregates of all of the items in the group you specified. You may access the group's regular fields (total Amount, Quantity, and Description), but the line items returned are not accessible with this object. However, you may parse the returned line items by passing the contents of the Aggregate field to the LineItemGroups component. You may use the LineItemGroups component to view or change the contents of the line items, and then pass the xml aggregate generated by the component back to the Aggregate field to use in an Update transaction.

GroupName
String?

Reference to a group of line items.

Line item groups represent sets of items that are grouped together. A line item group is a predefined shortcut within QuickBooks. For example, a "Cheeseburger Meal" might consist of a cheeseburger, an order of french fries, and a soft drink. To include an item group in a transaction one should simply set the value of ItemGroup, and optionally, of ItemQuantity. QuickBooks will automatically expand the group into its constituent items. This will send an ItemGroup instead of a regular Item on for this index.

When an ItemGroup is returned from QuickBooks it contains xml aggregates of all of the items in the group you specified. You may access the group's regular fields (total Amount, Quantity, and Description), but the line items returned are not accessible with this object. However, you may parse the returned line items by passing the contents of the Aggregate field to the LineItemGroups component. You may use the LineItemGroups component to view or change the contents of the line items, and then pass the xml aggregate generated by the component back to the Aggregate field to use in an Update transaction.

ItemId
String?

Line item field: Reference to the kind of item.

Line items represent goods or services bought in a QuickBooks transaction.

Each line item is represented by a number of properties, each prefixed by Item (see the list of properties for individual components for details). Properties such as Quantity and Description are always present; some properties are found in only certain types of transactions.

Item is a reference to a kind of item, predefined within QuickBooks. Generally items defined within QuickBooks have default values for Description, etc., and if only Item is set when adding a record to QuickBooks, the other properties will be set automatically.

This component is used to create a single item. However, any InQB component may be set with an unlimited number of these items. For example:


 Invoice.ItemCount = 3

 LineItems.ItemName = "Wingnut"
 LineItems.Quantity = 8
 Invoice.ItemAggregate[0] = LineItems.GetAggregate()

 LineItems.ItemName = "Shovel"
 LineItems.Quantity = 1
 Invoice.ItemAggregate[1] = LineItems.GetAggregate()

 LineItems.ItemName = "Mower blade"
 LineItems.Quantity = 1
 Invoice.ItemAggregate[2] = LineItems.GetAggregate()

Items may also be grouped into ItemGroups, using the LineItemGroups component.

ItemName
String?

Line item field: Reference to the kind of item.

Line items represent goods or services bought in a QuickBooks transaction.

Each line item is represented by a number of properties, each prefixed by Item (see the list of properties for individual components for details). Properties such as Quantity and Description are always present; some properties are found in only certain types of transactions.

Item is a reference to a kind of item, predefined within QuickBooks. Generally items defined within QuickBooks have default values for Description, etc., and if only Item is set when adding a record to QuickBooks, the other properties will be set automatically.

This component is used to create a single item. However, any InQB component may be set with an unlimited number of these items. For example:


 Invoice.ItemCount = 3

 LineItems.ItemName = "Wingnut"
 LineItems.Quantity = 8
 Invoice.ItemAggregate[0] = LineItems.GetAggregate()

 LineItems.ItemName = "Shovel"
 LineItems.Quantity = 1
 Invoice.ItemAggregate[1] = LineItems.GetAggregate()

 LineItems.ItemName = "Mower blade"
 LineItems.Quantity = 1
 Invoice.ItemAggregate[2] = LineItems.GetAggregate()

Items may also be grouped into ItemGroups, using the LineItemGroups component.

LineId
String?

Identification number of the transaction line, used for Updates.

If you need to add a new transaction line in a transaction Update request, you can do so by setting the LineId to -1.

OverrideAccountId
String?

An account which will override the default account for the line item. QBXMLVersion must be 2.0 or higher to use this configuration setting.

OverrideAccountName
String?

An account which will override the default account for the line item. QBXMLVersion must be 2.0 or higher to use this configuration setting.

Quantity
String?

Line item field: Quantity of item or item group.

The quantity of the Item specified in this line.

If Quantity and only one of Cost, Rate, or Amount are specified, QuickBooks will automatically calculate the other.

This field is a String type in order to allow setting fractional quantities. Setting this field with non-numeric data will cause an error. Correct usage of this field is shown below:


  component.Quantity = "3.5"

Leave this field blank and no quantity will be sent to QuickBooks.

TaxCodeId
String?

Line item field: Sales tax information for this item.

This is a reference to a sales tax code predefined within QuickBooks.

By default, two standard TaxCodes exist: "TAX", or Taxable Sales, and "NON", or Non-Taxable Sales. The QuickBooks user may also define custom tax codes.

Id/Name Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined.

Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined.

Setting the value of this property will set the corresponding Name property to an empty string.

TaxCodeName
String?

Line item field: Sales tax information for this item.

This is a reference to a sales tax code predefined within QuickBooks.

By default, two standard TaxCodes exist: "TAX", or Taxable Sales, and "NON", or Non-Taxable Sales. The QuickBooks user may also define custom tax codes.

Name/Id Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its full Name (this property) or its Id, for which a corresponding property is defined. If Name is used, it must contain the full name of the object referred to, as generated by QuickBooks. For hierarchically defined objects, such as Customers, this includes the names of parent objects, and the full name can be determined by reading the FullName special field.

Setting the value of this property will set the corresponding Id property to an empty string.

UnitOfMeasure
String?

Unit of measure describing the Quantity.

In a transaction line item, the name of the unit of measure selected from within the item's available units. If the company file is enabled only for single unit of measure per item, this must be the base unit!

This field is only available for QBXMLVersion 7.0 and higher.

Constructors

public constructor()



Copyright (c) 2021 /n software inc. - All rights reserved.
QuickBooks Integrator 2020 Kotlin Edition - Version 20.0 [Build 7941]