JournalEntry Class

Properties   Methods   Events   Config Settings   Errors  

A JournalEntry represents a general journal entry made directly in the company's chart of accounts.

Syntax

JournalEntry

Remarks

A JournalEntry represents a general journal entry made directly in the company's chart of accounts.

A journal entry must include one or more JournalLines. To set credit or debit lines, first set the appropriate value of LineCount. Then for each line, set an Account (Name or Id) and an Amount. You may set Entity to associate a customer or vendor with the line, and Class and Memo may be set as well.

Before adding the journal entry to QuickBooks, the transaction must be in balance: The total amount of the credit lines must be equal to the total amount of the debit lines. If the transaction is not in balance, QuickBooks will return an error.

If desired, you may set a RefNumber and TransactionDate for the journal entry as well.

Required Fields (Add):JournalLines

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

Example JournalEntry1.RefNumber = "123" JournalEntry1.TransactionDate = "2013-12-16" JournalEntry1.JournalLineCount = 2 JournalEntry1.JournalLineType(0) = jltCredit JournalEntry1.JournalLineAccountName(0) = "Trucks:Depreciation" '* JournalEntry1.JournalLineEntityName(0) = "Annual Depreciation" '* JournalEntry1.JournalLineAmount(0) = "3000.00" JournalEntry1.JournalLineType(1) = jltDebit JournalEntry1.JournalLineAccountName(1) = "Depreciation Expense" '* JournalEntry1.JournalLineAmount(1) = "3000.00" JournalEntry1.Add() '*: Item must already exist in QuickBooks.

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 journal entries, respectively. The ObjSearch Class may be used to search for JournalEntry records 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.

Adjustment Property (JournalEntry Class)

Indicates whether this Journal Entry is an adjustment or not.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAdjustment();
int SetAdjustment(int iAdjustment);

Unicode (Windows)
INT GetAdjustment();
INT SetAdjustment(INT iAdjustment);

JEA_NOT_SET(0), 
JEA_IS_ADJUSTMENT(1), 
JEA_IS_NOT_ADJUSTMENT(2)

int inqb_journalentry_getadjustment(void* lpObj);
int inqb_journalentry_setadjustment(void* lpObj, int iAdjustment);

int GetAdjustment();
int SetAdjustment(int iAdjustment);

Default Value

0

Remarks

When a change is an "adjustment," the original information is retained, usually so an accountant can see the effects of the adjustment. The use of this property requires QBXMLVersion to be 3.0 or greater.

Data Type

Integer

JournalLines Property (JournalEntry Class)

Specifies a collection of credit or debit transactions inside a General Journal Entry.

Syntax

• C++
• C
• Qt

InQBList<InQBJournalLine>* GetJournalLines();
int SetJournalLines(InQBList<InQBJournalLine>* val);

int inqb_journalentry_getjournallinecount(void* lpObj);
int inqb_journalentry_setjournallinecount(void* lpObj, int iJournalLineCount);

char* inqb_journalentry_getjournallineaccountid(void* lpObj, int journallineindex);
int inqb_journalentry_setjournallineaccountid(void* lpObj, int journallineindex, const char* lpszJournalLineAccountId);

char* inqb_journalentry_getjournallineaccountname(void* lpObj, int journallineindex);
int inqb_journalentry_setjournallineaccountname(void* lpObj, int journallineindex, const char* lpszJournalLineAccountName);

char* inqb_journalentry_getjournallineamount(void* lpObj, int journallineindex);
int inqb_journalentry_setjournallineamount(void* lpObj, int journallineindex, const char* lpszJournalLineAmount);

int inqb_journalentry_getjournallinebillablestatus(void* lpObj, int journallineindex);
int inqb_journalentry_setjournallinebillablestatus(void* lpObj, int journallineindex, int iJournalLineBillableStatus);

char* inqb_journalentry_getjournallineclassid(void* lpObj, int journallineindex);
int inqb_journalentry_setjournallineclassid(void* lpObj, int journallineindex, const char* lpszJournalLineClassId);

char* inqb_journalentry_getjournallineclassname(void* lpObj, int journallineindex);
int inqb_journalentry_setjournallineclassname(void* lpObj, int journallineindex, const char* lpszJournalLineClassName);

char* inqb_journalentry_getjournallineentityid(void* lpObj, int journallineindex);
int inqb_journalentry_setjournallineentityid(void* lpObj, int journallineindex, const char* lpszJournalLineEntityId);

