Employee resource

Methods

  • get - Search Employees

Resource

{
    "address": {
        "address": "string",
        "addressLine2": "string",
        "city": "string",
        "companyId": "string",
        "country": "string",
        "created": "int64",
        "deleted": "boolean",
        "id": "string",
        "latitude": "number",
        "longitude": "number",
        "modified": "int64",
        "state": "string",
        "updated": "boolean",
        "zipCode": "string"
    },
    "appAccessList": [
        "string"
    ],
    "assignedInventoryId": "string",
    "assignedTerminalId": "string",
    "canApplyCustomDiscount": "boolean",
    "cashDrawerStatus": "string",
    "companyId": "string",
    "created": "int64",
    "deleted": "boolean",
    "disabled": "boolean",
    "dlExpirationDate": "string",
    "driver": "boolean",
    "driversLicense": "string",
    "email": "string",
    "employeeOnFleetInfoList": [
        {
            "onFleetTeamList": [
                "string"
            ],
            "onFleetWorkerId": "string",
            "shopId": "string"
        }
    ],
    "externalId": "string",
    "firstName": "string",
    "id": "string",
    "insuranceCompanyName": "string",
    "insuranceExpireDate": "int64",
    "inventoryName": "string",
    "lastLoggedInShopId": "string",
    "lastLoginTime": "int64",
    "lastName": "string",
    "modified": "int64",
    "notes": [
        {
            "created": "int64",
            "deleted": "boolean",
            "enableOnFleet": "boolean",
            "id": "string",
            "message": "string",
            "modified": "int64",
            "updated": "boolean",
            "writerId": "string",
            "writerName": "string"
        }
    ],
    "occupationLicenseNumber": "string",
    "organizationIds": [
        "string"
    ],
    "password": "string",
    "phoneNumber": "string",
    "pin": "string",
    "policyNumber": "string",
    "recentLocation": {
        "companyId": "string",
        "created": "int64",
        "deleted": "boolean",
        "deviceId": "string",
        "dirty": "boolean",
        "employeeId": "string",
        "id": "string",
        "loc": [
            "double"
        ],
        "modified": "int64",
        "name": "string",
        "shopId": "string",
        "terminalId": "string",
        "timeCardId": "string",
        "updated": "boolean"
    },
    "registrationExpireDate": "int64",
    "role": {
        "companyId": "string",
        "created": "int64",
        "deleted": "boolean",
        "id": "string",
        "modified": "int64",
        "name": "string",
        "permissions": [
            "string"
        ],
        "updated": "boolean"
    },
    "roleId": "string",
    "shops": [
        "string"
    ],
    "terminalName": "string",
    "timeCard": {
        "clockInTime": "int64",
        "clockOutTime": "int64",
        "clockin": "boolean",
        "companyId": "string",
        "created": "int64",
        "deleted": "boolean",
        "dirty": "boolean",
        "employeeId": "string",
        "id": "string",
        "modified": "int64",
        "sessions": [
            {
                "companyId": "string",
                "created": "int64",
                "deleted": "boolean",
                "dirty": "boolean",
                "employeeId": "string",
                "endTime": "int64",
                "id": "string",
                "modified": "int64",
                "shopId": "string",
                "startTime": "int64",
                "terminalId": "string",
                "timeCardId": "string",
                "updated": "boolean"
            }
        ],
        "shopId": "string",
        "updated": "boolean"
    },
    "timecardId": "string",
    "tookanInfoList": [
        {
            "shopId": "string",
            "status": "string",
            "teamId": "string",
            "tookanAgentId": "string"
        }
    ],
    "updated": "boolean",
    "vehicleLicensePlate": "string",
    "vehicleMake": "string",
    "vehicleModel": "string",
    "vehiclePin": "string",
    "vinNo": "string"
}

Properties

Name Type Description Additional
address object Address Optional
address.address string Optional
address.addressLine2 string Optional
address.city string Optional
address.companyId string Optional
address.country string Optional
address.created int64 Optional
address.deleted boolean Optional
address.id string Optional
address.latitude number Optional
address.longitude number Optional
address.modified int64 Optional
address.state string Optional
address.updated boolean Optional
address.zipCode string Optional
appAccessList[] array of string

Possible values are:

  • AuthenticationApp
  • Retail
  • Distribution
  • Grow
  • Dispatch
 Optional
assignedInventoryId string Optional
assignedTerminalId string Optional
canApplyCustomDiscount boolean Optional
cashDrawerStatus string

Possible values are:

  • Open
  • Closed
 Optional
