Departments

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

Deductions - Child Support

Operations

Deductions - Miscellaneous

Operations

Departments

Operations

Create Department

Request

Path
companyIdstringrequired
Bodyapplication/jsonrequired
namestring or nullrequired
workplaceIdstring or null
employeesArray of strings or null
contractorsArray of strings or null
curl -i -X POST \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/departments' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "workplaceId": "string",
    "employees": [
      "string"
    ],
    "contractors": [
      "string"
    ]
  }'

Responses

OK

Bodyapplication/json
idstring
companyIdstring
workplaceobject(DepartmentWorkplace)
namestring or null
activeboolean
assignedEmployeesinteger(int32)
assignedContractorsinteger(int32)
Response
application/json
{
  "id": "string",
  "companyId": "string",
  "workplace": {
    "name": "string",
    "address": { … }
  },
  "name": "string",
  "active": true,
  "assignedEmployees": 0,
  "assignedContractors": 0
}

Query Departments

Request

Path
companyIdstringrequired
Query
idArray of stringsrequired
workplaceIdArray of stringsrequired
namestring
activeboolean
pageinteger(int32)
Default 1
pageSizeinteger(int32)
Default 10
curl -i -X GET \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/departments?active=true&id=string&name=string&page=1&pageSize=10&workplaceId=string'

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(Department)
Response
application/json
{
  "hasResources": true,
  "totalResources": 0,
  "totalPages": 0,
  "pageSize": 0,
  "currentPage": 0,
  "previousPage": 0,
  "nextPage": 0,
  "results": [
    { … }
  ]
}

Get Department

Request

Path
companyIdstringrequired
departmentIdstringrequired
curl -i -X GET \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/departments/{departmentId}'

Responses

OK

Bodyapplication/json
idstring
companyIdstring
workplaceobject(DepartmentWorkplace)
namestring or null
activeboolean
assignedEmployeesinteger(int32)
assignedContractorsinteger(int32)
Response
application/json
{
  "id": "string",
  "companyId": "string",
  "workplace": {
    "name": "string",
    "address": { … }
  },
  "name": "string",
  "active": true,
  "assignedEmployees": 0,
  "assignedContractors": 0
}

Update Department

Request

Path
companyIdstringrequired
departmentIdstringrequired
Bodyapplication/jsonrequired
namestring
activeboolean
workplaceIdstring
employeeIdsArray of strings or null
contractorIdsArray of strings or null
curl -i -X PATCH \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/departments/{departmentId}' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "active": true,
    "workplaceId": "string",
    "employeeIds": [
      "string"
    ],
    "contractorIds": [
      "string"
    ]
  }'

Responses

OK

Bodyapplication/json
idstring
companyIdstring
workplaceobject(DepartmentWorkplace)
namestring or null
activeboolean
assignedEmployeesinteger(int32)
assignedContractorsinteger(int32)
Response
application/json
{
  "id": "string",
  "companyId": "string",
  "workplace": {
    "name": "string",
    "address": { … }
  },
  "name": "string",
  "active": true,
  "assignedEmployees": 0,
  "assignedContractors": 0
}

Documents

Operations

Earning Codes

Operations

Employees

Operations

Partner Portfolio

Operations

Payment Schedules

Operations

Payrolls

Operations

Workplaces

Operations