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

Partner Portfolio

Operations

Payment Schedules

Operations

Payrolls

Operations

Create Payroll

Request

Path

companyIdstringrequired

Bodyapplication/jsonrequired

paymentScheduleIdstring or null

periodStartstring(date)

periodEndstring(date)

paydaystring(date)

typestring(PayrollType)

Enum"Regular""OffCycle""Adjustment""ThirdPartySickPay"

frequencystring(PayFrequency)

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

processingPeriodstring(ProcessingPeriod)

Enum"FourDay""TwoDay""OneDay"

forceSupplementalWithholdingsboolean

applyBenefitsboolean

applyDeductionsboolean

employeeItemsArray of objects or null(CreatePayrollEmployeeItem)

contractorItemsArray of objects or null(CreatePayrollContractorItem)

curl -i -X POST \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/payrolls' \
  -H 'Content-Type: application/json' \
  -d '{
    "paymentScheduleId": "string",
    "periodStart": "2019-08-24",
    "periodEnd": "2019-08-24",
    "payday": "2019-08-24",
    "type": "Regular",
    "frequency": "Weekly",
    "processingPeriod": "FourDay",
    "forceSupplementalWithholdings": true,
    "applyBenefits": true,
    "applyDeductions": true,
    "employeeItems": [
      {
        "employeeId": "string",
        "paymentMethod": "DirectDeposit",
        "flsaOvertimeExemption": "NonExempt",
        "supplementalTaxMethod": "Flat",
        "payments": [
          {
            "workplaceId": "string",
            "isSalaryRate": true,
            "payRate": 0.1,
            "regularHours": 0.1,
            "overtimeHours": 0.1,
            "doubleOvertimeHours": 0.1,
            "paidHolidayHours": 0.1,
            "sickHours": 0.1,
            "ptoHours": 0.1,
            "regularOverride": 0.1,
            "overtimeOverride": 0.1,
            "doubleOvertimeOverride": 0.1,
            "paidHolidayOverride": 0.1,
            "ptoOverride": 0.1,
            "sickOverride": 0.1,
            "nonHourlyRegular": 0.1,
            "bonus": 0.1,
            "commission": 0.1,
            "cashTips": 0.1,
            "paycheckTips": 0.1,
            "severance": 0.1,
            "groupTermLife": 0.1,
            "otherImputed": 0.1,
            "shareholderBenefits": 0.1,
            "shareholderHsa": 0.1,
            "earningCodeEarnings": [
              {
                "earningCodeId": "string",
                "value": 0.1,
                "valueOverride": 0.1
              }
            ]
          }
        ],
        "reimbursements": [
          {
            "amount": 0.1,
            "description": "string"
          }
        ]
      }
    ],
    "contractorItems": [
      {
        "contractorId": "string",
        "workplaceId": "string",
        "paymentMethod": "DirectDeposit",
        "hours": 0.1,
        "payRate": 0.1,
        "reimbursement": 0.1
      }
    ]
  }'

Responses

Bodyapplication/json

idstring

companyIdstring

paymentScheduleIdstring or null

periodStartstring(date)

periodEndstring(date)

deadlinestring(date)

paydaystring(date)

approvedAtstring or null(date-time)

statusstring(PayrollStatus)

Enum"Draft""Pending""Processing""Paid""PartiallyPaid""Failed"

typestring(PayrollType)

Enum"Regular""OffCycle""Adjustment""ThirdPartySickPay"

frequencystring(PayFrequency)

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

processingPeriodstring(ProcessingPeriod)

Enum"FourDay""TwoDay""OneDay"

fundingMethodstring(PayrollFundingMethod)

Enum"Ach""Wire"

totalsobject(PayrollTotals)

offCycleOptionsobject(PayrollOffCycleOptions)

employeeItemsArray of objects or null(PayrollEmployeeItem)

contractorItemsArray of objects or null(PayrollContractorItem)

warningsArray of objects or null(PayrollWarning)

isVoidboolean

isManagedboolean

Response

application/json

