Payroll Fields

Payroll

Listed below are the data fields that can be accessed for Payroll data using PlanSource's API. Each field is described as being "optional". That is because developers are not required to fill out every data field in order to make the API call. Although that is the case, PlanSource does require certain data fields to be entered in order to get Payroll data. What is required can be changed manually within the PlanSource Benefits Admin site by utilizing the Data Field Security configuration.

📘
NOTE: Some of these fields are list validated fields. To learn what that means, visit the Guide on List Validated Fields.

Payroll Fields	Data Types	Field Descriptions
id	integer	Unique ID for subscriber. Used as a parameter in endpoint URL
start_date	date	Start Date. Used as a parameter in endpoint URL
end_date	date	End Date. Used as a parameter in endpoint URL
first_name	string	First Name
last_name	string	Last Name
middle_name	string	Middle Name
ssn	string	SSN
pay_frequency	integer	Pay Frequency
plan_year_starts_on	string	Plan Year Starts On
plan_year_ends_on	string	Plan Year Ends On
benefit_name	string	Benefit Name
benefit_lookup_code	string	Benefit Lookup Code
plan_name	string	Plan Name
coverage_level	string	Coverage Level
subscriber_premium	number	Subscriber Premium
org_premium	number	Org Premium
imputed_income	number	Imputed Income
subscriber_pretax_premium	number	Subscriber Pretax Premium
subscriber_posttax_premium	number	Subscriber Posttax Premium
tax_treatment	string	Tax Treatment
volume	number	Volume
subscriber_fsa_amount	number	Subscriber FSA Amount
org_fsa_amount	number	Org FSA Amount
original_effective_date	string	Original Effective Date
change_effective_date	string	Change Effective Date
termination_date	string	Termination Date
dp_sub_imputed_income	number	Dependent Subscriber Imputed Income
dp_org_imputed_income	number	Dependent Organization Imputed Income
plan_payroll_mapping_code	string	Plan Payroll Mapping Code
plan_group_number	string	Plan Group Number
plan_partner_code_1	string	Plan Partner Code 1
plan_partner_code_2	string	Plan Partner Code 2
created_at	string	Time of creation
updated_at	string	Time of update
test_employee	boolean	Test Employee
current	string	Is current payroll Available Responses: Y: Denotes a current coverage. N: Denotes whenever the Y changes to keep a history. D: Denotes whenever a coverage is deleted (rarely used). P: Denotes when a LE is pending. A: Denotes when a LE is accepted. R: Denotes when a LE is rejected. CP: Denotes when the subscriber hasn't completed checkout yet. CA: Denotes when the cart has been checked out, but enrollment/life event window is still open, or a benefit is waiting on EOI/Doc Processing. CR: Denotes whenever the subscriber removes something from their cart or their entire cart is archived, either when enrollment is reset or abandoned and cleaned up.
organization_id	string	Organization ID
subscriber_code	string	Subscriber code
subscriber_pay_frequency	string	Payroll Schedule
subscriber_status	string	Status for subscriber
subscriber_total_paydays	string	Number of subscriber paydays
benefit_company	string	Returns the subscriber demographic field of benefit_company
changed_fields	array	Provides a full list of fields and previous/current values that where changed on the current record

Payroll

NOTE: Some of these fields are list validated fields. To learn what that means, visit the Guide on List Validated Fields.