Payroll Benefits
List Payroll Benefits
API Reference
- Authentication
- Carriers
- Components (Embeddable UI)
- Connections
- Dependents
- Employer Documents
- Employers
- Enrollments
- Group Connections
- Members
- Pay Rates
- Payroll Benefits
- Groups
- Plans
- Plan Configurations
- Subclasses
- Tasks
- Reports
Payroll Benefits
List Payroll Benefits
Returns a list of all payroll benefit deductions.
GET
/
payroll_benefits
curl --request GET \
--url https://sandbox.withclasp.com/payroll_benefits \
--header 'Authorization: Bearer <token>'
{
"next": "<string>",
"previous": "<string>",
"results": [
{
"id": "<string>",
"member": "<string>",
"line_of_coverage": "accident",
"description": "<string>",
"member_contribution": "<string>",
"employer_contribution": "<string>",
"period": "weekly",
"effective_start": "2023-11-07T05:31:56Z",
"effective_end": "2023-11-07T05:31:56Z",
"payroll_provider_external_id": "<string>",
"taxability": "pre_tax"
}
]
}
Authorizations
API Key authentication with required prefix "Bearer"
Query Parameters
The pagination cursor value.
Number of results to return per page.
Response
200 - application/json
accident
- Accidentaccidental_death
- Accidental Death and Dismembermentcancer
- Cancerdental
- Dentaldependent_care_fsa
- Dependent Care Flexible Spending Accounthealthcare_fsa
- Healthcare Flexible Spending Accounthospital_indemnity
- Hospital Indemnityhsa
- Health Savings Accountlife
- Lifelimited_purpose_fsa
- Limited Purpose Flexible Spending Accountltd
- Long Term Disabilitymedical
- Medicalstd
- Short Term Disabilityvision
- Visionvoluntary_critical_illness
- Voluntary Critical Illnessvoluntary_life
- Voluntary Lifevoluntary_std
- Voluntary Short Term Disability
Available options:
accident
, accidental_death
, cancer
, dental
, dependent_care_fsa
, healthcare_fsa
, hospital_indemnity
, hsa
, life
, limited_purpose_fsa
, ltd
, medical
, std
, vision
, voluntary_critical_illness
, voluntary_life
, voluntary_std
Maximum length:
255
weekly
- Weeklybiweekly
- Biweeklysemimonthly
- Semimonthlymonthly
- Monthly
Available options:
weekly
, biweekly
, semimonthly
, monthly
Maximum length:
255
pre_tax
- Pre-taxpost_tax
- Post-tax
Available options:
pre_tax
, post_tax
curl --request GET \
--url https://sandbox.withclasp.com/payroll_benefits \
--header 'Authorization: Bearer <token>'
{
"next": "<string>",
"previous": "<string>",
"results": [
{
"id": "<string>",
"member": "<string>",
"line_of_coverage": "accident",
"description": "<string>",
"member_contribution": "<string>",
"employer_contribution": "<string>",
"period": "weekly",
"effective_start": "2023-11-07T05:31:56Z",
"effective_end": "2023-11-07T05:31:56Z",
"payroll_provider_external_id": "<string>",
"taxability": "pre_tax"
}
]
}