# List PlanMaximum

Lists all PlanMaximum for the given planID and benefitCode

Endpoint: GET /plans/{planID}/benefits/{benefitCode}/maximums
Version: v1
Security: apiKeyAuth, bearerAuth

## Header parameters:

  - `vbasoftware-database` (string, required)
    Target database

## Path parameters:

  - `planID` (string, required)
    Plan ID

  - `benefitCode` (string, required)
    Benefit Code

## Response 200 fields (text/plain):

  - `data` (array,null)

  - `data.plan_ID` (string, required)
    References the PlanBenefits.Plan_ID value in parent table.

  - `data.benefit_Code` (string, required)
    References the PlanBenefits.Benefit_Code value in parent table.

  - `data.max_ID` (string, required)
    User-defined Identifier for the Maximum being entered.

  - `data.dental_Designation` (string,null)
    Specifies the Dental Designation options including Tooth, Quadrant, and Arch.

  - `data.effective_Date` (string,null)
    Having effective and term dates for the maximums allows for changes throughout the life of the plan. The dates defined reference to the date of service of the claim to determine which maximum applies.

  - `data.entry_Date` (string)
    Date when the record was added to the system.

  - `data.entry_User` (string,null)
    User that first added the record to the system.

  - `data.expire_Date` (string,null)
    Having effective and term dates for the maximums allows for changes throughout the life of the plan. The dates defined reference to the date of service of the claim to determine which maximum applies.

  - `data.frequency` (integer,null)
    The frequency defined here states how many of the Max Per apply for the Maximum line. This field has the logic of: Current minus Freq. A zero in this field will force the Maximum to calculate within the year, day, etc. defined in the Max Per. A 4 in this field will force the Maximum to calculate within 5 years, days, etc. defined in the Max Per.

  - `data.max_Description` (string,null)
    Description identifying the Plan Maximum.

  - `data.max_Ex_Code` (string,null)
    Each maximum needs and Ex Code defined for explanation during adjudication and for Remittance and EOB's. A denial Ex Code can only be used Visit Maximums as payable type Maximums can have partially paid lines. A denial code on at claim detail line that should be partially paid will result in the entire line being denied and the Maximum not being fulfilled.

  - `data.max_Payable_Ex_Code` (string,null)
    Used for dollar maximums. The Ex Code in field 11 would be an informational code which allows the amount over the max to roll to the next line and apply the Denial Ex Code.

  - `data.max_Per` (string,null)
    Defines the timeframe that applies to the Maximum: Day - per service date. Month - per every 30 or 31 days. Calendar Month - per calendar month in which the services were rendered. Calendar Year - per calendar year in which the services were rendered. Plan Year - per plan year as defined for the Member. Lifetime - per lifetime. Occurrence - per occurrence date on the claim header. Birth Date Year - per year defined by the Member's date of birth. Visit - per service date per Provider.

  - `data.max_Sequence` (integer,null)
    Each Maximum needs to be sequenced in order for adjudication to determine which Maximum line should apply first.

  - `data.max_Type` (string,null)
    Indicates the type of Maximum: Visits - per service date. Svc Count - per units on service line. Payable Amount - payable amounts from claims. Co-pay Amount - co-pay amounts from claims. Co-Ins Amount - co-ins amounts from claims. Deductible Amount - deductible amounts from claims. Occurrence Payable - payable amount per occurrence date. Occurrence - per occurrence date on the claim header. Svc Count_Payable - payable amount on the service line divided by the number of units on the claim. This will pay the amount per unit for the number of units that are allowed by the rule.

  - `data.max_Type_Net` (string,null)
    Indicates whether both In and/or Out of Network benefits apply.

  - `data.member_Family` (string, required)
    Indicates whether the Maximum applies to the Family or each Member. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.quantity` (number,null)
    Defines the dollar or count quantity that should apply to the Maximum.

  - `data.subscriber_Reimbursement` (boolean,null)
    Checking this box indicates that this benefit maximum represents a maximum that must be paid out in full regardless of the billed amount on the claim or allowable. A new claim will be created to pay any difference to the Subscriber. Note: The database will apply a default value of False for this field if a value is not provided.

  - `data.update_Date` (string)
    Date when the record was last updated in the system.

  - `data.update_User` (string,null)
    User that last updated the record in the system.

  - `data.visit_Criteria` (integer,null)
    No longer in use.

  - `data.cross_Plan_Max` (boolean)

  - `error` (object)

  - `error.detail` (string,null)
    A human-readable explanation specific to this occurrence of the problem.

  - `error.instance` (string,null)
    A URI reference that identifies the specific occurrence of the problem.It may
or may not yield further information if dereferenced.

  - `error.status` (integer)
    The HTTP status code([RFC7231], Section 6) generated by the origin server for
this occurrence of the problem.

  - `error.title` (string,null)
    A short, human-readable summary of the problem type.It SHOULD NOT change from
occurrence to occurrence of the problem, except for purposes of localization(e.g.,
using proactive content negotiation; see[RFC7231], Section 3.4).

  - `error.type` (string,null)
    A URI reference [RFC3986] that identifies the problem type. This specification
encourages that, when dereferenced, it provide human-readable documentation for
the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member
is not present, its value is assumed to be "about:blank".

  - `debug` (object)

  - `debug.activityID` (string, required)


## Response 401 fields