Skip to main content

Employee

Employees. Represents employee information.

type Employee {
employeeId: Int!
employeeNumber: String
employeeName: String
status: String!
lastModifiedDateTime: DateTime
parentBAccountId: Int
mainContactId: Int
mainAddressId: Int
employeeUserId: UUID
noteId: UUID
department: String
employeeClass: EmployeeClass
calendarId: String
employeeLogin: String
workGroupDescription: [String!]
timeStamp: [UnsignedByte!]!
deletedDatabaseRecord: Boolean!
companyId: Int!
id: String!
createdInDataMartDateTime: DateTime!
updatedInDataMartDateTime: DateTime!
}

Fields​

Employee.employeeId ● Int! non-null scalar​

employeeId > (PK) The stable company-scoped employee identifier.

Employee.employeeNumber ● String scalar​

employeeNumber > The trimmed ERP employee number.

Employee.employeeName ● String scalar​

employeeName > The employee name from the ERP business account.

Employee.status ● String! non-null scalar​

status > The REST status for the employee: Active, OnHold, Inactive, HoldPayments, or OneTime.

Employee.lastModifiedDateTime ● DateTime scalar​

lastModifiedDateTime > The UTC timestamp when the employee business account was last modified.

Employee.parentBAccountId ● Int scalar​

parentBAccountId > The parent business account identifier; resolve it to Branches.bAccountId within the same company.

Employee.mainContactId ● Int scalar​

mainContactId > The contact identifier; resolve to Contacts.contactId in the same company where Contacts.bAccountId equals parentBAccountId.

Employee.mainAddressId ● Int scalar​

mainAddressId > The address identifier; resolve to Addresses.addressId in the same company where Addresses.bAccountId equals parentBAccountId.

Employee.employeeUserId ● UUID scalar​

employeeUserId > The nullable ERP user identifier associated with the employee.

Employee.noteId ● UUID scalar​

noteId > The employee note identifier for attribute lookup within the same company. Attribute values are not yet available in DataMart.

Employee.department ● String scalar​

department > The ERP department identifier.

Employee.employeeClass ● EmployeeClass object​

employeeClass > The employee class identifier.

Employee.calendarId ● String scalar​

calendarId > The ERP calendar identifier.

Employee.employeeLogin ● String scalar​

employeeLogin > Username and full name joined with ' - ' when both exist.

Employee.workGroupDescription ● [String!] list scalar​

workGroupDescription > Workgroup descriptions associated with the employee.

Employee.timeStamp ● [UnsignedByte!]! non-null scalar​

timeStamp > The ERP employee timestamp inherited from BAccount.

Employee.deletedDatabaseRecord ● Boolean! non-null scalar​

deletedDatabaseRecord > Indicates whether the ERP employee has been soft-deleted.

Employee.companyId ● Int! non-null scalar​

companyId > (PK) The unique identifier of the company.

Employee.id ● String! non-null scalar​

id > The unique identifier of the document in DataMart.

Employee.createdInDataMartDateTime ● DateTime! non-null scalar​

createdInDataMartDateTime > The UTC DateTime when this document has been added to DataMart.

Employee.updatedInDataMartDateTime ● DateTime! non-null scalar​

updatedInDataMartDateTime > The UTC DateTime when this document has been updated in DataMart.

Returned By​

employees query