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

Contractors

Operations

Deductions - Child Support

Operations

Deductions - Miscellaneous

Operations

Departments

Operations

Documents

Operations

Earning Codes

Operations

Employees

Operations

Create Employee

Request

Path

companyIdstringrequired

Bodyapplication/jsonrequired

firstNamestring or nullrequired

middleNamestring or null

lastNamestring or nullrequired

emailstring or null

ssnstring or null

activebooleanrequired

primaryWorkplaceIdstringrequired

workplacesArray of strings or nullrequired

departmentIdstring or null

dateOfBirthstring or null(date)

startDatestring or null(date)

terminationDatestring or null(date)

defaultPaymentMethodstring(PaymentMethod)

Enum"DirectDeposit""Manual"

formW2ElectronicConsentboolean or null

residenceobject(CreateAddressRequest)

wageobject(EmployeeWage)

curl -i -X POST \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/employees' \
  -H 'Content-Type: application/json' \
  -d '{
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "email": "string",
    "ssn": "string",
    "active": true,
    "primaryWorkplaceId": "string",
    "workplaces": [
      "string"
    ],
    "departmentId": "string",
    "dateOfBirth": "2019-08-24",
    "startDate": "2019-08-24",
    "terminationDate": "2019-08-24",
    "defaultPaymentMethod": "DirectDeposit",
    "formW2ElectronicConsent": true,
    "residence": {
      "street1": "string",
      "street2": "string",
      "city": "string",
      "zipcode": "string",
      "state": "AL",
      "country": "US"
    },
    "wage": {
      "rate": 0.1,
      "period": "Hourly",
      "flsaOvertimeExemptionStatus": "NonExempt",
      "supplementalTaxMethod": "Flat",
      "fullTimeHours": 0.1
    }
  }'

Responses

Bodyapplication/json

idstring

companyIdstring

codestring or null

firstNamestring or null

middleNamestring or null

lastNamestring or null

emailstring or null

ssnLastFourstring or null

ssnValidationStatusstring(SsnValidationStatus)

Enum"Pending""Invalid""Validated"

activeboolean

formW2ElectronicConsentboolean

dateOfBirthstring or null(date)

startDatestring or null(date)

terminationDatestring or null(date)

defaultPaymentMethodstring(PaymentMethod)

Enum"DirectDeposit""Manual"

defaultNetPaySplitstring or null

bankAccountsArray of strings or null

primaryWorkplaceIdstring

workplacesArray of objects or null(EmployeeWorkplace)

departmentobject(EmployeeDepartment)

residenceobject(Address)

onboardobject(EmployeeOnboard)

Response

application/json

{
  "id": "string",
  "companyId": "string",
  "code": "string",
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "email": "string",
  "ssnLastFour": "string",
  "ssnValidationStatus": "Pending",
  "active": true,
  "formW2ElectronicConsent": true,
  "dateOfBirth": "2019-08-24",
  "startDate": "2019-08-24",
  "terminationDate": "2019-08-24",
  "defaultPaymentMethod": "DirectDeposit",
  "defaultNetPaySplit": "string",
  "bankAccounts": [
    "string"
  ],
  "primaryWorkplaceId": "string",
  "workplaces": [
    { … }
  ],
  "department": {
    "id": "string",
    "name": "string"
  },
  "residence": {
    "street1": "string",
    "street2": "string",
    "city": "string",
    "zipcode": "string",
    "state": "AL",
    "country": "US"
  },
  "onboard": {
    "status": "Blocking",
    "blockingSteps": [ … ],
    "remainingSteps": [ … ],
    "ssn": [ … ],
    "paymentMethod": [ … ],
    "workplaces": [ … ],
    "employeeDetails": [ … ],
    "withholdings": [ … ]
  }
}

Query Employees

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}/employees?active=true&id=string&page=1&pageSize=10'

Responses

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(Employee)

Response

application/json

{
  "hasResources": true,
  "totalResources": 0,
  "totalPages": 0,
  "pageSize": 0,
  "currentPage": 0,
  "previousPage": 0,
  "nextPage": 0,
  "results": [
    { … }
  ]
}

Get Employee

Request

Path

companyIdstringrequired

employeeIdstringrequired

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

Responses

Bodyapplication/json

idstring

companyIdstring

codestring or null

firstNamestring or null

middleNamestring or null

lastNamestring or null

emailstring or null