{
  "id": "string",
  "companyId": "string",
  "paymentScheduleId": "string",
  "periodStart": "2019-08-24",
  "periodEnd": "2019-08-24",
  "deadline": "2019-08-24",
  "payday": "2019-08-24",
  "approvedAt": "2019-08-24T14:15:22Z",
  "status": "Draft",
  "type": "Regular",
  "frequency": "Weekly",
  "processingPeriod": "FourDay",
  "fundingMethod": "Ach",
  "totals": {
    "employeeGross": 0.1,
    "employeeReimbursements": 0.1,
    "employeeTaxes": 0.1,
    "employeeBenefits": 0.1,
    "deductions": 0.1,
    "employeeNet": 0.1,
    "contractorGross": 0.1,
    "contractorReimbursements": 0.1,
    "contractorNet": 0.1,
    "companyTaxes": 0.1,
    "companyBenefits": 0.1,
    "liability": 0.1,
    "cashRequirement": 0.1
  },
  "offCycleOptions": {
    "forceSupplementalWithholdings": true,
    "applyBenefits": true,
    "applyDeductions": true
  },
  "employeeItems": [
    { … }
  ],
  "contractorItems": [
    { … }
  ],
  "warnings": [
    { … }
  ],
  "isVoid": true,
  "isManaged": true
}

Query Payrolls

Request

Path

companyIdstringrequired

Query

idArray of stringsrequired

pageinteger(int32)

Default 1

pageSizeinteger(int32)

Default 10

curl -i -X GET \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/payrolls?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(Payroll)

Response

application/json

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

Get Payroll

Request

Path

companyIdstringrequired

payrollIdstringrequired

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

Responses

Bodyapplication/json

idstring

companyIdstring

paymentScheduleIdstring or null

periodStartstring(date)

periodEndstring(date)

deadlinestring(date)

paydaystring(date)

approvedAtstring or null(date-time)

statusstring(PayrollStatus)

Enum"Draft""Pending""Processing""Paid""PartiallyPaid""Failed"

typestring(PayrollType)

Enum"Regular""OffCycle""Adjustment""ThirdPartySickPay"

frequencystring(PayFrequency)

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

processingPeriodstring(ProcessingPeriod)

Enum"FourDay""TwoDay""OneDay"

fundingMethodstring(PayrollFundingMethod)

Enum"Ach""Wire"

totalsobject(PayrollTotals)

offCycleOptionsobject(PayrollOffCycleOptions)

employeeItemsArray of objects or null(PayrollEmployeeItem)

contractorItemsArray of objects or null(PayrollContractorItem)

warningsArray of objects or null(PayrollWarning)

isVoidboolean

isManagedboolean

Response

application/json

{
  "id": "string",
  "companyId": "string",
  "paymentScheduleId": "string",
  "periodStart": "2019-08-24",
  "periodEnd": "2019-08-24",
  "deadline": "2019-08-24",
  "payday": "2019-08-24",
  "approvedAt": "2019-08-24T14:15:22Z",
  "status": "Draft",
  "type": "Regular",
  "frequency": "Weekly",
  "processingPeriod": "FourDay",
  "fundingMethod": "Ach",
  "totals": {
    "employeeGross": 0.1,
    "employeeReimbursements": 0.1,
    "employeeTaxes": 0.1,
    "employeeBenefits": 0.1,
    "deductions": 0.1,
    "employeeNet": 0.1,
    "contractorGross": 0.1,
    "contractorReimbursements": 0.1,
    "contractorNet": 0.1,
    "companyTaxes": 0.1,
    "companyBenefits": 0.1,
    "liability": 0.1,
    "cashRequirement": 0.1
  },
  "offCycleOptions": {
    "forceSupplementalWithholdings": true,
    "applyBenefits": true,
    "applyDeductions": true
  },
  "employeeItems": [
    { … }
  ],
  "contractorItems": [
    { … }
  ],
  "warnings": [
    { … }
  ],
  "isVoid": true,
  "isManaged": true
}

Update Payroll

Request

Path

companyIdstringrequired

payrollIdstringrequired

Bodyapplication/jsonrequired

paymentScheduleIdstring

periodStartstring(date)

periodEndstring(date)

paydaystring(date)

typestring

frequencystring

processingPeriodstring

forceSupplementalWithholdingsboolean

applyBenefitsboolean

applyDeductionsboolean

employeeItemsArray of objects or null(CreatePayrollEmployeeItem)

contractorItemsArray of objects or null(CreatePayrollContractorItem)

