Skip to content
Vitable Docs Vitable Docs Vitable Docs
API Reference
Employers

Submit Payroll Access Setup

employers.submit_payroll_access_setup(employer_id, **kwargs) -> EmployerSubmitPayrollAccessSetupResponse { data }
PUT/v1/employers/{employer_id}/payroll-access-setup

Submit the employer’s payroll access setup answers.

ParametersExpand Collapse
employer_id: String

Unique employer identifier (empr_*)

access_method: :SELF_SETUP | :NEEDS_HELP
  • SELF_SETUP - SELF_SETUP
  • NEEDS_HELP - NEEDS_HELP
One of the following:
:SELF_SETUP
:NEEDS_HELP
all_benefit_eligible_employees_present: bool
classifications_accurate: bool
employees_in_payroll_acknowledged: bool
has_additional_payroll_system: bool
is_controlled_group: bool
payroll_data_impacts_eligibility_acknowledged: bool
additional_access_method: :SELF_SETUP | :NEEDS_HELP
  • SELF_SETUP - SELF_SETUP
  • NEEDS_HELP - NEEDS_HELP
One of the following:
:SELF_SETUP
:NEEDS_HELP
additional_integration_confirmed: bool
additional_login_url: String
maxLength2048
additional_password: String
maxLength979
additional_phone: String
maxLength64
additional_username: String
maxLength255
classification_correction_source: :ENTER_NAMES | :EMAIL_LIST
  • ENTER_NAMES - ENTER_NAMES
  • EMAIL_LIST - EMAIL_LIST
One of the following:
:ENTER_NAMES
:EMAIL_LIST
integration_confirmed: bool
login_url: String
maxLength2048
misclassified_employee_names: Array[String]
missing_employee_resolution: :EMAIL_CENSUS | :SECOND_SYSTEM_ACCESS
  • EMAIL_CENSUS - EMAIL_CENSUS
  • SECOND_SYSTEM_ACCESS - SECOND_SYSTEM_ACCESS
One of the following:
:EMAIL_CENSUS
:SECOND_SYSTEM_ACCESS
password: String
maxLength979
phone: String
maxLength64
remaining_employee_action: :VITABLE_UPDATE | :EMPLOYER_UPDATE
  • VITABLE_UPDATE - VITABLE_UPDATE
  • EMPLOYER_UPDATE - EMPLOYER_UPDATE
One of the following:
:VITABLE_UPDATE
:EMPLOYER_UPDATE
same_payroll_covers_other_eins: bool
username: String
maxLength255
ReturnsExpand Collapse
class EmployerSubmitPayrollAccessSetupResponse { data }

Response containing a single payroll access setup status resource.

data: { completed, submitted_at}
completed: bool
submitted_at: Time
formatdate-time

Submit Payroll Access Setup

require "vitable_connect"

vitable_connect = VitableConnect::Client.new(
  api_key: "My API Key",
  environment: "environment_1" # defaults to "production"
)

response = vitable_connect.employers.submit_payroll_access_setup(
  "empr_abc123def456",
  access_method: :SELF_SETUP,
  all_benefit_eligible_employees_present: true,
  classifications_accurate: true,
  employees_in_payroll_acknowledged: true,
  has_additional_payroll_system: true,
  is_controlled_group: true,
  payroll_data_impacts_eligibility_acknowledged: true
)

puts(response)
{
  "data": {
    "completed": true,
    "submitted_at": "2019-12-27T18:11:19.117Z"
  }
}
Returns Examples
{
  "data": {
    "completed": true,
    "submitted_at": "2019-12-27T18:11:19.117Z"
  }
}