ssnLastFourstring or null

ssnValidationStatusstring(SsnValidationStatus)

Enum"Pending""Invalid""Validated"

activeboolean

formW2ElectronicConsentboolean

dateOfBirthstring or null(date)

startDatestring or null(date)

terminationDatestring or null(date)

defaultPaymentMethodstring(PaymentMethod)

Enum"DirectDeposit""Manual"

defaultNetPaySplitstring or null

bankAccountsArray of strings or null

primaryWorkplaceIdstring

workplacesArray of objects or null(EmployeeWorkplace)

departmentobject(EmployeeDepartment)

residenceobject(Address)

onboardobject(EmployeeOnboard)

Response

application/json

{
  "id": "string",
  "companyId": "string",
  "code": "string",
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "email": "string",
  "ssnLastFour": "string",
  "ssnValidationStatus": "Pending",
  "active": true,
  "formW2ElectronicConsent": true,
  "dateOfBirth": "2019-08-24",
  "startDate": "2019-08-24",
  "terminationDate": "2019-08-24",
  "defaultPaymentMethod": "DirectDeposit",
  "defaultNetPaySplit": "string",
  "bankAccounts": [
    "string"
  ],
  "primaryWorkplaceId": "string",
  "workplaces": [
    { … }
  ],
  "department": {
    "id": "string",
    "name": "string"
  },
  "residence": {
    "street1": "string",
    "street2": "string",
    "city": "string",
    "zipcode": "string",
    "state": "AL",
    "country": "US"
  },
  "onboard": {
    "status": "Blocking",
    "blockingSteps": [ … ],
    "remainingSteps": [ … ],
    "ssn": [ … ],
    "paymentMethod": [ … ],
    "workplaces": [ … ],
    "employeeDetails": [ … ],
    "withholdings": [ … ]
  }
}

Update Employee

Request

Path

companyIdstringrequired

employeeIdstringrequired

Bodyapplication/jsonrequired

firstNamestring

middleNamestring

lastNamestring

emailstring

ssnstring

defaultNetPaySplitstring

dateOfBirthstring(date)

startDatestring(date)

terminationDatestring(date)

defaultPaymentMethodstring

departmentIdstring

primaryWorkplaceIdstring

workplacesArray of strings or null

formW2ElectronicConsentboolean

activeboolean

residenceobject(CreateAddressRequest)

wageobject(EmployeeWage)

curl -i -X PATCH \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/employees/{employeeId}' \
  -H 'Content-Type: application/json' \
  -d '{
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "email": "string",
    "ssn": "string",
    "defaultNetPaySplit": "string",
    "dateOfBirth": "2019-08-24",
    "startDate": "2019-08-24",
    "terminationDate": "2019-08-24",
    "defaultPaymentMethod": "string",
    "departmentId": "string",
    "primaryWorkplaceId": "string",
    "workplaces": [
      "string"
    ],
    "formW2ElectronicConsent": true,
    "active": true,
    "residence": {
      "street1": "string",
      "street2": "string",
      "city": "string",
      "zipcode": "string",
      "state": "AL",
      "country": "US"
    },
    "wage": {
      "rate": 0.1,
      "period": "Hourly",
      "flsaOvertimeExemptionStatus": "NonExempt",
      "supplementalTaxMethod": "Flat",
      "fullTimeHours": 0.1
    }
  }'

Responses

Bodyapplication/json

idstring

companyIdstring

codestring or null

firstNamestring or null

middleNamestring or null

lastNamestring or null

emailstring or null

ssnLastFourstring or null

ssnValidationStatusstring(SsnValidationStatus)

Enum"Pending""Invalid""Validated"

activeboolean

formW2ElectronicConsentboolean

dateOfBirthstring or null(date)

startDatestring or null(date)

terminationDatestring or null(date)

defaultPaymentMethodstring(PaymentMethod)

Enum"DirectDeposit""Manual"

defaultNetPaySplitstring or null

bankAccountsArray of strings or null

primaryWorkplaceIdstring

workplacesArray of objects or null(EmployeeWorkplace)

departmentobject(EmployeeDepartment)

residenceobject(Address)

onboardobject(EmployeeOnboard)

Response

application/json

