QuickBooks Integrator 2022 macOS Edition
Version 22.0 [Build 8594]

LineItemGroups Module

Properties   Methods   Events   Config Settings   Errors  

Generates a group aggregate for use in another module's Update request.

Syntax

InQB.Lineitemgroups

Remarks

There is not exposed a way to directly edit the contents of a line item group when submitting an Update request with a class from this package. You can change the Quantity, but you cannot change the line items contained inside the group line. The LineItemGroups class is used to parse a line item group aggregate. You may then make changes to the individual line items, and then call the GetGroupUpdateAggregate to return an xml aggregate containing your changes. This is then set to the Aggregate property of the line you wish to modify in your Update.

For instance, the following code changes the BillableStatus of all line items and line item groups in the Bill retrieved from QuickBooks.

Bill.Get("123456"); for (int i = 0; i < Bill1.LineItems.Count; i++) { if (!Bill.LineItems[i].GroupName.Equals("")) { // this is a group line LineItemGroups.GroupType = gtBill; LineItemGroups.ParseAggregate(Bill.LineItems[0].Aggregate); for (int j = 0; j < LineItemGroups.LineItems.Count) { LineItemGroups.LineItems[j].BillableStatus = bsHasBeenBilled; } LineItemGroups.QBXMLVersion = Bill.QBXMLVersion; // so that the proper fields are included in the update aggregate. Bill1.LineItems[i].Aggregate = LineItemGroups.GetGroupUpdateAggregate(); } else { // regular line item Bill.LineItems[i].BillableStatus = bsHasBeenBilled; } } Bill.Update();

Property List

The following is the full list of the properties of the module with short descriptions. Click on the links for further details.

DescriptionA string description of the item group specified by GroupName or GroupId .
GroupIdReference to a group of line items.
GroupNameReference to a group of line items.
GroupTypeThe type of line item group aggregate to create.
LineIdIdentification number of the transaction line group, used for Updates.
LineItemsCollection of line items contained in this group.
PrintItemsInGroupIndicates whether line items will be shown on printed forms.
QBXMLVersionThe version of QBXML used to generate the update aggregate.
QuantityThe quantity of this line item group.
TotalAmountThe total amount of this group of line items.
UnitOfMeasureUnit of measure describing the Quantity .

Method List

The following is the full list of the methods of the module with short descriptions. Click on the links for further details.

ConfigSets or retrieves a configuration setting.
GetGroupUpdateAggregateGenerates a group aggregate for use in another module's Update request.
ParseAggregateParses the aggregate returned from another module's ItemAggregate property.
ResetResets this module to its default state.

Event List

The following is the full list of the events fired by the module with short descriptions. Click on the links for further details.

ErrorInformation about errors during data delivery.

Config Settings

The following is a list of config settings for the module with short descriptions. Click on the links for further details.

BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
MaskSensitiveWhether sensitive data is masked in log messages.
UseInternalSecurityAPITells the module whether or not to use the system security libraries or an internal implementation.

Description Property (LineItemGroups Module)

A string description of the item group specified by GroupName or GroupId .

Syntax

public var description_: String {
  get {...}
}


@property (nonatomic,readonly,assign,getter=description) NSString* description;

- (NSString*)description;
- (NSString*)description_;

Default Value

""

Remarks

This property will contain the description of the group as returned by QuickBooks.

This property is read-only.

GroupId Property (LineItemGroups Module)

Reference to a group of line items.

Syntax

public var groupId: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=groupId,setter=setGroupId:) NSString* groupId;

- (NSString*)groupId;
- (void)setGroupId :(NSString*)newGroupId;

Default Value

""

Remarks

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 properties (total Amount, Quantity, and Description), but the line items returned are not normally accessible. However, you may parse the returned line items by passing the contents of the Aggregate property to the LineItemGroups class. You may use the LineItemGroups class to view or change the contents of the line items, and then pass the xml aggregate generated by the class back to the Aggregate field of the original\ object to use in an Update transaction.

GroupName Property (LineItemGroups Module)

Reference to a group of line items.

Syntax

public var groupName: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=groupName,setter=setGroupName:) NSString* groupName;

- (NSString*)groupName;
- (void)setGroupName :(NSString*)newGroupName;

Default Value

""

