Encompass.Api (1.0)

Download OpenAPI description

sandbox.json

sandbox.yaml

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

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",
    "address": {
      "street1": "string",
      "street2": "string",
      "city": "string",
      "zipcode": "string",
      "state": "AL",
      "country": "US"
    }
  }'

Responses

Bodyapplication/json

idstring

legalNamestring or null

tradeNamestring or null

emailstring or null

phonestring or null

addressobject(Address)

createdAtUtcstring(date-time)

statusstring(BusinessStatus)

Enum"Active""Deactivated_Fraud""Deactivated_Closed""Deactivated_Duplicate"

timekeepingCodestring or null

acceptedTermsboolean

payrollDetailsobject(CompanyPayrollDetails)

merchantDetailsobject(CompanyMerchantDetails)

Response

application/json

{
  "id": "string",
  "legalName": "string",
  "tradeName": "string",
  "email": "string",
  "phone": "string",
  "address": {
    "street1": "string",
    "street2": "string",
    "city": "string",
    "zipcode": "string",
    "state": "AL",
    "country": "US"
  },
  "createdAtUtc": "2019-08-24T14:15:22Z",
  "status": "Active",
  "timekeepingCode": "string",
  "acceptedTerms": true,
  "payrollDetails": {
    "activated": true,
    "completedItems": [ … ],
    "onboardedAtUtc": "2019-08-24T14:15:22Z",
    "website": "string",
    "active": true,
    "inGoodStanding": true,
    "startDate": "2019-08-24",
    "companyType": "LLC",
    "companyIndustry": "GeneralConstructionGeneralContracting",
    "payFrequency": "Weekly",
    "processingPeriod": "FourDay",
    "employeeW2DeliveryMethod": "PrintAndMailAll",
    "contractor1099DeliveryMethod": "PrintAndMailAll",
    "onboardDetails": { … },
    "implementationDetails": { … }
  },
  "merchantDetails": {
    "activated": true,
    "onboardedDateUtc": "2019-08-24T14:15:22Z",
    "onboardingStatus": "NotStarted"
  }
}

Get Company

Request

Path

companyIdstringrequired

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

Responses

Bodyapplication/json

idstring

legalNamestring or null

tradeNamestring or null

emailstring or null

phonestring or null

addressobject(Address)

createdAtUtcstring(date-time)

statusstring(BusinessStatus)

Enum"Active""Deactivated_Fraud""Deactivated_Closed""Deactivated_Duplicate"

timekeepingCodestring or null

acceptedTermsboolean

payrollDetailsobject(CompanyPayrollDetails)

merchantDetailsobject(CompanyMerchantDetails)

Response

application/json

{
  "id": "string",
  "legalName": "string",
  "tradeName": "string",
  "email": "string",
  "phone": "string",
  "address": {
    "street1": "string",
    "street2": "string",
    "city": "string",
    "zipcode": "string",
    "state": "AL",
    "country": "US"
  },
  "createdAtUtc": "2019-08-24T14:15:22Z",
  "status": "Active",
  "timekeepingCode": "string",
  "acceptedTerms": true,
  "payrollDetails": {
    "activated": true,
    "completedItems": [ … ],
    "onboardedAtUtc": "2019-08-24T14:15:22Z",
    "website": "string",
    "active": true,
    "inGoodStanding": true,
    "startDate": "2019-08-24",
    "companyType": "LLC",
    "companyIndustry": "GeneralConstructionGeneralContracting",
    "payFrequency": "Weekly",
    "processingPeriod": "FourDay",
    "employeeW2DeliveryMethod": "PrintAndMailAll",
    "contractor1099DeliveryMethod": "PrintAndMailAll",
    "onboardDetails": { … },
    "implementationDetails": { … }
  },
  "merchantDetails": {
    "activated": true,
    "onboardedDateUtc": "2019-08-24T14:15:22Z",
    "onboardingStatus": "NotStarted"
  }
}

Update Company

Request

Path

companyIdstringrequired

Bodyapplication/jsonrequired

legalNamestring

tradeNamestring

websitestring

emailstring

phonestring

startDatestring(date)

typestring

industrystring

payFrequencystring

processingPeriodstring

employeeW2DeliveryMethodstring

contractor1099DeliveryMethodstring

primaryWorkplacestring

addressobject(CreateAddressRequest)

