Home
SpotOn
Restaurant Pos Export Employee Structure
Restaurant Pos Export Employee Structure
An employee record at a location.
Type: object
Properties: 17
Restaurant Point of Sale Payments Online Ordering Reservations Reporting
Employee is a JSON Structure definition published by SpotOn, describing 17 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
Properties
id
locationID
firstName
lastName
email
nickName
address
birthDate
hireDate
terminationDate
loginCode
payrollId
active
posUserId
deleted
excludeFromReporting
jobPositions
Meta-schema: https://json-structure.org/meta/core/v0/#
JSON Structure
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/spoton/refs/heads/main/json-structure/restaurant-pos-export-employee-structure.json",
"name": "Employee",
"description": "An employee record at a location.",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique employee identifier."
},
"locationID": {
"type": "string",
"description": "Associated location identifier."
},
"firstName": {
"type": "string",
"description": "Employee first name."
},
"lastName": {
"type": "string",
"description": "Employee last name."
},
"email": {
"type": "string",
"description": "Employee email address."
},
"nickName": {
"type": "string",
"description": "Employee nickname."
},
"address": {
"type": "object",
"description": "A mailing address for an employee.",
"properties": {
"street1": {
"type": "string",
"description": "First line of the street address."
},
"street2": {
"type": "string",
"description": "Second line of the street address."
},
"city": {
"type": "string",
"description": "City."
},
"state": {
"type": "string",
"description": "State or province."
},
"zip": {
"type": "string",
"description": "Postal code."
},
"phone": {
"type": "string",
"description": "Phone number."
}
}
},
"birthDate": {
"type": "datetime",
"description": "Employee birth date in RFC 3339 format. May be null."
},
"hireDate": {
"type": "datetime",
"description": "Employee hire date in RFC 3339 format. May be null."
},
"terminationDate": {
"type": "datetime",
"description": "Employee termination date in RFC 3339 format. May be null."
},
"loginCode": {
"type": "string",
"description": "POS login code for the employee."
},
"payrollId": {
"type": "string",
"description": "Optional payroll identifier."
},
"active": {
"type": "boolean",
"description": "Whether the employee is active at the location."
},
"posUserId": {
"type": "string",
"description": "Location-specific POS user identifier."
},
"deleted": {
"type": "boolean",
"description": "Whether the employee record is marked as deleted."
},
"excludeFromReporting": {
"type": "boolean",
"description": "Whether the employee is excluded from reporting."
},
"jobPositions": {
"type": "array",
"description": "The job positions the employee holds.",
"items": {
"type": "object",
"description": "A job position configured at a location.",
"properties": {
"id": {
"type": "string",
"description": "Unique job position identifier."
},
"locationId": {
"type": "string",
"description": "Associated location identifier."
},
"name": {
"type": "string",
"description": "Job position title."
},
"deleted": {
"type": "boolean",
"description": "Whether the job position is marked as deleted."
}
}
}
}
}
}