POS Jobs
Access job and role information from your POS system. Jobs define employee roles, permissions, and pay rates.
Overview
The POS Job API provides access to job/role definitions in your POS system. Jobs (also called roles or positions) define what employees can do, how they're paid, and how they appear in reports.
Jobs are referenced by:
- Employees - Each employee is assigned to a job
- Time Cards - Track hours worked by job
- Tickets - Show which job performed actions
API Endpoints
Retrieve Jobs
Returns all job definitions for a specific location.
Method: GET
Endpoint: /pos/v2/{locationId}/jobs
Authentication: Bearer token required
Retrieve all jobs (roles/positions) configured in the POS system for a location.
Path Parameters
| Name | Type | Description |
|---|---|---|
locationId * | integer | The unique identifier for the location |
Query Parameters
| Name | Type | Description |
|---|---|---|
page | integer | Page number for pagination (default: 1) |
pageSize | integer | Number of results per page (default: 50, max: 100) |
active | boolean | Filter by active/inactive status |
Request
curl -X GET https://conecto-api.shift4payments.com/pos/v2/12345/jobs \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Response
{
"results": [
{
"posRef": "JOB-SERVER",
"name": "Server",
"description": "Front of house server",
"isActive": true,
"defaultWageType": "HOURLY",
"defaultWageRate": 15.00,
"permissions": {
"canVoidItems": true,
"canApplyDiscounts": true,
"canAccessReports": false,
"canManageEmployees": false,
"canOpenCashDrawer": false
},
"locationId": 12345
},
{
"posRef": "JOB-MANAGER",
"name": "Manager",
"description": "Store manager",
"isActive": true,
"defaultWageType": "SALARY",
"defaultWageRate": 55000.00,
"permissions": {
"canVoidItems": true,
"canApplyDiscounts": true,
"canAccessReports": true,
"canManageEmployees": true,
"canOpenCashDrawer": true
},
"locationId": 12345
},
{
"posRef": "JOB-COOK",
"name": "Cook",
"description": "Kitchen staff",
"isActive": true,
"defaultWageType": "HOURLY",
"defaultWageRate": 18.00,
"permissions": {
"canVoidItems": false,
"canApplyDiscounts": false,
"canAccessReports": false,
"canManageEmployees": false,
"canOpenCashDrawer": false
},
"locationId": 12345
}
],
"meta": {
"page": 1,
"pageSize": 50,
"totalCount": 8
}
}
Models
Job
Represents a job/role definition in the POS system.
- Name
posRef- Type
- string
- Description
Unique POS system reference ID for the job
- Name
name- Type
- string
- Description
Display name of the job/role
- Name
description- Type
- string
- Description
Description of the job responsibilities
- Name
isActive- Type
- boolean
- Description
Whether the job is currently active
- Name
defaultWageType- Type
- string
- Description
Default wage type:
HOURLY,SALARY, orCOMMISSION
- Name
defaultWageRate- Type
- number
- Description
Default wage rate (hourly rate or annual salary)
- Name
permissions- Type
- object
- Description
Object containing default permissions for this job
- Name
departmentRef- Type
- string
- Description
Reference to the department this job belongs to
- Name
revenueClassRef- Type
- string
- Description
Reference to the revenue class for labor reporting
- Name
locationId- Type
- integer
- Description
Location ID where the job is defined
- Name
createdAt- Type
- datetime
- Description
When the job was created
- Name
updatedAt- Type
- datetime
- Description
When the job was last updated
Use Cases
Employee Management
Jobs are fundamental to employee management:
- Hiring - Assign new employees to appropriate jobs
- Permissions - Control what employees can do based on their job
- Scheduling - Schedule employees by job/role
- Labor Tracking - Track labor costs by job category
Reporting & Analytics
Job data enables various reporting capabilities:
- Labor Cost Analysis - Break down labor costs by job
- Performance Metrics - Analyze sales per job role
- Compliance - Ensure proper wage rates and permissions
- Scheduling Optimization - Optimize schedules based on job requirements
Best Practices
- Name
Synchronization- Description
Keep job definitions synchronized with your POS system. Changes to job permissions or wage rates should be reflected in your application.
- Name
Permission Enforcement- Description
Respect job-level permissions when building applications. Don't allow operations that an employee's job doesn't permit.
- Name
Active Jobs- Description
Filter for active jobs in most contexts, but retain inactive job data for historical employee records.
- Name
Wage Data Privacy- Description
Handle wage information with appropriate security and privacy measures. Limit access to authorized users only.