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

Create Company

Request

Bodyapplication/jsonrequired
legalNamestring or null
tradeNamestring or null
emailstring or null
phonestring or null
taxIdstring or null
legalTypestring(CompanyLegalType)
Enum"SoleProprietorship""LimitedLiabilityCompany""Partnership""NonProfitOrganization""GovernmentOrganization""CCorporation""SCorporation"
addressobject(CreateAddressRequest)
curl -i -X POST \
  https://docs.encompassfi.com/_mock/reference/sandbox/companies \
  -H 'Content-Type: application/json' \
  -d '{
    "legalName": "string",
    "tradeName": "string",
    "email": "string",
    "phone": "string",
    "taxId": "string",
    "legalType": "SoleProprietorship",
    "address": {
      "street1": "string",
      "street2": "string",
      "city": "string",
      "zipcode": "string",
      "state": "AL",
      "country": "US"
    }
  }'

Responses

OK

Bodyapplication/json
idstring
legalNamestring or null
tradeNamestring or null
emailstring or null
phonestring or null
websitestring or null
taxIdstring or null
timekeepingCodestring or null
deactivationReasonstring or null
acceptedTermsboolean
legalTypestring(CompanyLegalType)
Enum"SoleProprietorship""LimitedLiabilityCompany""Partnership""NonProfitOrganization""GovernmentOrganization""CCorporation""SCorporation"
industrystring(CompanyIndustry)
Enum"GeneralConstructionGeneralContracting""HvacPlumbingAndElectricalContracting""FoodAndBeverageRetailAndWholesale""ArtsEntertainmentAndRecreation""ScientificAndTechnicalServices""NonFoodRetailAndWholesale""HospitalityAccommodation""TobaccoOrAlcoholSales""PersonalCareServices""EducationalServices"
statusstring(CompanyStatus)
Enum"Active""Fraud""Closed""Duplicate"
addressobject(Address)
createdstring(date-time)
termsAcceptedAtstring or null(date-time)
payrollDetailsobject(CompanyPayrollDetails)
merchantDetailsobject(CompanyMerchantDetails)
Response
application/json
{
  "id": "string",
  "legalName": "string",
  "tradeName": "string",
  "email": "string",
  "phone": "string",
  "website": "string",
  "taxId": "string",
  "timekeepingCode": "string",
  "deactivationReason": "string",
  "acceptedTerms": true,
  "legalType": "SoleProprietorship",
  "industry": "GeneralConstructionGeneralContracting",
  "status": "Active",
  "address": {
    "street1": "string",
    "street2": "string",
    "city": "string",
    "zipcode": "string",
    "state": "AL",
    "country": "US"
  },
  "created": "2019-08-24T14:15:22Z",
  "termsAcceptedAt": "2019-08-24T14:15:22Z",
  "payrollDetails": {
    "activated": true,
    "canBoardPayroll": true,
    "onboardingStartedAt": "2019-08-24T14:15:22Z",
    "onboardingCompletedAt": "2019-08-24T14:15:22Z",
    "completedItems": [ … ],
    "terminated": true,
    "inGoodStanding": true,
    "startDate": "2019-08-24",
    "payFrequency": "Weekly",
    "processingPeriod": "FourDay",
    "employeeW2DeliveryMethod": "PrintAndMailAll",
    "contractor1099DeliveryMethod": "PrintAndMailAll",
    "onboardDetails": { … },
    "implementationDetails": { … }
  },
  "merchantDetails": {
    "deliveryPolicyUrl": "string",
    "returnPolicyUrl": "string",
    "termsOfServiceUrl": "string",
    "activated": true,
    "canBoardMerchants": true,
    "onboardingStartedAt": "2019-08-24T14:15:22Z",
    "onboardingCompletedAt": "2019-08-24T14:15:22Z",
    "onboardingStatus": "NotStarted"
  }
}

Queries Companies

Request

