Encompass.Api (1.0)

Download OpenAPI description

sandbox.json

sandbox.yaml

Servers

Mock server

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

Benefits - Company

Operations

Benefits - Employee

Operations

Create Employee Benefit

Request

Path

companyIdstringrequired

Bodyapplication/jsonrequired

descriptionstring or null

employeeIdstring

companyBenefitIdstring or null

effectiveStartstring or null(date)

effectiveEndstring(date)

typestring(BenefitType)

Enum"Medical125""Vision125""Dental125""Disability125""Accident125""Cancer125""CriticalIllness125""Hospital125""Life125""Pension401K"

hsaContributionLimitstring(HsaContributionLimit)

Enum"Single""Family"

periodstring

employeeContributionAmountnumber or null(double)

employeeContributionPercentnumber or null(double)

companyContributionAmountnumber or null(double)

companyContributionPercentnumber or null(double)

curl -i -X POST \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/benefits/employee' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": "string",
    "employeeId": "string",
    "companyBenefitId": "string",
    "effectiveStart": "2019-08-24",
    "effectiveEnd": "2019-08-24",
    "type": "Medical125",
    "hsaContributionLimit": "Single",
    "period": "string",
    "employeeContributionAmount": 0.1,
    "employeeContributionPercent": 0.1,
    "companyContributionAmount": 0.1,
    "companyContributionPercent": 0.1
  }'

Responses

Bodyapplication/json

idstring

employeeIdstring

companyBenefitIdstring or null

sourcestring or null

descriptionstring or null

effectiveStartstring(date)

effectiveEndstring or null(date)

typestring(BenefitType)

Enum"Medical125""Vision125""Dental125""Disability125""Accident125""Cancer125""CriticalIllness125""Hospital125""Life125""Pension401K"

hsaContributionLimitstring(HsaContributionLimit)

Enum"Single""Family"

periodstring(BenefitPeriod)

Value"Monthly"

employeeContributionAmountnumber or null(double)

employeeContributionPercentnumber or null(double)

companyContributionAmountnumber or null(double)

companyContributionPercentnumber or null(double)

isExternalboolean

Response

application/json

{
  "id": "string",
  "employeeId": "string",
  "companyBenefitId": "string",
  "source": "string",
  "description": "string",
  "effectiveStart": "2019-08-24",
  "effectiveEnd": "2019-08-24",
  "type": "Medical125",
  "hsaContributionLimit": "Single",
  "period": "Monthly",
  "employeeContributionAmount": 0.1,
  "employeeContributionPercent": 0.1,
  "companyContributionAmount": 0.1,
  "companyContributionPercent": 0.1,
  "isExternal": true
}

Query Employee Benefits

Request

Path

companyIdstringrequired

Query

idArray of stringsrequired

employeeIdstring

descriptionstring

periodstring(BenefitPeriod)

Value"Monthly"

typestring(BenefitType)

Enum"Medical125""Vision125""Dental125""Disability125""Accident125""Cancer125""CriticalIllness125""Hospital125""Life125""Pension401K"

hsaContributionLimitstring(HsaContributionLimit)

Enum"Single""Family"

effectivestring(date)

employeeContributionAmountAbovenumber(double)

employeeContributionPercentAbovenumber(double)

companyContributionAmountAbovenumber(double)

companyContributionPercentAbovenumber(double)

employeeContributionAmountBelownumber(double)

employeeContributionPercentBelownumber(double)

companyContributionAmountBelownumber(double)

companyContributionPercentBelownumber(double)

pageinteger(int32)

Default 1

pageSizeinteger(int32)

Default 10

curl -i -X GET \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/benefits/employee?companyContributionAmountAbove=0.1&companyContributionAmountBelow=0.1&companyContributionPercentAbove=0.1&companyContributionPercentBelow=0.1&description=string&effective=2019-08-24&employeeContributionAmountAbove=0.1&employeeContributionAmountBelow=0.1&employeeContributionPercentAbove=0.1&employeeContributionPercentBelow=0.1&employeeId=string&hsaContributionLimit=Single&id=string&page=1&pageSize=10&period=Monthly&type=Medical125'

Responses

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(EmployeeBenefit)

Response

application/json

{
  "hasResources": true,
  "totalResources": 0,
  "totalPages": 0,
  "pageSize": 0,
  "currentPage": 0,
  "previousPage": 0,
  "nextPage": 0,
  "results": [
    { … }
  ]
}

Get Employee Benefit

Request

Path

companyIdstringrequired

benefitIdstringrequired