Remarks

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 properties (total Amount, Quantity, and Description), but the line items returned are not normally accessible. However, you may parse the returned line items by passing the contents of the Aggregate property to the LineItemGroups class. You may use the LineItemGroups class to view or change the contents of the line items, and then pass the xml aggregate generated by the class back to the Aggregate field of the original\ object to use in an Update transaction.

GroupType Property (LineItemGroups Module)

The type of line item group aggregate to create.

Syntax

public var groupType: LineitemgroupsGroupTypes {
  get {...}
  set {...}
}

public enum LineitemgroupsGroupTypes: Int32 {
  case gtStandardGroup = 0
  case gtCreditMemo = 1
  case gtEstimate = 2
  case gtInvoice = 3
  case gtPurchaseOrder = 4
  case gtSalesOrder = 5
  case gtSalesReceipt = 6
}


@property (nonatomic,readwrite,assign,getter=groupType,setter=setGroupType:) int groupType;

- (int)groupType;
- (void)setGroupType :(int)newGroupType;

Default Value

0

Remarks

This property will be automatically filled after a call to ParseAggregate. The following values are permitted:

gtStandardGroup (0) Used for the Bill, CCCharge, CCCredit, Check, VendorCredit, and ItemReceipt classs.
gtCreditMemo (1) Corresponds to the CreditMemo class.
gtEstimate (2) Corresponds to the Estimate class.
gtInvoice (3) Corresponds to the Invoice class.
gtPurchaseOrder (4) Corresponds to the PurchaseOrder class.
gtSalesOrder (5) Corresponds to the SalesOrder class.
gtSalesReceipt (6) Corresponds to the SalesReceipt class.

LineId Property (LineItemGroups Module)

Identification number of the transaction line group, used for Updates.

Syntax

public var lineId: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=lineId,setter=setLineId:) NSString* lineId;

- (NSString*)lineId;
- (void)setLineId :(NSString*)newLineId;

Default Value

""

Remarks

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

LineItems Property (LineItemGroups Module)

Collection of line items contained in this group.

Syntax

public var lineItems: Array<LineItem> {
  get {...}
}


@property (nonatomic,readwrite,assign,getter=itemCount,setter=setItemCount:) int itemCount;

- (int)itemCount;
- (void)setItemCount :(int)newItemCount;

- (NSString*)itemAggregate:(int)itemIndex;
- (void)setItemAggregate:(int)itemIndex :(NSString*)newItemAggregate;

- (NSString*)itemAmount:(int)itemIndex;
- (void)setItemAmount:(int)itemIndex :(NSString*)newItemAmount;

- (int)itemBillableStatus:(int)itemIndex;
- (void)setItemBillableStatus:(int)itemIndex :(int)newItemBillableStatus;

- (NSString*)itemClassId:(int)itemIndex;
- (void)setItemClassId:(int)itemIndex :(NSString*)newItemClassId;

- (NSString*)itemClassName:(int)itemIndex;
- (void)setItemClassName:(int)itemIndex :(NSString*)newItemClassName;

- (NSString*)itemCost:(int)itemIndex;
- (void)setItemCost:(int)itemIndex :(NSString*)newItemCost;

- (NSString*)itemCustomerId:(int)itemIndex;
- (void)setItemCustomerId:(int)itemIndex :(NSString*)newItemCustomerId;

- (NSString*)itemCustomerName:(int)itemIndex;
- (void)setItemCustomerName:(int)itemIndex :(NSString*)newItemCustomerName;

- (NSString*)itemDescription:(int)itemIndex;
- (void)setItemDescription:(int)itemIndex :(NSString*)newItemDescription;

- (NSString*)itemId:(int)itemIndex;
- (void)setItemId:(int)itemIndex :(NSString*)newItemId;

- (NSString*)itemName:(int)itemIndex;
- (void)setItemName:(int)itemIndex :(NSString*)newItemName;

- (NSString*)itemLineId:(int)itemIndex;
- (void)setItemLineId:(int)itemIndex :(NSString*)newItemLineId;

- (int)itemManuallyClosed:(int)itemIndex;
- (void)setItemManuallyClosed:(int)itemIndex :(int)newItemManuallyClosed;

- (NSString*)itemOther1:(int)itemIndex;
- (void)setItemOther1:(int)itemIndex :(NSString*)newItemOther1;

- (NSString*)itemOther2:(int)itemIndex;
- (void)setItemOther2:(int)itemIndex :(NSString*)newItemOther2;