curl -i -X PATCH \
  'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/payrolls/{payrollId}' \
  -H 'Content-Type: application/json' \
  -d '{
    "paymentScheduleId": "string",
    "periodStart": "2019-08-24",
    "periodEnd": "2019-08-24",
    "payday": "2019-08-24",
    "type": "string",
    "frequency": "string",
    "processingPeriod": "string",
    "forceSupplementalWithholdings": true,
    "applyBenefits": true,
    "applyDeductions": true,
    "employeeItems": [
      {
        "employeeId": "string",
        "paymentMethod": "DirectDeposit",
        "flsaOvertimeExemption": "NonExempt",
        "supplementalTaxMethod": "Flat",
        "payments": [
          {
            "workplaceId": "string",
            "isSalaryRate": true,
            "payRate": 0.1,
            "regularHours": 0.1,
            "overtimeHours": 0.1,
            "doubleOvertimeHours": 0.1,
            "paidHolidayHours": 0.1,
            "sickHours": 0.1,
            "ptoHours": 0.1,
            "regularOverride": 0.1,
            "overtimeOverride": 0.1,
            "doubleOvertimeOverride": 0.1,
            "paidHolidayOverride": 0.1,
            "ptoOverride": 0.1,
            "sickOverride": 0.1,
            "nonHourlyRegular": 0.1,
            "bonus": 0.1,
            "commission": 0.1,
            "cashTips": 0.1,
            "paycheckTips": 0.1,
            "severance": 0.1,
            "groupTermLife": 0.1,
            "otherImputed": 0.1,
            "shareholderBenefits": 0.1,
            "shareholderHsa": 0.1,
            "earningCodeEarnings": [
              {
                "earningCodeId": "string",
                "value": 0.1,
                "valueOverride": 0.1
              }
            ]
          }
        ],
        "reimbursements": [
          {
            "amount": 0.1,
            "description": "string"
          }
        ]
      }
    ],
    "contractorItems": [
      {
        "contractorId": "string",
        "workplaceId": "string",
        "paymentMethod": "DirectDeposit",
        "hours": 0.1,
        "payRate": 0.1,
        "reimbursement": 0.1
      }
    ]
  }'

Responses

Bodyapplication/json

idstring

companyIdstring

paymentScheduleIdstring or null

periodStartstring(date)

periodEndstring(date)

deadlinestring(date)

paydaystring(date)

approvedAtstring or null(date-time)

statusstring(PayrollStatus)

Enum"Draft""Pending""Processing""Paid""PartiallyPaid""Failed"

typestring(PayrollType)

Enum"Regular""OffCycle""Adjustment""ThirdPartySickPay"

frequencystring(PayFrequency)

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

processingPeriodstring(ProcessingPeriod)

Enum"FourDay""TwoDay""OneDay"

fundingMethodstring(PayrollFundingMethod)

Enum"Ach""Wire"

totalsobject(PayrollTotals)

offCycleOptionsobject(PayrollOffCycleOptions)

employeeItemsArray of objects or null(PayrollEmployeeItem)

contractorItemsArray of objects or null(PayrollContractorItem)

warningsArray of objects or null(PayrollWarning)

isVoidboolean

isManagedboolean

Response

application/json

{
  "id": "string",
  "companyId": "string",
  "paymentScheduleId": "string",
  "periodStart": "2019-08-24",
  "periodEnd": "2019-08-24",
  "deadline": "2019-08-24",
  "payday": "2019-08-24",
  "approvedAt": "2019-08-24T14:15:22Z",
  "status": "Draft",
  "type": "Regular",
  "frequency": "Weekly",
  "processingPeriod": "FourDay",
  "fundingMethod": "Ach",
  "totals": {
    "employeeGross": 0.1,
    "employeeReimbursements": 0.1,
    "employeeTaxes": 0.1,
    "employeeBenefits": 0.1,
    "deductions": 0.1,
    "employeeNet": 0.1,
    "contractorGross": 0.1,
    "contractorReimbursements": 0.1,
    "contractorNet": 0.1,
    "companyTaxes": 0.1,
    "companyBenefits": 0.1,
    "liability": 0.1,
    "cashRequirement": 0.1
  },
  "offCycleOptions": {
    "forceSupplementalWithholdings": true,
    "applyBenefits": true,
    "applyDeductions": true
  },
  "employeeItems": [
    { … }
  ],
  "contractorItems": [
    { … }
  ],
  "warnings": [
    { … }
  ],
  "isVoid": true,
  "isManaged": true
}

