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.
Unique ID for subscriber. Used as a parameter in endpoint URL
Start Date. Used as a parameter in endpoint URL
End Date. Used as a parameter in endpoint URL
Plan Year Starts On
Plan Year Ends On
Benefit Lookup Code
Subscriber Pretax Premium
Subscriber Posttax Premium
Subscriber FSA Amount
Org FSA Amount
Original Effective Date
Change Effective Date
Dependent Subscriber Imputed Income
Dependent Organization Imputed Income
Plan Payroll Mapping Code
Plan Group Number
Plan Partner Code 1
Plan Partner Code 2
Time of creation
Time of update
Is current payroll
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.
Status for subscriber
Number of subscriber paydays
Returns the subscriber demographic field of benefit_company
Provides a full list of fields and previous/current values that where changed on the current record