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

Create Employee

Request

Path
companyIdstringrequired
Bodyapplication/jsonrequired
firstNamestring or nullrequired
middleNamestring or null
lastNamestring or nullrequired
emailstring or null
ssnstring or null
activeboolean
primaryWorkplaceIdstring or null
workplacesArray of strings or null
departmentIdstring or null
dateOfBirthstring or null(date)
startDatestring or null(date)
terminationDatestring or null(date)
defaultPaymentMethodstring(PaymentMethod)
Enum"DirectDeposit""Manual"
formW2ElectronicConsentboolean or null
residenceobject(CreateAddressRequest)
wageobject(CreateEmployeeWageRequest)
curl -i -X POST \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/employees' \
  -H 'Content-Type: application/json' \
  -d '{
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "email": "string",
    "ssn": "string",
    "active": true,
    "primaryWorkplaceId": "string",
    "workplaces": [
      "string"
    ],
    "departmentId": "string",
    "dateOfBirth": "2019-08-24",
    "startDate": "2019-08-24",
    "terminationDate": "2019-08-24",
    "defaultPaymentMethod": "DirectDeposit",
    "formW2ElectronicConsent": true,
    "residence": {
      "street1": "string",
      "street2": "string",
      "city": "string",
      "zipcode": "string",
      "state": "AL",
      "country": "US"
    },
    "wage": {
      "rate": 0.1,
      "period": "Hourly",
      "flsaOvertimeExemptionStatus": "NonExempt",
      "supplementalTaxMethod": "Flat",
      "fullTimeHours": 0.1
    }
  }'

Responses

OK

Bodyapplication/json
idstring
companyIdstring
codestring or null
firstNamestring or null
middleNamestring or null
lastNamestring or null
emailstring or null
ssnLastFourstring or null
ssnValidationStatusstring(SsnValidationStatus)
Enum"Pending""Invalid""Validated"
activeboolean
formW2ElectronicConsentboolean
dateOfBirthstring or null(date)
startDatestring or null(date)
terminationDatestring or null(date)
defaultPaymentMethodstring(PaymentMethod)
Enum"DirectDeposit""Manual"
defaultNetPaySplitstring or null
bankAccountsArray of strings or null
primaryWorkplaceIdstring or null
workplacesArray of objects or null(EmployeeWorkplace)
departmentobject(EmployeeDepartment)
residenceobject(Address)
wageobject(EmployeeWage)
onboardobject(EmployeeOnboard)
Response
application/json
{
  "id": "string",
  "companyId": "string",
  "code": "string",
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "email": "string",
  "ssnLastFour": "string",
  "ssnValidationStatus": "Pending",
  "active": true,
  "formW2ElectronicConsent": true,
  "dateOfBirth": "2019-08-24",
  "startDate": "2019-08-24",
  "terminationDate": "2019-08-24",
  "defaultPaymentMethod": "DirectDeposit",
  "defaultNetPaySplit": "string",
  "bankAccounts": [
    "string"
  ],
  "primaryWorkplaceId": "string",
  "workplaces": [
    { … }
  ],
  "department": {
    "id": "string",
    "name": "string"
  },
  "residence": {
    "street1": "string",
    "street2": "string",
    "city": "string",
    "zipcode": "string",
    "state": "AL",
    "country": "US"
  },
  "wage": {
    "rate": 0.1,
    "period": "Hourly",
    "flsaOvertimeExemptionStatus": "NonExempt",
    "supplementalTaxMethod": "Flat",
    "fullTimeHours": 0.1
  },
  "onboard": {
    "status": "Blocking",
    "blockingSteps": [ … ],
    "remainingSteps": [ … ],
    "ssn": [ … ],
    "paymentMethod": [ … ],
    "workplaces": [ … ],
    "employeeDetails": [ … ],
    "withholdings": [ … ],
    "companyDefinedAttributes": [ … ]
  }
}

Query Employees

Request

Path
companyIdstringrequired
Query
idArray of stringsrequired
workplaceIdArray of stringsrequired
departmentIdArray of stringsrequired
stateArray of strings(USState)required
Items Enum"AL""AK""AR""AZ""CA""CO""CT""DC""DE""FL"
searchstring
activeboolean
includeSearchboolean
Default true
includeIdboolean
Default true
includeWorkplaceIdboolean
Default true
includeDepartmentIdboolean
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}/employees?id=string&workplaceId=string&departmentId=string&state=AL&search=string&active=true&includeSearch=true&includeId=true&includeWorkplaceId=true&includeDepartmentId=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(Employee)
Response
application/json
{
  "hasResources": true,
  "totalResources": 0,
  "totalPages": 0,
  "pageSize": 0,
  "currentPage": 0,
  "previousPage": 0,
  "nextPage": 0,
  "results": [
    { … }
  ]
}

Get Employee

Request

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

Responses

OK

Bodyapplication/json
idstring
companyIdstring
codestring or null
firstNamestring or null
middleNamestring or null
lastNamestring or null
emailstring or null
ssnLastFourstring or null
ssnValidationStatusstring(SsnValidationStatus)
Enum"Pending""Invalid""Validated"
activeboolean
formW2ElectronicConsentboolean
dateOfBirthstring or null(date)
startDatestring or null(date)
terminationDatestring or null(date)
defaultPaymentMethodstring(PaymentMethod)
Enum"DirectDeposit""Manual"
defaultNetPaySplitstring or null
bankAccountsArray of strings or null
primaryWorkplaceIdstring or null
workplacesArray of objects or null(EmployeeWorkplace)
departmentobject(EmployeeDepartment)
residenceobject(Address)
wageobject(EmployeeWage)
onboardobject(EmployeeOnboard)
Response
application/json
{
  "id": "string",
  "companyId": "string",
  "code": "string",
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "email": "string",
  "ssnLastFour": "string",
  "ssnValidationStatus": "Pending",
  "active": true,
  "formW2ElectronicConsent": true,
  "dateOfBirth": "2019-08-24",
  "startDate": "2019-08-24",
  "terminationDate": "2019-08-24",
  "defaultPaymentMethod": "DirectDeposit",
  "defaultNetPaySplit": "string",
  "bankAccounts": [
    "string"
  ],
  "primaryWorkplaceId": "string",
  "workplaces": [
    { … }
  ],
  "department": {
    "id": "string",
    "name": "string"
  },
  "residence": {
    "street1": "string",
    "street2": "string",
    "city": "string",
    "zipcode": "string",
    "state": "AL",
    "country": "US"
  },
  "wage": {
    "rate": 0.1,
    "period": "Hourly",
    "flsaOvertimeExemptionStatus": "NonExempt",
    "supplementalTaxMethod": "Flat",
    "fullTimeHours": 0.1
  },
  "onboard": {
    "status": "Blocking",
    "blockingSteps": [ … ],
    "remainingSteps": [ … ],
    "ssn": [ … ],
    "paymentMethod": [ … ],
    "workplaces": [ … ],
    "employeeDetails": [ … ],
    "withholdings": [ … ],
    "companyDefinedAttributes": [ … ]
  }
}

Enrollment Profiles

Operations

Miscellaneous

Operations

Partners

Operations

Payment Schedules

Operations

Payrolls

Operations

Timecards

Operations

Workplaces

Operations