Employee Module

Properties   Methods   Events   Config Settings   Errors  

An Employee is anyone who works for the QuickBooks company.

Syntax

InQB.Employee

Remarks

The Employee class represents a company employee.

Required Fields (Add): EmployeeName

Supported Methods: Add, Update (contact info only), Get (Id/Name), Delete

Example (Adding an employee to QuickBooks) Employee1.EmployeeName = "John Smith" Employee1.Add() EmployeeName will automatically be parsed into a first name, last name, etc. by the class, so setting EmployeeName to "Smith, John" or to "John Smith" will have the same effect. Other contact information such as Address, Phone, and Email may be set or modified as well.

The SSN may be set when an employee is Added, but it may not be modified or even seen afterward, as it is considered sensitive information.

To retrieve an Employee, call the Get method with the employee's name as a parameter. This parameter will automatically be parsed in the same way as EmployeeName, so calling Get on "Smith, Mary A." will successfully retrieve "Mary A. Smith". The customer will be downloaded from QuickBooks, and all properties (except SSN) will be set.

The class may also be used to update contact information or to delete an employee by using the Update and Delete methods, respectively. To update contact information, first load the employee's information using Get or the ObjSearch class. Then change the value of one or more of the properties, and call Update to update the information. Note that not all properties can be updated using the class.

To search for Employees, the ObjSearch Class may be used.

Property List

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

Method List

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

Event List

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

Config Settings

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

AccountNumber Property (Employee Module)

Account number for this entity.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=accountNumber,setter=setAccountNumber:) NSString* accountNumber;

- (NSString*)accountNumber;
- (void)setAccountNumber :(NSString*)newAccountNumber;

Default Value

""

Remarks

The account number for this customer, vendor, or employee.

Address Property (Employee Module)

Address of employee.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=address,setter=setAddress:) NSString* address;

- (NSString*)address;
- (void)setAddress :(NSString*)newAddress;

Default Value

""

Remarks

The mailing address of the employee.

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>

AltPhone Property (Employee Module)

Alternate phone number of entity.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=altPhone,setter=setAltPhone:) NSString* altPhone;

- (NSString*)altPhone;
- (void)setAltPhone :(NSString*)newAltPhone;

Default Value

""

Remarks

An alternate phone number for the customer, vendor, or employee.

Earnings Property (Employee Module)

Payroll property: Employee Earnings.

Syntax

• Swift
• Objective-C

public var earnings: Array<EmployeeEarnings> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=earningsCount,setter=setEarningsCount:) int earningsCount;

- (int)earningsCount;
- (void)setEarningsCount :(int)newEarningsCount;

- (NSString*)earningsRate:(int)earningsIndex;
- (void)setEarningsRate:(int)earningsIndex :(NSString*)newEarningsRate;

- (NSString*)earningsRatePercent:(int)earningsIndex;
- (void)setEarningsRatePercent:(int)earningsIndex :(NSString*)newEarningsRatePercent;

- (NSString*)earningsWageId:(int)earningsIndex;
- (void)setEarningsWageId:(int)earningsIndex :(NSString*)newEarningsWageId;

- (NSString*)earningsWageName:(int)earningsIndex;
- (void)setEarningsWageName:(int)earningsIndex :(NSString*)newEarningsWageName;

 

Default Value

""

Remarks

Email Property (Employee Module)

Email address of entity.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=email,setter=setEmail:) NSString* email;

- (NSString*)email;
- (void)setEmail :(NSString*)newEmail;

Default Value

""

Remarks

The email address of the customer, vendor, or employee.

EmployeeName Property (Employee Module)

Employee's name.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=employeeName,setter=setEmployeeName:) NSString* employeeName;

- (NSString*)employeeName;
- (void)setEmployeeName :(NSString*)newEmployeeName;

Default Value

""

Remarks

The name of the employee.

The name will automatically be parsed into a first name, middle initial, last name, and salutation, and will appear in those fields respectively. These fields may be edited separately using Config.

This property is required in Add operations only.

EmployeeType Property (Employee Module)

Type of employee.

Syntax

• Swift
• Objective-C

public var employeeType: EmployeeEmployeeTypes {
  get {...}
  set {...}
}

public enum EmployeeEmployeeTypes: Int32 {
  case etUnspecified = 0
  case etRegular = 1
  case etOfficer = 2
  case etStatutory = 3
  case etOwner = 4
}

