Sign in
Deductions

Get Deductions for Individuals

Get enrollment information for the given individuals.

get/employer/benefits/{benefit_id}/individuals

Query parameters

entity_idsstring[]

The entity IDs to specify which entities' data to access. Provide exactly one entity ID per request; a maximum of one is accepted.

[
  "550e8400-e29b-41d4-a716-446655440000"
]
individual_idsstring
Example:d675d2b7-6d7b-41a8-b2d3-001eb3fb88f6,d02a6346-1f08-4312-a064-49ff3cafaa7a

comma-delimited list of stable Finch uuids for each individual. If empty, defaults to all individuals

Headers

Finch-API-Versionstring date required

Header used to specify the version for a given API request. Current version is 2020-09-17.

Response

Success

individual_idstring required
codeinteger required

Changes

Changed in 6 of the 53 revisions of this API.221019

  • e883eed838304See the full diff
    • ○

      added subschema #1: IndividualBenefit to the items/body response property anyOf list for the response status 200

      response-property-any-of-added

    • ○

      added subschema #1: IndividualBenefit to the items/body response property anyOf list for the response status 207

      response-property-any-of-added

    • ○

      removed subschema #1 from the items/body response property anyOf list for the response status 200

      response-property-any-of-removed

    • ○

      removed subschema #1 from the items/body response property anyOf list for the response status 207

      response-property-any-of-removed

  • 39e0191e43a944See the full diff
    • ▲

      added subschema #1 subschema #2 to the items/body/anyOf[subschema #1]/employee_deduction response property oneOf list for the response status 200

      response-property-one-of-added

    • ▲

      added subschema #1 subschema #2 to the items/body/anyOf[subschema #1]/employee_deduction response property oneOf list for the response status 207

      response-property-one-of-added

    • ▲

      added subschema #1 subschema #2 subschema #3 to the items/body/anyOf[subschema #1]/company_contribution response property oneOf list for the response status 200

      response-property-one-of-added

    • ▲

      added subschema #1 subschema #2 subschema #3 to the items/body/anyOf[subschema #1]/company_contribution response property oneOf list for the response status 207

      response-property-one-of-added

    • ○

      removed subschema #1 subschema #2 from the items/body/anyOf[subschema #1]/employee_deduction response property oneOf list for the response status 200

      response-property-one-of-removed

    • ○

      removed subschema #1 subschema #2 from the items/body/anyOf[subschema #1]/employee_deduction response property oneOf list for the response status 207

      response-property-one-of-removed

    • ○

      removed subschema #1 subschema #2 subschema #3 from the items/body/anyOf[subschema #1]/company_contribution response property oneOf list for the response status 200

      response-property-one-of-removed

    • ○

      removed subschema #1 subschema #2 subschema #3 from the items/body/anyOf[subschema #1]/company_contribution response property oneOf list for the response status 207

      response-property-one-of-removed

  • 0105d239fcaf161See the full diff
    • ▲

      added subschema #1 subschema #2 subschema #3 to the items/body/anyOf[subschema #1]/employee_deduction response property oneOf list for the response status 200

      response-property-one-of-added

    • ▲

      added subschema #1 subschema #2 subschema #3 to the items/body/anyOf[subschema #1]/employee_deduction response property oneOf list for the response status 207

      response-property-one-of-added

    • ▲

      added subschema #1 subschema #2 subschema #3 subschema #4 to the items/body/anyOf[subschema #1]/company_contribution response property oneOf list for the response status 200

      response-property-one-of-added

    • ▲

      added subschema #1 subschema #2 subschema #3 subschema #4 to the items/body/anyOf[subschema #1]/company_contribution response property oneOf list for the response status 207

      response-property-one-of-added

    • ▲

      the items/body/anyOf[subschema #1]/company_contribution response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ▲

      the items/body/anyOf[subschema #1]/company_contribution response's property type/format changed from object/ to / for status 207

      response-property-type-changed

    • ▲

      the items/body/anyOf[subschema #1]/employee_deduction response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ▲

      the items/body/anyOf[subschema #1]/employee_deduction response's property type/format changed from object/ to / for status 207

      response-property-type-changed

    • ▲

      removed the required property items/body/anyOf[subschema #1]/company_contribution/amount from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property items/body/anyOf[subschema #1]/company_contribution/amount from the response with the 207 status

      response-required-property-removed

    • ▲

      removed the required property items/body/anyOf[subschema #1]/company_contribution/type from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property items/body/anyOf[subschema #1]/company_contribution/type from the response with the 207 status

      response-required-property-removed

    • ▲

      removed the required property items/body/anyOf[subschema #1]/employee_deduction/amount from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property items/body/anyOf[subschema #1]/employee_deduction/amount from the response with the 207 status

      response-required-property-removed

    • ▲

      removed the required property items/body/anyOf[subschema #1]/employee_deduction/type from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property items/body/anyOf[subschema #1]/employee_deduction/type from the response with the 207 status

      response-required-property-removed

    • ○

      added the new optional query request parameter entity_ids

      new-optional-request-parameter

    This revision also has 10 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 73c284d36c1e2108See the full diff
    • ▲

      the items/body response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ▲

      the items/body response's property type/format changed from object/ to / for status 207

      response-property-type-changed

    • ●

      removed the optional property items/body/annual_maximum from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/body/annual_maximum from the response with the 207 status

      response-optional-property-removed

    • ●

      removed the optional property items/body/catch_up from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/body/catch_up from the response with the 207 status

      response-optional-property-removed

    • ●

      removed the optional property items/body/company_contribution from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/body/company_contribution from the response with the 207 status

      response-optional-property-removed

    • ●

      removed the optional property items/body/employee_deduction from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/body/employee_deduction from the response with the 207 status

      response-optional-property-removed

    • ●

      removed the optional property items/body/hsa_contribution_limit from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/body/hsa_contribution_limit from the response with the 207 status

      response-optional-property-removed

    • ○

      added BatchError subschema #1 to the items/body response property anyOf list for the response status 200

      response-property-any-of-added

    • ○

      added BatchError subschema #1 to the items/body response property anyOf list for the response status 207

      response-property-any-of-added

    • ○

      the response property items/body became required for the status 200

      response-property-became-required

    • ○

      the response property items/body became required for the status 207

      response-property-became-required

    • ○

      the response property items/code became required for the status 200

      response-property-became-required

    • ○

      the response property items/code became required for the status 207

      response-property-became-required

    • ○

      the response property items/individual_id became required for the status 200

      response-property-became-required

    • ○

      the response property items/individual_id became required for the status 207

      response-property-became-required

  • 46640c1b46881See the full diff
    • ○

      the endpoint scheme security bearerAuth was added to the API

      api-security-added

  • bf858f37d7ab1See the full diff
    • ○

      added the success response with the status 200

      response-success-status-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog