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

Create Miscellaneous Deduction

Request

Path
companyIdstringrequired
Bodyapplication/jsonrequired
employeeIdstring
descriptionstring or null
effectiveStartstring(date)
effectiveEndstring or null(date)
amountnumber or null(double)
percentnumber or null(double)
annualLimitAmountnumber or null(double)
totalLimitAmountnumber or null(double)
curl -i -X POST \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/post_tax_deductions/miscellaneous' \
  -H 'Content-Type: application/json' \
  -d '{
    "employeeId": "string",
    "description": "string",
    "effectiveStart": "2019-08-24",
    "effectiveEnd": "2019-08-24",
    "amount": 0.1,
    "percent": 0.1,
    "annualLimitAmount": 0.1,
    "totalLimitAmount": 0.1
  }'

Responses

OK

Bodyapplication/json
idstring
employeeIdstring
sourcestring or null
descriptionstring or null
effectiveStartstring(date)
effectiveEndstring or null(date)
amountnumber or null(double)
percentnumber or null(double)
annualLimitAmountnumber or null(double)
totalLimitAmountnumber or null(double)
isExternalboolean
Response
application/json
{
  "id": "string",
  "employeeId": "string",
  "source": "string",
  "description": "string",
  "effectiveStart": "2019-08-24",
  "effectiveEnd": "2019-08-24",
  "amount": 0.1,
  "percent": 0.1,
  "annualLimitAmount": 0.1,
  "totalLimitAmount": 0.1,
  "isExternal": true
}

Query Miscellaneous Deductions

Request

Path
companyIdstringrequired
Query
idArray of stringsrequired
employeeIdstring
descriptionstring
effectivestring(date)
amountAbovenumber(double)
amountBelownumber(double)
percentAbovenumber(double)
percentBelownumber(double)
annualAbovenumber(double)
annualBelownumber(double)
totalAbovenumber(double)
totalBelownumber(double)
pageinteger(int32)
Default 1
pageSizeinteger(int32)
Default 10
curl -i -X GET \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/post_tax_deductions/miscellaneous?id=string&employeeId=string&description=string&effective=2019-08-24&amountAbove=0.1&amountBelow=0.1&percentAbove=0.1&percentBelow=0.1&annualAbove=0.1&annualBelow=0.1&totalAbove=0.1&totalBelow=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(MiscellaneousDeduction)
Response
application/json
{
  "hasResources": true,
  "totalResources": 0,
  "totalPages": 0,
  "pageSize": 0,
  "currentPage": 0,
  "previousPage": 0,
  "nextPage": 0,
  "results": [
    { … }
  ]
}

Get Miscellaneous Deduction

Request

Path
companyIdstringrequired
deductionIdstringrequired
curl -i -X GET \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/post_tax_deductions/miscellaneous/{deductionId}'

Responses

OK

Bodyapplication/json
idstring
employeeIdstring
sourcestring or null
descriptionstring or null
effectiveStartstring(date)
effectiveEndstring or null(date)
amountnumber or null(double)
percentnumber or null(double)
annualLimitAmountnumber or null(double)
totalLimitAmountnumber or null(double)
isExternalboolean
Response
application/json
{
  "id": "string",
  "employeeId": "string",
  "source": "string",
  "description": "string",
  "effectiveStart": "2019-08-24",
  "effectiveEnd": "2019-08-24",
  "amount": 0.1,
  "percent": 0.1,
  "annualLimitAmount": 0.1,
  "totalLimitAmount": 0.1,
  "isExternal": true
}

Update Miscellaneous Deduction

Request

Path
companyIdstringrequired
deductionIdstringrequired
Bodyapplication/jsonrequired
descriptionstring
effectiveStartstring(date)
effectiveEndstring(date)
amountnumber(double)
percentnumber(double)
annualLimitAmountnumber(double)
totalLimitAmountnumber(double)
curl -i -X PATCH \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/post_tax_deductions/miscellaneous/{deductionId}' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": "string",
    "effectiveStart": "2019-08-24",
    "effectiveEnd": "2019-08-24",
    "amount": 0.1,
    "percent": 0.1,
    "annualLimitAmount": 0.1,
    "totalLimitAmount": 0.1
  }'

Responses

OK

Bodyapplication/json
idstring
employeeIdstring
sourcestring or null
descriptionstring or null
effectiveStartstring(date)
effectiveEndstring or null(date)
amountnumber or null(double)
percentnumber or null(double)
annualLimitAmountnumber or null(double)
totalLimitAmountnumber or null(double)
isExternalboolean
Response
application/json
{
  "id": "string",
  "employeeId": "string",
  "source": "string",
  "description": "string",
  "effectiveStart": "2019-08-24",
  "effectiveEnd": "2019-08-24",
  "amount": 0.1,
  "percent": 0.1,
  "annualLimitAmount": 0.1,
  "totalLimitAmount": 0.1,
  "isExternal": true
}

Delete Miscellaneous Deduction

Request

Path
companyIdstringrequired
deductionIdstringrequired
curl -i -X DELETE \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/post_tax_deductions/miscellaneous/{deductionId}'

Responses

OK

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