@property (nonatomic,readwrite,assign,getter=employeeType,setter=setEmployeeType:) int employeeType;

- (int)employeeType;
- (void)setEmployeeType :(int)newEmployeeType;

Default Value

0

Remarks

The type of employee. A default value of etRegular will be assigned after Add operations if the field is not specified.

The following types are permitted:

This property is allowed in Add operations, and not used in Update operations.

Gender Property (Employee Module)

Gender of Employee .

Syntax

• Swift
• Objective-C

public var gender: EmployeeGenders {
  get {...}
  set {...}
}

public enum EmployeeGenders: Int32 {
  case gUnspecified = 0
  case gMale = 1
  case gFemale = 2
}

@property (nonatomic,readwrite,assign,getter=gender,setter=setGender:) int gender;

- (int)gender;
- (void)setGender :(int)newGender;

Default Value

0

Remarks

The gender of the Employee: gMale or gFemale.

The value of Gender may be left as gUnspecified if the gender is unknown or unimportant.

The following values are permitted:

This property is allowed in Add operations, and not used in Update operations.

HiredDate Property (Employee Module)

Date employee was hired.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=hiredDate,setter=setHiredDate:) NSString* hiredDate;

- (NSString*)hiredDate;
- (void)setHiredDate :(NSString*)newHiredDate;

Default Value

""

Remarks

The date the employee was hired.

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 allowed in Add operations, and not used in Update operations.

IsActive Property (Employee Module)

Whether or not entity is active.

Syntax

• Swift
• Objective-C

public var isActive: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=isActive,setter=setIsActive:) BOOL isActive;

- (BOOL)isActive;
- (void)setIsActive :(BOOL)newIsActive;

Default Value

True

Remarks

This property indicates whether this object is currently enabled for use by QuickBooks.

This property is allowed in Add operations, and the QBXMLVersion must be set to "3.0" or higher for this to be used in Update operations.

Notes Property (Employee Module)

Notes for this transaction.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=notes,setter=setNotes:) NSString* notes;

- (NSString*)notes;
- (void)setNotes :(NSString*)newNotes;

Default Value

""

Remarks

This property may contain any notes you wish to make concerning the transaction.

PayPeriod Property (Employee Module)

Payroll property: Indicates how often employees are paid.

Syntax

• Swift
• Objective-C

public var payPeriod: EmployeePayPeriods {
  get {...}
  set {...}
}

public enum EmployeePayPeriods: Int32 {
  case ppNotSet = 0
  case ppDaily = 1
  case ppWeekly = 2
  case ppBiweekly = 3
  case ppSemimonthly = 4
  case ppMonthly = 5
  case ppQuarterly = 6
  case ppYearly = 7
}

@property (nonatomic,readwrite,assign,getter=payPeriod,setter=setPayPeriod:) int payPeriod;

- (int)payPeriod;
- (void)setPayPeriod :(int)newPayPeriod;

Default Value

0

Remarks

Indicates how often employees are paid. The default value is whatever the QuickBooks user has set in the QuickBooks Employee Preferences. This property is required for an Update request.

PayrollClassId Property (Employee Module)

Payroll property: class of the employee payroll info.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=payrollClassId,setter=setPayrollClassId:) NSString* payrollClassId;

- (NSString*)payrollClassId;
- (void)setPayrollClassId :(NSString*)newPayrollClassId;

Default Value

""

Remarks

A reference to the class into which this employee payroll falls. 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.

PayrollClassName Property (Employee Module)

Payroll property: class of the employee payroll info.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=payrollClassName,setter=setPayrollClassName:) NSString* payrollClassName;

- (NSString*)payrollClassName;
- (void)setPayrollClassName :(NSString*)newPayrollClassName;

Default Value

""

Remarks

A reference to the class into which this employee payroll falls. 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.

Phone Property (Employee Module)

Phone number of entity.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=phone,setter=setPhone:) NSString* phone;

- (NSString*)phone;
- (void)setPhone :(NSString*)newPhone;

Default Value

""

Remarks

The phone number of the customer, vendor, or employee.

QBConnectionString Property (Employee Module)

An aggregate consisting of various QuickBooks connection properties.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=QBConnectionString,setter=setQBConnectionString:) NSString* QBConnectionString;

- (NSString*)QBConnectionString;
- (void)setQBConnectionString :(NSString*)newQBConnectionString;

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:

QBRequestAggregate Property (Employee Module)