- (NSString*)itemOverrideAccountId:(int)itemIndex;
- (void)setItemOverrideAccountId:(int)itemIndex :(NSString*)newItemOverrideAccountId;

- (NSString*)itemOverrideAccountName:(int)itemIndex;
- (void)setItemOverrideAccountName:(int)itemIndex :(NSString*)newItemOverrideAccountName;

- (NSString*)itemPriceLevelId:(int)itemIndex;
- (void)setItemPriceLevelId:(int)itemIndex :(NSString*)newItemPriceLevelId;

- (NSString*)itemPriceLevelName:(int)itemIndex;
- (void)setItemPriceLevelName:(int)itemIndex :(NSString*)newItemPriceLevelName;

- (NSString*)itemQuantity:(int)itemIndex;
- (void)setItemQuantity:(int)itemIndex :(NSString*)newItemQuantity;

- (NSString*)itemRate:(int)itemIndex;
- (void)setItemRate:(int)itemIndex :(NSString*)newItemRate;

- (NSString*)itemRatePercent:(int)itemIndex;
- (void)setItemRatePercent:(int)itemIndex :(NSString*)newItemRatePercent;

- (NSString*)itemServiceDate:(int)itemIndex;
- (void)setItemServiceDate:(int)itemIndex :(NSString*)newItemServiceDate;

- (NSString*)itemTaxCodeId:(int)itemIndex;
- (void)setItemTaxCodeId:(int)itemIndex :(NSString*)newItemTaxCodeId;

- (NSString*)itemTaxCodeName:(int)itemIndex;
- (void)setItemTaxCodeName:(int)itemIndex :(NSString*)newItemTaxCodeName;

- (NSString*)itemUnitOfMeasure:(int)itemIndex;
- (void)setItemUnitOfMeasure:(int)itemIndex :(NSString*)newItemUnitOfMeasure;

Default Value

""

Remarks

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 property is only available for QBXMLVersion 7.0 and higher.

PrintItemsInGroup Property (LineItemGroups Module)

Indicates whether line items will be shown on printed forms.

Syntax

public var printItemsInGroup: Bool {
  get {...}
}


@property (nonatomic,readonly,assign,getter=printItemsInGroup) BOOL printItemsInGroup;

- (BOOL)printItemsInGroup;

Default Value

False

Remarks

If true, a list of this group's individual items their amounts will appear on printed forms.

This property is read-only.

QBXMLVersion Property (LineItemGroups Module)

The version of QBXML used to generate the update aggregate.

Syntax

public var qbxmlVersion: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=QBXMLVersion,setter=setQBXMLVersion:) NSString* QBXMLVersion;

- (NSString*)QBXMLVersion;
- (void)setQBXMLVersion :(NSString*)newQBXMLVersion;

Default Value

"3.0"

Remarks

This should match the QBXMLVersion of the class you're generating a group line update aggregate for.

Quantity Property (LineItemGroups Module)

The quantity of this line item group.

Syntax

public var quantity: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=quantity,setter=setQuantity:) NSString* quantity;

- (NSString*)quantity;
- (void)setQuantity :(NSString*)newQuantity;

Default Value

""

Remarks

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

class.Quantity = "3"

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

TotalAmount Property (LineItemGroups Module)

The total amount of this group of line items.

Syntax

public var totalAmount: String {
  get {...}
}


@property (nonatomic,readonly,assign,getter=totalAmount) NSString* totalAmount;

- (NSString*)totalAmount;

Default Value

""

Remarks

This property represents the total amount of all transaction lines in the group. This amount will be automatically computed by QuickBooks.

The amount should be formatted as a string in dollars.

This property is read-only.

UnitOfMeasure Property (LineItemGroups Module)

Unit of measure describing the Quantity .

Syntax

public var unitOfMeasure: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=unitOfMeasure,setter=setUnitOfMeasure:) NSString* unitOfMeasure;

- (NSString*)unitOfMeasure;
- (void)setUnitOfMeasure :(NSString*)newUnitOfMeasure;

Default Value

""

Remarks

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 property is only available for QBXMLVersion 7.0 and higher.

Config Method (LineItemGroups Module)

Sets or retrieves a configuration setting.

Syntax

public func config(configurationString: String) throws -> String

- (NSString*)config:(NSString*)configurationString;

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

GetGroupUpdateAggregate Method (LineItemGroups Module)

Generates a group aggregate for use in another component's Update request.

