Retrieve Payroll Access Setup

employers.retrieve_payroll_access_setup() -> EmployerRetrievePayrollAccessSetupResponse

GET/v1/employers/{employer_id}/payroll-access-setup

Return whether the employer has submitted payroll access setup.

ParametersExpand Collapse

employer_id: str

Unique employer identifier (empr_*)

ReturnsExpand Collapse

class EmployerRetrievePayrollAccessSetupResponse: …

Response containing a single payroll access setup status resource.

data: Data

completed: bool

submitted_at: Optional[datetime]

formatdate-time

Retrieve 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.retrieve_payroll_access_setup(
    "empr_abc123def456",
)
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"
  }
}