The request aggregate.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=QBRequestAggregate,setter=setQBRequestAggregate:) NSString* QBRequestAggregate;

- (NSString*)QBRequestAggregate;
- (void)setQBRequestAggregate :(NSString*)newQBRequestAggregate;

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.

QBRequestId Property (Employee Module)

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

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=QBRequestId,setter=setQBRequestId:) NSString* QBRequestId;

- (NSString*)QBRequestId;
- (void)setQBRequestId :(NSString*)newQBRequestId;

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.

QBRequestMode Property (Employee Module)

Defines whether the request is made online or stored offline.

Syntax

• Swift
• Objective-C

public var qbRequestMode: EmployeeQBRequestModes {
  get {...}
  set {...}
}

public enum EmployeeQBRequestModes: Int32 {
  case rmOnline = 0
  case rmOffline = 1
}

@property (nonatomic,readwrite,assign,getter=QBRequestMode,setter=setQBRequestMode:) int QBRequestMode;

- (int)QBRequestMode;
- (void)setQBRequestMode :(int)newQBRequestMode;

Default Value

0

Remarks

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

The use of offline mode is required when using the QBWCServer class. This allows requests to be generated and passed to QuickBooks Web Connector through the QBWCServer class.

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

QBResponseAggregate Property (Employee Module)

The last QBXML response aggregate received from QuickBooks.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=QBResponseAggregate,setter=setQBResponseAggregate:) NSString* QBResponseAggregate;

- (NSString*)QBResponseAggregate;
- (void)setQBResponseAggregate :(NSString*)newQBResponseAggregate;

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.

QBXMLVersion Property (Employee Module)

The version of QBXML used in the outgoing message.

Syntax

• Swift
• Objective-C

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

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

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

Default Value

"3.0"

Remarks

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:

In addition, versions of QuickBooks outside of the U.S. released before Quickbooks 2008 adhere to a different version of the QuickBooks SDK. These versions were updated with less frequency than the U.S. SDK, and may omit features introduced in later releases:

With the exception of Province in Address (set State) or EligibleForT4A in Vendor (set EligibleFor1099), Canadian-only fields are read-only and may be accessed with Config.

RefId Property (Employee Module)

An alphanumerical identifier generated by the server.

Syntax

• Swift
• Objective-C

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

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

- (NSString*)refId;

Default Value

""

Remarks

A RefId 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 required in Update operations, and not used in Add operations.

This property is read-only.

ReleasedDate Property (Employee Module)

Date employee was released.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=releasedDate,setter=setReleasedDate:) NSString* releasedDate;

- (NSString*)releasedDate;
- (void)setReleasedDate :(NSString*)newReleasedDate;

Default Value

""

Remarks

The date the employee was released (if he/she was released).

This property is allowed in Add operations, and not used in Update operations.

SickTime Property (Employee Module)

This property contains information about an employee's sick time.

Syntax

• Swift
• Objective-C

public var sickTime: EmployeeTimeOff {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=sickTimeAccrualPeriod,setter=setSickTimeAccrualPeriod:) int sickTimeAccrualPeriod;

- (int)sickTimeAccrualPeriod;
- (void)setSickTimeAccrualPeriod :(int)newSickTimeAccrualPeriod;

@property (nonatomic,readwrite,assign,getter=sickTimeAccrualStartDate,setter=setSickTimeAccrualStartDate:) NSString* sickTimeAccrualStartDate;

- (NSString*)sickTimeAccrualStartDate;
- (void)setSickTimeAccrualStartDate :(NSString*)newSickTimeAccrualStartDate;

@property (nonatomic,readwrite,assign,getter=sickTimeAccrued,setter=setSickTimeAccrued:) NSString* sickTimeAccrued;

- (NSString*)sickTimeAccrued;
- (void)setSickTimeAccrued :(NSString*)newSickTimeAccrued;

@property (nonatomic,readwrite,assign,getter=sickTimeAvailable,setter=setSickTimeAvailable:) NSString* sickTimeAvailable;

- (NSString*)sickTimeAvailable;
- (void)setSickTimeAvailable :(NSString*)newSickTimeAvailable;

@property (nonatomic,readwrite,assign,getter=sickTimeMaximumTime,setter=setSickTimeMaximumTime:) NSString* sickTimeMaximumTime;

- (NSString*)sickTimeMaximumTime;
- (void)setSickTimeMaximumTime :(NSString*)newSickTimeMaximumTime;

