POST api/deductibles

Posts a new global deductible resource

Request Information

URI Parameters

None.

Body Parameters

The global deductible model to add.

DeductibleModel
NameDescriptionTypeAdditional information
GroupPlanNo

Gets or sets the identifier for the Group Plan associated with this deductible

integer

None.

Description

Gets or sets the description of the deductible resource

string

None.

PersonAmount

Gets or sets the deductible amount for members *DEPRECATED - moved to DeductibleRates. will be removed at a later date

decimal number

None.

FamilyAmount

Gets or sets the deductible amount for families *DEPRECATED - moved to DeductibleRates. will be removed at a later date

decimal number

None.

MemberPortalDescription

Gets or sets the description to show on the member portal

string

None.

DeductibleRates

Gets or sets the deductibleRates associated with this deductible model

Collection of DeductibleRateModel

None.

Url

Gets or sets the link representing a link back to the resource

string

None.

ID

Gets or sets the identifier for the resource

integer

None.

Request Formats

application/json, text/json, application/json-patch+json

Sample:
{
  "url": "sample string 4",
  "id": 5,
  "groupPlanNo": 1,
  "description": "sample string 2",
  "personAmount": 1.0,
  "familyAmount": 1.0,
  "memberPortalDescription": "sample string 3",
  "deductibleRates": [
    {
      "url": "sample string 3",
      "id": 4,
      "effectiveStartDate": "2025-07-16T15:31:14.4360975-05:00",
      "personAmount": 1.0,
      "familyAmount": 1.0,
      "deductibleNo": 2
    },
    {
      "url": "sample string 3",
      "id": 4,
      "effectiveStartDate": "2025-07-16T15:31:14.4360975-05:00",
      "personAmount": 1.0,
      "familyAmount": 1.0,
      "deductibleNo": 2
    }
  ]
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Global deductible model that was just added to the database.

DeductibleModel
NameDescriptionTypeAdditional information
GroupPlanNo

Gets or sets the identifier for the Group Plan associated with this deductible

integer

None.

Description

Gets or sets the description of the deductible resource

string

None.

PersonAmount

Gets or sets the deductible amount for members *DEPRECATED - moved to DeductibleRates. will be removed at a later date

decimal number

None.

FamilyAmount

Gets or sets the deductible amount for families *DEPRECATED - moved to DeductibleRates. will be removed at a later date

decimal number

None.

MemberPortalDescription

Gets or sets the description to show on the member portal

string

None.

DeductibleRates

Gets or sets the deductibleRates associated with this deductible model

Collection of DeductibleRateModel

None.

Url

Gets or sets the link representing a link back to the resource

string

None.

ID

Gets or sets the identifier for the resource

integer

None.

Response Formats

application/json, text/json, application/json-patch+json

Sample:
{
  "url": "sample string 4",
  "id": 5,
  "groupPlanNo": 1,
  "description": "sample string 2",
  "personAmount": 1.0,
  "familyAmount": 1.0,
  "memberPortalDescription": "sample string 3",
  "deductibleRates": [
    {
      "url": "sample string 3",
      "id": 4,
      "effectiveStartDate": "2025-07-16T15:31:14.4360975-05:00",
      "personAmount": 1.0,
      "familyAmount": 1.0,
      "deductibleNo": 2
    },
    {
      "url": "sample string 3",
      "id": 4,
      "effectiveStartDate": "2025-07-16T15:31:14.4360975-05:00",
      "personAmount": 1.0,
      "familyAmount": 1.0,
      "deductibleNo": 2
    }
  ]
}