char* inqb_journalentry_getjournallineentityname(void* lpObj, int journallineindex);
int inqb_journalentry_setjournallineentityname(void* lpObj, int journallineindex, const char* lpszJournalLineEntityName);

char* inqb_journalentry_getjournallinelineid(void* lpObj, int journallineindex);
int inqb_journalentry_setjournallinelineid(void* lpObj, int journallineindex, const char* lpszJournalLineLineId);

int inqb_journalentry_getjournallinetype(void* lpObj, int journallineindex);
int inqb_journalentry_setjournallinetype(void* lpObj, int journallineindex, int iJournalLineType);

char* inqb_journalentry_getjournallinememo(void* lpObj, int journallineindex);
int inqb_journalentry_setjournallinememo(void* lpObj, int journallineindex, const char* lpszJournalLineMemo);

char* inqb_journalentry_getjournallinetaxitemid(void* lpObj, int journallineindex);
int inqb_journalentry_setjournallinetaxitemid(void* lpObj, int journallineindex, const char* lpszJournalLineTaxItemId);

char* inqb_journalentry_getjournallinetaxitemname(void* lpObj, int journallineindex);
int inqb_journalentry_setjournallinetaxitemname(void* lpObj, int journallineindex, const char* lpszJournalLineTaxItemName);

int GetJournalLineCount();
int SetJournalLineCount(int iJournalLineCount);

QString GetJournalLineAccountId(int iJournalLineIndex);
int SetJournalLineAccountId(int iJournalLineIndex, QString qsJournalLineAccountId);

QString GetJournalLineAccountName(int iJournalLineIndex);
int SetJournalLineAccountName(int iJournalLineIndex, QString qsJournalLineAccountName);

QString GetJournalLineAmount(int iJournalLineIndex);
int SetJournalLineAmount(int iJournalLineIndex, QString qsJournalLineAmount);

int GetJournalLineBillableStatus(int iJournalLineIndex);
int SetJournalLineBillableStatus(int iJournalLineIndex, int iJournalLineBillableStatus);

QString GetJournalLineClassId(int iJournalLineIndex);
int SetJournalLineClassId(int iJournalLineIndex, QString qsJournalLineClassId);

QString GetJournalLineClassName(int iJournalLineIndex);
int SetJournalLineClassName(int iJournalLineIndex, QString qsJournalLineClassName);

QString GetJournalLineEntityId(int iJournalLineIndex);
int SetJournalLineEntityId(int iJournalLineIndex, QString qsJournalLineEntityId);

QString GetJournalLineEntityName(int iJournalLineIndex);
int SetJournalLineEntityName(int iJournalLineIndex, QString qsJournalLineEntityName);

QString GetJournalLineLineId(int iJournalLineIndex);
int SetJournalLineLineId(int iJournalLineIndex, QString qsJournalLineLineId);

int GetJournalLineType(int iJournalLineIndex);
int SetJournalLineType(int iJournalLineIndex, int iJournalLineType);

QString GetJournalLineMemo(int iJournalLineIndex);
int SetJournalLineMemo(int iJournalLineIndex, QString qsJournalLineMemo);

QString GetJournalLineTaxItemId(int iJournalLineIndex);
int SetJournalLineTaxItemId(int iJournalLineIndex, QString qsJournalLineTaxItemId);

QString GetJournalLineTaxItemName(int iJournalLineIndex);
int SetJournalLineTaxItemName(int iJournalLineIndex, QString qsJournalLineTaxItemName);

Remarks

JournalLines represents a collection of Debit and Credit lines. All Debit and Credit lines must be in balance. The total Amount for all Debit lines must match the total Amount for all Debit lines, or QuickBooks will return an error.

Note: If no amount is included in the first credit or debit line of a journal entry in the QuickBooks user interface, then subsequent SDK queries on that JournalEntry object will fail XML validation.

This property is not available at design time.

Data Type

InQBJournalLine