@property (nonatomic,readwrite,assign,getter=sickTimeResetsEachYear,setter=setSickTimeResetsEachYear:) BOOL sickTimeResetsEachYear;

- (BOOL)sickTimeResetsEachYear;
- (void)setSickTimeResetsEachYear :(BOOL)newSickTimeResetsEachYear;

@property (nonatomic,readwrite,assign,getter=sickTimeUsed,setter=setSickTimeUsed:) NSString* sickTimeUsed;

- (NSString*)sickTimeUsed;
- (void)setSickTimeUsed :(NSString*)newSickTimeUsed;

 

Default Value

""

Remarks

SSN Property (Employee Module)

Social security number.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=SSN,setter=setSSN:) NSString* SSN;

- (NSString*)SSN;
- (void)setSSN :(NSString*)newSSN;

Default Value

""

Remarks

The social security number of the employee. Must include dashes.

As this information is considered sensitive, there is no way to change or retrieve the SSN of an Employee. This property may be specified when adding a record to QuickBooks, but it is impossible to determine the SSN of an employee already in QuickBooks.

UseTimeDataToCreatePaychecks Property (Employee Module)

Payroll property: Indicates whether time data is used to create paychecks for this employee.

Syntax

• Swift
• Objective-C

public var useTimeDataToCreatePaychecks: EmployeeUseTimeDataToCreatePaychecks {
  get {...}
  set {...}
}

public enum EmployeeUseTimeDataToCreatePaychecks: Int32 {
  case tdNotSet = 0
  case tdUseTimeData = 1
  case tdDoNotUseTimeData = 2
}

@property (nonatomic,readwrite,assign,getter=useTimeDataToCreatePaychecks,setter=setUseTimeDataToCreatePaychecks:) int useTimeDataToCreatePaychecks;

- (int)useTimeDataToCreatePaychecks;
- (void)setUseTimeDataToCreatePaychecks :(int)newUseTimeDataToCreatePaychecks;

Default Value

0

Remarks

Indicates whether time data is used to create paychecks for this employee.

VacationTime Property (Employee Module)

This property contains information about an employee's vacation time.

Syntax

• Swift
• Objective-C

public var vacationTime: EmployeeTimeOff {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=vacationTimeAccrualPeriod,setter=setVacationTimeAccrualPeriod:) int vacationTimeAccrualPeriod;

- (int)vacationTimeAccrualPeriod;
- (void)setVacationTimeAccrualPeriod :(int)newVacationTimeAccrualPeriod;

@property (nonatomic,readwrite,assign,getter=vacationTimeAccrualStartDate,setter=setVacationTimeAccrualStartDate:) NSString* vacationTimeAccrualStartDate;

- (NSString*)vacationTimeAccrualStartDate;
- (void)setVacationTimeAccrualStartDate :(NSString*)newVacationTimeAccrualStartDate;

@property (nonatomic,readwrite,assign,getter=vacationTimeAccrued,setter=setVacationTimeAccrued:) NSString* vacationTimeAccrued;

- (NSString*)vacationTimeAccrued;
- (void)setVacationTimeAccrued :(NSString*)newVacationTimeAccrued;

@property (nonatomic,readwrite,assign,getter=vacationTimeAvailable,setter=setVacationTimeAvailable:) NSString* vacationTimeAvailable;

- (NSString*)vacationTimeAvailable;
- (void)setVacationTimeAvailable :(NSString*)newVacationTimeAvailable;

@property (nonatomic,readwrite,assign,getter=vacationTimeMaximumTime,setter=setVacationTimeMaximumTime:) NSString* vacationTimeMaximumTime;

- (NSString*)vacationTimeMaximumTime;
- (void)setVacationTimeMaximumTime :(NSString*)newVacationTimeMaximumTime;

@property (nonatomic,readwrite,assign,getter=vacationTimeResetsEachYear,setter=setVacationTimeResetsEachYear:) BOOL vacationTimeResetsEachYear;

- (BOOL)vacationTimeResetsEachYear;
- (void)setVacationTimeResetsEachYear :(BOOL)newVacationTimeResetsEachYear;

@property (nonatomic,readwrite,assign,getter=vacationTimeUsed,setter=setVacationTimeUsed:) NSString* vacationTimeUsed;

- (NSString*)vacationTimeUsed;
- (void)setVacationTimeUsed :(NSString*)newVacationTimeUsed;

 

Default Value

""

Remarks

Add Method (Employee Module)