Delete Payroll

Request

Path

companyIdstringrequired

payrollIdstringrequired

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

Responses

Preview Payroll

Request

Path

companyIdstringrequired

payrollIdstringrequired

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

Responses

Bodyapplication/json

idstring

companyIdstring

paymentScheduleIdstring or null

periodStartstring(date)

periodEndstring(date)

deadlinestring(date)

paydaystring(date)

approvedAtstring or null(date-time)

statusstring(PayrollStatus)

Enum"Draft""Pending""Processing""Paid""PartiallyPaid""Failed"

typestring(PayrollType)

Enum"Regular""OffCycle""Adjustment""ThirdPartySickPay"

frequencystring(PayFrequency)

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

processingPeriodstring(ProcessingPeriod)

Enum"FourDay""TwoDay""OneDay"

fundingMethodstring(PayrollFundingMethod)

Enum"Ach""Wire"

totalsobject(PayrollTotals)

offCycleOptionsobject(PayrollOffCycleOptions)

employeeItemsArray of objects or null(PayrollEmployeeItem)

contractorItemsArray of objects or null(PayrollContractorItem)

warningsArray of objects or null(PayrollWarning)

isVoidboolean

isManagedboolean

Response

application/json

{
  "id": "string",
  "companyId": "string",
  "paymentScheduleId": "string",
  "periodStart": "2019-08-24",
  "periodEnd": "2019-08-24",
  "deadline": "2019-08-24",
  "payday": "2019-08-24",
  "approvedAt": "2019-08-24T14:15:22Z",
  "status": "Draft",
  "type": "Regular",
  "frequency": "Weekly",
  "processingPeriod": "FourDay",
  "fundingMethod": "Ach",
  "totals": {
    "employeeGross": 0.1,
    "employeeReimbursements": 0.1,
    "employeeTaxes": 0.1,
    "employeeBenefits": 0.1,
    "deductions": 0.1,
    "employeeNet": 0.1,
    "contractorGross": 0.1,
    "contractorReimbursements": 0.1,
    "contractorNet": 0.1,
    "companyTaxes": 0.1,
    "companyBenefits": 0.1,
    "liability": 0.1,
    "cashRequirement": 0.1
  },
  "offCycleOptions": {
    "forceSupplementalWithholdings": true,
    "applyBenefits": true,
    "applyDeductions": true
  },
  "employeeItems": [
    { … }
  ],
  "contractorItems": [
    { … }
  ],
  "warnings": [
    { … }
  ],
  "isVoid": true,
  "isManaged": true
}

Approve Payroll

Request

Path

companyIdstringrequired

payrollIdstringrequired

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

Responses

Bodyapplication/json

idstring

companyIdstring

paymentScheduleIdstring or null

periodStartstring(date)

periodEndstring(date)

deadlinestring(date)

paydaystring(date)

approvedAtstring or null(date-time)

statusstring(PayrollStatus)

Enum"Draft""Pending""Processing""Paid""PartiallyPaid""Failed"

typestring(PayrollType)

Enum"Regular""OffCycle""Adjustment""ThirdPartySickPay"

frequencystring(PayFrequency)

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

processingPeriodstring(ProcessingPeriod)

Enum"FourDay""TwoDay""OneDay"

fundingMethodstring(PayrollFundingMethod)

Enum"Ach""Wire"

totalsobject(PayrollTotals)

offCycleOptionsobject(PayrollOffCycleOptions)

employeeItemsArray of objects or null(PayrollEmployeeItem)

contractorItemsArray of objects or null(PayrollContractorItem)

warningsArray of objects or null(PayrollWarning)

isVoidboolean

isManagedboolean

Response

application/json