curl -i -X GET \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/benefits/employee/{benefitId}'

Responses

Bodyapplication/json

idstring

employeeIdstring

companyBenefitIdstring or null

sourcestring or null

descriptionstring or null

effectiveStartstring(date)

effectiveEndstring or null(date)

typestring(BenefitType)

Enum"Medical125""Vision125""Dental125""Disability125""Accident125""Cancer125""CriticalIllness125""Hospital125""Life125""Pension401K"

hsaContributionLimitstring(HsaContributionLimit)

Enum"Single""Family"

periodstring(BenefitPeriod)

Value"Monthly"

employeeContributionAmountnumber or null(double)

employeeContributionPercentnumber or null(double)

companyContributionAmountnumber or null(double)

companyContributionPercentnumber or null(double)

isExternalboolean

Response

application/json

{
  "id": "string",
  "employeeId": "string",
  "companyBenefitId": "string",
  "source": "string",
  "description": "string",
  "effectiveStart": "2019-08-24",
  "effectiveEnd": "2019-08-24",
  "type": "Medical125",
  "hsaContributionLimit": "Single",
  "period": "Monthly",
  "employeeContributionAmount": 0.1,
  "employeeContributionPercent": 0.1,
  "companyContributionAmount": 0.1,
  "companyContributionPercent": 0.1,
  "isExternal": true
}

Update Employee Benefit

Request

Path

companyIdstringrequired

benefitIdstringrequired

Bodyapplication/jsonrequired

descriptionstring

effectiveStartstring(date)

effectiveEndstring(date)

periodstring

hsaContributionLimitstring

employeeContributionAmountnumber(double)

employeeContributionPercentnumber(double)

companyContributionAmountnumber(double)

companyContributionPercentnumber(double)

curl -i -X PATCH \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/benefits/employee/{benefitId}' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": "string",
    "effectiveStart": "2019-08-24",
    "effectiveEnd": "2019-08-24",
    "period": "string",
    "hsaContributionLimit": "string",
    "employeeContributionAmount": 0.1,
    "employeeContributionPercent": 0.1,
    "companyContributionAmount": 0.1,
    "companyContributionPercent": 0.1
  }'

Responses

Bodyapplication/json

idstring

employeeIdstring

companyBenefitIdstring or null

sourcestring or null

descriptionstring or null

effectiveStartstring(date)

effectiveEndstring or null(date)

typestring(BenefitType)

Enum"Medical125""Vision125""Dental125""Disability125""Accident125""Cancer125""CriticalIllness125""Hospital125""Life125""Pension401K"

hsaContributionLimitstring(HsaContributionLimit)

Enum"Single""Family"

periodstring(BenefitPeriod)

Value"Monthly"

employeeContributionAmountnumber or null(double)

employeeContributionPercentnumber or null(double)

companyContributionAmountnumber or null(double)

companyContributionPercentnumber or null(double)

isExternalboolean

Response

application/json

{
  "id": "string",
  "employeeId": "string",
  "companyBenefitId": "string",
  "source": "string",
  "description": "string",
  "effectiveStart": "2019-08-24",
  "effectiveEnd": "2019-08-24",
  "type": "Medical125",
  "hsaContributionLimit": "Single",
  "period": "Monthly",
  "employeeContributionAmount": 0.1,
  "employeeContributionPercent": 0.1,
  "companyContributionAmount": 0.1,
  "companyContributionPercent": 0.1,
  "isExternal": true
}

Delete Employee Benefit

Request

Path

companyIdstringrequired

benefitIdstringrequired

curl -i -X DELETE \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/benefits/employee/{benefitId}'

Responses

Companies

Operations

Contractors

Operations

Deductions - Child Support

Operations

Deductions - Miscellaneous

Operations

Departments

Operations

Documents

Operations

Earning Codes

Operations

Employees

Operations

Partner Portfolio

Operations

Payment Schedules

Operations

Payrolls

Operations

Workplaces

Operations

Encompass.Api (1.0)

Benefits - Company

Benefits - Employee

Create Employee Benefit

Request

Responses

Was this helpful?

Query Employee Benefits

Request

Responses

Was this helpful?

Get Employee Benefit

Request

Responses

Was this helpful?

Update Employee Benefit

Request

Responses

Was this helpful?

Delete Employee Benefit

Request

Responses

Was this helpful?

Companies

Contractors

Deductions - Child Support

Deductions - Miscellaneous

Departments

Documents

Earning Codes

Employees

Partner Portfolio

Payment Schedules

Payrolls

Workplaces