Bill Class

Properties   Methods   Events   Config Settings   Errors  

A Bill indicates that the QuickBooks company owes money to a VENDOR . A Bill is the opposite of a VENDORCREDIT .

Syntax

Bill

Remarks

The Bill class represents a bill received from a Vendor. When a bill is added, the total amount is automatically entered into the Accounts Payable register.

Required Fields (Add): Vendor*, TransactionDate, Items or Expenses

Supported Methods: Add, Get (Id), Cancel, Delete

Example Bill1.VendorName = "ACME Inc." '* Bill1.TransactionDate = "1/17/03" Bill1.DueDate = "2/01/03" Bill1.ItemCount = 1 Bill1.ItemName(0) = "ACME Widget X" '* Bill1.ItemAmount(0) = "299.95" Bill1.ExpenseCount = 1 Bill1.ExpenseAccountName(0) = "Shipping" '* Bill1.ExpenseAmount(0) = "12.00" Bill1.Add() '*: Item must already exist in QuickBooks.

Amount is the total of the item lines and (if present) expense lines. It is computed automatically, and should never be set.

Item Lines: Item lines are used to track the purchase of goods or services. Line items may be added by first setting ItemCount. Then, for each line set the Item ID (or Name), Cost, Quantity, Description, Class, Customer, and Amount.

Note: For advanced users, the entire XML item structure may be set and retrieved through the Item's Aggregate property. However, it is up to the developer to ensure that this aggregate is formatted correctly.

Expense Lines: Expense lines are used to track portions of the total amount to expense accounts. To add expense lines to the transaction, first set ExpenseCount. This will initialize the Expenses array. Each expense will be tracked to the account specified in ExpenseAccount. The ExpenseAmount should also be specified for each expense; optionally, the ExpenseClass, ExpenseCustomer, and ExpenseMemo properties may be set as well.

The class supports a variety of other operations as well. The class's Get, Cancel, and Delete methods may be used to retrieve, cancel, and delete Bills, respectively. The ObjSearch Class may be used to search for Bills in the QuickBooks database.

Property List

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

Method List

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

Event List

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

Config Settings

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

Amount Property (Bill Class)

Amount of transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAmount();

Unicode (Windows)
LPWSTR GetAmount();

char* inqb_bill_getamount(void* lpObj);

QString GetAmount();

Default Value

""

Remarks

The amount of the transaction. Amount will be total of the amounts in the item lines and (if present) expense lines.

The amount should be formatted as a string in dollars.

This property is read-only.

Data Type

String

APAccountId Property (Bill Class)

Reference to the Accounts Payable account where money goes.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAPAccountId();
int SetAPAccountId(const char* lpszAPAccountId);

Unicode (Windows)
LPWSTR GetAPAccountId();
INT SetAPAccountId(LPCWSTR lpszAPAccountId);

char* inqb_bill_getapaccountid(void* lpObj);
int inqb_bill_setapaccountid(void* lpObj, const char* lpszAPAccountId);

QString GetAPAccountId();
int SetAPAccountId(QString qsAPAccountId);

Default Value

""

Remarks

A reference to the Accounts Payable account where the money received from this transaction will go.

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.

Data Type

String

APAccountName Property (Bill Class)

Reference to the Accounts Payable account.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAPAccountName();
int SetAPAccountName(const char* lpszAPAccountName);

Unicode (Windows)
LPWSTR GetAPAccountName();
INT SetAPAccountName(LPCWSTR lpszAPAccountName);

char* inqb_bill_getapaccountname(void* lpObj);
int inqb_bill_setapaccountname(void* lpObj, const char* lpszAPAccountName);

QString GetAPAccountName();
int SetAPAccountName(QString qsAPAccountName);

Default Value

""

Remarks

A reference to the Accounts Payable account where the money received from this transaction will go.

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.

Data Type

String

DueDate Property (Bill Class)

Date when payment is due.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDueDate();
int SetDueDate(const char* lpszDueDate);

Unicode (Windows)
LPWSTR GetDueDate();
INT SetDueDate(LPCWSTR lpszDueDate);

char* inqb_bill_getduedate(void* lpObj);
int inqb_bill_setduedate(void* lpObj, const char* lpszDueDate);

QString GetDueDate();
int SetDueDate(QString qsDueDate);

Default Value

""

Remarks

Appears in a variety of transactions. The date when payment is due.

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.

Data Type

String

ExpenseCount Property (Bill Class)

The number of records in the Expense arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetExpenseCount();
int SetExpenseCount(int iExpenseCount);

Unicode (Windows)
INT GetExpenseCount();
INT SetExpenseCount(INT iExpenseCount);

int inqb_bill_getexpensecount(void* lpObj);
int inqb_bill_setexpensecount(void* lpObj, int iExpenseCount);

