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

Enrollment Profiles

Operations

Miscellaneous

Operations

Partners

Operations

Payment Schedules

Operations

Create Payment Schedule

Request

Path
companyIdstringrequired
Bodyapplication/jsonrequired
namestring or nullrequired
activebooleanrequired
frequencystring(PayFrequency)required
Enum"Weekly""Biweekly""Semimonthly""Monthly""Quarterly""Annually"
firstPeriodEndstring(date)required
firstPaydaystring(date)required
secondPaydaystring or null(date)
curl -i -X POST \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/payment_schedules' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "active": true,
    "frequency": "Weekly",
    "firstPeriodEnd": "2019-08-24",
    "firstPayday": "2019-08-24",
    "secondPayday": "2019-08-24"
  }'

Responses

OK

Bodyapplication/json
idstring
companyIdstring
activeboolean
namestring or null
frequencystring(PayFrequency)
Enum"Weekly""Biweekly""Semimonthly""Monthly""Quarterly""Annually"
firstPeriodEndstring(date-time)
firstPaydaystring(date-time)
secondPaydaystring or null(date-time)
Response
application/json
{
  "id": "string",
  "companyId": "string",
  "active": true,
  "name": "string",
  "frequency": "Weekly",
  "firstPeriodEnd": "2019-08-24T14:15:22Z",
  "firstPayday": "2019-08-24T14:15:22Z",
  "secondPayday": "2019-08-24T14:15:22Z"
}

Query Payment Schedules

Request

Path
companyIdstringrequired
Query
idArray of stringsrequired
activeboolean
pageinteger(int32)
Default 1
pageSizeinteger(int32)
Default 10
curl -i -X GET \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/payment_schedules?id=string&active=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(PaymentSchedule)
Response
application/json
{
  "hasResources": true,
  "totalResources": 0,
  "totalPages": 0,
  "pageSize": 0,
  "currentPage": 0,
  "previousPage": 0,
  "nextPage": 0,
  "results": [
    { … }
  ]
}

Get Payment Schedule

Request

Path
companyIdstringrequired
paymentScheduleIdstringrequired
curl -i -X GET \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/payment_schedules/{paymentScheduleId}'

Responses

OK

Bodyapplication/json
idstring
companyIdstring
activeboolean
namestring or null
frequencystring(PayFrequency)
Enum"Weekly""Biweekly""Semimonthly""Monthly""Quarterly""Annually"
firstPeriodEndstring(date-time)
firstPaydaystring(date-time)
secondPaydaystring or null(date-time)
Response
application/json
{
  "id": "string",
  "companyId": "string",
  "active": true,
  "name": "string",
  "frequency": "Weekly",
  "firstPeriodEnd": "2019-08-24T14:15:22Z",
  "firstPayday": "2019-08-24T14:15:22Z",
  "secondPayday": "2019-08-24T14:15:22Z"
}

Update Payment Schedule

Request

Path
companyIdstringrequired
paymentScheduleIdstringrequired
Bodyapplication/jsonrequired
namestring or null
frequencystring(PayFrequency)
Enum"Weekly""Biweekly""Semimonthly""Monthly""Quarterly""Annually"
firstPeriodEndstring or null(date)
firstPaydaystring or null(date)
secondPaydaystring or null(date)
activeboolean or null
curl -i -X PATCH \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/payment_schedules/{paymentScheduleId}' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "frequency": "Weekly",
    "firstPeriodEnd": "2019-08-24",
    "firstPayday": "2019-08-24",
    "secondPayday": "2019-08-24",
    "active": true
  }'

Responses

OK

Bodyapplication/json
idstring
companyIdstring
activeboolean
namestring or null
frequencystring(PayFrequency)
Enum"Weekly""Biweekly""Semimonthly""Monthly""Quarterly""Annually"
firstPeriodEndstring(date-time)
firstPaydaystring(date-time)
secondPaydaystring or null(date-time)
Response
application/json
{
  "id": "string",
  "companyId": "string",
  "active": true,
  "name": "string",
  "frequency": "Weekly",
  "firstPeriodEnd": "2019-08-24T14:15:22Z",
  "firstPayday": "2019-08-24T14:15:22Z",
  "secondPayday": "2019-08-24T14:15:22Z"
}

Get Payment Schedule Paydays

Request

Path
companyIdstringrequired
paymentScheduleIdstringrequired
Query
startDatestring(date)
curl -i -X GET \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/payment_schedules/{paymentScheduleId}/paydays?startDate=2019-08-24'

Responses

OK

Bodyapplication/json
previousPagestring or null
nextPagestring or null
resultsArray of objects or null(ScheduledPayday)
Response
application/json
{
  "previousPage": "string",
  "nextPage": "string",
  "results": [
    { … }
  ]
}

Payrolls

Operations

Timecards

Operations

Workplaces

Operations