Earning Codes

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

Documents

Operations

Earning Codes

Operations

Create Earning Code

Request

Path
companyIdstringrequired
Bodyapplication/jsonrequired
namestring or null
typestring(EarningType)
Enum"Salaried""Hourly""Overtime""DoubleOvertime""PaidHoliday""PTO""Sick""NonHourlyRegular""Bonus""Commission"
activeboolean
curl -i -X POST \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/earning_codes' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "type": "Salaried",
    "active": true
  }'

Responses

OK

Bodyapplication/json
idstring
companyIdstring
typestring(EarningType)
Enum"Salaried""Hourly""Overtime""DoubleOvertime""PaidHoliday""PTO""Sick""NonHourlyRegular""Bonus""Commission"
namestring or null
activeboolean
Response
application/json
{
  "id": "string",
  "companyId": "string",
  "type": "Salaried",
  "name": "string",
  "active": true
}

Query Earning Codes

Request

Path
companyIdstringrequired
Query
idArray 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}/earning_codes?active=true&id=string&name=string&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(EarningCode)
Response
application/json
{
  "hasResources": true,
  "totalResources": 0,
  "totalPages": 0,
  "pageSize": 0,
  "currentPage": 0,
  "previousPage": 0,
  "nextPage": 0,
  "results": [
    { … }
  ]
}

Get Earning Code

Request

Path
companyIdstringrequired
earningCodeIdstringrequired
curl -i -X GET \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/earning_codes/{earningCodeId}'

Responses

OK

Bodyapplication/json
idstring
companyIdstring
typestring(EarningType)
Enum"Salaried""Hourly""Overtime""DoubleOvertime""PaidHoliday""PTO""Sick""NonHourlyRegular""Bonus""Commission"
namestring or null
activeboolean
Response
application/json
{
  "id": "string",
  "companyId": "string",
  "type": "Salaried",
  "name": "string",
  "active": true
}

Update Earning Code

Request

Path
companyIdstringrequired
earningCodeIdstringrequired
Bodyapplication/jsonrequired
activeboolean
curl -i -X PATCH \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/earning_codes/{earningCodeId}' \
  -H 'Content-Type: application/json' \
  -d '{
    "active": true
  }'

Responses

OK

Bodyapplication/json
idstring
companyIdstring
typestring(EarningType)
Enum"Salaried""Hourly""Overtime""DoubleOvertime""PaidHoliday""PTO""Sick""NonHourlyRegular""Bonus""Commission"
namestring or null
activeboolean
Response
application/json
{
  "id": "string",
  "companyId": "string",
  "type": "Salaried",
  "name": "string",
  "active": true
}

Employees

Operations

Partner Portfolio

Operations

Payment Schedules

Operations

Payrolls

Operations

Workplaces

Operations