SalesReceipt Class

Properties   Methods   Events   Config Settings   Errors  

A SalesReceipt is used to record point-of-sale payments.

Syntax

SalesReceipt

Remarks

The SalesReceipt class represents a point-of-sale payment by a Customer. A SalesReceipt should be used in place of an Invoice when full payment is received at the time of sale.

Required Fields (Add): Customer*, Items

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

Example SalesReceipt1.CustomerName = "John Q. Customer" '* SalesReceipt1.TransactionDate = "1/17/03" SalesReceipt1.ItemCount = 1 SalesReceipt1.ItemName(0) = "Our Company's Product" '* SalesReceipt1.ItemAmount(0) = "140.00" SalesReceipt1.Add() '*: Item must already exist in QuickBooks. TotalAmount is the total of the item lines. It is computed automatically, and should never be set.

Item Lines: Item lines are used to track the sale of goods or services. Line items may be added by first setting ItemCount. Then for each line set the Item Id (or Name) or Group. You may also optionally set the Rate/RatePercent/PriceLevel, Quantity, Description, Class, TaxCode, ServiceDate, and Amount for each item 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 SalesReceipts, respectively. The ObjSearch Class may be used to search for SalesReceipts 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.

BillingAddress Property (SalesReceipt Class)

Address to bill to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBillingAddress();
int SetBillingAddress(const char* lpszBillingAddress);

Unicode (Windows)
LPWSTR GetBillingAddress();
INT SetBillingAddress(LPCWSTR lpszBillingAddress);

char* inqb_salesreceipt_getbillingaddress(void* lpObj);
int inqb_salesreceipt_setbillingaddress(void* lpObj, const char* lpszBillingAddress);

QString GetBillingAddress();
int SetBillingAddress(QString qsBillingAddress);

Default Value

""

Remarks

The address to bill to.

The address is stored as a string, formatted as XML. It may be read and written directly, or with the Address component.

To read an address, set the Aggregate property of an Address class to this value, and read the values of the desired fields. To write an address, write the values of the desired Address fields and set this property to the Address's Aggregate.

To read and/or write directly, use the QBXML formatting: <Addr1>Line1</Addr1><Addr2>Line2</Addr2><Addr3>Line3</Addr3> <City>City</City><State>State</State><PostalCode>PostalCode</PostalCode> <Country>Country</Country>

Data Type

String

CheckNumber Property (SalesReceipt Class)

Check number (if payment was made by check).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCheckNumber();
int SetCheckNumber(const char* lpszCheckNumber);

Unicode (Windows)
LPWSTR GetCheckNumber();
INT SetCheckNumber(LPCWSTR lpszCheckNumber);

char* inqb_salesreceipt_getchecknumber(void* lpObj);
int inqb_salesreceipt_setchecknumber(void* lpObj, const char* lpszCheckNumber);

QString GetCheckNumber();
int SetCheckNumber(QString qsCheckNumber);

Default Value

""

Remarks

The check number. This property should only be specified if payment is made by check.

Data Type

String

CustomerId Property (SalesReceipt Class)

A reference to the customer or customer job.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomerId();
int SetCustomerId(const char* lpszCustomerId);

Unicode (Windows)
LPWSTR GetCustomerId();
INT SetCustomerId(LPCWSTR lpszCustomerId);

char* inqb_salesreceipt_getcustomerid(void* lpObj);
int inqb_salesreceipt_setcustomerid(void* lpObj, const char* lpszCustomerId);

QString GetCustomerId();
int SetCustomerId(QString qsCustomerId);

Default Value

""

Remarks

The Customer property indicates the Customer who has purchased goods or services from the company.

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.

Either CustomerId or CustomerName is required.

Data Type

String

CustomerMessageId Property (SalesReceipt Class)

Reference to message to appear to customer.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomerMessageId();
int SetCustomerMessageId(const char* lpszCustomerMessageId);

Unicode (Windows)
LPWSTR GetCustomerMessageId();
INT SetCustomerMessageId(LPCWSTR lpszCustomerMessageId);

char* inqb_salesreceipt_getcustomermessageid(void* lpObj);
int inqb_salesreceipt_setcustomermessageid(void* lpObj, const char* lpszCustomerMessageId);

QString GetCustomerMessageId();
int SetCustomerMessageId(QString qsCustomerMessageId);

Default Value

""

Remarks

A reference to a predefined message that will appear to the customer.

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

CustomerMessageName Property (SalesReceipt Class)

Reference to message to appear to customer.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomerMessageName();
int SetCustomerMessageName(const char* lpszCustomerMessageName);

Unicode (Windows)
LPWSTR GetCustomerMessageName();
INT SetCustomerMessageName(LPCWSTR lpszCustomerMessageName);

char* inqb_salesreceipt_getcustomermessagename(void* lpObj);
int inqb_salesreceipt_setcustomermessagename(void* lpObj, const char* lpszCustomerMessageName);

QString GetCustomerMessageName();
int SetCustomerMessageName(QString qsCustomerMessageName);

Default Value

""

Remarks

A reference to a predefined message that will appear to the customer.

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

CustomerName Property (SalesReceipt Class)

A reference to the customer or customer job.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomerName();
int SetCustomerName(const char* lpszCustomerName);

Unicode (Windows)
LPWSTR GetCustomerName();
INT SetCustomerName(LPCWSTR lpszCustomerName);

char* inqb_salesreceipt_getcustomername(void* lpObj);
int inqb_salesreceipt_setcustomername(void* lpObj, const char* lpszCustomerName);

QString GetCustomerName();
int SetCustomerName(QString qsCustomerName);

Default Value

""

Remarks

The Customer property indicates the Customer who has purchased goods or services from the 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.

Either CustomerId or CustomerName is required.

Data Type

String

DepositToAccountId Property (SalesReceipt Class)

Reference to account where money will be deposited.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDepositToAccountId();
int SetDepositToAccountId(const char* lpszDepositToAccountId);

Unicode (Windows)
LPWSTR GetDepositToAccountId();
INT SetDepositToAccountId(LPCWSTR lpszDepositToAccountId);

