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

Submit Payroll Access Setup

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

Submit the employer’s payroll access setup answers.

ParametersExpand Collapse
employer_id: str

Unique employer identifier (empr_*)

access_method: Literal["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: Optional[Literal["SELF_SETUP", "NEEDS_HELP"]]
  • SELF_SETUP - SELF_SETUP
  • NEEDS_HELP - NEEDS_HELP
One of the following:
"SELF_SETUP"
"NEEDS_HELP"
additional_integration_confirmed: Optional[bool]
additional_login_url: Optional[str]
maxLength2048
additional_password: Optional[str]
maxLength979
additional_phone: Optional[str]
maxLength64
additional_username: Optional[str]
maxLength255
classification_correction_source: Optional[Literal["ENTER_NAMES", "EMAIL_LIST"]]
  • ENTER_NAMES - ENTER_NAMES
  • EMAIL_LIST - EMAIL_LIST
One of the following:
"ENTER_NAMES"
"EMAIL_LIST"
integration_confirmed: Optional[bool]
login_url: Optional[str]
maxLength2048
misclassified_employee_names: Optional[SequenceNotStr[str]]
missing_employee_resolution: Optional[Literal["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: Optional[str]
maxLength979
phone: Optional[str]
maxLength64
remaining_employee_action: Optional[Literal["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: Optional[bool]
username: Optional[str]
maxLength255
ReturnsExpand Collapse
class EmployerSubmitPayrollAccessSetupResponse: …

Response containing a single payroll access setup status resource.

data: Data
completed: bool
submitted_at: Optional[datetime]
formatdate-time

Submit Payroll Access Setup

import os
from vitable_connect import VitableConnect

client = VitableConnect(
    api_key=os.environ.get("VITABLE_CONNECT_API_KEY"),  # This is the default and can be omitted
)
response = client.employers.submit_payroll_access_setup(
    employer_id="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,
)
print(response.data)
{
  "data": {
    "completed": true,
    "submitted_at": "2019-12-27T18:11:19.117Z"
  }
}
Returns Examples
{
  "data": {
    "completed": true,
    "submitted_at": "2019-12-27T18:11:19.117Z"
  }
}