Skip to content
Vitable Docs Vitable Docs Vitable Docs
API Reference

Employees

Get employee
employees.retrieve(stremployee_id) -> EmployeeRetrieveResponse
GET/v1/employees/{employee_id}
Update employee
employees.update(stremployee_id, EmployeeUpdateParams**kwargs) -> EmployeeUpdateResponse
PATCH/v1/employees/{employee_id}
List employee enrollments
employees.list_enrollments(stremployee_id, EmployeeListEnrollmentsParams**kwargs) -> SyncPageNumberPage[Enrollment]
GET/v1/employees/{employee_id}/enrollments
ModelsExpand Collapse
class Employee: …
id: str

Unique employee identifier with ‘empl_’ prefix

classification_effective_date: date

Date the employee’s current classification took effect

formatdate
compensation_type: Optional[Literal["Salary", "Hourly"]]
  • Salary - Salary
  • Hourly - Hourly
One of the following:
"Salary"
"Hourly"
compensation_type_effective_date: date

Date the employee’s current compensation type took effect

formatdate
created_at: datetime

Timestamp when the employee was created

formatdate-time
date_of_birth: date

Date of birth (YYYY-MM-DD)

formatdate
deductions: List[Deduction]

Payroll deductions from the most recent statement period. Replaced when a new statement is generated.

benefit_name: str

Name of the benefit plan

deduction_amount_in_cents: int

Employee deduction amount in cents

deduction_category: Optional[str]

Deduction category (reserved for future use)

frequency: Literal["weekly", "bi_weekly", "semi_monthly", "monthly"]
  • weekly - Weekly
  • bi_weekly - Bi Weekly
  • semi_monthly - Semi Monthly
  • monthly - Monthly
One of the following:
"weekly"
"bi_weekly"
"semi_monthly"
"monthly"
period_end_date: date

Period end date (YYYY-MM-DD)

formatdate
period_start_date: date

Period start date (YYYY-MM-DD)

formatdate
tax_classification: Literal["Unknown", "Pre-tax", "Post-tax"]
  • Unknown - Unknown
  • Pre-tax - Pre Tax
  • Post-tax - Post Tax
One of the following:
"Unknown"
"Pre-tax"
"Post-tax"
email: str

Email address

formatemail
employee_class: EmployeeClass
  • Full Time - Full Time
  • Part Time - Part Time
  • Temporary - Temporary
  • Intern - Intern
  • Seasonal - Seasonal
  • Individual Contractor - Individual Contractor
One of the following:
"Full Time"
"Part Time"
"Temporary"
"Intern"
"Seasonal"
"Individual Contractor"
employer_id: str

Unique identifier of the employer this employment is with (empr_*)

first_name: str

Employee’s legal first name

last_name: str

Employee’s legal last name

member_id: str

Unique member identifier with ‘mbr_’ prefix

phone: Optional[str]

Phone number (10-digit US domestic string)

start_date: date

Employee’s start date with the employer

formatdate
status: Literal["active", "terminated"]

Employee status (active or terminated)

One of the following:
"active"
"terminated"
updated_at: datetime

Timestamp when the employee was last updated

formatdate-time
address: Optional[Address]

Employee’s residential address

address_line_1: str

Primary street address

city: str

City name

state: str

Two-letter state code (e.g., CA, NY)

zipcode: str

ZIP code (5 or 9 digit)

address_line_2: Optional[str]

Secondary street address (apt, suite, etc.)

employer_name: Optional[str]

Name of the employer this employment is with

gender: Optional[str]

Gender identity, if provided

reference_id: Optional[str]

Partner-assigned reference ID for the employee

suffix: Optional[str]

Name suffix (e.g., Jr., Sr., III)

termination_date: Optional[date]

Employee’s termination date, if terminated

formatdate
Literal["Full Time", "Part Time", "Temporary", 3 more]
  • Full Time - Full Time
  • Part Time - Part Time
  • Temporary - Temporary
  • Intern - Intern
  • Seasonal - Seasonal
  • Individual Contractor - Individual Contractor
One of the following:
"Full Time"
"Part Time"
"Temporary"
"Intern"
"Seasonal"
"Individual Contractor"
class EmployeeRetrieveResponse: …

Response containing a single employee resource.

data: Employee
id: str

Unique employee identifier with ‘empl_’ prefix

classification_effective_date: date

Date the employee’s current classification took effect

formatdate
compensation_type: Optional[Literal["Salary", "Hourly"]]
  • Salary - Salary
  • Hourly - Hourly
One of the following:
"Salary"
"Hourly"
compensation_type_effective_date: date

Date the employee’s current compensation type took effect

formatdate
created_at: datetime

Timestamp when the employee was created

formatdate-time
date_of_birth: date

Date of birth (YYYY-MM-DD)

formatdate
deductions: List[Deduction]

Payroll deductions from the most recent statement period. Replaced when a new statement is generated.

benefit_name: str

Name of the benefit plan

deduction_amount_in_cents: int

Employee deduction amount in cents

deduction_category: Optional[str]

Deduction category (reserved for future use)

frequency: Literal["weekly", "bi_weekly", "semi_monthly", "monthly"]
  • weekly - Weekly
  • bi_weekly - Bi Weekly
  • semi_monthly - Semi Monthly
  • monthly - Monthly