curl -i -X PATCH \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}' \
  -H 'Content-Type: application/json' \
  -d '{
    "legalName": "string",
    "tradeName": "string",
    "website": "string",
    "email": "string",
    "phone": "string",
    "startDate": "2019-08-24",
    "type": "string",
    "industry": "string",
    "payFrequency": "string",
    "processingPeriod": "string",
    "employeeW2DeliveryMethod": "string",
    "contractor1099DeliveryMethod": "string",
    "primaryWorkplace": "string",
    "address": {
      "street1": "string",
      "street2": "string",
      "city": "string",
      "zipcode": "string",
      "state": "AL",
      "country": "US"
    }
  }'

Responses

Bodyapplication/json

idstring

legalNamestring or null

tradeNamestring or null

emailstring or null

phonestring or null

addressobject(Address)

createdAtUtcstring(date-time)

statusstring(BusinessStatus)

Enum"Active""Deactivated_Fraud""Deactivated_Closed""Deactivated_Duplicate"

timekeepingCodestring or null

acceptedTermsboolean

payrollDetailsobject(CompanyPayrollDetails)

merchantDetailsobject(CompanyMerchantDetails)

Response

application/json

{
  "id": "string",
  "legalName": "string",
  "tradeName": "string",
  "email": "string",
  "phone": "string",
  "address": {
    "street1": "string",
    "street2": "string",
    "city": "string",
    "zipcode": "string",
    "state": "AL",
    "country": "US"
  },
  "createdAtUtc": "2019-08-24T14:15:22Z",
  "status": "Active",
  "timekeepingCode": "string",
  "acceptedTerms": true,
  "payrollDetails": {
    "activated": true,
    "completedItems": [ … ],
    "onboardedAtUtc": "2019-08-24T14:15:22Z",
    "website": "string",
    "active": true,
    "inGoodStanding": true,
    "startDate": "2019-08-24",
    "companyType": "LLC",
    "companyIndustry": "GeneralConstructionGeneralContracting",
    "payFrequency": "Weekly",
    "processingPeriod": "FourDay",
    "employeeW2DeliveryMethod": "PrintAndMailAll",
    "contractor1099DeliveryMethod": "PrintAndMailAll",
    "onboardDetails": { … },
    "implementationDetails": { … }
  },
  "merchantDetails": {
    "activated": true,
    "onboardedDateUtc": "2019-08-24T14:15:22Z",
    "onboardingStatus": "NotStarted"
  }
}

Start Payroll

Request

Path

companyIdstringrequired

Bodyapplication/jsonrequired

startDatestring(date)

legalNamestring

tradeNamestring

emailstring

phonestring

websitestring or null

typestring(CompanyType)

Enum"LLC""Partnership""CCorporation""SCorporation""SoleProprietorship"

industrystring(CompanyIndustry)

Enum"GeneralConstructionGeneralContracting""HvacPlumbingAndElectricalContracting""FoodAndBeverageRetailAndWholesale""ArtsEntertainmentAndRecreation""ScientificAndTechnicalServices""NonFoodRetailAndWholesale""HospitalityAccomodation""TobaccoOrAlcoholSales""PersonalCareServices""EducationalServices"

payFrequencystring(PayFrequency)

Enum"Weekly""Biweekly""Semimonthly""Monthly""Quarterly""Annually"

employeeW2DeliveryMethodstring(DeliveryMethod)

Enum"PrintAndMailAll""Manual"

contractor1099DeliveryMethodstring(DeliveryMethod)

Enum"PrintAndMailAll""Manual"

addressobject(CreateAddressRequest)

curl -i -X POST \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/start_payroll' \
  -H 'Content-Type: application/json' \
  -d '{
    "startDate": "2019-08-24",
    "legalName": "string",
    "tradeName": "string",
    "email": "string",
    "phone": "string",
    "website": "string",
    "type": "LLC",
    "industry": "GeneralConstructionGeneralContracting",
    "payFrequency": "Weekly",
    "employeeW2DeliveryMethod": "PrintAndMailAll",
    "contractor1099DeliveryMethod": "PrintAndMailAll",
    "address": {
      "street1": "string",
      "street2": "string",
      "city": "string",
      "zipcode": "string",
      "state": "AL",
      "country": "US"
    }
  }'

Responses

Bodyapplication/json

idstring

legalNamestring or null

tradeNamestring or null

emailstring or null

phonestring or null

addressobject(Address)

createdAtUtcstring(date-time)

statusstring(BusinessStatus)

Enum"Active""Deactivated_Fraud""Deactivated_Closed""Deactivated_Duplicate"

timekeepingCodestring or null

acceptedTermsboolean

payrollDetailsobject(CompanyPayrollDetails)

merchantDetailsobject(CompanyMerchantDetails)

Response

application/json