{
  "id": "string",
  "companyId": "string",
  "code": "string",
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "email": "string",
  "ssnLastFour": "string",
  "ssnValidationStatus": "Pending",
  "active": true,
  "formW2ElectronicConsent": true,
  "dateOfBirth": "2019-08-24",
  "startDate": "2019-08-24",
  "terminationDate": "2019-08-24",
  "defaultPaymentMethod": "DirectDeposit",
  "defaultNetPaySplit": "string",
  "bankAccounts": [
    "string"
  ],
  "primaryWorkplaceId": "string",
  "workplaces": [
    { … }
  ],
  "department": {
    "id": "string",
    "name": "string"
  },
  "residence": {
    "street1": "string",
    "street2": "string",
    "city": "string",
    "zipcode": "string",
    "state": "AL",
    "country": "US"
  },
  "onboard": {
    "status": "Blocking",
    "blockingSteps": [ … ],
    "remainingSteps": [ … ],
    "ssn": [ … ],
    "paymentMethod": [ … ],
    "workplaces": [ … ],
    "employeeDetails": [ … ],
    "withholdings": [ … ]
  }
}

Get Employee Paystub

Request

Path

companyIdstringrequired

employeeIdstringrequired

payrollIdstringrequired

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

Responses

Bodyapplication/json

payrollobject(EmployeePaystubPayroll)

companyobject(EmployeePaystubCompany)

employeeobject(EmployeePaystubEmployee)

timeOffBalanceobject(EmployeePaystubTimeOffBalance)

summaryobject(EmployeePaystubSummary)

earningsArray of objects or null(EmployeePaystubEarning)

reimbursementsArray of objects or null(EmployeePaystubReimbursement)

postTaxDeductionsArray of objects or null(EmployeePaystubDeduction)

employeeBenefitContributionsArray of objects or null(EmployeePaystubBenefit)

companyBenefitContributionsArray of objects or null(EmployeePaystubBenefit)

employeeTaxesArray of objects or null(EmployeePaystubTax)

companyTaxesArray of objects or null(EmployeePaystubTax)

Response

application/json

{
  "payroll": {
    "payrollId": "string",
    "payday": "2019-08-24",
    "periodStart": "2019-08-24",
    "periodEnd": "2019-08-24",
    "voidedPayrollId": "string",
    "voidedBy": "string"
  },
  "company": {
    "legalName": "string",
    "tradeName": "string",
    "phone": "string",
    "address": { … }
  },
  "employee": {
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "ssnLastFour": "string",
    "residence": { … }
  },
  "timeOffBalance": {
    "ptoBalanceHours": 0.1,
    "sickBalanceHours": 0.1,
    "stateCovidSickBalanceHours": 0.1
  },
  "summary": {
    "netPay": 0.1,
    "netPayYtd": 0.1,
    "earnings": 0.1,
    "earningsYtd": 0.1,
    "reimbursements": 0.1,
    "reimbursementsYtd": 0.1,
    "postTaxDeductions": 0.1,
    "postTaxDeductionsYtd": 0.1,
    "employeeBenefitContributions": 0.1,
    "employeeBenefitContributionsYtd": 0.1,
    "companyBenefitContributions": 0.1,
    "companyBenefitContributionsYtd": 0.1,
    "employeeTaxes": 0.1,
    "employeeTaxesYtd": 0.1,
    "companyTaxes": 0.1,
    "companyTaxesYtd": 0.1
  },
  "earnings": [
    { … }
  ],
  "reimbursements": [
    { … }
  ],
  "postTaxDeductions": [
    { … }
  ],
  "employeeBenefitContributions": [
    { … }
  ],
  "companyBenefitContributions": [
    { … }
  ],
  "employeeTaxes": [
    { … }
  ],
  "companyTaxes": [
    { … }
  ]
}

Query Employee Paystubs

Request

Path

companyIdstringrequired

employeeIdstringrequired

Query

cursorstring

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

Responses

Bodyapplication/json

previousPagestring or null

nextPagestring or null

resultsArray of objects or null(EmployeePaystub)

Response

application/json

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

Download Employee Paystub

Request

Path

companyIdstringrequired

employeeIdstringrequired

payrollIdstringrequired

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

Responses

Bodyapplication/json

filestring or null

Response

application/json

{
  "file": "string"
}

Query Employee Forms

Request

Path

companyIdstringrequired

employeeIdstringrequired

Query

cursorstring

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

Responses

Bodyapplication/json

previousPagestring or null

nextPagestring or null

resultsArray of objects or null(PayrollFormDocument)

