# Create or Update Batch GroupContractPlan

Create or Update multiple GroupContractPlan at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.

Endpoint: PUT /groups/{groupID}/divisions/{divisionID}/contracts/{coverageStart}/plans-batch
Version: v1
Security: apiKeyAuth, bearerAuth

## Header parameters:

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

## Path parameters:

  - `groupID` (string, required)
    Group ID

  - `divisionID` (string, required)
    Division ID

  - `coverageStart` (string, required)
    Coverage Start

## Request fields (application/json):

  - `group_ID` (string, required)
    References GroupContract.Group_ID value on the parent record.

  - `division_ID` (string, required)
    References GroupContract.Division_ID value on the parent record.

  - `coverage_Start` (string, required)
    References GroupContract.Coverage_Start value on the parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `plan_ID` (string, required)
    References Plans.Plan_ID on the parent record.

  - `account_Key` (integer,null)
    Identifies the banking account associated with the selected contract.

  - `advice_To_Pay` (boolean, required)
    When this option is selected, adjudication to mark every claim as 'Advice to Pay' (ATP). Advice to Pay claims do not produce check records when processed. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `bpl` (string,null)
    No longer in use.

  - `billing_Basis` (string,null)
    No longer in use.

  - `calc_Interest` (boolean, required)
    Indicates if interest is to be calculated for this contract plan during check processing. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `calc_Interest_ACH` (boolean, required)
    For ACH payments, Indicates if interest is to be calculated for this contract plan during check processing. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `calc_Interest_ACH_Min` (number,null)
    For ACH payments, If interest is to be calculated, this value determines the minimum interest that can be applied. Any interst calculated below this number is ignored.

  - `calc_Interest_ACH_Network_Option` (string,null)
    For ACH payments, Indicates if interest is to be calculated by: N - In Network or O - Out of Network. Leave this blank if interest applies to both.

  - `calc_Interest_ACH_On_Adj` (boolean, required)
    For ACH payments, Flag indicating if interest should be calculated on adjustment claims. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `calc_Interest_ACH_Option` (string,null)
    For ACH payments, Indicates what field will be used for interest calculation: B - Billed Amount, A - Allowed Amount or P - Paid Amount.

  - `calc_Interest_ACH_Pct` (number,null)
    For ACH payments, Indicates the interest percentage to be applied during interest calculations.

  - `calc_Interest_ACH_Prompt_Pay_Freq` (integer,null)
    For ACH payments, This is the frequency of "Calc_Interest_Prompt_Pay_Type" for determining if interest is applicable.

  - `calc_Interest_ACH_Prompt_Pay_Type` (string,null)
    For ACH payments, This is the "Calc_Interest_Prompt_Pay_Freq" in number of: D - Days, M - Months or Y - Years.

  - `calc_Interest_Min` (number,null)
    If interest is to be calculated, this value determines the minimum interest that can be applied. Any interst calculated below this number is ignored.

  - `calc_Interest_Network_Option` (string,null)
    Indicates if interest is to be calculated by: N - In Network or O - Out of Network. Leave this blank if interest applies to both.

  - `calc_Interest_On_Adj` (boolean, required)
    Flag indicating if interest should be calculated on adjustment claims. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `calc_Interest_Option` (string,null)
    Indicates what field will be used for interest calculation: B - Billed Amount, A - Allowed Amount or P - Paid Amount.

  - `calc_Interest_Pct` (number,null)
    Indicates the interest percentage to be applied during interest calculations.

  - `calc_Interest_Prompt_Pay_Freq` (integer,null)
    This is the frequency of "Calc_Interest_Prompt_Pay_Type" for determining if interest is applicable.

  - `calc_Interest_Prompt_Pay_Type` (string,null)
    This is the "Calc_Interest_Prompt_Pay_Freq" in number of: D - Days, M - Months or Y - Years.

  - `dependent_Contribution` (number,null)
    For flex, determines the Dependent Contribution amount (or Pct if "Dependent_Contribution_Pct" is flagged)

  - `dependent_Contribution_Pct` (boolean, required)
    For flex, notes if the amount entered into "Dependent_Contribution" is a percent or flat amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `disability_Pay_Through_Day` (integer,null)
    This is the day number of the week that disability claims created through the disability advisor will run through. This allows a disability claim with an ETD that ends in the middle of a week to be pushed through the end of that week if needed.

  - `employee_Contribution` (number,null)
    For flex, determines the Employee Contribution amount (or Pct if "Employee_Contribution_Pct" is flagged)

  - `employee_Contribution_Pct` (boolean, required)
    For flex, notes if the amount entered into "Employee_Contribution" is a percent or flat amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `end_Coverage_Age` (integer,null)
    This is the age of the subscribers on the day based on "End_Coverage_Age_Type" before benefits are no longer eligible.

  - `end_Coverage_Age_Type` (string,null)
    The type of age in years entered in "End_Coverage_Age" by type: EXACTDATE - Age Exact Date, BEGINMONTH - Age at Beginning of month, ENDMONTH - Age at End of month, BEGINYEAR - Age at the beginning of the year, or ENDYEAR - Age at the End of the year.

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

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

  - `exempt_Federal` (boolean, required)
    Indicates a federal exemption as part of the selected contract. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `exempt_Medicare` (boolean, required)
    indicates a medicare exemption as part of the selected contract. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `exempt_SocSec` (boolean, required)
    Indicates a social security exemption as part of the selected contract. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `exempt_State` (boolean, required)
    Indicates a state exemption as part of the selected contract. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `federal_Tax_Day_Limit` (integer,null)
    Limit of days for the federal tax exemption.

  - `federal_Wage_Limit` (number,null)
    Wage limit for the federal tax exemption.

  - `locator` (string,null)
    No longer in use.

  - `medicare_Tax_Day_Limit` (integer,null)
    Limit of days for the medicare tax exemption.

  - `medicare_Wage_Limit` (number,null)
    Wage liimit for the medicare tax exemption.

  - `minimum_Benefit` (number,null)
    For disability claims, this indicates the minimum benefit (weekly for STD plans or monthly for LTD plans).

  - `paid_Through` (string,null)
    Premium Billing setting that holds the premiums paid through for a selection of contracted subscribers.

  - `payor_ID` (string,null)
    References PayorAccount.Payor_ID value on parent record.

  - `prorate_FICA` (boolean, required)
    Notes if Disability Claims should Prorate the FICA tax based on the disability payment duration. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `rX_BIN` (string,null)
    Information fields used to hold RX information on this Contract Plan for reporting and interfaces.

  - `rX_CS_Contact` (string,null)
    Information fields used to hold RX information on this Contract Plan for reporting and interfaces.

  - `rX_CS_Phone` (string,null)
    Information fields used to hold RX information on this Contract Plan for reporting and interfaces.

  - `rX_GRP` (string,null)
    Information fields used to hold RX information on this Contract Plan for reporting and interfaces.

  - `rX_Name` (string,null)
    Information fields used to hold RX information on this Contract Plan for reporting and interfaces.

  - `rX_PCN` (string,null)
    Information fields used to hold RX information on this Contract Plan for reporting and interfaces.

  - `retirement_Plan` (boolean, required)
    Flag to indicate if this plan on this contract is a retirement plan. This is information only. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `salary_Pct` (number,null)
    If "Use_Salary_Pct" option is enabled, this indicatres the percent of salary.

  - `socSec_Tax_Day_Limit` (integer,null)
    Limit of days for the social security tax exemption.

  - `socSec_Wage_Limit` (number,null)
    Wage limite for Social Security tax exemption.

  - `state_Tax_Day_Limit` (integer,null)
    Limit of days for the state tax exemption.

  - `state_Wage_Limit` (number,null)
    Wage limit for the state tax exemption.

  - `tax_Day_Limit_Type` (integer, required)
    Indicates if the tax day limitations are by day or calendar months.  The database default for this field is '1'.  Note: This field is marked as NOT NULL in the database and therefore required by the API.

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

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

  - `use_Plan_Options` (boolean, required)
    Used on the front end to indicate if the plan options should be shown to the user, has not backend functional impact. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `use_Salary_Pct` (boolean, required)
    Indicates that disability should be based upon salary percentage. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `volume` (number,null)
    No longer in use.

  - `volume_Max` (number,null)
    Indicates the benefit maximum of the disabiltiy plan.

  - `volume_Min` (number,null)
    Indicates the benefit minimum of the disability plan.

  - `pay_To_Subscriber_Payee_ID` (string,null)

## Response 207 fields (text/plain):

  - `data` (array,null)

  - `data.id` (array, required)
    List of key/value pairs that represent the unique id for the entity operation.

  - `data.id.key` (string,null)

  - `data.id.value` (any,null)

  - `data.status` (integer, required)
    http status of the operation (eg, 200, 201, 500)

  - `data.body` (string, required)
    operation message (eg, Updated, Created, Error message)

  - `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