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

Create Contractor

Request

Path
companyIdstringrequired
Bodyapplication/jsonrequired
firstNamestring or null
middleNamestring or null
lastNamestring or null
businessNamestring or null
emailstring or null
ssnstring or null
einstring or null
departmentIdstring or null
primaryWorkplaceIdstring or null
workplacesArray of strings or null
dateOfBirthstring or null(date)
startDatestring or null(date)
terminationDatestring or null(date)
typestring(ContractorType)
Enum"Individual""Business"
defaultPaymentMethodstring(PaymentMethod)
Enum"DirectDeposit""Manual"
form1099ElectronicConsentboolean
activeboolean
addressobject(CreateAddressRequest)
wageobject(CreateContractorWageRequest)
curl -i -X POST \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/contractors' \
  -H 'Content-Type: application/json' \
  -d '{
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "businessName": "string",
    "email": "string",
    "ssn": "string",
    "ein": "string",
    "departmentId": "string",
    "primaryWorkplaceId": "string",
    "workplaces": [
      "string"
    ],
    "dateOfBirth": "2019-08-24",
    "startDate": "2019-08-24",
    "terminationDate": "2019-08-24",
    "type": "Individual",
    "defaultPaymentMethod": "DirectDeposit",
    "form1099ElectronicConsent": true,
    "active": true,
    "address": {
      "street1": "string",
      "street2": "string",
      "city": "string",
      "zipcode": "string",
      "state": "AL",
      "country": "US"
    },
    "wage": {
      "rate": 0.1,
      "period": "Hourly"
    }
  }'

Responses

OK

Bodyapplication/json
idstring
companyIdstring
firstNamestring or null
middleNamestring or null
lastNamestring or null
businessNamestring or null
emailstring or null
einstring or null
ssnLastFourstring or null
ssnValidationStatusstring(SsnValidationStatus)
Enum"Pending""Invalid""Validated"
dateOfBirthstring or null(date)
startDatestring or null(date)
terminationDatestring or null(date)
typestring(ContractorType)
Enum"Individual""Business"
defaultPaymentMethodstring(PaymentMethod)
Enum"DirectDeposit""Manual"
defaultNetPaySplitstring or null
bankAccountsArray of strings or null
primaryWorkplacestring or null
workplacesArray of objects or null(ContractorWorkplace)
departmentobject(ContractorDepartment)
addressobject(Address)
wageobject(ContractorWage)
onboardobject(ContractorOnboard)
form1099ElectronicConsentboolean
activeboolean
Response
application/json
{
  "id": "string",
  "companyId": "string",
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "businessName": "string",
  "email": "string",
  "ein": "string",
  "ssnLastFour": "string",
  "ssnValidationStatus": "Pending",
  "dateOfBirth": "2019-08-24",
  "startDate": "2019-08-24",
  "terminationDate": "2019-08-24",
  "type": "Individual",
  "defaultPaymentMethod": "DirectDeposit",
  "defaultNetPaySplit": "string",
  "bankAccounts": [
    "string"
  ],
  "primaryWorkplace": "string",
  "workplaces": [
    { … }
  ],
  "department": {
    "id": "string",
    "name": "string"
  },
  "address": {
    "street1": "string",
    "street2": "string",
    "city": "string",
    "zipcode": "string",
    "state": "AL",
    "country": "US"
  },
  "wage": {
    "rate": 0.1,
    "period": "Hourly"
  },
  "onboard": {
    "status": "Blocking",
    "blockingSteps": [ … ],
    "remainingSteps": [ … ],
    "type": [ … ],
    "ssn": [ … ],
    "ein": [ … ],
    "paymentMethod": [ … ]
  },
  "form1099ElectronicConsent": true,
  "active": true
}

Query Contractors

Request

Path
companyIdstringrequired
Query
idArray of stringsrequired
workplaceIdArray of stringsrequired
departmentIdArray of stringsrequired
stateArray of strings(USState)required
Items Enum"AL""AK""AR""AZ""CA""CO""CT""DC""DE""FL"
searchstring
activeboolean
includeSearchboolean
Default true
includeIdboolean
Default true
includeWorkplaceIdboolean
Default true
includeDepartmentIdboolean
Default true
includeStateboolean
Default true
pageinteger(int32)
Default 1
pageSizeinteger(int32)
Default 10
curl -i -X GET \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/contractors?id=string&workplaceId=string&departmentId=string&state=AL&search=string&active=true&includeSearch=true&includeId=true&includeWorkplaceId=true&includeDepartmentId=true&includeState=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(Contractor)
Response
application/json
{
  "hasResources": true,
  "totalResources": 0,
  "totalPages": 0,
  "pageSize": 0,
  "currentPage": 0,
  "previousPage": 0,
  "nextPage": 0,
  "results": [
    { … }
  ]
}

Get Contractor

Request

Path
companyIdstringrequired
contractorIdstringrequired
curl -i -X GET \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/contractors/{contractorId}'

Responses

OK

Bodyapplication/json
idstring
companyIdstring
firstNamestring or null
middleNamestring or null
lastNamestring or null
businessNamestring or null
emailstring or null
einstring or null
ssnLastFourstring or null
ssnValidationStatusstring(SsnValidationStatus)
Enum"Pending""Invalid""Validated"
dateOfBirthstring or null(date)
startDatestring or null(date)
terminationDatestring or null(date)
typestring(ContractorType)
Enum"Individual""Business"
defaultPaymentMethodstring(PaymentMethod)
Enum"DirectDeposit""Manual"
defaultNetPaySplitstring or null
bankAccountsArray of strings or null
primaryWorkplacestring or null
workplacesArray of objects or null(ContractorWorkplace)
departmentobject(ContractorDepartment)
addressobject(Address)
wageobject(ContractorWage)
onboardobject(ContractorOnboard)
form1099ElectronicConsentboolean
activeboolean
Response
application/json
{
  "id": "string",
  "companyId": "string",
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "businessName": "string",
  "email": "string",
  "ein": "string",
  "ssnLastFour": "string",
  "ssnValidationStatus": "Pending",
  "dateOfBirth": "2019-08-24",
  "startDate": "2019-08-24",
  "terminationDate": "2019-08-24",
  "type": "Individual",
  "defaultPaymentMethod": "DirectDeposit",
  "defaultNetPaySplit": "string",
  "bankAccounts": [
    "string"
  ],
  "primaryWorkplace": "string",
  "workplaces": [
    { … }
  ],
  "department": {
    "id": "string",
    "name": "string"
  },
  "address": {
    "street1": "string",
    "street2": "string",
    "city": "string",
    "zipcode": "string",
    "state": "AL",
    "country": "US"
  },
  "wage": {
    "rate": 0.1,
    "period": "Hourly"
  },
  "onboard": {
    "status": "Blocking",
    "blockingSteps": [ … ],
    "remainingSteps": [ … ],
    "type": [ … ],
    "ssn": [ … ],
    "ein": [ … ],
    "paymentMethod": [ … ]
  },
  "form1099ElectronicConsent": true,
  "active": true
}

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