companyId string Optional
created int64 Optional
deleted boolean Optional
disabled boolean Optional
dlExpirationDate string Optional
driver boolean Optional
driversLicense string Optional
email string Optional
employeeOnFleetInfoList[] array Optional
employeeOnFleetInfoList[].onFleetTeamList[] array of string Optional
employeeOnFleetInfoList[].onFleetWorkerId string Optional
employeeOnFleetInfoList[].shopId string Optional
externalId string Optional
firstName string Optional
id string Optional
insuranceCompanyName string Optional
insuranceExpireDate int64 Optional
inventoryName string Optional
lastLoggedInShopId string Optional
lastLoginTime int64 Optional
lastName string Optional
modified int64 Optional
notes[] array Optional
notes[].created int64 Optional
notes[].deleted boolean Optional
notes[].enableOnFleet boolean Optional
notes[].id string Optional
notes[].message string Optional
notes[].modified int64 Optional
notes[].updated boolean Optional
notes[].writerId string Optional
notes[].writerName string Optional
occupationLicenseNumber string Optional
organizationIds[] array of string Optional
password string Optional
phoneNumber string Optional
pin string Optional
policyNumber string Optional
recentLocation object TerminalLocation Optional
recentLocation.companyId string Optional
recentLocation.created int64 Optional
recentLocation.deleted boolean Optional
recentLocation.deviceId string Optional
recentLocation.dirty boolean Optional
recentLocation.employeeId string Optional
recentLocation.id string Optional
recentLocation.loc[] array of double Optional
recentLocation.modified int64 Optional
recentLocation.name string Optional
recentLocation.shopId string Optional
recentLocation.terminalId string Optional
recentLocation.timeCardId string Optional
recentLocation.updated boolean Optional
registrationExpireDate int64 Optional
role object Role Optional
role.companyId string Optional
role.created int64 Optional
role.deleted boolean Optional
role.id string Optional
role.modified int64 Optional
role.name string Optional
role.permissions[] array of string

Possible values are:

  • None
  • iPadMemberAdd
  • iPadMemberEdit
  • iPadQueueAddMember
  • iPadTransactionsViews
  • iPadProcessSales
  • iPadRefund
  • iPadApplyCartDiscounts
  • iPadApplyLineItemDiscounts
  • iPadApplyCoupons
  • iPadCashDrawerOpen
  • iPadCashDrawerCloseOut
  • iPadTransactionsLookup
  • iPadInitiation
  • iPadQuickPinLogin
  • iPadManageSettingsView
  • iPadManagerSettingsManage
  • WebAdminLogin
  • WebAllMembersView
  • WebMembersView
  • WebMembersManage
  • WebMembersAddToQueue
  • WebPromotionsView
  • WebPromotionsManage
  • WebTransactionsView
  • WebTransactionsRefund
  • WebInventoryView
  • WebInventoryManage
  • WebInventoryTransfer
  • WebInventoryCategoryManage
  • WebEmployeeView
  • WebEmployeeManage
  • WebEmployeeClockout
  • WebVendorView
  • WebVendorManage
  • WebSettingsView
  • WebSettingsManage
  • WebPhysiciansView
  • WebPhysiciansManage
  • WebReportsView
  • WebDeliveryView
  • WebCashDrawerView
  • WebUnlockOrder
  • WebEditBatch
  • WebAddBatch
  • WebInvoiceView
  • WebInvoiceManage
  • WebInventoryReconciliation
  • WebDashboardView
  • WebPurchaseOrderView
  • WebPurchaseOrderManage
  • WebExpenseView
  • WebExpenseManage
  • WebQuickBookManage
  • WebInvoiceManifestChange
  • WebEditPosPayment
  • WebTransactionsVoid
  • WebCancelPosOrders
 Optional
role.updated boolean Optional
roleId string Optional
shops[] array of string Optional
terminalName string Optional
timeCard object TimeCard Optional
timeCard.clockInTime int64 Optional
timeCard.clockOutTime int64 Optional
timeCard.clockin boolean Optional
timeCard.companyId string Optional
timeCard.created int64 Optional
timeCard.deleted boolean Optional
timeCard.dirty boolean Optional
timeCard.employeeId string Optional
timeCard.id string Optional
timeCard.modified int64 Optional
timeCard.sessions[] array Optional
timeCard.sessions[].companyId string Optional
timeCard.sessions[].created int64 Optional
timeCard.sessions[].deleted boolean Optional
timeCard.sessions[].dirty boolean Optional
timeCard.sessions[].employeeId string Optional
timeCard.sessions[].endTime int64 Optional
timeCard.sessions[].id string Optional
timeCard.sessions[].modified int64 Optional
timeCard.sessions[].shopId string Optional
timeCard.sessions[].startTime int64 Optional
timeCard.sessions[].terminalId string Optional
timeCard.sessions[].timeCardId string Optional
timeCard.sessions[].updated boolean Optional
timeCard.shopId string Optional
timeCard.updated boolean Optional
timecardId string Optional
tookanInfoList[] array Optional
tookanInfoList[].shopId string Optional
tookanInfoList[].status string

Possible values are:

  • AVAILABLE
  • OFFLINE
  • BUSY
 Optional
tookanInfoList[].teamId string Optional
tookanInfoList[].tookanAgentId string Optional
updated boolean Optional
vehicleLicensePlate string Optional
vehicleMake string Optional
vehicleModel string Optional
vehiclePin string Optional
vinNo string Optional