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

Get Company Authorization Document

Request

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

Responses

OK

Bodyapplication/json
idstring or null
companyIdstring
categorystring(DocumentCategory)
Enum"CompanyTaxDocument""CompanyAuthorizationDocument""EmployeeTaxDocument""ContractorTaxDocument"
labelstring or null
jurisdictionstring or null
yearinteger(int32)
filedOnstring(date)
Response
application/json
{
  "id": "string",
  "companyId": "string",
  "category": "CompanyTaxDocument",
  "label": "string",
  "jurisdiction": "string",
  "year": 0,
  "filedOn": "2019-08-24"
}

Query Company Authorization Documents

Request

Path
companyIdstringrequired
Query
yearinteger(int32)
curl -i -X GET \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/documents/company_authorization_documents?year=0'

Responses

OK

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

Download Company Authorization Document

Request

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

Responses

OK

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

Get Company Tax Document

Request

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

Responses

OK

Bodyapplication/json
idstring or null
companyIdstring
categorystring(DocumentCategory)
Enum"CompanyTaxDocument""CompanyAuthorizationDocument""EmployeeTaxDocument""ContractorTaxDocument"
labelstring or null
jurisdictionstring or null
yearinteger(int32)
filedOnstring(date)
descriptionstring or null
quarterstring or null
Response
application/json
{
  "id": "string",
  "companyId": "string",
  "category": "CompanyTaxDocument",
  "label": "string",
  "jurisdiction": "string",
  "year": 0,
  "filedOn": "2019-08-24",
  "description": "string",
  "quarter": "string"
}

Query Company Tax Documents

Request

Path
companyIdstringrequired
Query
yearinteger(int32)
quarterstring
curl -i -X GET \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/documents/company_tax_documents?year=0&quarter=string'

Responses

OK

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

Download Company Tax Document

Request

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

Responses

OK

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

Get Contractor Tax Document

Request

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

Responses

OK

Bodyapplication/json
idstring or null
contractorIdstring
categorystring(DocumentCategory)
Enum"CompanyTaxDocument""CompanyAuthorizationDocument""EmployeeTaxDocument""ContractorTaxDocument"
labelstring or null
jurisdictionstring or null
yearinteger(int32)
filedOnstring(date)
descriptionstring or null
Response
application/json
{
  "id": "string",
  "contractorId": "string",
  "category": "CompanyTaxDocument",
  "label": "string",
  "jurisdiction": "string",
  "year": 0,
  "filedOn": "2019-08-24",
  "description": "string"
}

Query Contractor Tax Documents

Request

Path
companyIdstringrequired
Query
contractorIdstring
yearinteger(int32)
quarterstring
curl -i -X GET \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/documents/contractor_tax_documents?contractorId=string&year=0&quarter=string'

Responses

OK

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

Download Contractor Tax Document

Request

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

Responses

OK

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

Get Employee Tax Document

Request

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

Responses

OK

Bodyapplication/json
idstring or null
employeeIdstring
categorystring(DocumentCategory)
Enum"CompanyTaxDocument""CompanyAuthorizationDocument""EmployeeTaxDocument""ContractorTaxDocument"
labelstring or null
jurisdictionstring or null
yearinteger(int32)
filedOnstring(date)
Response
application/json
{
  "id": "string",
  "employeeId": "string",
  "category": "CompanyTaxDocument",
  "label": "string",
  "jurisdiction": "string",
  "year": 0,
  "filedOn": "2019-08-24"
}

Query Employee Tax Documents

Request

Path
companyIdstringrequired
Query
employeeIdstring
yearinteger(int32)
quarterstring
curl -i -X GET \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/documents/employee_tax_documents?employeeId=string&year=0&quarter=string'

Responses

OK

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

Download Employee Tax Document

Request

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

Responses

OK

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

Earning Codes

Operations

Employees

Operations

Enrollment Profiles

Operations

Miscellaneous

Operations

Partners

Operations

Payment Schedules

Operations

Payrolls

Operations

Timecards

Operations

Workplaces

Operations