Contractors

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(ContractorWage)
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)
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"
  },
  "onboard": {
    "status": "Blocking",
    "blockingSteps": [ … ],
    "remainingSteps": [ … ],
    "ssn": [ … ],
    "ein": [ … ],
    "paymentMethod": [ … ],
    "address": [ … ],
    "withholdings": [ … ]
  },
  "form1099ElectronicConsent": true,
  "active": true
}

Query Contractors

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}/contractors?active=true&id=string&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)
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"
  },
  "onboard": {
    "status": "Blocking",
    "blockingSteps": [ … ],
    "remainingSteps": [ … ],
    "ssn": [ … ],
    "ein": [ … ],
    "paymentMethod": [ … ],
    "address": [ … ],
    "withholdings": [ … ]
  },
  "form1099ElectronicConsent": true,
  "active": true
}

Update Contractor

Request

Path
companyIdstringrequired
contractorIdstringrequired
Bodyapplication/jsonrequired
departmentIdstring
primaryWorkplaceIdstring
workplacesArray of strings or null
firstNamestring
middleNamestring
lastNamestring
businessNamestring
emailstring
ssnstring
einstring
dateOfBirthstring(date)
startDatestring(date)
terminationDatestring(date)
typestring
defaultPaymentMethodstring
form1099ElectronicConsentboolean
activeboolean
addressobject(CreateAddressRequest)
wageobject(ContractorWage)
curl -i -X PATCH \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/contractors/{contractorId}' \
  -H 'Content-Type: application/json' \
  -d '{
    "departmentId": "string",
    "primaryWorkplaceId": "string",
    "workplaces": [
      "string"
    ],
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "businessName": "string",
    "email": "string",
    "ssn": "string",
    "ein": "string",
    "dateOfBirth": "2019-08-24",
    "startDate": "2019-08-24",
    "terminationDate": "2019-08-24",
    "type": "string",
    "defaultPaymentMethod": "string",
    "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)
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"
  },
  "onboard": {
    "status": "Blocking",
    "blockingSteps": [ … ],
    "remainingSteps": [ … ],
    "ssn": [ … ],
    "ein": [ … ],
    "paymentMethod": [ … ],
    "address": [ … ],
    "withholdings": [ … ]
  },
  "form1099ElectronicConsent": true,
  "active": true
}

Get Contractor Paystub

Request

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

Responses

OK

Bodyapplication/json
payrollobject(ContractorPaystubPayroll)
companyobject(ContractorPaystubCompany)
contractorobject(ContractorPaystubContractor)
netPaynumber(double)
netPayYtdnumber(double)
amountnumber(double)
amountYtdnumber(double)
reimbursementnumber(double)
reimbursementYtdnumber(double)
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": { … }
  },
  "contractor": {
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "businessName": "string",
    "email": "string",
    "ssnLastFour": "string",
    "ein": "string",
    "type": "Individual",
    "address": { … }
  },
  "netPay": 0.1,
  "netPayYtd": 0.1,
  "amount": 0.1,
  "amountYtd": 0.1,
  "reimbursement": 0.1,
  "reimbursementYtd": 0.1
}

Query Contractor Paystubs

Request

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

Responses

OK

Bodyapplication/json
previousPagestring or null
nextPagestring or null
resultsArray of objects or null(ContractorPaystub)
Response
application/json
{
  "previousPage": "string",
  "nextPage": "string",
  "results": [
    { … }
  ]
}

Download Contractor Paystub

Request

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

Responses

OK

Bodyapplication/json
filestring or null
Response
application/json
{
  "file": "string"
}

Query Contractor Forms

Request

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

Responses

OK

Bodyapplication/json
previousPagestring or null
nextPagestring or null
resultsArray of objects or null(PayrollFormDocument)
Response
application/json
{
  "previousPage": "string",
  "nextPage": "string",
  "results": [
    { … }
  ]
}

Get Contractor Form

Request

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

Responses

OK

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"
}

Preview Contractor Form

Request

Path
companyIdstringrequired
contractorIdstringrequired
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}/contractors/{contractorId}/forms/{formId}/preview' \
  -H 'Content-Type: application/json' \
  -d '{
    "parameters": [
      {
        "name": "string",
        "value": "string"
      }
    ]
  }'

Responses

OK

Submit Contractor Form

Request

Path
companyIdstringrequired
contractorIdstringrequired
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}/contractors/{contractorId}/forms/{formId}/submit' \
  -H 'Content-Type: application/json' \
  -d '{
    "parameters": [
      {
        "name": "string",
        "value": "string"
      }
    ]
  }'

Responses

OK

Create Contractor Bank Account

Request

Path
companyIdstringrequired
contractorIdstringrequired
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}/contractors/{contractorId}/bank_accounts' \
  -H 'Content-Type: application/json' \
  -d '{
    "accountNumber": "string",
    "routingNumber": "string",
    "institutionName": "string",
    "subtype": "Checking"
  }'

Responses

OK

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 Contractor Bank Accounts

Request

Path
companyIdstringrequired
contractorIdstringrequired
Query
cursorstring
curl -i -X GET \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/contractors/{contractorId}/bank_accounts?cursor=string'

Responses

OK

Bodyapplication/json
previousPagestring or null
nextPagestring or null
resultsArray of objects or null(BankAccount)
Response
application/json
{
  "previousPage": "string",
  "nextPage": "string",
  "results": [
    { … }
  ]
}

Get Contractor Bank Account

Request

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

Responses

OK

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 Contractor Bank Account

Request

Path
companyIdstringrequired
contractorIdstringrequired
bankAccountIdstringrequired
Bodyapplication/jsonrequired
accountNumberstring
routingNumberstring
institutionNamestring
subtypestring
curl -i -X PATCH \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/contractors/{contractorId}/bank_accounts/{bankAccountId}' \
  -H 'Content-Type: application/json' \
  -d '{
    "accountNumber": "string",
    "routingNumber": "string",
    "institutionName": "string",
    "subtype": "string"
  }'

Responses

OK

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 Contractor Bank Account

Request

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

Responses

OK

Create Contractor Net Pay Split

Request

Path
companyIdstringrequired
contractorIdstringrequired
Bodyapplication/jsonrequired
isDefaultboolean
splitsArray of objects or null(CreateNetPaySplitItemRequest)
curl -i -X POST \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/contractors/{contractorId}/net_pay_splits' \
  -H 'Content-Type: application/json' \
  -d '{
    "isDefault": true,
    "splits": [
      {
        "bankAccountId": "string",
        "priority": 0,
        "amount": 0.1,
        "percent": 0.1
      }
    ]
  }'

Responses

OK

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 Contractor Net Pay Splits

Request

Path
companyIdstringrequired
contractorIdstringrequired
Query
cursorstring
curl -i -X GET \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/contractors/{contractorId}/net_pay_splits?cursor=string'

Responses

OK

Bodyapplication/json
previousPagestring or null
nextPagestring or null
resultsArray of objects or null(NetPaySplit)
Response
application/json
{
  "previousPage": "string",
  "nextPage": "string",
  "results": [
    { … }
  ]
}

Get Contractor Net Pay Split

Request

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

Responses

OK

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": [
    { … }
  ]
}

Contractor Tax Forms

Request

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

Responses

OK

Bodyapplication/json
urlstring or null
Response
application/json
{
  "url": "string"
}

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