Syntax

public func getGroupUpdateAggregate() throws -> String

- (NSString*)getGroupUpdateAggregate;

Remarks

There is not exposed a way to directly edit the contents of a line item group when submitting an Update request with a class from this package. You can change the Quantity, but you cannot change the line items contained inside the group line. The LineItemGroups class is used to parse a line item group aggregate. You may then make changes to the individual line items, and then call the GetGroupUpdateAggregate to return an xml aggregate containing your changes. This is then set to the Aggregate property of the line you wish to modify in your Update.

For instance, the following code changes the BillableStatus of all line items and line item groups in the Bill retrieved from QuickBooks.

Bill.Get("123456"); for (int i = 0; i < Bill1.LineItems.Count; i++) { if (!Bill.LineItems[i].GroupName.Equals("")) { // this is a group line LineItemGroups.GroupType = gtBill; LineItemGroups.ParseAggregate(Bill.LineItems[0].Aggregate); for (int j = 0; j < LineItemGroups.LineItems.Count) { LineItemGroups.LineItems[j].BillableStatus = bsHasBeenBilled; } LineItemGroups.QBXMLVersion = Bill.QBXMLVersion; // so that the proper fields are included in the update aggregate. Bill1.LineItems[i].Aggregate = LineItemGroups.GetGroupUpdateAggregate(); } else { // regular line item Bill.LineItems[i].BillableStatus = bsHasBeenBilled; } } Bill.Update();

ParseAggregate Method (LineItemGroups Module)

Parses the aggregate returned from another component's ItemAggregate property.

Syntax

public func parseAggregate(aggregate: String) throws -> Void

- (void)parseAggregate:(NSString*)aggregate;

Remarks

This method takes the XML aggregate returned from any class's ItemAggregate property, and then fills all the properties of this class. For example:

Invoice.Add() For (i = 0 to Invoice.ItemCount - 1) LineItems.ParseAggregate(Invoice.ItemAggregate[0]) Debug.Print(LineItems.ItemName & VbTab & LineItems.Quantity & VbTab & LineItems.Amount) Next

Reset Method (LineItemGroups Module)

Resets this component to its default state.

Syntax

public func reset() throws -> Void

- (void)reset;

Remarks

This method clears all properties and returns the class to its default state.

Error Event (LineItemGroups Module)

Information about errors during data delivery.

Syntax

func onError(errorCode: Int32, description: String)

- (void)onError:(int)errorCode :(NSString*)description;

Remarks

The Error event is fired in case of exceptional conditions during message processing.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

LineItem Type

A single line item inside of an Item Group.

Remarks

This type of line item is used by the LineItemGroups class, and contains a superset of the properties from all other item types.

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 properties the property will re-generate the line item XML with the new data.

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

You may set this property with raw xml. So long as you do not modify any other properties (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 property. When setting this property manually, the class 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 field with your own custom XML, all of this will be taken care of you automatically by the class.

amount
String

Line item property: the total amount of this item.

This property represents the total amount of a transaction line. If , and/or are specified the will be automatically computed by QuickBooks.

Whether or is used will depend on the transaction type. is available for CreditMemo, Estimate, Invoice, PurchaseOrder, SalesOrder, and SalesReceipt transactions while 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 property: 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 value will be returned.

Values:

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

Line item property: 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 property: 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 property: Unit cost for item.

The unit cost for this item.

If is specified, then 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 property 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 property: A reference to customer for whom the item was ordered.

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

If this property 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 property: Description of item.

A string description of the Item specified by or .

itemId
String

Line item property: 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 classs for details). Properties such as and 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 , etc., and if only Item is set when adding a record to QuickBooks, the other properties will be set automatically.

This class is used to create a single item. However, any InQB class 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 class.

itemName
String

Line item property: 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 classs for details). Properties such as and 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 , etc., and if only Item is set when adding a record to QuickBooks, the other properties will be set automatically.

This class is used to create a single item. However, any InQB class 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 class.

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 to -1.

manuallyClosed
ManuallyCloseds

Indicates if the line item has been manually closed.

If is mcManuallyClosed, the purchase order line has been closed, even if this item has not been received or its sale canceled. If all the purchase order lines are marked as closed, the purchase order itself is marked as closed as well. You cannot change to mcNotManuallyClosed after the purchase order line has been fully received. If set to mcNotSet the field is not sent in the request.

Only applicable to Update transactions.

other1
String

Standard QuickBooks Custom Field available for transaction line items.

The and custom fields are available for immediate use: you don't need to enable these in the transaction template to be able to access them via SDK. (However, those and fields and their values are viewable and printable in QuickBooks only if the transaction template has these enabled!). QBXMLVersion 6.0 or higher is required to use this property.

other2
String

Standard QuickBooks Custom Field available for transaction line items.

The and custom fields are available for immediate use: you don't need to enable these in the transaction template to be able to access them via SDK. (However, those and fields and their values are viewable and printable in QuickBooks only if the transaction template has these enabled!). QBXMLVersion 6.0 or higher is required to use this property.

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.

priceLevelId
String

Line Item property: Used to specify custom pricing for specific customers.

Id for the PriceLevel selected for this transaction.

If and/or are specified, then will be calculated automatically and should not be specified.

Note that and , OR OR may be specified. and are ONLY available for QBXMLVersions 4.0 and above.

You can use price levels to specify custom pricing for specific customers. Once you create a price level for a customer, QuickBooks will automatically use the custom price in new invoices, sales receipts, sales orders or credit memos for that customer. You can override this automatic feature, however, when you create the invoices, sales receipts, etc.)