QBConnectionString Property (JournalEntry 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_journalentry_getqbconnectionstring(void* lpObj);
int inqb_journalentry_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 (JournalEntry 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_journalentry_getqbrequestaggregate(void* lpObj);
int inqb_journalentry_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 (JournalEntry 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_journalentry_getqbrequestid(void* lpObj);
int inqb_journalentry_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 (JournalEntry 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_journalentry_getqbrequestmode(void* lpObj);
int inqb_journalentry_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 (JournalEntry 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_journalentry_getqbresponseaggregate(void* lpObj);
int inqb_journalentry_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 (JournalEntry 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_journalentry_getqbxmlversion(void* lpObj);
int inqb_journalentry_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 (JournalEntry Class)

An alphanumerical identifier generated by the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRefId();

Unicode (Windows)
LPWSTR GetRefId();

char* inqb_journalentry_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 (JournalEntry 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_journalentry_getrefnumber(void* lpObj);
int inqb_journalentry_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

TransactionDate Property (JournalEntry 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_journalentry_gettransactiondate(void* lpObj);
int inqb_journalentry_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 unless QBXMLVersion is at least "2.0" (in which case QuickBooks will assign a default).

Data Type

String

Add Method (JournalEntry Class)

Adds the record into QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Add();

Unicode (Windows)
INT Add();

int inqb_journalentry_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 (JournalEntry Class)

Cancels (voids) the transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Cancel();

Unicode (Windows)
INT Cancel();

int inqb_journalentry_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 (JournalEntry 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_journalentry_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 (JournalEntry Class)

Closes a persistent connection to QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CloseQBConnection();

Unicode (Windows)
INT CloseQBConnection();

int inqb_journalentry_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 (JournalEntry 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_journalentry_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 (JournalEntry Class)

Deletes the record from QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Delete();

Unicode (Windows)
INT Delete();

int inqb_journalentry_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 (JournalEntry 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_journalentry_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 (JournalEntry 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_journalentry_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 (JournalEntry 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_journalentry_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 (JournalEntry Class)

Opens a persistent connection to QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int OpenQBConnection();

Unicode (Windows)
INT OpenQBConnection();

int inqb_journalentry_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 (JournalEntry Class)

Resets all properties to their defaults.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int inqb_journalentry_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 (JournalEntry 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_journalentry_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 (JournalEntry Class)

Updates the sales order in QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Update();

Unicode (Windows)
INT Update();

int inqb_journalentry_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 (JournalEntry Class)

Information about errors during data delivery.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_JOURNALENTRY_ERROR 1

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

class JournalEntryErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

// Or, subclass JournalEntry and override this emitter function.
virtual int FireError(JournalEntryErrorEventParams *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 (JournalEntry Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_JOURNALENTRY_SSLSERVERAUTHENTICATION 2

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

class JournalEntrySSLServerAuthenticationEventParams {
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(JournalEntrySSLServerAuthenticationEventParams *e);

// Or, subclass JournalEntry and override this emitter function.
virtual int FireSSLServerAuthentication(JournalEntrySSLServerAuthenticationEventParams *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 (JournalEntry Class)

Fired when secure connection progress messages are available.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_JOURNALENTRY_SSLSTATUS 3

virtual INT INQB_CALL FireSSLStatus(LPSTR &lpszMessage);

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

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

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

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

Remarks

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

Status Event (JournalEntry Class)

Shows the progress of the QuickBooks connection.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_JOURNALENTRY_STATUS 4

virtual INT INQB_CALL FireStatus(LPSTR &lpszMessage);

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

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

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

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

Remarks

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

Warning Event (JournalEntry Class)

Fired when a warning occurs.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_JOURNALENTRY_WARNING 5

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

class JournalEntryWarningEventParams {
public:
  int Code();

  const QString &Description();

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

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

// Or, subclass JournalEntry and override this emitter function.
virtual int FireWarning(JournalEntryWarningEventParams *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.

JournalLine Type

Debit or Credit line used in Journal Entries.

Syntax

InQBJournalLine (declared in inqb.h)

Remarks

Journal Lines are used to move funds from one account to another using the JournalEntry class, and can be used to represent both credits and debits.

• AccountId
• AccountName
• Amount
• BillableStatus
• ClassId
• ClassName
• EntityId
• EntityName
• LineId
• LineType
• Memo
• TaxItemId
• TaxItemName

Fields

Constructors

JournalLine()

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 JournalEntry class.

int GetCount() {}

int SetCount(int count) {}

T* Get(int index) {}

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

Config Settings (JournalEntry Class)

JournalEntry Config Settings

Base Config Settings

Trappable Errors (JournalEntry 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.

JournalEntry Errors