{
  "id": "string",
  "legalName": "string",
  "tradeName": "string",
  "email": "string",
  "phone": "string",
  "address": {
    "street1": "string",
    "street2": "string",
    "city": "string",
    "zipcode": "string",
    "state": "AL",
    "country": "US"
  },
  "createdAtUtc": "2019-08-24T14:15:22Z",
  "status": "Active",
  "timekeepingCode": "string",
  "acceptedTerms": true,
  "payrollDetails": {
    "activated": true,
    "completedItems": [ … ],
    "onboardedAtUtc": "2019-08-24T14:15:22Z",
    "website": "string",
    "active": true,
    "inGoodStanding": true,
    "startDate": "2019-08-24",
    "companyType": "LLC",
    "companyIndustry": "GeneralConstructionGeneralContracting",
    "payFrequency": "Weekly",
    "processingPeriod": "FourDay",
    "employeeW2DeliveryMethod": "PrintAndMailAll",
    "contractor1099DeliveryMethod": "PrintAndMailAll",
    "onboardDetails": { … },
    "implementationDetails": { … }
  },
  "merchantDetails": {
    "activated": true,
    "onboardedDateUtc": "2019-08-24T14:15:22Z",
    "onboardingStatus": "NotStarted"
  }
}

Create Signatory

Request

Path

companyIdstringrequired

Bodyapplication/jsonrequired

firstNamestring or null

middleNamestring or null

lastNamestring or null

titlestring or null

emailstring or null

curl -i -X POST \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/signatories' \
  -H 'Content-Type: application/json' \
  -d '{
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "title": "string",
    "email": "string"
  }'

Responses

Bodyapplication/json

idstring or null

companyIdstring

firstNamestring or null

middleNamestring or null

lastNamestring or null

titlestring or null

emailstring or null

Response

application/json

{
  "id": "string",
  "companyId": "string",
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "title": "string",
  "email": "string"
}

Query Signatories

Request

Path

companyIdstringrequired

Query

cursorstring

curl -i -X GET \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/signatories?cursor=string'

Responses

Bodyapplication/json

previousPagestring or null

nextPagestring or null

resultsArray of objects or null(Signatory)

Response

application/json

{
  "previousPage": "string",
  "nextPage": "string",
  "results": [
    { … }
  ]
}

Company Signatory Agreements

Request

Path

companyIdstringrequired

Bodyapplication/jsonrequired

signatoryIdstring or null

signerNamestring or null

signerTitlestring or null

signerEmailstring or null

curl -i -X POST \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/onboard/signatory_agreements' \
  -H 'Content-Type: application/json' \
  -d '{
    "signatoryId": "string",
    "signerName": "string",
    "signerTitle": "string",
    "signerEmail": "string"
  }'

Responses

Bodyapplication/json

urlstring or null

Response

application/json

{
  "url": "string"
}

Company Employee Setup

Request

Path

companyIdstringrequired

curl -i -X POST \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/onboard/employee_setup'

Responses

Bodyapplication/json

urlstring or null

Response

application/json

{
  "url": "string"
}

Company Connect Bank Account

Request

Path

companyIdstringrequired

Bodyapplication/jsonrequired

signatoryIdstring or null

signerNamestring or null

signerTitlestring or null

signerEmailstring or null

curl -i -X POST \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/onboard/connect_bank_account' \
  -H 'Content-Type: application/json' \
  -d '{
    "signatoryId": "string",
    "signerName": "string",
    "signerTitle": "string",
    "signerEmail": "string"
  }'

Responses

Bodyapplication/json

urlstring or null

Response

application/json

{
  "url": "string"
}

Company Tax Setup

Request

Path

companyIdstringrequired

Bodyapplication/jsonrequired

signatoryIdstring or null

signerNamestring or null

signerTitlestring or null

signerEmailstring or null

curl -i -X POST \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/onboard/tax_setup' \
  -H 'Content-Type: application/json' \
  -d '{
    "signatoryId": "string",
    "signerName": "string",
    "signerTitle": "string",
    "signerEmail": "string"
  }'

Responses

Bodyapplication/json

urlstring or null

Response

application/json

{
  "url": "string"
}

Company Filing Authorization

Request

Path

companyIdstringrequired

Bodyapplication/jsonrequired

signatoryIdstring or null

signerNamestring or null

signerTitlestring or null

signerEmailstring or null

curl -i -X POST \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/onboard/filing_authorization' \
  -H 'Content-Type: application/json' \
  -d '{
    "signatoryId": "string",
    "signerName": "string",
    "signerTitle": "string",
    "signerEmail": "string"
  }'

Responses