int GetExpenseCount();
int SetExpenseCount(int iExpenseCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• ExpenseAccountId
• ExpenseAccountName
• ExpenseAmount
• ExpenseBillableStatus
• ExpenseClassId
• ExpenseClassName
• ExpenseCustomerId
• ExpenseCustomerName
• ExpenseLineId
• ExpenseMemo
• ExpenseTaxCodeId
• ExpenseTaxCodeName

The array indices start at 0 and end at ExpenseCount - 1.

This property is not available at design time.

Data Type

Integer

ExpenseAccountId Property (Bill Class)

A reference to the account to which this expense is be charged.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExpenseAccountId(int iExpenseIndex);
int SetExpenseAccountId(int iExpenseIndex, const char* lpszExpenseAccountId);

Unicode (Windows)
LPWSTR GetExpenseAccountId(INT iExpenseIndex);
INT SetExpenseAccountId(INT iExpenseIndex, LPCWSTR lpszExpenseAccountId);

char* inqb_bill_getexpenseaccountid(void* lpObj, int expenseindex);
int inqb_bill_setexpenseaccountid(void* lpObj, int expenseindex, const char* lpszExpenseAccountId);

QString GetExpenseAccountId(int iExpenseIndex);
int SetExpenseAccountId(int iExpenseIndex, QString qsExpenseAccountId);

Default Value

""

Remarks

A reference to the account to which this expense is be charged. Either ExpenseAccountName or ExpenseAccountId (but not both) may be used to specify the Account. For example, an ExpenseAccountName of "Rent".

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.

The ExpenseIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ExpenseCount property.

This property is not available at design time.

Data Type

String

ExpenseAccountName Property (Bill Class)

A reference to the account to which this expense is be charged.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExpenseAccountName(int iExpenseIndex);
int SetExpenseAccountName(int iExpenseIndex, const char* lpszExpenseAccountName);

Unicode (Windows)
LPWSTR GetExpenseAccountName(INT iExpenseIndex);
INT SetExpenseAccountName(INT iExpenseIndex, LPCWSTR lpszExpenseAccountName);

char* inqb_bill_getexpenseaccountname(void* lpObj, int expenseindex);
int inqb_bill_setexpenseaccountname(void* lpObj, int expenseindex, const char* lpszExpenseAccountName);

QString GetExpenseAccountName(int iExpenseIndex);
int SetExpenseAccountName(int iExpenseIndex, QString qsExpenseAccountName);

Default Value

""

Remarks

A reference to the account to which this expense is be charged. Either ExpenseAccountName or ExpenseAccountId (but not both) may be used to specify the Account. For example, an ExpenseAccountName of "Rent".

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.

The ExpenseIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ExpenseCount property.

This property is not available at design time.

Data Type

String

ExpenseAmount Property (Bill Class)

The total amount of this expense line.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExpenseAmount(int iExpenseIndex);
int SetExpenseAmount(int iExpenseIndex, const char* lpszExpenseAmount);

Unicode (Windows)
LPWSTR GetExpenseAmount(INT iExpenseIndex);
INT SetExpenseAmount(INT iExpenseIndex, LPCWSTR lpszExpenseAmount);

char* inqb_bill_getexpenseamount(void* lpObj, int expenseindex);
int inqb_bill_setexpenseamount(void* lpObj, int expenseindex, const char* lpszExpenseAmount);

QString GetExpenseAmount(int iExpenseIndex);
int SetExpenseAmount(int iExpenseIndex, QString qsExpenseAmount);

Default Value

""

Remarks

The total amount of this expense line. The amount should be formatted as a string in dollars.

About Expenses:

In payment transactions (a Bill, a VendorCredit, a CCCharge, a CCCredit, or a Check) the payment may be tracked through Items and/or Expenses. A set of array properties is available for each. Expense lines are used to charge regularly occurring expenses such as freight charges, rent, etc., to an ExpenseAccount.

Expense line items consist of an ExpenseAccount (Name or Id), an ExpenseAmount, an ExpenseClass (Name or Id), an ExpenseCustomer (Name or Id), and an ExpenseMemo. The number of expense lines is given by ExpenseCount.

The ExpenseIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ExpenseCount property.

This property is not available at design time.

Data Type

String

ExpenseBillableStatus Property (Bill Class)

The billing status of this expense line.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetExpenseBillableStatus(int iExpenseIndex);
int SetExpenseBillableStatus(int iExpenseIndex, int iExpenseBillableStatus);

Unicode (Windows)
INT GetExpenseBillableStatus(INT iExpenseIndex);
INT SetExpenseBillableStatus(INT iExpenseIndex, INT iExpenseBillableStatus);

BS_EMPTY(0), 
BS_BILLABLE(1), 
BS_NOT_BILLABLE(2), 
BS_HAS_BEEN_BILLED(3)

int inqb_bill_getexpensebillablestatus(void* lpObj, int expenseindex);
int inqb_bill_setexpensebillablestatus(void* lpObj, int expenseindex, int iExpenseBillableStatus);

int GetExpenseBillableStatus(int iExpenseIndex);
int SetExpenseBillableStatus(int iExpenseIndex, int iExpenseBillableStatus);

Default Value

0

Remarks

The billing status of this expense line.

If the billing status is empty (that is, if no billing status appears in QuickBooks), then BillableStatus will be bsEmpty

Values:

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

About Expenses:

In payment transactions (a Bill, a VendorCredit, a CCCharge, a CCCredit, or a Check) the payment may be tracked through Items and/or Expenses. A set of array properties is available for each. Expense lines are used to charge regularly occurring expenses such as freight charges, rent, etc., to an ExpenseAccount.

Expense line items consist of an ExpenseAccount (Name or Id), an ExpenseAmount, an ExpenseClass (Name or Id), an ExpenseCustomer (Name or Id), and an ExpenseMemo. The number of expense lines is given by ExpenseCount.

The ExpenseIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ExpenseCount property.

This property is not available at design time.

Data Type

Integer

ExpenseClassId Property (Bill Class)

A reference to the class of this expense.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExpenseClassId(int iExpenseIndex);
int SetExpenseClassId(int iExpenseIndex, const char* lpszExpenseClassId);

Unicode (Windows)
LPWSTR GetExpenseClassId(INT iExpenseIndex);
INT SetExpenseClassId(INT iExpenseIndex, LPCWSTR lpszExpenseClassId);

char* inqb_bill_getexpenseclassid(void* lpObj, int expenseindex);
int inqb_bill_setexpenseclassid(void* lpObj, int expenseindex, const char* lpszExpenseClassId);

QString GetExpenseClassId(int iExpenseIndex);
int SetExpenseClassId(int iExpenseIndex, QString qsExpenseClassId);

Default Value

""

Remarks

A reference to the class of this expense. The class may be specified by either ExpenseClassName or ExpenseClassId. This property is only used if class tracking is being done with the QuickBooks company.

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.

About Expenses:

In payment transactions (a Bill, a VendorCredit, a CCCharge, a CCCredit, or a Check) the payment may be tracked through Items and/or Expenses. A set of array properties is available for each. Expense lines are used to charge regularly occurring expenses such as freight charges, rent, etc., to an ExpenseAccount.

Expense line items consist of an ExpenseAccount (Name or Id), an ExpenseAmount, an ExpenseClass (Name or Id), an ExpenseCustomer (Name or Id), and an ExpenseMemo. The number of expense lines is given by ExpenseCount.

The ExpenseIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ExpenseCount property.

This property is not available at design time.

Data Type

String

ExpenseClassName Property (Bill Class)

A reference to the class of this expense.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExpenseClassName(int iExpenseIndex);
int SetExpenseClassName(int iExpenseIndex, const char* lpszExpenseClassName);

Unicode (Windows)
LPWSTR GetExpenseClassName(INT iExpenseIndex);
INT SetExpenseClassName(INT iExpenseIndex, LPCWSTR lpszExpenseClassName);

char* inqb_bill_getexpenseclassname(void* lpObj, int expenseindex);
int inqb_bill_setexpenseclassname(void* lpObj, int expenseindex, const char* lpszExpenseClassName);

QString GetExpenseClassName(int iExpenseIndex);
int SetExpenseClassName(int iExpenseIndex, QString qsExpenseClassName);

Default Value

""

Remarks

A reference to the class of this expense. The class may be specified by either ExpenseClassName or ExpenseClassId. This property is only used if class tracking is being done with the QuickBooks company.

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.

About Expenses:

In payment transactions (a Bill, a VendorCredit, a CCCharge, a CCCredit, or a Check) the payment may be tracked through Items and/or Expenses. A set of array properties is available for each. Expense lines are used to charge regularly occurring expenses such as freight charges, rent, etc., to an ExpenseAccount.

Expense line items consist of an ExpenseAccount (Name or Id), an ExpenseAmount, an ExpenseClass (Name or Id), an ExpenseCustomer (Name or Id), and an ExpenseMemo. The number of expense lines is given by ExpenseCount.

The ExpenseIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ExpenseCount property.

This property is not available at design time.

Data Type

String

ExpenseCustomerId Property (Bill Class)

The customer associated with this expense line.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExpenseCustomerId(int iExpenseIndex);
int SetExpenseCustomerId(int iExpenseIndex, const char* lpszExpenseCustomerId);

Unicode (Windows)
LPWSTR GetExpenseCustomerId(INT iExpenseIndex);
INT SetExpenseCustomerId(INT iExpenseIndex, LPCWSTR lpszExpenseCustomerId);

char* inqb_bill_getexpensecustomerid(void* lpObj, int expenseindex);
int inqb_bill_setexpensecustomerid(void* lpObj, int expenseindex, const char* lpszExpenseCustomerId);

QString GetExpenseCustomerId(int iExpenseIndex);
int SetExpenseCustomerId(int iExpenseIndex, QString qsExpenseCustomerId);

Default Value

""

Remarks

The customer associated with this expense line.

Either ExpenseCustomerName or ExpenseCustomerId may reference to a Customer for this expense line.

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.

About Expenses:

In payment transactions (a Bill, a VendorCredit, a CCCharge, a CCCredit, or a Check) the payment may be tracked through Items and/or Expenses. A set of array properties is available for each. Expense lines are used to charge regularly occurring expenses such as freight charges, rent, etc., to an ExpenseAccount.

Expense line items consist of an ExpenseAccount (Name or Id), an ExpenseAmount, an ExpenseClass (Name or Id), an ExpenseCustomer (Name or Id), and an ExpenseMemo. The number of expense lines is given by ExpenseCount.

The ExpenseIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ExpenseCount property.

This property is not available at design time.

Data Type

String

ExpenseCustomerName Property (Bill Class)

The customer associated with this expense line.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExpenseCustomerName(int iExpenseIndex);
int SetExpenseCustomerName(int iExpenseIndex, const char* lpszExpenseCustomerName);

Unicode (Windows)
LPWSTR GetExpenseCustomerName(INT iExpenseIndex);
INT SetExpenseCustomerName(INT iExpenseIndex, LPCWSTR lpszExpenseCustomerName);

char* inqb_bill_getexpensecustomername(void* lpObj, int expenseindex);
int inqb_bill_setexpensecustomername(void* lpObj, int expenseindex, const char* lpszExpenseCustomerName);

QString GetExpenseCustomerName(int iExpenseIndex);
int SetExpenseCustomerName(int iExpenseIndex, QString qsExpenseCustomerName);

Default Value

""

Remarks

The customer associated with this expense line.

Either ExpenseCustomerName or ExpenseCustomerId may reference to a Customer for this expense line.

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.

About Expenses:

In payment transactions (a Bill, a VendorCredit, a CCCharge, a CCCredit, or a Check) the payment may be tracked through Items and/or Expenses. A set of array properties is available for each. Expense lines are used to charge regularly occurring expenses such as freight charges, rent, etc., to an ExpenseAccount.

Expense line items consist of an ExpenseAccount (Name or Id), an ExpenseAmount, an ExpenseClass (Name or Id), an ExpenseCustomer (Name or Id), and an ExpenseMemo. The number of expense lines is given by ExpenseCount.

The ExpenseIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ExpenseCount property.

This property is not available at design time.

Data Type

String

ExpenseLineId Property (Bill Class)

Identification number of the expense line, used for Updates.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExpenseLineId(int iExpenseIndex);
int SetExpenseLineId(int iExpenseIndex, const char* lpszExpenseLineId);

Unicode (Windows)
LPWSTR GetExpenseLineId(INT iExpenseIndex);
INT SetExpenseLineId(INT iExpenseIndex, LPCWSTR lpszExpenseLineId);

char* inqb_bill_getexpenselineid(void* lpObj, int expenseindex);
int inqb_bill_setexpenselineid(void* lpObj, int expenseindex, const char* lpszExpenseLineId);

QString GetExpenseLineId(int iExpenseIndex);
int SetExpenseLineId(int iExpenseIndex, QString qsExpenseLineId);

Default Value

""

Remarks

Identification number of the expense line, used for Updates.

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

The ExpenseIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ExpenseCount property.

This property is not available at design time.

Data Type

String

ExpenseMemo Property (Bill Class)

A memo for this expense line, which will appear to the QuickBooks user only.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExpenseMemo(int iExpenseIndex);
int SetExpenseMemo(int iExpenseIndex, const char* lpszExpenseMemo);

Unicode (Windows)
LPWSTR GetExpenseMemo(INT iExpenseIndex);
INT SetExpenseMemo(INT iExpenseIndex, LPCWSTR lpszExpenseMemo);

char* inqb_bill_getexpensememo(void* lpObj, int expenseindex);
int inqb_bill_setexpensememo(void* lpObj, int expenseindex, const char* lpszExpenseMemo);

QString GetExpenseMemo(int iExpenseIndex);
int SetExpenseMemo(int iExpenseIndex, QString qsExpenseMemo);

Default Value

""

Remarks

A memo for this expense line, which will appear to the QuickBooks user only.

About Expenses:

In payment transactions (a Bill, a VendorCredit, a CCCharge, a CCCredit, or a Check) the payment may be tracked through Items and/or Expenses. A set of array properties is available for each. Expense lines are used to charge regularly occurring expenses such as freight charges, rent, etc., to an ExpenseAccount.

Expense line items consist of an ExpenseAccount (Name or Id), an ExpenseAmount, an ExpenseClass (Name or Id), an ExpenseCustomer (Name or Id), and an ExpenseMemo. The number of expense lines is given by ExpenseCount.

The ExpenseIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ExpenseCount property.

This property is not available at design time.

Data Type

String

ExpenseTaxCodeId Property (Bill Class)

Line item property: Sales tax information for this item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExpenseTaxCodeId(int iExpenseIndex);
int SetExpenseTaxCodeId(int iExpenseIndex, const char* lpszExpenseTaxCodeId);

Unicode (Windows)
LPWSTR GetExpenseTaxCodeId(INT iExpenseIndex);
INT SetExpenseTaxCodeId(INT iExpenseIndex, LPCWSTR lpszExpenseTaxCodeId);

char* inqb_bill_getexpensetaxcodeid(void* lpObj, int expenseindex);
int inqb_bill_setexpensetaxcodeid(void* lpObj, int expenseindex, const char* lpszExpenseTaxCodeId);

QString GetExpenseTaxCodeId(int iExpenseIndex);
int SetExpenseTaxCodeId(int iExpenseIndex, QString qsExpenseTaxCodeId);

Default Value

""

Remarks

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.

About Expenses:

In payment transactions (a Bill, a VendorCredit, a CCCharge, a CCCredit, or a Check) the payment may be tracked through Items and/or Expenses. A set of array properties is available for each. Expense lines are used to charge regularly occurring expenses such as freight charges, rent, etc., to an ExpenseAccount.

Expense line items consist of an ExpenseAccount (Name or Id), an ExpenseAmount, an ExpenseClass (Name or Id), an ExpenseCustomer (Name or Id), and an ExpenseMemo. The number of expense lines is given by ExpenseCount.

The ExpenseIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ExpenseCount property.

This property is not available at design time.

Data Type

String

ExpenseTaxCodeName Property (Bill Class)

Line item property: Sales tax information for this item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetExpenseTaxCodeName(int iExpenseIndex);
int SetExpenseTaxCodeName(int iExpenseIndex, const char* lpszExpenseTaxCodeName);

Unicode (Windows)
LPWSTR GetExpenseTaxCodeName(INT iExpenseIndex);
INT SetExpenseTaxCodeName(INT iExpenseIndex, LPCWSTR lpszExpenseTaxCodeName);

char* inqb_bill_getexpensetaxcodename(void* lpObj, int expenseindex);
int inqb_bill_setexpensetaxcodename(void* lpObj, int expenseindex, const char* lpszExpenseTaxCodeName);

QString GetExpenseTaxCodeName(int iExpenseIndex);
int SetExpenseTaxCodeName(int iExpenseIndex, QString qsExpenseTaxCodeName);

Default Value

""

Remarks

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.

About Expenses:

In payment transactions (a Bill, a VendorCredit, a CCCharge, a CCCredit, or a Check) the payment may be tracked through Items and/or Expenses. A set of array properties is available for each. Expense lines are used to charge regularly occurring expenses such as freight charges, rent, etc., to an ExpenseAccount.

Expense line items consist of an ExpenseAccount (Name or Id), an ExpenseAmount, an ExpenseClass (Name or Id), an ExpenseCustomer (Name or Id), and an ExpenseMemo. The number of expense lines is given by ExpenseCount.

The ExpenseIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ExpenseCount property.

This property is not available at design time.

Data Type

String

IncludeLinkedTxns Property (Bill Class)

Indicates whether to include linked transactions in the response.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIncludeLinkedTxns();
int SetIncludeLinkedTxns(int bIncludeLinkedTxns);

Unicode (Windows)
BOOL GetIncludeLinkedTxns();
INT SetIncludeLinkedTxns(BOOL bIncludeLinkedTxns);

int inqb_bill_getincludelinkedtxns(void* lpObj);
int inqb_bill_setincludelinkedtxns(void* lpObj, int bIncludeLinkedTxns);

bool GetIncludeLinkedTxns();
int SetIncludeLinkedTxns(bool bIncludeLinkedTxns);

Default Value

FALSE

Remarks

If you set IncludeLinkedTxns to true, then the returned object will include a list of all the transactions linked to the queried object (this list is similar to the History view of a transaction in the user interface, but not identical, as the SDK list contains only linked transactions, not items). Each linked transaction will be represented by a LinkedTxn aggregate, which will be parsed by the class into the following properties:

• LinkedTxnCount
• LinkedTxnAmount
• LinkedTxnDate
• LinkedTxnId
• LinkedTxnLinkType
• LinkedTxnRefNumber
• LinkedTxnType

Data Type

Boolean

IsPaid Property (Bill Class)

Indicates whether this bill has been paid.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIsPaid();

Unicode (Windows)
BOOL GetIsPaid();

int inqb_bill_getispaid(void* lpObj);

bool GetIsPaid();

Default Value

FALSE

Remarks

This property is only returned if the QBXMLVersion is set to "2.0" or higher.

This property is read-only.

Data Type

Boolean

ItemCount Property (Bill Class)

The number of records in the Item arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetItemCount();
int SetItemCount(int iItemCount);

Unicode (Windows)
INT GetItemCount();
INT SetItemCount(INT iItemCount);

int inqb_bill_getitemcount(void* lpObj);
int inqb_bill_setitemcount(void* lpObj, int iItemCount);

int GetItemCount();
int SetItemCount(int iItemCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• ItemAggregate
• ItemAmount
• ItemBillableStatus
• ItemClassId
• ItemClassName
• ItemCost
• ItemCustomerId
• ItemCustomerName
• ItemDescription
• ItemGroupId
• ItemGroupName
• ItemId
• ItemLineId
• ItemName
• ItemOverrideAccountId
• ItemOverrideAccountName
• ItemQuantity
• ItemTaxCodeId
• ItemTaxCodeName
• ItemUnitOfMeasure

The array indices start at 0 and end at ItemCount - 1.

This property is not available at design time.

Data Type

Integer

ItemAggregate Property (Bill Class)

Contains an XML aggregate of the line item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemAggregate(int iItemIndex);
int SetItemAggregate(int iItemIndex, const char* lpszItemAggregate);

Unicode (Windows)
LPWSTR GetItemAggregate(INT iItemIndex);
INT SetItemAggregate(INT iItemIndex, LPCWSTR lpszItemAggregate);

char* inqb_bill_getitemaggregate(void* lpObj, int itemindex);
int inqb_bill_setitemaggregate(void* lpObj, int itemindex, const char* lpszItemAggregate);

QString GetItemAggregate(int iItemIndex);
int SetItemAggregate(int iItemIndex, QString qsItemAggregate);

Default Value

""

Remarks

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

If you set the other line item properties and then query the ItemAggregate, 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 ItemAggregate field with your own custom XML, all of this will be taken care of you automatically by the class.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemAmount Property (Bill Class)

Line item property: the total amount of this item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemAmount(int iItemIndex);
int SetItemAmount(int iItemIndex, const char* lpszItemAmount);

Unicode (Windows)
LPWSTR GetItemAmount(INT iItemIndex);
INT SetItemAmount(INT iItemIndex, LPCWSTR lpszItemAmount);

char* inqb_bill_getitemamount(void* lpObj, int itemindex);
int inqb_bill_setitemamount(void* lpObj, int itemindex, const char* lpszItemAmount);

QString GetItemAmount(int iItemIndex);
int SetItemAmount(int iItemIndex, QString qsItemAmount);

Default Value

""

Remarks

Line item property: the total amount of this item.

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

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

The amount should be formatted as a string in dollars.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemBillableStatus Property (Bill Class)

Line item property: Billing status of this item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetItemBillableStatus(int iItemIndex);
int SetItemBillableStatus(int iItemIndex, int iItemBillableStatus);

Unicode (Windows)
INT GetItemBillableStatus(INT iItemIndex);
INT SetItemBillableStatus(INT iItemIndex, INT iItemBillableStatus);

BS_EMPTY(0), 
BS_BILLABLE(1), 
BS_NOT_BILLABLE(2), 
BS_HAS_BEEN_BILLED(3)

int inqb_bill_getitembillablestatus(void* lpObj, int itemindex);
int inqb_bill_setitembillablestatus(void* lpObj, int itemindex, int iItemBillableStatus);

int GetItemBillableStatus(int iItemIndex);
int SetItemBillableStatus(int iItemIndex, int iItemBillableStatus);

Default Value

0

Remarks

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 ItemBillableStatus value will be returned.

Values:

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

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

Integer

ItemClassId Property (Bill Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemClassId(int iItemIndex);
int SetItemClassId(int iItemIndex, const char* lpszItemClassId);

Unicode (Windows)
LPWSTR GetItemClassId(INT iItemIndex);
INT SetItemClassId(INT iItemIndex, LPCWSTR lpszItemClassId);

char* inqb_bill_getitemclassid(void* lpObj, int itemindex);
int inqb_bill_setitemclassid(void* lpObj, int itemindex, const char* lpszItemClassId);

QString GetItemClassId(int iItemIndex);
int SetItemClassId(int iItemIndex, QString qsItemClassId);

Default Value

""

Remarks

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.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemClassName Property (Bill Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemClassName(int iItemIndex);
int SetItemClassName(int iItemIndex, const char* lpszItemClassName);

Unicode (Windows)
LPWSTR GetItemClassName(INT iItemIndex);
INT SetItemClassName(INT iItemIndex, LPCWSTR lpszItemClassName);

char* inqb_bill_getitemclassname(void* lpObj, int itemindex);
int inqb_bill_setitemclassname(void* lpObj, int itemindex, const char* lpszItemClassName);

QString GetItemClassName(int iItemIndex);
int SetItemClassName(int iItemIndex, QString qsItemClassName);

Default Value

""

Remarks

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.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemCost Property (Bill Class)

Line item property: Unit cost for item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemCost(int iItemIndex);
int SetItemCost(int iItemIndex, const char* lpszItemCost);

Unicode (Windows)
LPWSTR GetItemCost(INT iItemIndex);
INT SetItemCost(INT iItemIndex, LPCWSTR lpszItemCost);

char* inqb_bill_getitemcost(void* lpObj, int itemindex);
int inqb_bill_setitemcost(void* lpObj, int itemindex, const char* lpszItemCost);

QString GetItemCost(int iItemIndex);
int SetItemCost(int iItemIndex, QString qsItemCost);

Default Value

""

Remarks

Line item property: Unit cost for item.

The unit cost for this item.

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

The amount should be formatted as a string in dollars.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemCustomerId Property (Bill Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemCustomerId(int iItemIndex);
int SetItemCustomerId(int iItemIndex, const char* lpszItemCustomerId);

Unicode (Windows)
LPWSTR GetItemCustomerId(INT iItemIndex);
INT SetItemCustomerId(INT iItemIndex, LPCWSTR lpszItemCustomerId);

char* inqb_bill_getitemcustomerid(void* lpObj, int itemindex);
int inqb_bill_setitemcustomerid(void* lpObj, int itemindex, const char* lpszItemCustomerId);

QString GetItemCustomerId(int iItemIndex);
int SetItemCustomerId(int iItemIndex, QString qsItemCustomerId);

Default Value

""

Remarks

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.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemCustomerName Property (Bill Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemCustomerName(int iItemIndex);
int SetItemCustomerName(int iItemIndex, const char* lpszItemCustomerName);

Unicode (Windows)
LPWSTR GetItemCustomerName(INT iItemIndex);
INT SetItemCustomerName(INT iItemIndex, LPCWSTR lpszItemCustomerName);

char* inqb_bill_getitemcustomername(void* lpObj, int itemindex);
int inqb_bill_setitemcustomername(void* lpObj, int itemindex, const char* lpszItemCustomerName);

QString GetItemCustomerName(int iItemIndex);
int SetItemCustomerName(int iItemIndex, QString qsItemCustomerName);

Default Value

""

Remarks

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.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemDescription Property (Bill Class)

Line item property: Description of item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemDescription(int iItemIndex);
int SetItemDescription(int iItemIndex, const char* lpszItemDescription);

Unicode (Windows)
LPWSTR GetItemDescription(INT iItemIndex);
INT SetItemDescription(INT iItemIndex, LPCWSTR lpszItemDescription);

char* inqb_bill_getitemdescription(void* lpObj, int itemindex);
int inqb_bill_setitemdescription(void* lpObj, int itemindex, const char* lpszItemDescription);

QString GetItemDescription(int iItemIndex);
int SetItemDescription(int iItemIndex, QString qsItemDescription);

Default Value

""

Remarks

Line item property: Description of item.

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

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemGroupId Property (Bill Class)

Reference to a group of line items.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemGroupId(int iItemIndex);
int SetItemGroupId(int iItemIndex, const char* lpszItemGroupId);

Unicode (Windows)
LPWSTR GetItemGroupId(INT iItemIndex);
INT SetItemGroupId(INT iItemIndex, LPCWSTR lpszItemGroupId);

char* inqb_bill_getitemgroupid(void* lpObj, int itemindex);
int inqb_bill_setitemgroupid(void* lpObj, int itemindex, const char* lpszItemGroupId);

QString GetItemGroupId(int iItemIndex);
int SetItemGroupId(int iItemIndex, QString qsItemGroupId);

Default Value

""

Remarks

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 properties (total ItemAmount, ItemQuantity, and ItemDescription), 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 ItemAggregate 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 ItemAggregate field to use in an Update transaction.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemGroupName Property (Bill Class)

Reference to a group of line items.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemGroupName(int iItemIndex);
int SetItemGroupName(int iItemIndex, const char* lpszItemGroupName);

Unicode (Windows)
LPWSTR GetItemGroupName(INT iItemIndex);
INT SetItemGroupName(INT iItemIndex, LPCWSTR lpszItemGroupName);

char* inqb_bill_getitemgroupname(void* lpObj, int itemindex);
int inqb_bill_setitemgroupname(void* lpObj, int itemindex, const char* lpszItemGroupName);

QString GetItemGroupName(int iItemIndex);
int SetItemGroupName(int iItemIndex, QString qsItemGroupName);

Default Value

""

Remarks

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 properties (total ItemAmount, ItemQuantity, and ItemDescription), 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 ItemAggregate 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 ItemAggregate field to use in an Update transaction.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemId Property (Bill Class)

Line item property: Reference to the kind of item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemId(int iItemIndex);
int SetItemId(int iItemIndex, const char* lpszItemId);

Unicode (Windows)
LPWSTR GetItemId(INT iItemIndex);
INT SetItemId(INT iItemIndex, LPCWSTR lpszItemId);

char* inqb_bill_getitemid(void* lpObj, int itemindex);
int inqb_bill_setitemid(void* lpObj, int itemindex, const char* lpszItemId);

QString GetItemId(int iItemIndex);
int SetItemId(int iItemIndex, QString qsItemId);

Default Value

""

Remarks

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 ItemQuantity and ItemDescription 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 ItemDescription, 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.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemName Property (Bill Class)

Line item property: Reference to the kind of item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemName(int iItemIndex);
int SetItemName(int iItemIndex, const char* lpszItemName);

Unicode (Windows)
LPWSTR GetItemName(INT iItemIndex);
INT SetItemName(INT iItemIndex, LPCWSTR lpszItemName);

char* inqb_bill_getitemname(void* lpObj, int itemindex);
int inqb_bill_setitemname(void* lpObj, int itemindex, const char* lpszItemName);

QString GetItemName(int iItemIndex);
int SetItemName(int iItemIndex, QString qsItemName);

Default Value

""

Remarks

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 ItemQuantity and ItemDescription 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 ItemDescription, 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.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemLineId Property (Bill Class)

Identification number of the transaction line, used for Updates.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemLineId(int iItemIndex);
int SetItemLineId(int iItemIndex, const char* lpszItemLineId);

Unicode (Windows)
LPWSTR GetItemLineId(INT iItemIndex);
INT SetItemLineId(INT iItemIndex, LPCWSTR lpszItemLineId);

char* inqb_bill_getitemlineid(void* lpObj, int itemindex);
int inqb_bill_setitemlineid(void* lpObj, int itemindex, const char* lpszItemLineId);

QString GetItemLineId(int iItemIndex);
int SetItemLineId(int iItemIndex, QString qsItemLineId);

Default Value

""

Remarks

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

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemOverrideAccountId Property (Bill Class)

An account which will override the default account for the line item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemOverrideAccountId(int iItemIndex);
int SetItemOverrideAccountId(int iItemIndex, const char* lpszItemOverrideAccountId);

Unicode (Windows)
LPWSTR GetItemOverrideAccountId(INT iItemIndex);
INT SetItemOverrideAccountId(INT iItemIndex, LPCWSTR lpszItemOverrideAccountId);

char* inqb_bill_getitemoverrideaccountid(void* lpObj, int itemindex);
int inqb_bill_setitemoverrideaccountid(void* lpObj, int itemindex, const char* lpszItemOverrideAccountId);

QString GetItemOverrideAccountId(int iItemIndex);
int SetItemOverrideAccountId(int iItemIndex, QString qsItemOverrideAccountId);

Default Value

""

Remarks

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

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemOverrideAccountName Property (Bill Class)

An account which will override the default account for the line item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemOverrideAccountName(int iItemIndex);
int SetItemOverrideAccountName(int iItemIndex, const char* lpszItemOverrideAccountName);

Unicode (Windows)
LPWSTR GetItemOverrideAccountName(INT iItemIndex);
INT SetItemOverrideAccountName(INT iItemIndex, LPCWSTR lpszItemOverrideAccountName);

char* inqb_bill_getitemoverrideaccountname(void* lpObj, int itemindex);
int inqb_bill_setitemoverrideaccountname(void* lpObj, int itemindex, const char* lpszItemOverrideAccountName);

QString GetItemOverrideAccountName(int iItemIndex);
int SetItemOverrideAccountName(int iItemIndex, QString qsItemOverrideAccountName);

Default Value

""

Remarks

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

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemQuantity Property (Bill Class)

Line item property: Quantity of item or item group.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemQuantity(int iItemIndex);
int SetItemQuantity(int iItemIndex, const char* lpszItemQuantity);

Unicode (Windows)
LPWSTR GetItemQuantity(INT iItemIndex);
INT SetItemQuantity(INT iItemIndex, LPCWSTR lpszItemQuantity);

char* inqb_bill_getitemquantity(void* lpObj, int itemindex);
int inqb_bill_setitemquantity(void* lpObj, int itemindex, const char* lpszItemQuantity);

QString GetItemQuantity(int iItemIndex);
int SetItemQuantity(int iItemIndex, QString qsItemQuantity);

Default Value

""

Remarks

Line item property: Quantity of item or item group.

The quantity of the Item specified in this line.

If ItemQuantity and only one of ItemCost, ItemRate, or ItemAmount 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.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemTaxCodeId Property (Bill Class)

Line item property: Sales tax information for this item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemTaxCodeId(int iItemIndex);
int SetItemTaxCodeId(int iItemIndex, const char* lpszItemTaxCodeId);

Unicode (Windows)
LPWSTR GetItemTaxCodeId(INT iItemIndex);
INT SetItemTaxCodeId(INT iItemIndex, LPCWSTR lpszItemTaxCodeId);

char* inqb_bill_getitemtaxcodeid(void* lpObj, int itemindex);
int inqb_bill_setitemtaxcodeid(void* lpObj, int itemindex, const char* lpszItemTaxCodeId);

QString GetItemTaxCodeId(int iItemIndex);
int SetItemTaxCodeId(int iItemIndex, QString qsItemTaxCodeId);

Default Value

""

Remarks

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.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemTaxCodeName Property (Bill Class)

Line item property: Sales tax information for this item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemTaxCodeName(int iItemIndex);
int SetItemTaxCodeName(int iItemIndex, const char* lpszItemTaxCodeName);

Unicode (Windows)
LPWSTR GetItemTaxCodeName(INT iItemIndex);
INT SetItemTaxCodeName(INT iItemIndex, LPCWSTR lpszItemTaxCodeName);

char* inqb_bill_getitemtaxcodename(void* lpObj, int itemindex);
int inqb_bill_setitemtaxcodename(void* lpObj, int itemindex, const char* lpszItemTaxCodeName);

QString GetItemTaxCodeName(int iItemIndex);
int SetItemTaxCodeName(int iItemIndex, QString qsItemTaxCodeName);

Default Value

""

Remarks

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.