Get benefit fields requirements by ID
GET {{baseUrl}}/v1/benefits/:benefit_id/requirements
Returns field requirements for the requested benefit type.
scope: benefits:read
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
X-Gusto-API-Version | string | Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used. | |
Accept | string |
RESPONSES
status: OK
{"employee_deduction":{"required":true,"editable":true,"default_value":null,"choices":null},"contribution":{"required":true,"editable":true,"default_value":{"type":"percentage","value":2},"choices":["percentage"]},"deduct_as_percentage":{"required":true,"editable":true,"default_value":null,"choices":null},"catch_up":{"required":true,"editable":true,"default_value":null,"choices":null},"limit_option":{"required":false,"editable":false,"default_value":null,"choices":null},"company_contribution_annual_maximum":{"required":false,"editable":false,"default_value":null,"choices":null},"coverage_salary_multiplier":{"required":false,"editable":false,"default_value":null,"choices":null},"coverage_amount":{"required":false,"editable":false,"default_value":null,"choices":null}}