{ "opencollection": "1.0.0", "info": { "name": "Plansource Admin Collections API", "version": "2.0.0" }, "request": { "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.plansource.com/oauth/v2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "Collections", "type": "folder" }, "items": [ { "info": { "name": "GET /payroll_coverages_subscribers", "type": "http" }, "http": { "method": "GET", "url": "https://api.plansource.com/admin/v2/payroll_coverages_subscribers", "params": [ { "name": "start_date", "value": "", "type": "query", "description": "Start date of a date range of payroll changes. ISO 8601 date or RFC 3339 date time date (ex. 2017-12-01 or 2017-12-01T12:30:30-06:00)." }, { "name": "end_date", "value": "", "type": "query", "description": "End date of a date range of payroll changes. ISO 8601 date or RFC 3339 date time (ex. 2017-12-01 or 2017-12-01T12:30:30-06:00)." }, { "name": "page", "value": "", "type": "query", "description": "Set to page number. Large responses are parsed into a maximum of 500 records or the per_page value for large responses." }, { "name": "per_page", "value": "", "type": "query", "description": "Override of the maximum of 500 records returned in a response." }, { "name": "include_test", "value": "", "type": "query", "description": "Include test employees." }, { "name": "current", "value": "", "type": "query", "description": "Return only the subscriber's current coverage records." }, { "name": "previous", "value": "", "type": "query", "description": "Return only the subscriber's coverage records that are immediately prior to the current record." } ] }, "docs": "Retrieve payroll coverages for all subscribers in the organization." }, { "info": { "name": "GET /subscribers", "type": "http" }, "http": { "method": "GET", "url": "https://api.plansource.com/admin/v2/subscribers", "params": [ { "name": "is_custom_id", "value": "", "type": "query", "description": "Set to true if the {id} in the path is customer generated." }, { "name": "page", "value": "", "type": "query", "description": "Set to page number. Large responses are parsed into a maximum of 500 subscribers or the per_page value for large responses of subscribers." }, { "name": "per_page", "value": "", "type": "query", "description": "Override of the maximum of 500 subscribers returned in a response." }, { "name": "include_test", "value": "", "type": "query", "description": "Include test employees." } ] }, "docs": "Retrieve data for all subscribers." }, { "info": { "name": "POST /subscribers", "type": "http" }, "http": { "method": "POST", "url": "https://api.plansource.com/admin/v2/subscribers", "params": [ { "name": "is_custom_id", "value": "", "type": "query", "description": "Set to true if the {id} in the path is customer generated." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create subscriber resources." }, { "info": { "name": "PUT /subscribers", "type": "http" }, "http": { "method": "PUT", "url": "https://api.plansource.com/admin/v2/subscribers", "params": [ { "name": "is_custom_id", "value": "", "type": "query", "description": "Set to true if the {id} is customer generated." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update data for all subscribers." }, { "info": { "name": "PUT /subscribers/terminate", "type": "http" }, "http": { "method": "PUT", "url": "https://api.plansource.com/admin/v2/subscribers/terminate", "params": [ { "name": "is_custom_id", "value": "", "type": "query", "description": "Set to true if the {id} is customer generated." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Terminate subscriber resources." }, { "info": { "name": "PUT /subscribers/rehire", "type": "http" }, "http": { "method": "PUT", "url": "https://api.plansource.com/admin/v2/subscribers/rehire", "params": [ { "name": "is_custom_id", "value": "", "type": "query", "description": "Set to true if the {id} is customer generated." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Rehire subscriber resources." }, { "info": { "name": "GET /dependents", "type": "http" }, "http": { "method": "GET", "url": "https://api.plansource.com/admin/v2/dependents", "params": [ { "name": "is_custom_id", "value": "", "type": "query", "description": "Set to true if the {subscriber_id} is customer generated." }, { "name": "subscriber_id", "value": "", "type": "query", "description": "Set {subscriber_id} to get all dependents for selected subscriber." } ] }, "docs": "Retrieve data for all dependents." }, { "info": { "name": "GET /organizations", "type": "http" }, "http": { "method": "GET", "url": "https://api.plansource.com/admin/v2/organizations" }, "docs": "Retrieve all organizations current API User has access to." }, { "info": { "name": "GET /eoi/subscriber/{subscriber_id}", "type": "http" }, "http": { "method": "GET", "url": "https://api.plansource.com/admin/v2/eoi/subscriber/:subscriber_id", "params": [ { "name": "subscriber_id", "value": "", "type": "path", "description": "The ID of the subscriber." } ] }, "docs": "Retrieve pending EOI data for a single subscriber." }, { "info": { "name": "GET /eoi/subscribers", "type": "http" }, "http": { "method": "GET", "url": "https://api.plansource.com/admin/v2/eoi/subscribers", "params": [ { "name": "include_test", "value": "", "type": "query", "description": "Include test employees." } ] }, "docs": "Retrieve pending EOI data for all subscribers." }, { "info": { "name": "PUT /eoi/decision/{subscriber_id}", "type": "http" }, "http": { "method": "PUT", "url": "https://api.plansource.com/admin/v2/eoi/decision/:subscriber_id", "params": [ { "name": "subscriber_id", "value": "", "type": "path", "description": "The ID of the subscriber." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Process EOI decisions for a single subscriber." }, { "info": { "name": "PUT /eoi/decisions", "type": "http" }, "http": { "method": "PUT", "url": "https://api.plansource.com/admin/v2/eoi/decisions", "body": { "type": "json", "data": "{}" } }, "docs": "Process EOI decisions for multiple subscribers." }, { "info": { "name": "PUT /eoi/form_completion/{subscriber_id}", "type": "http" }, "http": { "method": "PUT", "url": "https://api.plansource.com/admin/v2/eoi/form_completion/:subscriber_id", "params": [ { "name": "subscriber_id", "value": "", "type": "path", "description": "The ID of the subscriber." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Process EOI form completions for single subscriber." }, { "info": { "name": "PUT /eoi/form_completions", "type": "http" }, "http": { "method": "PUT", "url": "https://api.plansource.com/admin/v2/eoi/form_completions", "body": { "type": "json", "data": "{}" } }, "docs": "Process EOI form completions for multiple subscribers." }, { "info": { "name": "GET /coverages", "type": "http" }, "http": { "method": "GET", "url": "https://api.plansource.com/admin/v2/coverages", "params": [ { "name": "start_date", "value": "", "type": "query", "description": "Start date of a date range of coverage changes. ISO 8601 date or RFC 3339 date time date (ex. 2017-12-01 or 2017-12-01T12:30:30-06:00)." }, { "name": "end_date", "value": "", "type": "query", "description": "End date of a date range of coverage changes. ISO 8601 date or RFC 3339 date time (ex. 2017-12-01 or 2017-12-01T12:30:30-06:00)." }, { "name": "plan_year", "value": "", "type": "query", "description": "Plan year." }, { "name": "page", "value": "", "type": "query", "description": "Page number." }, { "name": "per_page", "value": "", "type": "query", "description": "Override the maximum of records returned in a response." }, { "name": "include_test", "value": "", "type": "query", "description": "Include test employees." } ] }, "docs": "Retrieve all coverages." }, { "info": { "name": "POST /coverages", "type": "http" }, "http": { "method": "POST", "url": "https://api.plansource.com/admin/v2/coverages", "params": [ { "name": "plan_year", "value": "", "type": "query", "description": "Plan year" }, { "name": "recalculate", "value": "", "type": "query", "description": "Perform a recalculate of the coverage" }, { "name": "validate_volume", "value": "", "type": "query", "description": "Perform the validation of the coverage" }, { "name": "recalculate_volume", "value": "", "type": "query", "description": "Perform a volume recalculate of the coverage" }, { "name": "set_original_effective_date", "value": "", "type": "query", "description": "Allow the setting of the original effective date" }, { "name": "set_change_effective_date", "value": "", "type": "query", "description": "Allow the setting of the change effective date" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create coverages" }, { "info": { "name": "PUT /coverages", "type": "http" }, "http": { "method": "PUT", "url": "https://api.plansource.com/admin/v2/coverages", "params": [ { "name": "plan_year", "value": "", "type": "query", "description": "Plan year" }, { "name": "recalculate", "value": "", "type": "query", "description": "Perform a recalculate of the coverage" }, { "name": "validate_volume", "value": "", "type": "query", "description": "Perform the validation of the coverage" }, { "name": "recalculate_volume", "value": "", "type": "query", "description": "Perform a volume recalculate of the coverage" }, { "name": "set_original_effective_date", "value": "", "type": "query", "description": "Allow the setting of the original effective date" }, { "name": "set_change_effective_date", "value": "", "type": "query", "description": "Allow the setting of the change effective date" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update coverages" }, { "info": { "name": "PUT /coverages/terminate", "type": "http" }, "http": { "method": "PUT", "url": "https://api.plansource.com/admin/v2/coverages/terminate", "params": [ { "name": "plan_year", "value": "", "type": "query", "description": "Plan year" }, { "name": "set_change_effective_date", "value": "", "type": "query", "description": "Allow the setting of the change effective date" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Terminate coverages" }, { "info": { "name": "GET /coverages/lines", "type": "http" }, "http": { "method": "GET", "url": "https://api.plansource.com/admin/v2/coverages/lines", "params": [ { "name": "start_date", "value": "", "type": "query", "description": "Start date of a date range of coverage changes. ISO 8601 date or RFC 3339 date time date (ex. 2017-12-01 or 2017-12-01T12:30:30-06:00)." }, { "name": "end_date", "value": "", "type": "query", "description": "End date of a date range of coverage changes. ISO 8601 date or RFC 3339 date time (ex. 2017-12-01 or 2017-12-01T12:30:30-06:00)." }, { "name": "plan_year", "value": "", "type": "query", "description": "Plan year." }, { "name": "page", "value": "", "type": "query", "description": "Page number." }, { "name": "per_page", "value": "", "type": "query", "description": "Override the maximum of records returned in a response." }, { "name": "include_test", "value": "", "type": "query", "description": "Include test employees." } ] }, "docs": "Retrieve all stacked coverage lines." }, { "info": { "name": "POST /coverages/lines", "type": "http" }, "http": { "method": "POST", "url": "https://api.plansource.com/admin/v2/coverages/lines", "params": [ { "name": "plan_year", "value": "", "type": "query", "description": "Plan year" }, { "name": "recalculate", "value": "", "type": "query", "description": "Perform a recalculate of the coverage" }, { "name": "validate_volume", "value": "", "type": "query", "description": "Perform the validation of the coverage" }, { "name": "recalculate_volume", "value": "", "type": "query", "description": "Perform a volume recalculate of the coverage" }, { "name": "set_original_effective_date", "value": "", "type": "query", "description": "Allow the setting of the original effective date" }, { "name": "set_change_effective_date", "value": "", "type": "query", "description": "Allow the setting of the change effective date" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create stacked coverage lines" }, { "info": { "name": "PUT /coverages/lines", "type": "http" }, "http": { "method": "PUT", "url": "https://api.plansource.com/admin/v2/coverages/lines", "params": [ { "name": "plan_year", "value": "", "type": "query", "description": "Plan year" }, { "name": "recalculate", "value": "", "type": "query", "description": "Perform a recalculate of the coverage" }, { "name": "validate_volume", "value": "", "type": "query", "description": "Perform the validation of the coverage" }, { "name": "recalculate_volume", "value": "", "type": "query", "description": "Perform a volume recalculate of the coverage" }, { "name": "set_original_effective_date", "value": "", "type": "query", "description": "Allow the setting of the original effective date" }, { "name": "set_change_effective_date", "value": "", "type": "query", "description": "Allow the setting of the change effective date" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update stacked coverage lines" }, { "info": { "name": "PUT /coverages/lines/terminate", "type": "http" }, "http": { "method": "PUT", "url": "https://api.plansource.com/admin/v2/coverages/lines/terminate", "params": [ { "name": "plan_year", "value": "", "type": "query", "description": "Plan year" }, { "name": "set_change_effective_date", "value": "", "type": "query", "description": "Allow the setting of the change effective date" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Terminate stacked coverage lines" }, { "info": { "name": "GET /coverages/dependents", "type": "http" }, "http": { "method": "GET", "url": "https://api.plansource.com/admin/v2/coverages/dependents", "params": [ { "name": "start_date", "value": "", "type": "query", "description": "Start date of a date range of coverage changes. ISO 8601 date or RFC 3339 date time date (ex. 2017-12-01 or 2017-12-01T12:30:30-06:00)." }, { "name": "end_date", "value": "", "type": "query", "description": "End date of a date range of coverage changes. ISO 8601 date or RFC 3339 date time (ex. 2017-12-01 or 2017-12-01T12:30:30-06:00)." }, { "name": "plan_year", "value": "", "type": "query", "description": "Plan year." }, { "name": "page", "value": "", "type": "query", "description": "Page number." }, { "name": "per_page", "value": "", "type": "query", "description": "Override the maximum of records returned in a response." }, { "name": "include_test", "value": "", "type": "query", "description": "Include test employees." } ] }, "docs": "Retrieve data for all dependent coverages." }, { "info": { "name": "POST /coverages/dependents", "type": "http" }, "http": { "method": "POST", "url": "https://api.plansource.com/admin/v2/coverages/dependents", "params": [ { "name": "plan_year", "value": "", "type": "query", "description": "Plan year" }, { "name": "set_change_effective_date", "value": "", "type": "query", "description": "Allow the setting of the change effective date" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create dependent coverages" }, { "info": { "name": "PUT /coverages/dependents", "type": "http" }, "http": { "method": "PUT", "url": "https://api.plansource.com/admin/v2/coverages/dependents", "params": [ { "name": "plan_year", "value": "", "type": "query", "description": "Plan year" }, { "name": "set_change_effective_date", "value": "", "type": "query", "description": "Allow the setting of the change effective date" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an dependents coverages" }, { "info": { "name": "PUT /coverages/dependents/terminate", "type": "http" }, "http": { "method": "PUT", "url": "https://api.plansource.com/admin/v2/coverages/dependents/terminate", "params": [ { "name": "plan_year", "value": "", "type": "query", "description": "Plan year" }, { "name": "set_change_effective_date", "value": "", "type": "query", "description": "Allow the setting of the change effective date" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Terminate dependents coverages" }, { "info": { "name": "GET /aca/offers", "type": "http" }, "http": { "method": "GET", "url": "https://api.plansource.com/admin/v2/aca/offers", "params": [ { "name": "changes_since", "value": "", "type": "query", "description": "Number of minutes since now to find new, changed and deleted offers" }, { "name": "include_deletes", "value": "", "type": "query", "description": "Should deleted offers be included?" }, { "name": "page", "value": "", "type": "query", "description": "Page number" }, { "name": "per_page", "value": "", "type": "query", "description": "Override the maximum of records returned in a response." } ] }, "docs": "Retrieve new, changed and deleted offers. If including deleted offers, they are appended after existing offers. Deleted offers are designated by is_deleted = true. Deleted offers are shown in the state they were upon deletion." }, { "info": { "name": "GET /aca/enrollees", "type": "http" }, "http": { "method": "GET", "url": "https://api.plansource.com/admin/v2/aca/enrollees", "params": [ { "name": "changes_since", "value": "", "type": "query", "description": "Number of minutes since now to find new, changed and deleted enrollees" }, { "name": "include_deletes", "value": "", "type": "query", "description": "Should deleted enrollees be included?" }, { "name": "page", "value": "", "type": "query", "description": "Page number" }, { "name": "per_page", "value": "", "type": "query", "description": "Override the maximum of records returned in a response." } ] }, "docs": "Retrieve new, changed and deleted enrollees. If including deleted enrollees, they are appended after existing enrollees. Deleted enrollees are designated by is_deleted = true. Deleted enrollees are shown in the state they were upon deletion." } ] } ], "bundled": true }