Adds the record into QuickBooks.

Syntax

• Swift
• Objective-C

public func add() throws -> Void

- (void)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.

CheckRequestStatus Method (Employee Module)

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

Syntax

• Swift
• Objective-C

public func checkRequestStatus(requestId: String) throws -> String

- (NSString*)checkRequestStatus:(NSString*)requestId;

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.

CloseQBConnection Method (Employee Module)

Closes a persistent connection to QuickBooks.

Syntax

• Swift
• Objective-C

public func closeQBConnection() throws -> Void

- (void)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.

Config Method (Employee Module)

Sets or retrieves a configuration setting.

Syntax

• Swift
• Objective-C

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

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

Remarks

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

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

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

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

Delete Method (Employee Module)

Deletes the record from QuickBooks.

Syntax

• Swift
• Objective-C

public func delete_() throws -> Void

- (void)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.

Get Method (Employee Module)

Gets a single record from QuickBooks.

Syntax

• Swift
• Objective-C

public func get(id: String) throws -> Void

- (void)get:(NSString*)id;

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.

GetByName Method (Employee Module)

Gets a single record from QuickBooks.

Syntax

• Swift
• Objective-C

public func getByName(fullName: String) throws -> Void

- (void)getByName:(NSString*)fullName;

Remarks

GetByName may be used to retrieve a single object from QuickBooks, based on its full Name. For Employee and Vendor objects, and for most Customer objects, the full name is given by the Name (CustomerName, VendorName, or EmployeeName property. For Customer objects that represent jobs or sub-customers, the full name will include the parent objects' name(s), and is given by the FullName special field. 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 full name of any class may be used for the parameter. So, for example, the following pseudocode would get customer information for a Customer listed on an Invoice:

Customer.GetByName( Invoice.CustomerName )

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 name is not known, or to perform more advanced searches the ObjSearch class may be used.

GetCustomField Method (Employee Module)

Gets a custom field value from QuickBooks.

Syntax

• Swift
• Objective-C

public func getCustomField(fieldName: String) throws -> String

- (NSString*)getCustomField:(NSString*)fieldName;

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.

ImportQBXML Method (Employee Module)

Imports a QBXML response aggregate.

Syntax

• Swift
• Objective-C

public func importQBXML(xmlData: String) throws -> Void

- (void)importQBXML:(NSString*)XMLData;

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.

OpenQBConnection Method (Employee Module)

Opens a persistent connection to QuickBooks.

Syntax

• Swift
• Objective-C

public func openQBConnection() throws -> Void

- (void)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.

Reset Method (Employee Module)

Resets all properties to their defaults.

Syntax

• Swift
• Objective-C

public func reset() throws -> Void

- (void)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.

SetCustomField Method (Employee Module)

Sets a custom field value within QuickBooks.

Syntax

• Swift
• Objective-C

public func setCustomField(fieldName: String, fieldValue: String) throws -> Void

- (void)setCustomField:(NSString*)fieldName :(NSString*)fieldValue;

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.

Update Method (Employee Module)

Updates the entity object in QuickBooks.

Syntax

• Swift
• Objective-C

public func update() throws -> Void

- (void)update;

Remarks

This method is used to update entity (Customer, Vendor, and Employee) records in QuickBooks.

When the method is called, an Update request will be submitted to QuickBooks. The object represented by RefId 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.

One condition must be met for an Update operation to succeed: QuickBooks checks a property called EditSequence. EditSequence is similar to RefId, but is changed every time the object is changed. When an Updateoperation is submitted, the server compares EditSequence with its own EditSequence for the object. If they match, this means that the client program has the latest copy of the object, and the Update operation is permitted. If they don't match, an error will be returned.

If this object represents a value returned from QuickBooks (i.e., a Get or Add call has been made, or the QBResponseAggregate property has been set), the EditSequence will be automatically set. Otherwise this value may be accessed through Config.

Error Event (Employee Module)

Information about errors during data delivery.

Syntax

• Swift
• Objective-C

func onError(errorCode: Int32, description: String)

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

Remarks

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

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

SSLServerAuthentication Event (Employee Module)

Fired after the server presents its certificate to the client.

Syntax

• Swift
• Objective-C

func onSSLServerAuthentication(certEncoded: Data, certSubject: String, certIssuer: String, status: String, accept: inout Bool)

- (void)onSSLServerAuthentication:(NSData*)certEncoded :(NSString*)certSubject :(NSString*)certIssuer :(NSString*)status :(int*)accept;

Remarks

This event is where the client can decide whether to continue with the connection process or not. 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 to continue or not.

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 (Employee Module)

Shows the progress of the secure connection.

Syntax

• Swift
• Objective-C

func onSSLStatus(message: String)

- (void)onSSLStatus:(NSString*)message;

Remarks

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

Status Event (Employee Module)

Shows the progress of the QuickBooks connection.

Syntax

• Swift
• Objective-C

func onStatus(message: String)

- (void)onStatus:(NSString*)message;

Remarks

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

Warning Event (Employee Module)

Fired when a warning occurs.

Syntax

• Swift
• Objective-C

func onWarning(code: Int32, description: String)

- (void)onWarning:(int)code :(NSString*)description;

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.

Unlisted QuickBooks warnings will cause the class to throw an exception instead.

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.

EmployeeEarnings Type

An employee's earnings, used for payroll.

Remarks

This type is used by the Employee class.

Fields

Constructors

public init()

EmployeeTimeOff Type

Describes how time off (either sick or vacation) is accrued for an employee.

Remarks

This type is used by the Employee class.

Fields

Constructors

public init()

Config Settings (Employee Module)

Trappable Errors (Employee Module)

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.

Employee Errors

	101   String too long.
	103   Invalid date format (YYYY-MM-DD is standard).
	104   Invalid value for enumerated field.
	105   Invalid integer.
	106   Invalid dollar amount.
	107   Invalid boolean value (must be 'true' or 'false').
	108   Invalid number.
	111   Invalid special characters in string.
	112   Invalid special field syntax.
	181   Could not load certificate file.
	201   Required field unspecified.
	211   Unsupported field specified.
	301   Array line count must be nonnegative.
	302   Array index out of bounds.
	303   Invalid field index.
	401   Field not accessible as a special field.
	402   Write access attempted of readonly field.
	403   Read access attempted of writeonly field.
	421   The object cannot be modified.
	511   The QBRequestId has been previously used. Please generate a new one.
	601   Could not access QuickBooks.
	602   Could not open specified file.
	603   The version of QuickBooks currently being used is not supported.
	604   QuickBooks has not been installed properly.
	605   The specified file was of an incorrect version.
	606   Could not start QuickBooks.
	607   QuickBooks is open in a mode different than the one requested.
	608   QuickBooks cannot currently be accessed.
	609   An application name must be specified.
	610   A file name must be specified if one is not currently open in QuickBooks.
	611   Access denied.
	612   QuickBooks is busy and cannot open your application in the mode requested.
	699   The connection to QuickBooks has failed for an unknown reason.
	702   The object requested does not exist in QuickBooks.
	751   Unsupported QBXML version.
	752   The QBXMLVersion chosen is insufficient to execute the request.
	801   A QuickBooks internal error has occurred.
	802   QuickBooks is not available due to a system-related problem.
	803   The Id specified is invalid.
	804   Invalid object name.
	805   The name already exists in QuickBooks.
	807   An object could not be found in QuickBooks.
	808   A reference did not refer to an object that exists in QuickBooks.
	809   The object is currently in use by the QuickBooks end user.
	810   The object may not be added.
	811   The object may not be updated because it is obsolete.
	812   The address is invalid.
	813   Permission to perform this operation is not granted.
	814   The request has not been processed.
	815   Time creation mismatch.
	816   The feature is turned off or not enabled.
	817   Permission level configured is insufficient for access.
	818    The item specified was of an unknown type.
	819   The object may not be changed.
	820   An internal QuickBooks error has occurred.
	821   An attempt was made to use a connection that was not properly initiated.
	822   An attempt was made to use a connection that is invalid or was previously closed.
	823   Not enough memory.
	824   Unable to lock the necessary information to allow this application access to the company file. Try again later.
	850   An older version of QuickBooks 2002 is being used. Please download the latest update from Intuit.
	851   The QuickBooks request processor was not found. Check that QuickBooks Pro 2002 or higher is installed on your system.
	861   Server error on WebExport (details follow).
	862   The WebExport is impossible: an HTTP context was not found.
	871   You may not set the value of QBConnectionTicket. This value is readonly.
	880   Interrupted by the user.
	881   An error has occurred connecting to a remote machine.
	899   An unknown QuickBooks error has occurred. The message contains more details.
	901   XML Parser Error. Should not occur under normal circumstances.