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

Workplaces

Operations

Create Workplace

Request

Path
companyIdstringrequired
Bodyapplication/jsonrequired
namestring or null
activeboolean
addressobject(CreateAddressRequest)
timekeepingSettingsobject(CreateWorkplaceTimekeepingSettingsRequest)
curl -i -X POST \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/workplaces' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "active": true,
    "address": {
      "street1": "string",
      "street2": "string",
      "city": "string",
      "zipcode": "string",
      "state": "AL",
      "country": "US"
    },
    "timekeepingSettings": {
      "defaultTimeZoneId": "string",
      "dailyOvertimeHoursStart": 0.1,
      "weeklyOvertimeHoursStart": 0.1,
      "dailyDoubleOvertimeHoursStart": 0.1,
      "weeklyDoubleOvertimeHoursStart": 0.1,
      "enablePaidMealBreaks": true,
      "enablePaidRestBreaks": true
    }
  }'

Responses

OK

Bodyapplication/json
idstring
companyIdstring
namestring or null
activeboolean
addressobject(Address)
timekeepingSettingsobject(WorkplaceTimekeepingSettings)
Response
application/json
{
  "id": "string",
  "companyId": "string",
  "name": "string",
  "active": true,
  "address": {
    "street1": "string",
    "street2": "string",
    "city": "string",
    "zipcode": "string",
    "state": "AL",
    "country": "US"
  },
  "timekeepingSettings": {
    "dailyOvertimeHoursStart": 0.1,
    "weeklyOvertimeHoursStart": 0.1,
    "dailyDoubleOvertimeHoursStart": 0.1,
    "weeklyDoubleOvertimeHoursStart": 0.1,
    "enablePaidMealBreaks": true,
    "enablePaidRestBreaks": true,
    "defaultTimeZoneId": "string"
  }
}

Query Workplaces

Request

Path
companyIdstringrequired
Query
idArray of stringsrequired
searchstring
activeboolean
stateArray of strings(USState)required
Items Enum"AL""AK""AR""AZ""CA""CO""CT""DC""DE""FL"
includeIdboolean
Default true
includeSearchboolean
Default true
includeStateboolean
Default true
pageinteger(int32)
Default 1
pageSizeinteger(int32)
Default 10
curl -i -X GET \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/workplaces?id=string&search=string&active=true&state=AL&includeId=true&includeSearch=true&includeState=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(Workplace)
Response
application/json
{
  "hasResources": true,
  "totalResources": 0,
  "totalPages": 0,
  "pageSize": 0,
  "currentPage": 0,
  "previousPage": 0,
  "nextPage": 0,
  "results": [
    { … }
  ]
}

Get Workplace

Request

Path
companyIdstringrequired
workplaceIdstringrequired
curl -i -X GET \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/workplaces/{workplaceId}'

Responses

OK

Bodyapplication/json
idstring
companyIdstring
namestring or null
activeboolean
addressobject(Address)
timekeepingSettingsobject(WorkplaceTimekeepingSettings)
Response
application/json
{
  "id": "string",
  "companyId": "string",
  "name": "string",
  "active": true,
  "address": {
    "street1": "string",
    "street2": "string",
    "city": "string",
    "zipcode": "string",
    "state": "AL",
    "country": "US"
  },
  "timekeepingSettings": {
    "dailyOvertimeHoursStart": 0.1,
    "weeklyOvertimeHoursStart": 0.1,
    "dailyDoubleOvertimeHoursStart": 0.1,
    "weeklyDoubleOvertimeHoursStart": 0.1,
    "enablePaidMealBreaks": true,
    "enablePaidRestBreaks": true,
    "defaultTimeZoneId": "string"
  }
}

Update Workplace

Request

Path
companyIdstringrequired
workplaceIdstringrequired
Bodyapplication/jsonrequired
namestring
activeboolean
addressobject(UpdateAddressRequest)
timekeepingSettingsobject(UpdateWorkplaceTimekeepingSettingsRequest)
curl -i -X PATCH \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/workplaces/{workplaceId}' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "active": true,
    "address": {
      "street1": "string",
      "street2": "string",
      "city": "string",
      "zipcode": "string",
      "state": "string",
      "country": "string"
    },
    "timekeepingSettings": {
      "defaultTimeZoneId": "string",
      "dailyOvertimeHoursStart": 0.1,
      "weeklyOvertimeHoursStart": 0.1,
      "dailyDoubleOvertimeHoursStart": 0.1,
      "weeklyDoubleOvertimeHoursStart": 0.1,
      "enablePaidMealBreaks": true,
      "enablePaidRestBreaks": true
    }
  }'

Responses

OK

Bodyapplication/json
idstring
companyIdstring
namestring or null
activeboolean
addressobject(Address)
timekeepingSettingsobject(WorkplaceTimekeepingSettings)
Response
application/json
{
  "id": "string",
  "companyId": "string",
  "name": "string",
  "active": true,
  "address": {
    "street1": "string",
    "street2": "string",
    "city": "string",
    "zipcode": "string",
    "state": "AL",
    "country": "US"
  },
  "timekeepingSettings": {
    "dailyOvertimeHoursStart": 0.1,
    "weeklyOvertimeHoursStart": 0.1,
    "dailyDoubleOvertimeHoursStart": 0.1,
    "weeklyDoubleOvertimeHoursStart": 0.1,
    "enablePaidMealBreaks": true,
    "enablePaidRestBreaks": true,
    "defaultTimeZoneId": "string"
  }
}