Deductibles

If an exposure has a deductible, you can do the following through Cloud API:

  • Access information about it

  • Modify its amount

  • Waive it

Note that Cloud API does not have separate endpoints for managing deductibles. All of the actions in the previous list are executed by specifying information in the related exposure, either in the initial POST or a subsequent PATCH.

User interface behaviors that are not enforced by Cloud API

Be aware that, in the base configuration, ClaimCenter has behaviors and restrictions related to deductibles that are defined in the user interface layer and not in the domain layer. Given that these behaviors are not declared in the domain layer, they are not enforced when working with deductibles through Cloud API. The user interface behaviors include the following:

  • If a deductible amount is overridden:

    • The new amount cannot be greater than the original amount.

    • The edit reason cannot be null.

  • If a deductible is waived:

    • The edit reason cannot be null.

  • If a deductible amount is not overridden and the deductible is not waived:

    • You cannot change the amount.

    • You cannot specify an edit reason.

  • If a deductible has been partially or entirely applied, it cannot be waived.

Accessing deductible information

The Exposure schema has a Deductible child schema. This schema includes the following fields related to deductibles. When an exposure has a deductible, this information is returned by default with any call, provided the field is non-null.

  • amount

  • amountApplied

  • amountRemaining

  • editReason

  • overridden

  • waived

For example, exposure cc:222 on claim cc:111 has a deductible of $500. The following call returns information about the exposure. This includes information about the exposure's deductible. (editReason does not appear because that field's value is null.)

Command

GET /claim/v1/claims/cc:111/exposures/cc:222

Response

{
    "data": {
        "attributes": {
            ...
            "deductible": {
                "amount": {
                    "amount": "500.00",
                    "currency": "usd"
                },
                "amountApplied": {
                    "amount": "0.00",
                    "currency": "usd"
                },
                "amountRemaining": {
                    "amount": "500.00",
                    "currency": "usd"
                },
                "overridden": false,
                "waived": false
            },
            "id": "cc:222",
            ...
        },
        ...
}

Modifying a deductible amount

When PATCHing an exposure, you can modify a deductible amount by setting the amount field. Note that you can modify amount, which is a database-backed value. But, you cannot modify either amountApplied or amountRemaining, as these are calculated values.

The base configuration user interface has the following behaviors:

  • In order to modify a deductible amount, you must first set the Modified field to true. (This value is stored in the Overridden field.)

  • When you set the Modified field to true, the Edit Reason field becomes visible and is required.

Because these behaviors are declared in the user interface, and not as domain-level logic, Cloud API does not enforce them. Thus:

  • You can modify a deductible amount without setting overridden to true. However, if you want to match base configuration user interface behavior, then set overridden to true.

  • You can modify a deductible amount without providing an editReason. However, if you want to match base configuration user interface behavior, then provide a value for editReason.

For example, the following call sets the deductible for exposure cc:222 on claim cc:111 to $550. It sets overridden to true and provides an edit reason of "Deductible entered incorrectly in PAS".

Command

PATCH /claim/v1/claims/cc:111/exposures/cc:222

Request

{
  "data": {
    "attributes": {
        "deductible": {
            "amount": {
                "amount": "550.00",
                "currency": "usd"
            },
            "editReason": "Deductible entered incorrectly in PAS",
            "overridden": true
        }
    }
  }
}

Response

{
    "data": {
        "attributes": {
            ...
            "deductible": {
                "amount": {
                    "amount": "550.00",
                    "currency": "usd"
                },
                "amountApplied": {
                    "amount": "0.00",
                    "currency": "usd"
                },
                "amountRemaining": {
                    "amount": "550.00",
                    "currency": "usd"
                },
                "editReason": "Deductible entered incorrectly in PAS",
                "overridden": true,
                "waived": false
            },
            "id": "cc:222",
            ...
        },
        ...
}

Waiving a deductible

You can waive a deductible, either during the initial POST or a subsequent PATCH.

The base configuration user interface has the following behaviors:

  • In order to waive a deductible, you must first set the Modified field to true. (This value is stored in the Overridden field.)

  • When you set the Modified field to true, the Edit Reason field becomes visible and is required.

Because these behaviors are declared in the user interface, and not as domain-level logic, Cloud API does not enforce them. Thus:

  • You can waive a deductible without setting overridden to true. However, if you want to match base configuration user interface behavior, then set overridden to true.

  • You can waive a deductible without providing an editReason. However, if you want to match base configuration user interface behavior, then provide a value for editReason.

For example, the following call waives the deductible for exposure cc:222 on claim cc:111. It sets overridden to true and provides an edit reason of "Third party at fault".

Command

PATCH /claim/v1/claims/cc:111/exposures/cc:222

Request

{
  "data": {
    "attributes": {
        "deductible": {
            "editReason": "Third party at fault",
            "overridden": true,
            "waived": true
        }
    }
  }
}

Response

{
    "data": {
        "attributes": {
            ...
            "deductible": {
                "amount": {
                    "amount": "500.00",
                    "currency": "usd"
                },
                "amountApplied": {
                    "amount": "0.00",
                    "currency": "usd"
                },
                "amountRemaining": {
                    "amount": "500.00",
                    "currency": "usd"
                },
                "editReason": "Third party at fault",
                "overridden": true,
                "waived": true
            },
            "id": "cc:222",
            ...
        },
        ...
}