Skip to content

Encompass.Api (1.0)

Download OpenAPI description
sandbox.json
sandbox.yaml
Languages
Servers
Mock server

https://docs.encompassfi.com/_mock/reference/sandbox/

Benefits - Company

Operations

Benefits - Employee

Operations

Companies

Operations

Contractors

Operations

Corporations

Operations

Deductions - Child Support

Operations

Deductions - Miscellaneous

Operations

Departments

Operations

Documents

Operations

Earning Codes

Operations

Employees

Operations

Enrollment Profiles

Operations

Miscellaneous

Operations

Partners

Operations

Payment Schedules

Operations

Payrolls

Operations

Timecards

Operations

Get Employee Timecard

Request

Path
companyIdstringrequired
timecardIdstringrequired
curl -i -X GET \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/timecards/employees/{timecardId}'

Responses

OK

Bodyapplication/json
idstring
employeeIdstring
workplaceIdstring
statusstring(TimecardStatus)
Enum"InProgress""Pending""Approved""Denied"
clockInNotestring or null
clockOutNotestring or null
clockInstring or null(date-time)
clockOutstring or null(date-time)
breaksArray of objects or null(EmployeeTimecardBreak)
changesArray of objects or null(EmployeeTimecardChange)
Response
application/json
{
  "id": "string",
  "employeeId": "string",
  "workplaceId": "string",
  "status": "InProgress",
  "clockInNote": "string",
  "clockOutNote": "string",
  "clockIn": "2019-08-24T14:15:22Z",
  "clockOut": "2019-08-24T14:15:22Z",
  "breaks": [
    { … }
  ],
  "changes": [
    { … }
  ]
}

Query Employee Timecards

Request

Path
companyIdstringrequired
Query
idArray of stringsrequired
employeeIdArray of stringsrequired
workplaceIdArray of stringsrequired
statusArray of strings(TimecardStatus)required
Items Enum"InProgress""Pending""Approved""Denied"
searchstring
includeIdboolean
Default true
includeEmployeeIdboolean
Default true
includeWorkplaceIdboolean
Default true
includeStatusboolean
Default true
includeSearchboolean
Default true
pageinteger(int32)
Default 1
pageSizeinteger(int32)
Default 10
curl -i -X GET \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/timecards/employees?id=string&employeeId=string&workplaceId=string&status=InProgress&search=string&includeId=true&includeEmployeeId=true&includeWorkplaceId=true&includeStatus=true&includeSearch=true&page=1&pageSize=10'

Responses

OK

Bodyapplication/json
hasResourcesboolean
totalResourcesinteger(int32)
totalPagesinteger(int32)
pageSizeinteger(int32)
currentPageinteger or null(int32)
previousPageinteger or null(int32)
nextPageinteger or null(int32)
resultsArray of objects or null(EmployeeTimecard)
Response
application/json
{
  "hasResources": true,
  "totalResources": 0,
  "totalPages": 0,
  "pageSize": 0,
  "currentPage": 0,
  "previousPage": 0,
  "nextPage": 0,
  "results": [
    { … }
  ]
}

Employee Clock In

Request

Path
companyIdstringrequired
Bodyapplication/jsonrequired
employeeIdstring
workplaceIdstring
notestring or null
curl -i -X POST \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/timecards/employees/clock_in' \
  -H 'Content-Type: application/json' \
  -d '{
    "employeeId": "string",
    "workplaceId": "string",
    "note": "string"
  }'

Responses

OK

Bodyapplication/json
idstring
employeeIdstring
workplaceIdstring
statusstring(TimecardStatus)
Enum"InProgress""Pending""Approved""Denied"
clockInNotestring or null
clockOutNotestring or null
clockInstring or null(date-time)
clockOutstring or null(date-time)
breaksArray of objects or null(EmployeeTimecardBreak)
changesArray of objects or null(EmployeeTimecardChange)
Response
application/json
{
  "id": "string",
  "employeeId": "string",
  "workplaceId": "string",
  "status": "InProgress",
  "clockInNote": "string",
  "clockOutNote": "string",
  "clockIn": "2019-08-24T14:15:22Z",
  "clockOut": "2019-08-24T14:15:22Z",
  "breaks": [
    { … }
  ],
  "changes": [
    { … }
  ]
}