Bodyapplication/json

urlstring or null

Response

application/json

{
  "url": "string"
}

Company Verification Documents

Request

Path

companyIdstringrequired

curl -i -X POST \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/onboard/verification_documents'

Responses

Bodyapplication/json

urlstring or null

Response

application/json

{
  "url": "string"
}

Company Accounting Integration

Request

Path

companyIdstringrequired

curl -i -X POST \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/onboard/accounting_integration'

Responses

Bodyapplication/json

urlstring or null

Response

application/json

{
  "url": "string"
}

Start Payroll Implementation

Request

Path

companyIdstringrequired

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

Responses

Bodyapplication/json

idstring

legalNamestring or null

tradeNamestring or null

emailstring or null

phonestring or null

addressobject(Address)

createdAtUtcstring(date-time)

statusstring(BusinessStatus)

Enum"Active""Deactivated_Fraud""Deactivated_Closed""Deactivated_Duplicate"

timekeepingCodestring or null

acceptedTermsboolean

payrollDetailsobject(CompanyPayrollDetails)

merchantDetailsobject(CompanyMerchantDetails)

Response

application/json

{
  "id": "string",
  "legalName": "string",
  "tradeName": "string",
  "email": "string",
  "phone": "string",
  "address": {
    "street1": "string",
    "street2": "string",
    "city": "string",
    "zipcode": "string",
    "state": "AL",
    "country": "US"
  },
  "createdAtUtc": "2019-08-24T14:15:22Z",
  "status": "Active",
  "timekeepingCode": "string",
  "acceptedTerms": true,
  "payrollDetails": {
    "activated": true,
    "completedItems": [ … ],
    "onboardedAtUtc": "2019-08-24T14:15:22Z",
    "website": "string",
    "active": true,
    "inGoodStanding": true,
    "startDate": "2019-08-24",
    "companyType": "LLC",
    "companyIndustry": "GeneralConstructionGeneralContracting",
    "payFrequency": "Weekly",
    "processingPeriod": "FourDay",
    "employeeW2DeliveryMethod": "PrintAndMailAll",
    "contractor1099DeliveryMethod": "PrintAndMailAll",
    "onboardDetails": { … },
    "implementationDetails": { … }
  },
  "merchantDetails": {
    "activated": true,
    "onboardedDateUtc": "2019-08-24T14:15:22Z",
    "onboardingStatus": "NotStarted"
  }
}

Cancel Payroll Implementation

Request

Path

companyIdstringrequired

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

Responses

Tax Deposits

Request

Path

companyIdstringrequired

Query

startDatestring(date)

endDatestring(date)

cursorstring

curl -i -X GET \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/tax_deposits?cursor=string&endDate=2019-08-24&startDate=2019-08-24'

Responses

Bodyapplication/json

previousPagestring or null

nextPagestring or null

resultsArray of objects or null(TaxDeposit)

Response

application/json

{
  "previousPage": "string",
  "nextPage": "string",
  "results": [
    { … }
  ]
}

Contractors

Operations

Deductions - Child Support

Operations

Deductions - Miscellaneous

Operations

Departments

Operations

Documents

Operations

Earning Codes

Operations

Employees

Operations

Partner Portfolio

Operations

Payment Schedules

Operations

Payrolls

Operations

Workplaces

Operations

Encompass.Api (1.0)

Benefits - Company

Benefits - Employee

Companies

Create Company

RequestExpand all

Responses

Was this helpful?

Get Company

Request

Responses

Was this helpful?

Update Company

RequestExpand all

Responses

Was this helpful?

Start Payroll

RequestExpand all

Responses

Was this helpful?

Create Signatory

Request

Responses

Was this helpful?

Query Signatories

Request

Responses

Was this helpful?

Company Signatory Agreements

Request

Responses

Was this helpful?

Company Employee Setup

Request

Responses

Was this helpful?

Company Connect Bank Account

Request

Responses

Was this helpful?

Company Tax Setup

Request

Responses

Was this helpful?

Company Filing Authorization

Request

Responses

Was this helpful?

Company Verification Documents

Request

Responses

Was this helpful?

Company Accounting Integration

Request

Responses

Was this helpful?

Start Payroll Implementation

Request

Responses

Was this helpful?

Cancel Payroll Implementation

Request

Responses

Was this helpful?

Tax Deposits

Request

Responses

Was this helpful?

Contractors

Deductions - Child Support

Deductions - Miscellaneous

Departments

Documents

Earning Codes

Employees

Partner Portfolio

Payment Schedules

Payrolls

Workplaces

Request

Request

Request