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

Create Company Benefit

Request

Path
companyIdstringrequired
Bodyapplication/jsonrequired
descriptionstring or null
effectiveStartstring(date)
effectiveEndstring or null(date)
typestring(BenefitType)
Enum"Medical125""Vision125""Dental125""Disability125""Accident125""Cancer125""CriticalIllness125""Hospital125""Life125""Pension401K"
periodstring(BenefitPeriod)
Value"Monthly"
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/company' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": "string",
    "effectiveStart": "2019-08-24",
    "effectiveEnd": "2019-08-24",
    "type": "Medical125",
    "period": "Monthly",
    "employeeContributionAmount": 0.1,
    "employeeContributionPercent": 0.1,
    "companyContributionAmount": 0.1,
    "companyContributionPercent": 0.1
  }'

Responses

OK

Bodyapplication/json
idstring
companyIdstring
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"
periodstring(BenefitPeriod)
Value"Monthly"
employeeContributionAmountnumber or null(double)
employeeContributionPercentnumber or null(double)
companyContributionAmountnumber or null(double)
companyContributionPercentnumber or null(double)
associatedEmployeeBenefitsinteger(int32)
Response
application/json
{
  "id": "string",
  "companyId": "string",
  "source": "string",
  "description": "string",
  "effectiveStart": "2019-08-24",
  "effectiveEnd": "2019-08-24",
  "type": "Medical125",
  "period": "Monthly",
  "employeeContributionAmount": 0.1,
  "employeeContributionPercent": 0.1,
  "companyContributionAmount": 0.1,
  "companyContributionPercent": 0.1,
  "associatedEmployeeBenefits": 0
}

Query Company Benefits

Request

Path
companyIdstringrequired
Query
idArray of stringsrequired
descriptionstring
periodstring(BenefitPeriod)
Value"Monthly"
typestring(BenefitType)
Enum"Medical125""Vision125""Dental125""Disability125""Accident125""Cancer125""CriticalIllness125""Hospital125""Life125""Pension401K"
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/company?id=string&description=string&period=Monthly&type=Medical125&effective=2019-08-24&employeeContributionAmountAbove=0.1&employeeContributionPercentAbove=0.1&companyContributionAmountAbove=0.1&companyContributionPercentAbove=0.1&employeeContributionAmountBelow=0.1&employeeContributionPercentBelow=0.1&companyContributionAmountBelow=0.1&companyContributionPercentBelow=0.1&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(CompanyBenefit)
Response
application/json
{
  "hasResources": true,
  "totalResources": 0,
  "totalPages": 0,
  "pageSize": 0,
  "currentPage": 0,
  "previousPage": 0,
  "nextPage": 0,
  "results": [
    { … }
  ]
}

Get Company Benefit

Request

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

Responses

OK

Bodyapplication/json
idstring
companyIdstring
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"
periodstring(BenefitPeriod)
Value"Monthly"
employeeContributionAmountnumber or null(double)
employeeContributionPercentnumber or null(double)
companyContributionAmountnumber or null(double)
companyContributionPercentnumber or null(double)
associatedEmployeeBenefitsinteger(int32)
Response
application/json
{
  "id": "string",
  "companyId": "string",
  "source": "string",
  "description": "string",
  "effectiveStart": "2019-08-24",
  "effectiveEnd": "2019-08-24",
  "type": "Medical125",
  "period": "Monthly",
  "employeeContributionAmount": 0.1,
  "employeeContributionPercent": 0.1,
  "companyContributionAmount": 0.1,
  "companyContributionPercent": 0.1,
  "associatedEmployeeBenefits": 0
}

Update Company Benefit

Request

Path
companyIdstringrequired
benefitIdstringrequired
Bodyapplication/jsonrequired
descriptionstring
effectiveStartstring(date)
effectiveEndstring(date)
employeeContributionAmountnumber(double)
employeeContributionPercentnumber(double)
companyContributionAmountnumber(double)
companyContributionPercentnumber(double)
periodstring
curl -i -X PATCH \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/benefits/company/{benefitId}' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": "string",
    "effectiveStart": "2019-08-24",
    "effectiveEnd": "2019-08-24",
    "employeeContributionAmount": 0.1,
    "employeeContributionPercent": 0.1,
    "companyContributionAmount": 0.1,
    "companyContributionPercent": 0.1,
    "period": "string"
  }'

Responses

OK

Bodyapplication/json
idstring
companyIdstring
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"
periodstring(BenefitPeriod)
Value"Monthly"
employeeContributionAmountnumber or null(double)
employeeContributionPercentnumber or null(double)
companyContributionAmountnumber or null(double)
companyContributionPercentnumber or null(double)
associatedEmployeeBenefitsinteger(int32)
Response
application/json
{
  "id": "string",
  "companyId": "string",
  "source": "string",
  "description": "string",
  "effectiveStart": "2019-08-24",
  "effectiveEnd": "2019-08-24",
  "type": "Medical125",
  "period": "Monthly",
  "employeeContributionAmount": 0.1,
  "employeeContributionPercent": 0.1,
  "companyContributionAmount": 0.1,
  "companyContributionPercent": 0.1,
  "associatedEmployeeBenefits": 0
}

Delete Company Benefit

Request

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

Responses

OK

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