{
  "id": "string",
  "companyId": "string",
  "paymentScheduleId": "string",
  "periodStart": "2019-08-24",
  "periodEnd": "2019-08-24",
  "deadline": "2019-08-24",
  "payday": "2019-08-24",
  "approvedAt": "2019-08-24T14:15:22Z",
  "status": "Draft",
  "type": "Regular",
  "frequency": "Weekly",
  "processingPeriod": "FourDay",
  "fundingMethod": "Ach",
  "totals": {
    "employeeGross": 0.1,
    "employeeReimbursements": 0.1,
    "employeeTaxes": 0.1,
    "employeeBenefits": 0.1,
    "deductions": 0.1,
    "employeeNet": 0.1,
    "contractorGross": 0.1,
    "contractorReimbursements": 0.1,
    "contractorNet": 0.1,
    "companyTaxes": 0.1,
    "companyBenefits": 0.1,
    "liability": 0.1,
    "cashRequirement": 0.1
  },
  "offCycleOptions": {
    "forceSupplementalWithholdings": true,
    "applyBenefits": true,
    "applyDeductions": true
  },
  "employeeItems": [
    { … }
  ],
  "contractorItems": [
    { … }
  ],
  "warnings": [
    { … }
  ],
  "isVoid": true,
  "isManaged": true
}

Reopen Payroll

Request

Path

companyIdstringrequired

payrollIdstringrequired

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

Responses

Bodyapplication/json

idstring

companyIdstring

paymentScheduleIdstring or null

periodStartstring(date)

periodEndstring(date)

deadlinestring(date)

paydaystring(date)

approvedAtstring or null(date-time)

statusstring(PayrollStatus)

Enum"Draft""Pending""Processing""Paid""PartiallyPaid""Failed"

typestring(PayrollType)

Enum"Regular""OffCycle""Adjustment""ThirdPartySickPay"

frequencystring(PayFrequency)

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

processingPeriodstring(ProcessingPeriod)

Enum"FourDay""TwoDay""OneDay"

fundingMethodstring(PayrollFundingMethod)

Enum"Ach""Wire"

totalsobject(PayrollTotals)

offCycleOptionsobject(PayrollOffCycleOptions)

employeeItemsArray of objects or null(PayrollEmployeeItem)

contractorItemsArray of objects or null(PayrollContractorItem)

warningsArray of objects or null(PayrollWarning)

isVoidboolean

isManagedboolean

Response

application/json

{
  "id": "string",
  "companyId": "string",
  "paymentScheduleId": "string",
  "periodStart": "2019-08-24",
  "periodEnd": "2019-08-24",
  "deadline": "2019-08-24",
  "payday": "2019-08-24",
  "approvedAt": "2019-08-24T14:15:22Z",
  "status": "Draft",
  "type": "Regular",
  "frequency": "Weekly",
  "processingPeriod": "FourDay",
  "fundingMethod": "Ach",
  "totals": {
    "employeeGross": 0.1,
    "employeeReimbursements": 0.1,
    "employeeTaxes": 0.1,
    "employeeBenefits": 0.1,
    "deductions": 0.1,
    "employeeNet": 0.1,
    "contractorGross": 0.1,
    "contractorReimbursements": 0.1,
    "contractorNet": 0.1,
    "companyTaxes": 0.1,
    "companyBenefits": 0.1,
    "liability": 0.1,
    "cashRequirement": 0.1
  },
  "offCycleOptions": {
    "forceSupplementalWithholdings": true,
    "applyBenefits": true,
    "applyDeductions": true
  },
  "employeeItems": [
    { … }
  ],
  "contractorItems": [
    { … }
  ],
  "warnings": [
    { … }
  ],
  "isVoid": true,
  "isManaged": true
}

Payroll Paper Checks

Request

Path

companyIdstringrequired

payrollIdstringrequired

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

Responses

Bodyapplication/json

base64Contentstring or null

paperChecksAvailableboolean

Response

application/json

{
  "base64Content": "string",
  "paperChecksAvailable": true
}

Workplaces

Operations

Encompass.Api (1.0)

Benefits - Company

Benefits - Employee

Companies

Contractors

Deductions - Child Support

Deductions - Miscellaneous

Departments

Documents

Earning Codes

Employees

Partner Portfolio

Payment Schedules

Payrolls

Create Payroll

RequestExpand all

Responses

Was this helpful?

Query Payrolls

Request

Responses

Was this helpful?

Get Payroll

Request

Responses

Was this helpful?

Update Payroll

RequestExpand all

Responses

Was this helpful?

Delete Payroll

Request

Responses

Was this helpful?

Preview Payroll

Request

Responses

Was this helpful?

Approve Payroll

Request

Responses

Was this helpful?

Reopen Payroll

Request

Responses

Was this helpful?

Payroll Paper Checks

Request

Responses

Was this helpful?

Workplaces

Request

Request