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

Get Enrollment Profile

Request

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

Responses

OK

Bodyapplication/json
employeeCountinteger or null(int32)
contractorCountinteger or null(int32)
payPeriodAmountnumber or null(double)
previousPayrollProviderstring(PreviousPayrollProvider)
Enum"Accupay""ADPEnterprise""ADPPayforce""ADPPCPW""ADPRun""ADPTotalsource""ADPWorkforceNow""BenefitMallCompupay""CBIZ""Ceridian"
monthsOnPreviousPayrollProviderinteger or null(int32)
socialMediaArray of strings or null
firstPayrollboolean or null
firstPayrollOfYearboolean or null
averageMonthlyRevenuenumber or null(double)
earliestKnownRevenuestring or null(date)
userSincestring or null(date)
approvedForPaymentProcessingboolean or null
fraudScorenumber or null(double)
predictedFraudboolean or null
submissionCommentstring or null
enrollmentModestring(EnrollmentMode)
Enum"SelfService""ImplementationServices"
Response
application/json
{
  "employeeCount": 0,
  "contractorCount": 0,
  "payPeriodAmount": 0.1,
  "previousPayrollProvider": "Accupay",
  "monthsOnPreviousPayrollProvider": 0,
  "socialMedia": [
    "string"
  ],
  "firstPayroll": true,
  "firstPayrollOfYear": true,
  "averageMonthlyRevenue": 0.1,
  "earliestKnownRevenue": "2019-08-24",
  "userSince": "2019-08-24",
  "approvedForPaymentProcessing": true,
  "fraudScore": 0.1,
  "predictedFraud": true,
  "submissionComment": "string",
  "enrollmentMode": "SelfService"
}

Update Enrollment Profile

Request

Path
companyIdstringrequired
Bodyapplication/jsonrequired
employeeCountobject(PatchableInt)
contractorCountobject(PatchableInt)
payPeriodAmountnumber(double)
previousPayrollProviderstring
monthsOnPreviousPayrollProviderobject(PatchableInt)
firstPayrollboolean
firstPayrollOfYearboolean
averageMonthlyRevenuenumber(double)
earliestKnownRevenuestring(date)
socialMediaArray of strings or null
curl -i -X PATCH \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/enrollment_profile' \
  -H 'Content-Type: application/json' \
  -d '{
    "employeeCount": {
      "value": 0,
      "included": true
    },
    "contractorCount": {
      "value": 0,
      "included": true
    },
    "payPeriodAmount": 0.1,
    "previousPayrollProvider": "string",
    "monthsOnPreviousPayrollProvider": {
      "value": 0,
      "included": true
    },
    "firstPayroll": true,
    "firstPayrollOfYear": true,
    "averageMonthlyRevenue": 0.1,
    "earliestKnownRevenue": "2019-08-24",
    "socialMedia": [
      "string"
    ]
  }'

Responses

OK

Bodyapplication/json
employeeCountinteger or null(int32)
contractorCountinteger or null(int32)
payPeriodAmountnumber or null(double)
previousPayrollProviderstring(PreviousPayrollProvider)
Enum"Accupay""ADPEnterprise""ADPPayforce""ADPPCPW""ADPRun""ADPTotalsource""ADPWorkforceNow""BenefitMallCompupay""CBIZ""Ceridian"
monthsOnPreviousPayrollProviderinteger or null(int32)
socialMediaArray of strings or null
firstPayrollboolean or null
firstPayrollOfYearboolean or null
averageMonthlyRevenuenumber or null(double)
earliestKnownRevenuestring or null(date)
userSincestring or null(date)
approvedForPaymentProcessingboolean or null
fraudScorenumber or null(double)
predictedFraudboolean or null
submissionCommentstring or null
enrollmentModestring(EnrollmentMode)
Enum"SelfService""ImplementationServices"
Response
application/json
{
  "employeeCount": 0,
  "contractorCount": 0,
  "payPeriodAmount": 0.1,
  "previousPayrollProvider": "Accupay",
  "monthsOnPreviousPayrollProvider": 0,
  "socialMedia": [
    "string"
  ],
  "firstPayroll": true,
  "firstPayrollOfYear": true,
  "averageMonthlyRevenue": 0.1,
  "earliestKnownRevenue": "2019-08-24",
  "userSince": "2019-08-24",
  "approvedForPaymentProcessing": true,
  "fraudScore": 0.1,
  "predictedFraud": true,
  "submissionComment": "string",
  "enrollmentMode": "SelfService"
}

Miscellaneous

Operations

Partners

Operations

Payment Schedules

Operations

Payrolls

Operations

Timecards

Operations

Workplaces

Operations