Response

application/json

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

Get Employee Form

Request

Path

companyIdstringrequired

employeeIdstringrequired

formIdstringrequired

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

Responses

Bodyapplication/json

idstring or null

descriptionstring or null

linkstring or null

jurisdictionNamestring or null

revisionDatestring or null(date)

parametersArray of objects or null(PayrollFormParameter)

signatureConfirmationTextstring or null

Response

application/json

{
  "id": "string",
  "description": "string",
  "link": "string",
  "jurisdictionName": "string",
  "revisionDate": "2019-08-24",
  "parameters": [
    { … }
  ],
  "signatureConfirmationText": "string"
}

Submit Employee Form

Request

Path

companyIdstringrequired

employeeIdstringrequired

formIdstringrequired

Bodyapplication/jsonrequired

parametersArray of objects or null(PayrollFormSubmissionParameter)required

parameters[].namestring or null

parameters[].valuestring or null

curl -i -X POST \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/employees/{employeeId}/forms/{formId}' \
  -H 'Content-Type: application/json' \
  -d '{
    "parameters": [
      {
        "name": "string",
        "value": "string"
      }
    ]
  }'

Responses

Query Company Defined Attributes

Request

Path

companyIdstringrequired

employeeIdstringrequired

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

Responses

Bodyapplication/jsonArray [

namestring or null

descriptionstring or null

labelstring or null

valuestring or null

defaultValuestring or null

effectiveStartstring or null(date)

effectiveStartRequiredboolean

typestring(CheckCompanyDefinedAttributeType)

Enum"String""Numeric""Currency""Percent""Boolean""Select"

optionsArray of objects or null(CompanyDefinedAttributeOption)

]

Response

application/json

[
  {
    "name": "string",
    "description": "string",
    "label": "string",
    "value": "string",
    "defaultValue": "string",
    "effectiveStart": "2019-08-24",
    "effectiveStartRequired": true,
    "type": "String",
    "options": [ … ]
  }
]

Update Company Defined Attributes

Request

Path

companyIdstringrequired

employeeIdstringrequired

Bodyapplication/jsonrequiredArray [

namestring or null

valuestring or null

effectiveStartstring or null(date)

]

curl -i -X PATCH \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/employees/{employeeId}/company_defined_attributes' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "name": "string",
      "value": "string",
      "effectiveStart": "2019-08-24"
    }
  ]'

Responses

Bodyapplication/jsonArray [

namestring or null

descriptionstring or null

labelstring or null

valuestring or null

defaultValuestring or null

effectiveStartstring or null(date)

effectiveStartRequiredboolean

typestring(CheckCompanyDefinedAttributeType)

Enum"String""Numeric""Currency""Percent""Boolean""Select"

optionsArray of objects or null(CompanyDefinedAttributeOption)

]

Response

application/json

[
  {
    "name": "string",
    "description": "string",
    "label": "string",
    "value": "string",
    "defaultValue": "string",
    "effectiveStart": "2019-08-24",
    "effectiveStartRequired": true,
    "type": "String",
    "options": [ … ]
  }
]

Query Reciprocity Elections

Request

Path

companyIdstringrequired

employeeIdstringrequired

Query

cursorstring

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

Responses

Bodyapplication/json

previousPagestring or null

nextPagestring or null

resultsArray of objects or null(ReciprocityElection)

Response

application/json

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

Update Reciprocity Elections

Request

Path

companyIdstringrequired

employeeIdstringrequired

Query

cursorstring

Bodyapplication/jsonrequiredArray [

jurisdictionstring or null

optInboolean

effectiveStartstring or null(date)

]

curl -i -X PATCH \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/employees/{employeeId}/reciprocity_elections?cursor=string' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "jurisdiction": "string",
      "optIn": true,
      "effectiveStart": "2019-08-24"
    }
  ]'

Responses

Bodyapplication/json

previousPagestring or null

nextPagestring or null

resultsArray of objects or null(ReciprocityElection)

Response

application/json

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

Create Employee Bank Account

Request

Path

companyIdstringrequired

employeeIdstringrequired

Bodyapplication/jsonrequired

accountNumberstring or null

routingNumberstring or null

institutionNamestring or null

subtypestring(BankAccountSubtype)

Enum"Checking""Savings"