One of the following:
"weekly"
"bi_weekly"
"semi_monthly"
"monthly"
period_end_date: date

Period end date (YYYY-MM-DD)

formatdate
period_start_date: date

Period start date (YYYY-MM-DD)

formatdate
tax_classification: Literal["Unknown", "Pre-tax", "Post-tax"]
  • Unknown - Unknown
  • Pre-tax - Pre Tax
  • Post-tax - Post Tax
One of the following:
"Unknown"
"Pre-tax"
"Post-tax"
email: str

Email address

formatemail
employee_class: EmployeeClass
  • Full Time - Full Time
  • Part Time - Part Time
  • Temporary - Temporary
  • Intern - Intern
  • Seasonal - Seasonal
  • Individual Contractor - Individual Contractor
One of the following:
"Full Time"
"Part Time"
"Temporary"
"Intern"
"Seasonal"
"Individual Contractor"
employer_id: str

Unique identifier of the employer this employment is with (empr_*)

first_name: str

Employee’s legal first name

last_name: str

Employee’s legal last name

member_id: str

Unique member identifier with ‘mbr_’ prefix

phone: Optional[str]

Phone number (10-digit US domestic string)

start_date: date

Employee’s start date with the employer

formatdate
status: Literal["active", "terminated"]

Employee status (active or terminated)

One of the following:
"active"
"terminated"
updated_at: datetime

Timestamp when the employee was last updated

formatdate-time
address: Optional[Address]

Employee’s residential address

address_line_1: str

Primary street address

city: str

City name

state: str

Two-letter state code (e.g., CA, NY)

zipcode: str

ZIP code (5 or 9 digit)

address_line_2: Optional[str]

Secondary street address (apt, suite, etc.)

employer_name: Optional[str]

Name of the employer this employment is with

gender: Optional[str]

Gender identity, if provided

reference_id: Optional[str]

Partner-assigned reference ID for the employee

suffix: Optional[str]

Name suffix (e.g., Jr., Sr., III)

termination_date: Optional[date]

Employee’s termination date, if terminated

formatdate
class EmployeeUpdateResponse: …

Response containing a single employee resource.

data: Employee
id: str

Unique employee identifier with ‘empl_’ prefix

classification_effective_date: date

Date the employee’s current classification took effect

formatdate
compensation_type: Optional[Literal["Salary", "Hourly"]]
  • Salary - Salary
  • Hourly - Hourly
One of the following:
"Salary"
"Hourly"
compensation_type_effective_date: date

Date the employee’s current compensation type took effect

formatdate
created_at: datetime

Timestamp when the employee was created

formatdate-time
date_of_birth: date

Date of birth (YYYY-MM-DD)

formatdate
deductions: List[Deduction]

Payroll deductions from the most recent statement period. Replaced when a new statement is generated.

benefit_name: str

Name of the benefit plan

deduction_amount_in_cents: int

Employee deduction amount in cents

deduction_category: Optional[str]

Deduction category (reserved for future use)

frequency: Literal["weekly", "bi_weekly", "semi_monthly", "monthly"]
  • weekly - Weekly
  • bi_weekly - Bi Weekly
  • semi_monthly - Semi Monthly
  • monthly - Monthly
One of the following:
"weekly"
"bi_weekly"
"semi_monthly"
"monthly"
period_end_date: date

Period end date (YYYY-MM-DD)

formatdate
period_start_date: date

Period start date (YYYY-MM-DD)

formatdate
tax_classification: Literal["Unknown", "Pre-tax", "Post-tax"]
  • Unknown - Unknown
  • Pre-tax - Pre Tax
  • Post-tax - Post Tax
One of the following:
"Unknown"
"Pre-tax"
"Post-tax"
email: str

Email address

formatemail
employee_class: EmployeeClass
  • Full Time - Full Time
  • Part Time - Part Time
  • Temporary - Temporary
  • Intern - Intern
  • Seasonal - Seasonal
  • Individual Contractor - Individual Contractor
One of the following:
"Full Time"
"Part Time"
"Temporary"
"Intern"
"Seasonal"
"Individual Contractor"
employer_id: str

Unique identifier of the employer this employment is with (empr_*)

first_name: str

Employee’s legal first name

last_name: str

Employee’s legal last name

member_id: str

Unique member identifier with ‘mbr_’ prefix

phone: Optional[str]

Phone number (10-digit US domestic string)

start_date: date

Employee’s start date with the employer

formatdate
status: Literal["active", "terminated"]

Employee status (active or terminated)

One of the following:
"active"
"terminated"
updated_at: datetime

Timestamp when the employee was last updated

formatdate-time
address: Optional[Address]

Employee’s residential address

address_line_1: str

Primary street address

city: str

City name

state: str

Two-letter state code (e.g., CA, NY)

zipcode: str

ZIP code (5 or 9 digit)

address_line_2: Optional[str]

Secondary street address (apt, suite, etc.)

employer_name: Optional[str]

Name of the employer this employment is with

gender: Optional[str]

Gender identity, if provided

reference_id: Optional[str]

Partner-assigned reference ID for the employee

suffix: Optional[str]

Name suffix (e.g., Jr., Sr., III)

termination_date: Optional[date]

Employee’s termination date, if terminated

formatdate