Employee Clock Out

Request

Path
companyIdstringrequired
timecardIdstringrequired
Bodyapplication/jsonrequired
notestring or null
curl -i -X POST \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/timecards/employees/{timecardId}/clock_out' \
  -H 'Content-Type: application/json' \
  -d '{
    "note": "string"
  }'

Responses

OK

Bodyapplication/json
idstring
employeeIdstring
workplaceIdstring
statusstring(TimecardStatus)
Enum"InProgress""Pending""Approved""Denied"
clockInNotestring or null
clockOutNotestring or null
clockInstring or null(date-time)
clockOutstring or null(date-time)
breaksArray of objects or null(EmployeeTimecardBreak)
changesArray of objects or null(EmployeeTimecardChange)
Response
application/json
{
  "id": "string",
  "employeeId": "string",
  "workplaceId": "string",
  "status": "InProgress",
  "clockInNote": "string",
  "clockOutNote": "string",
  "clockIn": "2019-08-24T14:15:22Z",
  "clockOut": "2019-08-24T14:15:22Z",
  "breaks": [
    { … }
  ],
  "changes": [
    { … }
  ]
}

Employee Break Start

Request

Path
companyIdstringrequired
timecardIdstringrequired
Bodyapplication/jsonrequired
notestring or null
typestring(TimecardBreakType)
Enum"PaidMealBreak""UnpaidMealBreak""PaidRestBreak""UnpaidRestBreak"
curl -i -X POST \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/timecards/employees/{timecardId}/start_break' \
  -H 'Content-Type: application/json' \
  -d '{
    "note": "string",
    "type": "PaidMealBreak"
  }'

Responses

OK

Bodyapplication/json
idstring
acceptedStatusboolean
typestring(TimecardBreakType)
Enum"PaidMealBreak""UnpaidMealBreak""PaidRestBreak""UnpaidRestBreak"
breakStartNotestring or null
breakEndNotestring or null
breakStartstring or null(date-time)
breakEndstring or null(date-time)
changesArray of objects or null(EmployeeTimecardBreakChange)
Response
application/json
{
  "id": "string",
  "acceptedStatus": true,
  "type": "PaidMealBreak",
  "breakStartNote": "string",
  "breakEndNote": "string",
  "breakStart": "2019-08-24T14:15:22Z",
  "breakEnd": "2019-08-24T14:15:22Z",
  "changes": [
    { … }
  ]
}

Employee Break End

Request

Path
companyIdstringrequired
timecardIdstringrequired
Bodyapplication/jsonrequired
notestring or null
curl -i -X POST \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/timecards/employees/{timecardId}/end_break' \
  -H 'Content-Type: application/json' \
  -d '{
    "note": "string"
  }'

Responses

OK

Bodyapplication/json
idstring
acceptedStatusboolean
typestring(TimecardBreakType)
Enum"PaidMealBreak""UnpaidMealBreak""PaidRestBreak""UnpaidRestBreak"
breakStartNotestring or null
breakEndNotestring or null
breakStartstring or null(date-time)
breakEndstring or null(date-time)
changesArray of objects or null(EmployeeTimecardBreakChange)
Response
application/json
{
  "id": "string",
  "acceptedStatus": true,
  "type": "PaidMealBreak",
  "breakStartNote": "string",
  "breakEndNote": "string",
  "breakStart": "2019-08-24T14:15:22Z",
  "breakEnd": "2019-08-24T14:15:22Z",
  "changes": [
    { … }
  ]
}

Workplaces

Operations