Query
idArray of stringsrequired
corporationIdArray of stringsrequired
partnerIdArray of stringsrequired
statusstring(CompanyStatus)
Enum"Active""Fraud""Closed""Duplicate"
searchstring
includeIdboolean
Default true
includeCorporationIdboolean
Default true
includePartnerIdboolean
Default true
includeStatusboolean
Default true
includeSearchboolean
Default true
pageinteger(int32)
Default 1
pageSizeinteger(int32)
Default 10
curl -i -X GET \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies?id=string&corporationId=string&partnerId=string&status=Active&search=string&includeId=true&includeCorporationId=true&includePartnerId=true&includeStatus=true&includeSearch=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(Company)
Response
application/json
{
  "hasResources": true,
  "totalResources": 0,
  "totalPages": 0,
  "pageSize": 0,
  "currentPage": 0,
  "previousPage": 0,
  "nextPage": 0,
  "results": [
    { … }
  ]
}

Get Company

Request

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

Responses

OK

Bodyapplication/json
idstring
legalNamestring or null
tradeNamestring or null
emailstring or null
phonestring or null
websitestring or null
taxIdstring or null
timekeepingCodestring or null
deactivationReasonstring or null
acceptedTermsboolean
legalTypestring(CompanyLegalType)
Enum"SoleProprietorship""LimitedLiabilityCompany""Partnership""NonProfitOrganization""GovernmentOrganization""CCorporation""SCorporation"
industrystring(CompanyIndustry)
Enum"GeneralConstructionGeneralContracting""HvacPlumbingAndElectricalContracting""FoodAndBeverageRetailAndWholesale""ArtsEntertainmentAndRecreation""ScientificAndTechnicalServices""NonFoodRetailAndWholesale""HospitalityAccommodation""TobaccoOrAlcoholSales""PersonalCareServices""EducationalServices"
statusstring(CompanyStatus)
Enum"Active""Fraud""Closed""Duplicate"
addressobject(Address)
createdstring(date-time)
termsAcceptedAtstring or null(date-time)
payrollDetailsobject(CompanyPayrollDetails)
merchantDetailsobject(CompanyMerchantDetails)
Response
application/json
{
  "id": "string",
  "legalName": "string",
  "tradeName": "string",
  "email": "string",
  "phone": "string",
  "website": "string",
  "taxId": "string",
  "timekeepingCode": "string",
  "deactivationReason": "string",
  "acceptedTerms": true,
  "legalType": "SoleProprietorship",
  "industry": "GeneralConstructionGeneralContracting",
  "status": "Active",
  "address": {
    "street1": "string",
    "street2": "string",
    "city": "string",
    "zipcode": "string",
    "state": "AL",
    "country": "US"
  },
  "created": "2019-08-24T14:15:22Z",
  "termsAcceptedAt": "2019-08-24T14:15:22Z",
  "payrollDetails": {
    "activated": true,
    "canBoardPayroll": true,
    "onboardingStartedAt": "2019-08-24T14:15:22Z",
    "onboardingCompletedAt": "2019-08-24T14:15:22Z",
    "completedItems": [ … ],
    "terminated": true,
    "inGoodStanding": true,
    "startDate": "2019-08-24",
    "payFrequency": "Weekly",
    "processingPeriod": "FourDay",
    "employeeW2DeliveryMethod": "PrintAndMailAll",
    "contractor1099DeliveryMethod": "PrintAndMailAll",
    "onboardDetails": { … },
    "implementationDetails": { … }
  },
  "merchantDetails": {
    "deliveryPolicyUrl": "string",
    "returnPolicyUrl": "string",
    "termsOfServiceUrl": "string",
    "activated": true,
    "canBoardMerchants": true,
    "onboardingStartedAt": "2019-08-24T14:15:22Z",
    "onboardingCompletedAt": "2019-08-24T14:15:22Z",
    "onboardingStatus": "NotStarted"
  }
}

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