char* inqb_salesreceipt_getdeposittoaccountid(void* lpObj);
int inqb_salesreceipt_setdeposittoaccountid(void* lpObj, const char* lpszDepositToAccountId);

QString GetDepositToAccountId();
int SetDepositToAccountId(QString qsDepositToAccountId);

Default Value

""

Remarks

A reference to the account where the money will be deposited. For example, "Checking".

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

DepositToAccountName Property (SalesReceipt Class)

Reference to account where money will be deposited.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDepositToAccountName();
int SetDepositToAccountName(const char* lpszDepositToAccountName);

Unicode (Windows)
LPWSTR GetDepositToAccountName();
INT SetDepositToAccountName(LPCWSTR lpszDepositToAccountName);

char* inqb_salesreceipt_getdeposittoaccountname(void* lpObj);
int inqb_salesreceipt_setdeposittoaccountname(void* lpObj, const char* lpszDepositToAccountName);

QString GetDepositToAccountName();
int SetDepositToAccountName(QString qsDepositToAccountName);

Default Value

""

Remarks

A reference to the account where the money will be deposited. For example, "Checking".

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 (SalesReceipt 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_salesreceipt_getduedate(void* lpObj);
int inqb_salesreceipt_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.

NOTE: A sales receipt does not ordinarily include a due date, because sales receipts are generally used for point-of-sale payments, where full payment is received at the time of purchase.

Data Type

String

IsPending Property (SalesReceipt Class)

If true, this transaction has not been completed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIsPending();
int SetIsPending(int bIsPending);

Unicode (Windows)
BOOL GetIsPending();
INT SetIsPending(BOOL bIsPending);

int inqb_salesreceipt_getispending(void* lpObj);
int inqb_salesreceipt_setispending(void* lpObj, int bIsPending);

bool GetIsPending();
int SetIsPending(bool bIsPending);

Default Value

FALSE

Remarks

If set to true, this transaction (an Invoice, SalesReceipt, or CreditMemo) has not been completed. Pending sales might include unpaid orders, sales of back-ordered items, etc.

Data Type

Boolean

IsToBePrinted Property (SalesReceipt Class)

Whether this transaction is to be printed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIsToBePrinted();
int SetIsToBePrinted(int bIsToBePrinted);

Unicode (Windows)
BOOL GetIsToBePrinted();
INT SetIsToBePrinted(BOOL bIsToBePrinted);

int inqb_salesreceipt_getistobeprinted(void* lpObj);
int inqb_salesreceipt_setistobeprinted(void* lpObj, int bIsToBePrinted);

bool GetIsToBePrinted();
int SetIsToBePrinted(bool bIsToBePrinted);

Default Value

FALSE

Remarks

Indicates whether or not the transaction is to be printed. If set to true, the "To Be Printed" box in the QuickBooks user interface will be checked.

Data Type

Boolean

LineItems Property (SalesReceipt Class)

Collection of line items.

Syntax

• C++
• C
• Qt

InQBList<InQBSalesReceiptItem>* GetLineItems();
int SetLineItems(InQBList<InQBSalesReceiptItem>* val);

int inqb_salesreceipt_getitemcount(void* lpObj);
int inqb_salesreceipt_setitemcount(void* lpObj, int iItemCount);

char* inqb_salesreceipt_getitemaggregate(void* lpObj, int itemindex);
int inqb_salesreceipt_setitemaggregate(void* lpObj, int itemindex, const char* lpszItemAggregate);

char* inqb_salesreceipt_getitemamount(void* lpObj, int itemindex);
int inqb_salesreceipt_setitemamount(void* lpObj, int itemindex, const char* lpszItemAmount);

char* inqb_salesreceipt_getitemclassid(void* lpObj, int itemindex);
int inqb_salesreceipt_setitemclassid(void* lpObj, int itemindex, const char* lpszItemClassId);

char* inqb_salesreceipt_getitemclassname(void* lpObj, int itemindex);
int inqb_salesreceipt_setitemclassname(void* lpObj, int itemindex, const char* lpszItemClassName);

char* inqb_salesreceipt_getitemdescription(void* lpObj, int itemindex);
int inqb_salesreceipt_setitemdescription(void* lpObj, int itemindex, const char* lpszItemDescription);

char* inqb_salesreceipt_getitemgroupid(void* lpObj, int itemindex);
int inqb_salesreceipt_setitemgroupid(void* lpObj, int itemindex, const char* lpszItemGroupId);

char* inqb_salesreceipt_getitemgroupname(void* lpObj, int itemindex);
int inqb_salesreceipt_setitemgroupname(void* lpObj, int itemindex, const char* lpszItemGroupName);

char* inqb_salesreceipt_getitemid(void* lpObj, int itemindex);
int inqb_salesreceipt_setitemid(void* lpObj, int itemindex, const char* lpszItemId);

char* inqb_salesreceipt_getitemname(void* lpObj, int itemindex);
int inqb_salesreceipt_setitemname(void* lpObj, int itemindex, const char* lpszItemName);

char* inqb_salesreceipt_getitemlineid(void* lpObj, int itemindex);
int inqb_salesreceipt_setitemlineid(void* lpObj, int itemindex, const char* lpszItemLineId);

char* inqb_salesreceipt_getitemother1(void* lpObj, int itemindex);
int inqb_salesreceipt_setitemother1(void* lpObj, int itemindex, const char* lpszItemOther1);

char* inqb_salesreceipt_getitemother2(void* lpObj, int itemindex);
int inqb_salesreceipt_setitemother2(void* lpObj, int itemindex, const char* lpszItemOther2);

char* inqb_salesreceipt_getitemoverrideaccountid(void* lpObj, int itemindex);
int inqb_salesreceipt_setitemoverrideaccountid(void* lpObj, int itemindex, const char* lpszItemOverrideAccountId);

char* inqb_salesreceipt_getitemoverrideaccountname(void* lpObj, int itemindex);
int inqb_salesreceipt_setitemoverrideaccountname(void* lpObj, int itemindex, const char* lpszItemOverrideAccountName);

char* inqb_salesreceipt_getitempricelevelid(void* lpObj, int itemindex);
int inqb_salesreceipt_setitempricelevelid(void* lpObj, int itemindex, const char* lpszItemPriceLevelId);

char* inqb_salesreceipt_getitempricelevelname(void* lpObj, int itemindex);
int inqb_salesreceipt_setitempricelevelname(void* lpObj, int itemindex, const char* lpszItemPriceLevelName);

char* inqb_salesreceipt_getitemquantity(void* lpObj, int itemindex);
int inqb_salesreceipt_setitemquantity(void* lpObj, int itemindex, const char* lpszItemQuantity);

char* inqb_salesreceipt_getitemrate(void* lpObj, int itemindex);
int inqb_salesreceipt_setitemrate(void* lpObj, int itemindex, const char* lpszItemRate);

char* inqb_salesreceipt_getitemratepercent(void* lpObj, int itemindex);
int inqb_salesreceipt_setitemratepercent(void* lpObj, int itemindex, const char* lpszItemRatePercent);

char* inqb_salesreceipt_getitemservicedate(void* lpObj, int itemindex);
int inqb_salesreceipt_setitemservicedate(void* lpObj, int itemindex, const char* lpszItemServiceDate);

char* inqb_salesreceipt_getitemtaxcodeid(void* lpObj, int itemindex);
int inqb_salesreceipt_setitemtaxcodeid(void* lpObj, int itemindex, const char* lpszItemTaxCodeId);

char* inqb_salesreceipt_getitemtaxcodename(void* lpObj, int itemindex);
int inqb_salesreceipt_setitemtaxcodename(void* lpObj, int itemindex, const char* lpszItemTaxCodeName);

char* inqb_salesreceipt_getitemunitofmeasure(void* lpObj, int itemindex);
int inqb_salesreceipt_setitemunitofmeasure(void* lpObj, int itemindex, const char* lpszItemUnitOfMeasure);

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

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

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

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

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

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

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

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

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

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

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

QString GetItemOther1(int iItemIndex);
int SetItemOther1(int iItemIndex, QString qsItemOther1);

QString GetItemOther2(int iItemIndex);
int SetItemOther2(int iItemIndex, QString qsItemOther2);

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

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

QString GetItemPriceLevelId(int iItemIndex);
int SetItemPriceLevelId(int iItemIndex, QString qsItemPriceLevelId);

QString GetItemPriceLevelName(int iItemIndex);
int SetItemPriceLevelName(int iItemIndex, QString qsItemPriceLevelName);

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

QString GetItemRate(int iItemIndex);
int SetItemRate(int iItemIndex, QString qsItemRate);

QString GetItemRatePercent(int iItemIndex);
int SetItemRatePercent(int iItemIndex, QString qsItemRatePercent);

QString GetItemServiceDate(int iItemIndex);
int SetItemServiceDate(int iItemIndex, QString qsItemServiceDate);

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

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

QString GetItemUnitOfMeasure(int iItemIndex);
int SetItemUnitOfMeasure(int iItemIndex, QString qsItemUnitOfMeasure);

Remarks

A Line Item is used to track any portion of a transaction that represents the purchase of an "item".

This property is not available at design time.

Data Type

InQBSalesReceiptItem

Memo Property (SalesReceipt Class)

Memo to appear on internal reports only.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMemo();
int SetMemo(const char* lpszMemo);

Unicode (Windows)
LPWSTR GetMemo();
INT SetMemo(LPCWSTR lpszMemo);

char* inqb_salesreceipt_getmemo(void* lpObj);
int inqb_salesreceipt_setmemo(void* lpObj, const char* lpszMemo);

QString GetMemo();
int SetMemo(QString qsMemo);

Default Value

""

Remarks

A memo to appear on internal reports. Will not appear to customers, vendors, etc.

Data Type

String

PaymentMethodId Property (SalesReceipt Class)

Reference to method of payment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPaymentMethodId();
int SetPaymentMethodId(const char* lpszPaymentMethodId);

Unicode (Windows)
LPWSTR GetPaymentMethodId();
INT SetPaymentMethodId(LPCWSTR lpszPaymentMethodId);

char* inqb_salesreceipt_getpaymentmethodid(void* lpObj);
int inqb_salesreceipt_setpaymentmethodid(void* lpObj, const char* lpszPaymentMethodId);

QString GetPaymentMethodId();
int SetPaymentMethodId(QString qsPaymentMethodId);

Default Value

""

Remarks

A reference to the method of payment used. For example, "Cash".

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

PaymentMethodName Property (SalesReceipt Class)

Reference to method of payment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPaymentMethodName();
int SetPaymentMethodName(const char* lpszPaymentMethodName);

Unicode (Windows)
LPWSTR GetPaymentMethodName();
INT SetPaymentMethodName(LPCWSTR lpszPaymentMethodName);

char* inqb_salesreceipt_getpaymentmethodname(void* lpObj);
int inqb_salesreceipt_setpaymentmethodname(void* lpObj, const char* lpszPaymentMethodName);

QString GetPaymentMethodName();
int SetPaymentMethodName(QString qsPaymentMethodName);

Default Value

""

Remarks

A reference to the method of payment used. For example, "Cash".

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

QBConnectionString Property (SalesReceipt Class)

An aggregate consisting of various QuickBooks connection properties.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetQBConnectionString();
int SetQBConnectionString(const char* lpszQBConnectionString);

Unicode (Windows)
LPWSTR GetQBConnectionString();
INT SetQBConnectionString(LPCWSTR lpszQBConnectionString);

char* inqb_salesreceipt_getqbconnectionstring(void* lpObj);
int inqb_salesreceipt_setqbconnectionstring(void* lpObj, const char* lpszQBConnectionString);

QString GetQBConnectionString();
int SetQBConnectionString(QString qsQBConnectionString);

Default Value

""

Remarks

QBConnectionString allows the user to customize the application's interaction with QuickBooks.

The connection properties should be formatted in a sequence as follows:

propertyname = "propertyvalue" propertyname = "propertyvalue" ...

The order is irrelevant, and the whitespace around the equal sign is optional.

The following properties are currently supported:

Data Type

String

QBRequestAggregate Property (SalesReceipt Class)

The request aggregate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetQBRequestAggregate();
int SetQBRequestAggregate(const char* lpszQBRequestAggregate);

Unicode (Windows)
LPWSTR GetQBRequestAggregate();
INT SetQBRequestAggregate(LPCWSTR lpszQBRequestAggregate);

char* inqb_salesreceipt_getqbrequestaggregate(void* lpObj);
int inqb_salesreceipt_setqbrequestaggregate(void* lpObj, const char* lpszQBRequestAggregate);

QString GetQBRequestAggregate();
int SetQBRequestAggregate(QString qsQBRequestAggregate);

Default Value

""

Remarks

This property will be populated when QBRequestMode is set to rmOffline and a method is called. This is used when working with the QBWCServer class to generate requests to be sent to QuickBooks Web Connector.

This property is not available at design time.

Data Type

String

QBRequestId Property (SalesReceipt Class)

The Id of the next message to be sent to QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetQBRequestId();
int SetQBRequestId(const char* lpszQBRequestId);

Unicode (Windows)
LPWSTR GetQBRequestId();
INT SetQBRequestId(LPCWSTR lpszQBRequestId);

char* inqb_salesreceipt_getqbrequestid(void* lpObj);
int inqb_salesreceipt_setqbrequestid(void* lpObj, const char* lpszQBRequestId);

QString GetQBRequestId();
int SetQBRequestId(QString qsQBRequestId);

Default Value

""

Remarks

The next message Id to be sent to QuickBooks. Message Id's are used by CheckRequestStatus to check on the status of previously made requests.

This property allows the user to determine whether a previous request was successfully processed by QuickBooks. Ordinarily QuickBooks either processes requests successfully or returns an error, but in the event of a power outage or other system failure, QuickBooks might or might not have time to process a request before issuing a response.

QuickBooks stores internally a list of QBRequestIds for which it has processed a request, and updated its internal state accordingly. Use of this property in conjunction with CheckRequestStatus allows the user to query this internal list.

To enable error recovery, the user application should store the value of QBRequestId before submitting a request to QuickBooks. If a system failure occurs, CheckRequestStatus should be called with this value of QBRequestId to find whether the request was processed before the system failed.

Unique values for QBRequestId will be generated on startup and after each request to QuickBooks. The automatically generated value may be overwritten by the user. Error checking may be turned off by setting QBRequestId equal to the empty string. See CheckRequestStatus for more information on error recovery.

This property is not available at design time.

Data Type

String

QBRequestMode Property (SalesReceipt Class)

Defines whether the request is made online or stored offline.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetQBRequestMode();
int SetQBRequestMode(int iQBRequestMode);

Unicode (Windows)
INT GetQBRequestMode();
INT SetQBRequestMode(INT iQBRequestMode);

RM_ONLINE(0), 
RM_OFFLINE(1)

int inqb_salesreceipt_getqbrequestmode(void* lpObj);
int inqb_salesreceipt_setqbrequestmode(void* lpObj, int iQBRequestMode);

int GetQBRequestMode();
int SetQBRequestMode(int iQBRequestMode);

Default Value

0

Remarks

This property defines the behavior of the class when calling a method. Possible values are:

For normal communication to QuickBooks either directly or through the QBConnector application use the default online mode.

Data Type

Integer

QBResponseAggregate Property (SalesReceipt Class)

The last QBXML response aggregate received from QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetQBResponseAggregate();
int SetQBResponseAggregate(const char* lpszQBResponseAggregate);

Unicode (Windows)
LPWSTR GetQBResponseAggregate();
INT SetQBResponseAggregate(LPCWSTR lpszQBResponseAggregate);

char* inqb_salesreceipt_getqbresponseaggregate(void* lpObj);
int inqb_salesreceipt_setqbresponseaggregate(void* lpObj, const char* lpszQBResponseAggregate);

QString GetQBResponseAggregate();
int SetQBResponseAggregate(QString qsQBResponseAggregate);

Default Value

""

Remarks

The last QBXML response aggregate received from QuickBooks. This property is set whenever a response is received from QuickBooks.

This property may also be set to a response aggregate. When set to a QBXML aggregate, such as a response from ObjSearch or QBWCServer the class will parse the response as if it had been received directly from QuickBooks and the applicable properties will be updated.

This property is not available at design time.

Data Type

String

QBXMLVersion Property (SalesReceipt Class)

The version of QBXML used in the outgoing message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetQBXMLVersion();
int SetQBXMLVersion(const char* lpszQBXMLVersion);

Unicode (Windows)
LPWSTR GetQBXMLVersion();
INT SetQBXMLVersion(LPCWSTR lpszQBXMLVersion);

char* inqb_salesreceipt_getqbxmlversion(void* lpObj);
int inqb_salesreceipt_setqbxmlversion(void* lpObj, const char* lpszQBXMLVersion);

QString GetQBXMLVersion();
int SetQBXMLVersion(QString qsQBXMLVersion);

Default Value

"3.0"

Remarks

The version of QBXML used in the outgoing message. Except as noted in the documentation, a value of "1.1" will suffice for all requests, and for all versions of QuickBooks which support integrated applications.

With each release of QuickBooks since 2002, a corresponding version of the QuickBooks SDK has also been released: 1.0 for QuickBooks 2002, 2.0 for QuickBooks 2003, 3.0 for QuickBooks 2004, etc., up to 8.0 for QuickBooks 2009. In addition, each release of QuickBooks continues to support all earlier versions of the SDK, meaning that requests using version 1.1 of the QuickBooks SDK are supported by all versions of QuickBooks. However, new requests and newer fields in existing requests are only supported in later versions of the QuickBooks SDK. As such, it is recommended that you set the QBXMLVersion property to correspond to the version of QuickBooks you are interacting with. These values are:

This property is not available at design time.

Data Type

String

RefId Property (SalesReceipt Class)

An alphanumerical identifier generated by the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRefId();

Unicode (Windows)
LPWSTR GetRefId();

char* inqb_salesreceipt_getrefid(void* lpObj);

QString GetRefId();

Default Value

""

Remarks

An Id is an alphanumerical identifier assigned by the server whenever an object is added to QuickBooks. It is guaranteed to be unique across all objects of the same type.

This property is read-only and not available at design time.

Data Type

String

RefNumber Property (SalesReceipt Class)

Reference number for the transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRefNumber();
int SetRefNumber(const char* lpszRefNumber);

Unicode (Windows)
LPWSTR GetRefNumber();
INT SetRefNumber(LPCWSTR lpszRefNumber);

char* inqb_salesreceipt_getrefnumber(void* lpObj);
int inqb_salesreceipt_setrefnumber(void* lpObj, const char* lpszRefNumber);

QString GetRefNumber();
int SetRefNumber(QString qsRefNumber);

Default Value

""

Remarks

This is the reference number assigned to a transaction. Depending on the type of transaction, it appears in the QuickBooks user interface as Bill Number, Invoice Number, etc.

Reference numbers are alphanumeric strings and are not limited to actually being numbers.

For some types of transactions, if RefNumber is not assigned, QuickBooks will automatically assign a unique one. Reference numbers should generally be unique, but are not guaranteed to be so. It is recommended that applications generating their own reference numbers take steps to ensure their uniqueness.

Data Type

String

SalesRepId Property (SalesReceipt Class)

Reference to (initials of) sales rep.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSalesRepId();
int SetSalesRepId(const char* lpszSalesRepId);

Unicode (Windows)
LPWSTR GetSalesRepId();
INT SetSalesRepId(LPCWSTR lpszSalesRepId);

char* inqb_salesreceipt_getsalesrepid(void* lpObj);
int inqb_salesreceipt_setsalesrepid(void* lpObj, const char* lpszSalesRepId);

QString GetSalesRepId();
int SetSalesRepId(QString qsSalesRepId);

Default Value

""

Remarks

A reference to a sales rep for the Customer. Sales reps should be referred to by their initials rather than their name.

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.

This property appears in the Customer class as well as some transaction classs. When found in a Customer class this property is unsupported for Update operations.

Data Type

String

SalesRepName Property (SalesReceipt Class)

Reference to (initials of) sales rep.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSalesRepName();
int SetSalesRepName(const char* lpszSalesRepName);

Unicode (Windows)
LPWSTR GetSalesRepName();
INT SetSalesRepName(LPCWSTR lpszSalesRepName);

char* inqb_salesreceipt_getsalesrepname(void* lpObj);
int inqb_salesreceipt_setsalesrepname(void* lpObj, const char* lpszSalesRepName);

QString GetSalesRepName();
int SetSalesRepName(QString qsSalesRepName);

Default Value

""

Remarks

A reference to a sales rep for the Customer. Sales reps should be referred to by their initials rather than their name.

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.

This property appears in the Customer class as well as some transaction classs. When found in a Customer class this property is unsupported for Update operations.

Data Type

String

SalesTaxTotal Property (SalesReceipt Class)

Total amount of sales tax.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSalesTaxTotal();

Unicode (Windows)
LPWSTR GetSalesTaxTotal();

char* inqb_salesreceipt_getsalestaxtotal(void* lpObj);

QString GetSalesTaxTotal();

Default Value

""

Remarks

The total amount of sales tax charged in this transaction.

Not used with Canadian editions of QuickBooks.

The amount should be formatted as a string in dollars.

This property is read-only.

Data Type

String

ShipDate Property (SalesReceipt Class)

Date of shipping.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetShipDate();
int SetShipDate(const char* lpszShipDate);

Unicode (Windows)
LPWSTR GetShipDate();
INT SetShipDate(LPCWSTR lpszShipDate);

char* inqb_salesreceipt_getshipdate(void* lpObj);
int inqb_salesreceipt_setshipdate(void* lpObj, const char* lpszShipDate);

QString GetShipDate();
int SetShipDate(QString qsShipDate);

Default Value

""

Remarks

The date when goods were, or will be, shipped to the Customer.

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

ShipMethodId Property (SalesReceipt Class)

Reference to preferred method of shipping.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetShipMethodId();
int SetShipMethodId(const char* lpszShipMethodId);

Unicode (Windows)
LPWSTR GetShipMethodId();
INT SetShipMethodId(LPCWSTR lpszShipMethodId);

char* inqb_salesreceipt_getshipmethodid(void* lpObj);
int inqb_salesreceipt_setshipmethodid(void* lpObj, const char* lpszShipMethodId);

QString GetShipMethodId();
int SetShipMethodId(QString qsShipMethodId);

Default Value

""

Remarks

Reference to the preferred method of shipping, e.g., UPS.

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

ShipMethodName Property (SalesReceipt Class)

Reference to preferred method of shipping.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetShipMethodName();
int SetShipMethodName(const char* lpszShipMethodName);

Unicode (Windows)
LPWSTR GetShipMethodName();
INT SetShipMethodName(LPCWSTR lpszShipMethodName);

char* inqb_salesreceipt_getshipmethodname(void* lpObj);
int inqb_salesreceipt_setshipmethodname(void* lpObj, const char* lpszShipMethodName);

QString GetShipMethodName();
int SetShipMethodName(QString qsShipMethodName);

Default Value

""

Remarks

Reference to the preferred method of shipping, e.g., UPS.

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

ShippingAddress Property (SalesReceipt Class)

Address to ship to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetShippingAddress();
int SetShippingAddress(const char* lpszShippingAddress);

Unicode (Windows)
LPWSTR GetShippingAddress();
INT SetShippingAddress(LPCWSTR lpszShippingAddress);

char* inqb_salesreceipt_getshippingaddress(void* lpObj);
int inqb_salesreceipt_setshippingaddress(void* lpObj, const char* lpszShippingAddress);

QString GetShippingAddress();
int SetShippingAddress(QString qsShippingAddress);

Default Value

""

Remarks

The address to whom goods were shipped, or are to be shipped.

The address is stored as a string, formatted as XML. It may be read and written directly, or with the Address component.

To read an address, set the Aggregate property of an Address class to this value, and read the values of the desired fields. To write an address, write the values of the desired Address fields and set this property to the Address's Aggregate.

To read and/or write directly, use the QBXML formatting: <Addr1>Line1</Addr1><Addr2>Line2</Addr2><Addr3>Line3</Addr3> <City>City</City><State>State</State><PostalCode>PostalCode</PostalCode> <Country>Country</Country>

Data Type

String

Subtotal Property (SalesReceipt Class)

Gross subtotal; doesn't count taxes/amount already paid.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSubtotal();

Unicode (Windows)
LPWSTR GetSubtotal();

char* inqb_salesreceipt_getsubtotal(void* lpObj);

QString GetSubtotal();

Default Value

""

Remarks

The total of the amounts in all the lines of an invoice, credit memo, or sales receipt, before taxes or payments are applied.

The amount should be formatted as a string in dollars.

This property is read-only.

Data Type

String

TaxItemId Property (SalesReceipt Class)

Reference to detailed taxation information.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTaxItemId();
int SetTaxItemId(const char* lpszTaxItemId);

Unicode (Windows)
LPWSTR GetTaxItemId();
INT SetTaxItemId(LPCWSTR lpszTaxItemId);

char* inqb_salesreceipt_gettaxitemid(void* lpObj);
int inqb_salesreceipt_settaxitemid(void* lpObj, const char* lpszTaxItemId);

QString GetTaxItemId();
int SetTaxItemId(QString qsTaxItemId);

Default Value

""

Remarks

A sales tax item refers to a single sales tax that is collected at a specified rate and paid to a single agency. For example, a TaxItem might represent sales tax for a particular city.

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.

This property appears in the Customer class as well as some transaction classs. When found in a Customer class this property is unsupported for Update operations.

Not used with Canadian editions of QuickBooks.

Data Type

String

TaxItemName Property (SalesReceipt Class)

Reference to detailed taxation information.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTaxItemName();
int SetTaxItemName(const char* lpszTaxItemName);

Unicode (Windows)
LPWSTR GetTaxItemName();
INT SetTaxItemName(LPCWSTR lpszTaxItemName);

char* inqb_salesreceipt_gettaxitemname(void* lpObj);
int inqb_salesreceipt_settaxitemname(void* lpObj, const char* lpszTaxItemName);

QString GetTaxItemName();
int SetTaxItemName(QString qsTaxItemName);

Default Value

""

Remarks

A sales tax item refers to a single sales tax that is collected at a specified rate and paid to a single agency. For example, a TaxItem might represent sales tax for a particular city.

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.

This property appears in the Customer class as well as some transaction classs. When found in a Customer class this property is unsupported for Update operations.

Data Type

String

TotalAmount Property (SalesReceipt Class)

Subtotal + SalesTaxTotal.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTotalAmount();

Unicode (Windows)
LPWSTR GetTotalAmount();

char* inqb_salesreceipt_gettotalamount(void* lpObj);

QString GetTotalAmount();

Default Value

""

Remarks

The total amount of the CreditMemo or SalesReceipt. Will be equal to Subtotal + SalesTaxTotal.

The amount should be formatted as a string in dollars.

This property is read-only.

Data Type

String

TransactionDate Property (SalesReceipt Class)

Date of transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTransactionDate();
int SetTransactionDate(const char* lpszTransactionDate);

Unicode (Windows)
LPWSTR GetTransactionDate();
INT SetTransactionDate(LPCWSTR lpszTransactionDate);

char* inqb_salesreceipt_gettransactiondate(void* lpObj);
int inqb_salesreceipt_settransactiondate(void* lpObj, const char* lpszTransactionDate);

QString GetTransactionDate();
int SetTransactionDate(QString qsTransactionDate);

Default Value

""

Remarks

The date of the transaction.

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.

This property is required in Accounts Payable (Bill and VendorCredit) transactions. In other kinds of transactions this property is optional.

Data Type

String

Add Method (SalesReceipt Class)

Adds the record into QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Add();

Unicode (Windows)
INT Add();

int inqb_salesreceipt_add(void* lpObj);

int Add();

Remarks

Add is used to add the object to QuickBooks.

If QuickBooks is able to add the object, it will return a copy of the object, and the values of all properties will be reset from the QuickBooks response. The QBResponseAggregate property will also be set to the entire QBXML aggregate received from QuickBooks.

For example, read-only properties such as RefIds will be assigned. In transaction objects, line item information will be filled out, and ItemGroups will be broken up into their respective Items. Also, a total will be calculated.

If QuickBooks is not able to add the object, a trappable error will occur.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Cancel Method (SalesReceipt Class)

Cancels (voids) the transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Cancel();

Unicode (Windows)
INT Cancel();

int inqb_salesreceipt_cancel(void* lpObj);

int Cancel();

Remarks

Cancel causes the transaction to be voided in QuickBooks. The amount of the transaction and all line item quantities are changed to zero, and the memo is changed to "VOID:". The transaction will not, however, be deleted.

The transaction canceled in QuickBooks is the one specified by RefId. If the value of RefId is known then Get should first be called to retrieve the transaction. Otherwise the ObjSearch class should be used to search for the desired transaction in the QuickBooks database.

As the QuickBooks response to Cancel does not include the updated transaction, the values of all properties are instead set to their defaults. To get a copy of the updated transaction, the value of RefId should first be stored, and then Get should be called.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

CheckRequestStatus Method (SalesReceipt Class)

Checks whether or not the specified request was processed by QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* CheckRequestStatus(const char* lpszRequestId);

Unicode (Windows)
LPWSTR CheckRequestStatus(LPCWSTR lpszRequestId);

char* inqb_salesreceipt_checkrequeststatus(void* lpObj, const char* lpszRequestId);

QString CheckRequestStatus(const QString& qsRequestId);

Remarks

This method allows the user to determine whether a previous request was successfully processed by QuickBooks. Ordinarily QuickBooks either processes requests successfully or returns an error, but in the event of a power outage or other system failure, QuickBooks might or might not have time to process a request before issuing a response.

QuickBooks stores internally a list of QBRequestIds for which it has processed a request, and updated its internal state accordingly. Use of this method allows the user to query the list for any RequestId whose value is known.

The method returns a string corresponding to the result of the query. If the request was processed successfully, an empty string ("") will be returned. If the request was not processed, the string "Request not processed." will be returned. If the request was processed but an error occurred, a string containing the error code and a description will be returned; for example, "801: A QuickBooks internal error has occurred."

See QBRequestId for more information on error recovery.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

CloseQBConnection Method (SalesReceipt Class)

Closes a persistent connection to QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CloseQBConnection();

Unicode (Windows)
INT CloseQBConnection();

int inqb_salesreceipt_closeqbconnection(void* lpObj);

int CloseQBConnection();

Remarks

Invoking CloseQBConnection closes the QuickBooks connection specified in QBConnectionString. After the connection has been closed, the class will revert to its default behavior, and a new connection will be established for each request until QBConnectionString is invoked again.

In case the connection is already closed invoking CloseQBConnection will have no effect. Moreover, if multiple connections are open CloseQBConnection will only close the connection specified in QBConnectionString.

Be sure to always invoke this method after calling OpenQBConnection.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (SalesReceipt Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* inqb_salesreceipt_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Delete Method (SalesReceipt Class)

Deletes the record from QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Delete();

Unicode (Windows)
INT Delete();

int inqb_salesreceipt_delete(void* lpObj);

int Delete();

Remarks

Delete causes the object to be deleted in QuickBooks. After this method is called, the values of all fields will be reset to their defaults.

The object deleted in QuickBooks is the one specified by RefId. This read-only property may be assigned either by calling Get or by assigning the value of QBResponseAggregate.

A typical example: Customer.GetByName("John Smith") 'this will assign the RefId Customer.Delete() Deleting entity objects (Customer, Employee, and Vendor) requires that QuickBooks be open in single-user mode. Transaction objects, however, may be deleted while QuickBooks is in any mode.

Use this method with caution, as there is no way to recover deleted objects.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Get Method (SalesReceipt Class)

Gets a single record from QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Get(const char* lpszId);

Unicode (Windows)
INT Get(LPCWSTR lpszId);

int inqb_salesreceipt_get(void* lpObj, const char* lpszId);

int Get(const QString& qsId);

Remarks

Get may be used to retrieve a single object from QuickBooks, based on its RefId. When the method is called, a search will be initiated for the requested object. If it is found, all properties of the class will be set to the information retrieved from QuickBooks. The QBResponseAggregate property will also be set to the entire QBXML aggregate received from QuickBooks.

The RefId of any class, or the Id of any reference property, may be used for the parameter. So for example, the following pseudocode would get customer information for a Customer listed on an Invoice:

Customer.Get( Invoice.CustomerId )

The GetByName method, present only in entity objects (Customer, Vendor, and Employee) and QBObject, may be used to get an object based on its Name. To retrieve multiple objects, to retrieve transaction objects whose RefId is not known, or to perform more advanced searches the ObjSearch class may be used.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

GetCustomField Method (SalesReceipt Class)

Gets a custom field value from QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomField(const char* lpszFieldName);

Unicode (Windows)
LPWSTR GetCustomField(LPCWSTR lpszFieldName);

char* inqb_salesreceipt_getcustomfield(void* lpObj, const char* lpszFieldName);

QString GetCustomField(const QString& qsFieldName);

Remarks

This method will get the value of a custom field, which has been defined by the user from within the QuickBooks UI.

To read the values of custom fields, be sure to set QBXMLVersion to at least "2.0" when retrieving data from QuickBooks. Then, QuickBooks will return custom field information, and it will be accessible through this method.

You may also invoke Config to read the value of custom fields. However, to set the value of custom fields you must set QBXMLVersion to at least "3.0" and invoke SetCustomField.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

ImportQBXML Method (SalesReceipt Class)

Imports a QBXML response aggregate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ImportQBXML(const char* lpszXMLData);

Unicode (Windows)
INT ImportQBXML(LPCWSTR lpszXMLData);

int inqb_salesreceipt_importqbxml(void* lpObj, const char* lpszXMLData);

int ImportQBXML(const QString& qsXMLData);

Remarks

This method imports a QBXML response aggregate. When called with a QBXML aggregate, such as a response from ObjSearch or QBWCServer the class will parse the response as if it had been received directly from QuickBooks and the applicable properties will be updated.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

OpenQBConnection Method (SalesReceipt Class)

Opens a persistent connection to QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int OpenQBConnection();

Unicode (Windows)
INT OpenQBConnection();

int inqb_salesreceipt_openqbconnection(void* lpObj);

int OpenQBConnection();

Remarks

Invoking OpenQBConnection will open a persistent connection to QuickBooks. After invoking OpenQBConnection, all requests such as Get, Add, etc. will use the established connection until CloseQBConnection is invoked.

The effect of OpenQBConnection is to increase performance. If OpenQBConnection is not invoked, a connection to QuickBooks will automatically be created and destroyed each time the class communicates with QuickBooks. Using OpenQBConnection will be faster, particularly in the case of automatic login.

After OpenQBConnection is invoked, QuickBooks will issue a connection ticket, and it will be stored in QBConnectionString. When CloseQBConnection is invoked the ticket will be invalidated, and any further attempts to use it will fail.

Be sure to invoke CloseQBConnection when you have finished communicating with QuickBooks. Leaving an open QuickBooks connection may lock out other integrated applications, affect QuickBooks performance, or cause other problems.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (SalesReceipt Class)

Resets all properties to their defaults.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int inqb_salesreceipt_reset(void* lpObj);

int Reset();

Remarks

This method resets the values of all properties (and all special fields) to their defaults.

After calling this method, the class may be reused as if it were newly created.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetCustomField Method (SalesReceipt Class)

Sets a custom field value within QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetCustomField(const char* lpszFieldName, const char* lpszFieldValue);

Unicode (Windows)
INT SetCustomField(LPCWSTR lpszFieldName, LPCWSTR lpszFieldValue);

int inqb_salesreceipt_setcustomfield(void* lpObj, const char* lpszFieldName, const char* lpszFieldValue);

int SetCustomField(const QString& qsFieldName, const QString& qsFieldValue);

Remarks

This method requires QuickBooks 2004 or above, with QBXMLVersion set to at least "3.0".

This method will immediately set the value of a QuickBooks custom field, which has been defined by the user from within the QuickBooks UI. Before calling this method, the preceding operation must retrieve the object from QuickBooks, using Get, ObjSearch, etc. Then, you may use SetCustomField to set custom field values (the fields will be modified or added, as appropriate).

Note that invoking this method will create a connection to QuickBooks if one is not already in place.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Update Method (SalesReceipt Class)

Updates the sales order in QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Update();

Unicode (Windows)
INT Update();

int inqb_salesreceipt_update(void* lpObj);

int Update();

Remarks

This method will update the sales order in QuickBooks.

When the method is called, an Update request will be submitted to QuickBooks. The sales order will have its information updated based on the various property values.

If QuickBooks is able to update the object, it will return a copy of the object, and the values of all properties will be reset from the QuickBooks response. The QBResponseAggregate property will also be set to the entire QBXML aggregate received from QuickBooks.

QBXMLVersion must be set to "3.0" or greater to update a sales order. Moreover, QBXMLVersion should be set to the same value when retrieving the sales order from QuickBooks (either through ObjSearch or through the Get method).

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Error Event (SalesReceipt Class)

Information about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(SalesReceiptErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} SalesReceiptErrorEventParams;


Unicode (Windows)
virtual INT FireError(SalesReceiptErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} SalesReceiptErrorEventParams;

#define EID_SALESRECEIPT_ERROR 1

virtual INT INQB_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class SalesReceiptErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(SalesReceiptErrorEventParams *e);

// Or, subclass SalesReceipt and override this emitter function.
virtual int FireError(SalesReceiptErrorEventParams *e) {...}

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.

SSLServerAuthentication Event (SalesReceipt Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(SalesReceiptSSLServerAuthenticationEventParams *e);

typedef struct {
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} SalesReceiptSSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(SalesReceiptSSLServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} SalesReceiptSSLServerAuthenticationEventParams;

#define EID_SALESRECEIPT_SSLSERVERAUTHENTICATION 2

virtual INT INQB_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class SalesReceiptSSLServerAuthenticationEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLServerAuthentication(SalesReceiptSSLServerAuthenticationEventParams *e);

// Or, subclass SalesReceipt and override this emitter function.
virtual int FireSSLServerAuthentication(SalesReceiptSSLServerAuthenticationEventParams *e) {...}

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (SalesReceipt Class)

Fired when secure connection progress messages are available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLStatus(SalesReceiptSSLStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} SalesReceiptSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(SalesReceiptSSLStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} SalesReceiptSSLStatusEventParams;

#define EID_SALESRECEIPT_SSLSTATUS 3

virtual INT INQB_CALL FireSSLStatus(LPSTR &lpszMessage);

class SalesReceiptSSLStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLStatus(SalesReceiptSSLStatusEventParams *e);

// Or, subclass SalesReceipt and override this emitter function.
virtual int FireSSLStatus(SalesReceiptSSLStatusEventParams *e) {...}

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

Status Event (SalesReceipt Class)

Shows the progress of the QuickBooks connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireStatus(SalesReceiptStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} SalesReceiptStatusEventParams;


Unicode (Windows)
virtual INT FireStatus(SalesReceiptStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} SalesReceiptStatusEventParams;

#define EID_SALESRECEIPT_STATUS 4

virtual INT INQB_CALL FireStatus(LPSTR &lpszMessage);

class SalesReceiptStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Status(SalesReceiptStatusEventParams *e);

// Or, subclass SalesReceipt and override this emitter function.
virtual int FireStatus(SalesReceiptStatusEventParams *e) {...}

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

Warning Event (SalesReceipt Class)

Fired when a warning occurs.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireWarning(SalesReceiptWarningEventParams *e);

typedef struct {
  int Code;
  const char *Description;
  int reserved;
} SalesReceiptWarningEventParams;


Unicode (Windows)
virtual INT FireWarning(SalesReceiptWarningEventParams *e);

typedef struct {
  INT Code;
  LPCWSTR Description;
  INT reserved;
} SalesReceiptWarningEventParams;

#define EID_SALESRECEIPT_WARNING 5

virtual INT INQB_CALL FireWarning(INT &iCode, LPSTR &lpszDescription);

class SalesReceiptWarningEventParams {
public:
  int Code();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Warning(SalesReceiptWarningEventParams *e);

// Or, subclass SalesReceipt and override this emitter function.
virtual int FireWarning(SalesReceiptWarningEventParams *e) {...}

Remarks

The Warning event is fired when the class has produced, or will produce, possibly unexpected results.

Warnings may be generated by QuickBooks or the class. Starred warning codes correspond to warnings and warning codes generated by QuickBooks.

Warning 801 will be thrown if the user attempts to Update properties that cannot be updated. For example, the following code will cause this warning to be fired: Customer1.GetByName("Joe Smith") Customer1.Email = "joe@abc.com" 'ok Customer1.CreditLimit = "200.00" 'Not used in Update operations! Customer1.Update() Only the email address will be updated, and the credit limit will be unchanged. Each property description for entity objects lists whether or not it is used in Update operations.

SalesReceiptItem Type

A single sales receipt line item.

Syntax

InQBSalesReceiptItem (declared in inqb.h)

Remarks

This type of line item is used by the SalesReceipt class.

• Aggregate
• Amount
• ClassId
• ClassName
• Description
• GroupId
• GroupName
• ItemId
• ItemName
• LineId
• Other1
• Other2
• OverrideAccountId
• OverrideAccountName
• PriceLevelId
• PriceLevelName
• Quantity
• Rate
• RatePercent
• ServiceDate
• TaxCodeId
• TaxCodeName
• UnitOfMeasure

Fields

Constructors

SalesReceiptItem()

InQBList Type

Syntax

InQBList<T> (declared in inqb.h)

Remarks

InQBList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the SalesReceipt class.

int GetCount() {}

int SetCount(int count) {}

T* Get(int index) {}

T* Set(int index, T* value) {}

Config Settings (SalesReceipt Class)

SalesReceipt Config Settings

Base Config Settings

Trappable Errors (SalesReceipt Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

The following errors may be generated by the class. Note that frequently the error message will contain more specific information than what is listed here.

SalesReceipt Errors