The user can now specify a price level on line items in the following supported sales transactions: invoices, sales receipts, credit memos, and sales orders.

Notice that the response data for the affected sales transaction does not list the price level that was used. The response simply lists the , which was set using the price level.

priceLevelName
String

Line Item property: Specify custom pricing for specific customers.

Id for the PriceLevel selected for this transaction.

If and/or are specified, then will be calculated automatically and should not be specified.

Note that and , OR OR may be specified. and are ONLY available for QBXMLVersions 4.0 and above.

You can use price levels to specify custom pricing for specific customers. Once you create a price level for a customer, QuickBooks will automatically use the custom price in new invoices, sales receipts, sales orders or credit memos for that customer. You can override this automatic feature, however, when you create the invoices, sales receipts, etc.)

The user can now specify a price level on line items in the following supported sales transactions: invoices, sales receipts, credit memos, and sales orders.

Notice that the response data for the affected sales transaction does not list the price level that was used. The response simply lists the , which was set using the price level.

quantity
String

Line item property: Quantity of item or item group.

The quantity of the Item specified in this line.

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

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

class.Quantity = "3.5"

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

rate
String

Unit rate of item.

The unit rate charged for this item.

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

The amount should be formatted as a string in dollars.

ratePercent
String

Line item property: A markup or discount percentage.

If is specified instead of , then this line item represents a percentage markup or discount, to be applied to the previous Item or Item group.

should be formatted as a positive or negative integer; a positive value indicates a markup.

Only one of and may be specified. If is set, then will be set to its default.

serviceDate
String

Line item property: Date of service.

For Items that represent a service, refers to the date of service. is only applicable for the CreditMemo, Invoice, PurchaseOrder, and SalesReceipt classs.

The standard formatting for dates is YYYY-MM-DD; i.e., September 2, 2002 is formatted as 2002-09-02. When getting the value of a date property, the date will always be in this format.

When setting the value of a date property, the formats MM-DD-YY, MM-DD-YYYY, MM/DD/YY, and MM/DD/YYYY are also acceptable. Dates in these formats will be automatically parsed and stored in YYYY-MM-DD format.

taxCodeId
String

Line item property: 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 property: 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 .

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 property is only available for QBXMLVersion 7.0 and higher.

Constructors

public init()

Config Settings (LineItemGroups Module)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

Base Config Settings

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8

The following is a list of valid code page identifiers for Mac OS only:

IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary
LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
  • Last Valid Build: The last valid build number for which the license will work.
MaskSensitive:   Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to to mask sensitive data. The default is .

This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

UseInternalSecurityAPI:   Tells the class whether or not to use the system security libraries or an internal implementation.

When set to , the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this setting to tells the class to use the internal implementation instead of using the system security libraries.

This setting is set to by default on all platforms.

Trappable Errors (LineItemGroups Module)

LineItemGroups Errors

201   A required field was not specified.
421   Update is not supported for this GroupType.
901   Unable to parse aggregate.
902   Invalid GroupType.

Copyright (c) 2023 4D Payments Inc.
QuickBooks Integrator 2022 macOS Edition - Version 22.0 [Build 8594]