EmployeeService class

URL: https://developer.intuit.com/app/developer/qbo/docs/api/accounting/most-commonly-used/employee An Employee object represents a person working for the company. If you are looking to create a Contractor via API, refer how to create a Vendor object, with Vendor1099 field set to true.

The DisplayName, Title, GivenName, MiddleName, FamilyName, Suffix, and PrintOnCheckName attributes must not contain colon (:), tab (\t), or newline (\n) characters.

The DisplayName attribute must be unique across all other customer, employee, and vendor objects.

The GivenName and FamilyName attributes are required. The PrimaryEmailAddress attribute must contain an at sign (@) and dot (.). The full complement of read, create, delete via deactivation (active=false), and update operations are available both with and without QuickBooks Payroll enabled. However, when Payroll is enabled, support for some attributes is limited: Title—Not supported when QuickBooks Payroll is enabled. Suffix—Not supported when QuickBooks Payroll is enabled. DisplayName —It’s read only when QuickBooks Payroll is enabled and a concatenation of GivenName MiddleName FamilyName. PrintOnCheckName—Not supported when QuickBooks Payroll is enabled. BillRate—Not supported when QuickBooks Payroll is enabled. SSN—Masked SSNs, as is returned in a response, cannot be passed in a request when QuickBooks Payroll is enabled. Code for this field must be removed before submitting.

Constructors

EmployeeService.new({required String baseUrl, required AuthenticationService authenticationService, int minorVersion = 63})

Properties

authenticationService → AuthenticationService

final

baseUrl → String

final

hashCode → int

The hash code for this object.

no setter, inherited

minorVersion → int

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

createEmployee({required Employee employee, String? realmId, String? authToken}) → Future<Employee>

Create an employee

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

queryEmployee({required String query, String? realmId, String? authToken}) → Future<List<Employee>>

Returns the results of the query.

readEmployee({required String employeeId, String? realmId, String? authToken}) → Future<Employee>

Retrieves the details of a Employee object that has been previously created.

toString() → String

A string representation of this object.

inherited

updateEmployee({required Employee employee, String? realmId, String? authToken}) → Future<Employee>

Use this operation to update any of the writable fields of an existing employee object. The request body must include all writable fields of the existing object as returned in a read response. Writable fields omitted from the request body are set to NULL. The ID of the object to update is specified in the request body.

Operators

operator ==(Object other) → bool

The equality operator.

inherited