curl -i -X POST \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/employees/{employeeId}/bank_accounts' \
  -H 'Content-Type: application/json' \
  -d '{
    "accountNumber": "string",
    "routingNumber": "string",
    "institutionName": "string",
    "subtype": "Checking"
  }'

Responses

Bodyapplication/json

idstring or null

companyIdstring or null

employeeIdstring or null

contractorIdstring or null

statusstring(BankAccountStatus)

Enum"ValidationPending""Validated""OwnershipVerified""DisabledRecoverable""DisabledIrrecoverable"

disabledReasonstring(BankAccountDisabledReason)

Enum"ValidationFailed""FailedPayment""VerificationPending""VerificationFailed""ConsumerAccount"

rawBankAccountobject(RawBankAccount)

plaidBankAccountobject(PlaidBankAccount)

Response

application/json

{
  "id": "string",
  "companyId": "string",
  "employeeId": "string",
  "contractorId": "string",
  "status": "ValidationPending",
  "disabledReason": "ValidationFailed",
  "rawBankAccount": {
    "institutionName": "string",
    "accountLastFour": "string",
    "routingNumber": "string",
    "subtype": "Checking"
  },
  "plaidBankAccount": {
    "name": "string",
    "plaidPublicToken": "string",
    "institutionName": "string",
    "accountLastFour": "string",
    "subtype": "Checking",
    "verified": true,
    "microdepositVerificationStatus": "string"
  }
}

Query Employee Bank Accounts

Request

Path

companyIdstringrequired

employeeIdstringrequired

Query

cursorstring

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

Responses

Bodyapplication/json

previousPagestring or null

nextPagestring or null

resultsArray of objects or null(BankAccount)

Response

application/json

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

Get Employee Bank Account

Request

Path

companyIdstringrequired

employeeIdstringrequired

bankAccountIdstringrequired

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

Responses

Bodyapplication/json

idstring or null

companyIdstring or null

employeeIdstring or null

contractorIdstring or null

statusstring(BankAccountStatus)

Enum"ValidationPending""Validated""OwnershipVerified""DisabledRecoverable""DisabledIrrecoverable"

disabledReasonstring(BankAccountDisabledReason)

Enum"ValidationFailed""FailedPayment""VerificationPending""VerificationFailed""ConsumerAccount"

rawBankAccountobject(RawBankAccount)

plaidBankAccountobject(PlaidBankAccount)

Response

application/json

{
  "id": "string",
  "companyId": "string",
  "employeeId": "string",
  "contractorId": "string",
  "status": "ValidationPending",
  "disabledReason": "ValidationFailed",
  "rawBankAccount": {
    "institutionName": "string",
    "accountLastFour": "string",
    "routingNumber": "string",
    "subtype": "Checking"
  },
  "plaidBankAccount": {
    "name": "string",
    "plaidPublicToken": "string",
    "institutionName": "string",
    "accountLastFour": "string",
    "subtype": "Checking",
    "verified": true,
    "microdepositVerificationStatus": "string"
  }
}

Update Employee Bank Account

Request

Path

companyIdstringrequired

employeeIdstringrequired

bankAccountIdstringrequired

Bodyapplication/jsonrequired

accountNumberstring

routingNumberstring

institutionNamestring

subtypestring

curl -i -X PATCH \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/employees/{employeeId}/bank_accounts/{bankAccountId}' \
  -H 'Content-Type: application/json' \
  -d '{
    "accountNumber": "string",
    "routingNumber": "string",
    "institutionName": "string",
    "subtype": "string"
  }'

Responses

Bodyapplication/json

idstring or null

companyIdstring or null

employeeIdstring or null

contractorIdstring or null

statusstring(BankAccountStatus)

Enum"ValidationPending""Validated""OwnershipVerified""DisabledRecoverable""DisabledIrrecoverable"

disabledReasonstring(BankAccountDisabledReason)

Enum"ValidationFailed""FailedPayment""VerificationPending""VerificationFailed""ConsumerAccount"

rawBankAccountobject(RawBankAccount)

plaidBankAccountobject(PlaidBankAccount)

Response

application/json

{
  "id": "string",
  "companyId": "string",
  "employeeId": "string",
  "contractorId": "string",
  "status": "ValidationPending",
  "disabledReason": "ValidationFailed",
  "rawBankAccount": {
    "institutionName": "string",
    "accountLastFour": "string",
    "routingNumber": "string",
    "subtype": "Checking"
  },
  "plaidBankAccount": {
    "name": "string",
    "plaidPublicToken": "string",
    "institutionName": "string",
    "accountLastFour": "string",
    "subtype": "Checking",
    "verified": true,
    "microdepositVerificationStatus": "string"
  }
}

Delete Employee Bank Account

Request

Path

companyIdstringrequired

employeeIdstringrequired

bankAccountIdstringrequired

curl -i -X DELETE \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/employees/{employeeId}/bank_accounts/{bankAccountId}'

Responses

Create Employee Net Pay Split

Request

Path

companyIdstringrequired

employeeIdstringrequired

Bodyapplication/jsonrequired

isDefaultboolean

splitsArray of objects or null(CreateNetPaySplitItemRequest)

curl -i -X POST \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/employees/{employeeId}/net_pay_splits' \
  -H 'Content-Type: application/json' \
  -d '{
    "isDefault": true,
    "splits": [
      {
        "bankAccountId": "string",
        "priority": 0,
        "amount": 0.1,
        "percent": 0.1
      }
    ]
  }'

Responses

Bodyapplication/json

idstring or null

employeeIdstring or null

contractorIdstring or null

deactivatedAtstring or null(date-time)

deactivatedReasonstring or null

isDefaultboolean

splitsArray of objects or null(NetPaySplitItem)

Response

application/json

{
  "id": "string",
  "employeeId": "string",
  "contractorId": "string",
  "deactivatedAt": "2019-08-24T14:15:22Z",
  "deactivatedReason": "string",
  "isDefault": true,
  "splits": [
    { … }
  ]
}

Query Employee Net Pay Splits

Request

Path

companyIdstringrequired

employeeIdstringrequired

Query

cursorstring

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

Responses

Bodyapplication/json

previousPagestring or null

nextPagestring or null

resultsArray of objects or null(NetPaySplit)

Response

application/json

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

Get Employee Net Pay Split

Request

Path

companyIdstringrequired

employeeIdstringrequired

netPaySplitIdstringrequired

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

Responses

Bodyapplication/json

idstring or null

employeeIdstring or null

contractorIdstring or null

deactivatedAtstring or null(date-time)

deactivatedReasonstring or null

isDefaultboolean

splitsArray of objects or null(NetPaySplitItem)

Response

application/json

{
  "id": "string",
  "employeeId": "string",
  "contractorId": "string",
  "deactivatedAt": "2019-08-24T14:15:22Z",
  "deactivatedReason": "string",
  "isDefault": true,
  "splits": [
    { … }
  ]
}

Employee SSN Setup

Request

Path

companyIdstringrequired

employeeIdstringrequired

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

Responses

Bodyapplication/json

urlstring or null

Response

application/json

{
  "url": "string"
}

Employee Withholdings Setup

Request

Path

companyIdstringrequired

employeeIdstringrequired

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

Responses

Bodyapplication/json

urlstring or null

Response

application/json

{
  "url": "string"
}

Partner Portfolio

Operations

Payment Schedules

Operations

Payrolls

Operations

Workplaces

Operations

Encompass.Api (1.0)

Benefits - Company

Benefits - Employee

Companies

Contractors

Deductions - Child Support

Deductions - Miscellaneous

Departments

Documents

Earning Codes

Employees

Create Employee

RequestExpand all

Responses

Was this helpful?

Query Employees

Request

Responses

Was this helpful?

Get Employee

Request

Responses

Was this helpful?

Update Employee

RequestExpand all

Responses

Was this helpful?

Get Employee Paystub

Request

Responses

Was this helpful?

Query Employee Paystubs

Request

Responses

Was this helpful?

Download Employee Paystub

Request

Responses

Was this helpful?

Query Employee Forms

Request

Responses

Was this helpful?

Get Employee Form

Request

Responses

Was this helpful?

Submit Employee Form

RequestExpand all

Responses

Was this helpful?

Query Company Defined Attributes

Request

Responses

Was this helpful?

Update Company Defined Attributes

Request

Responses

Was this helpful?

Query Reciprocity Elections

Request

Responses

Was this helpful?

Update Reciprocity Elections

Request

Responses

Was this helpful?

Create Employee Bank Account

Request

Responses

Was this helpful?

Query Employee Bank Accounts

Request

Responses

Was this helpful?

Get Employee Bank Account

Request

Responses

Was this helpful?

Update Employee Bank Account

Request

Request

Request

Request