# Create or Update Batch Groups

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

Endpoint: PUT /groups-batch
Version: v1
Security: apiKeyAuth, bearerAuth

## Header parameters:

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

## Request fields (application/json):

  - `group_ID` (string, required)
    Unique identifier for each Group.

  - `account_Key` (integer,null)
    Identifies the Account associated with this Group.

  - `account_Manager` (string,null)
    Information field used in custom client reporting.

  - `addOn_Rate_Option` (string,null)
    Determines whether a Group's AddOn Rates are combined and applied once (Additive) or applies rates separately, in a sequence (Sequential).

  - `address` (string,null)
    Adderss of the Group.

  - `address2` (string,null)
    Line 2 of the Group's address.

  - `admin_COBRA` (boolean, required)
    Indicates if this Group administers COBRA. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `adult_Age` (integer,null)
    Identifies the age at which dependents are considered to be adults. Student status information is required on the enrollment to allow claims to pay for a dependent whose age exceeds the age defined here.

  - `advice_To_Pay` (boolean, required)
    Notes if the claims for this Group should be Advice_To_Pay (flagged as unpaid when processed). Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `apply_Ex_Code` (boolean, required)
    Flag if adjudication should apply an Ex Code to a claim for this Group. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `auth_Not_Reqd_Override` (boolean, required)
    Notes if this group allows Auth Required claims edit to be overridden and paid. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `billing_Age_Calc` (string,null)
    No longer in use. Replaced by Premium Billing module.

  - `billing_Cycle_ID` (string,null)
    Identifies the bill cycle for this Group. This will be used when creating invoices.

  - `billing_Due_Date_Range` (integer,null)
    Used when Set_Billing_Due_Date is enabled.

  - `billing_Due_Date_Range_Type` (string,null)
    Used when Set_Billing_Due_Date is enabled.

  - `billing_Due_Date_Type` (string,null)
    Used when Set_Billing_Due_Date is enabled.

  - `billing_Invoice_Create` (integer,null)
    Indicates the group is included in invoice generation processes.

  - `billing_Retro_Limit` (integer,null)
    Indicates how many bills (based on billing cycles) should be interrogated to determine adjustments.

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

  - `check_Birthday` (string,null)
    Identifies whether date of birth edits are performed for this Group during adjudication.

  - `city` (string,null)
    City of the Group's address.

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

  - `coPay_Max_Per_Date_Provider` (boolean, required)
    Notes that this group calculates copay max (based on plan configuration) by provider rather than across the entire plan. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `commission_Lookback` (integer,null)
    Notes the number of billing cycles to lookback when calculating commissions.

  - `contact_Country_Code` (string,null)
    Country code of the Group's contact number.

  - `contact_Email_Address` (string,null)
    Email address of the identified Group contact.

  - `contact_Extension` (string,null)
    Extension number of the Group's contact.

  - `contact_Phone` (string,null)
    Phone number of the Group's contact.

  - `contact_Title` (string,null)
    Title of the Group's primary contact.

  - `country_ID` (string,null)
    Identifier of the Groups's country.

  - `county_Code` (string,null)
    County code of the Group address.

  - `cutoff_Age` (integer,null)
    Identifies the age at which dependents are no longer eligible for coverage. Adult Dependent information is required on the enrollment to allow claims to pay for a dependent whose age exceeds the age defined here.

  - `default_EOB_Report` (integer,null)
    Defines the default EOB report object from our core admin system. This is a developer setting.

  - `default_Invoice_ReportDefinition_Key` (integer,null)
    By default, indicates which Invoice report should be used for automation.

  - `default_Process_by_Disability_Date` (boolean, required)
    Process by Disability Date can be defined here to apply to all claims for this group rather than on a claim by claim basis (acts as a default). Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `default_Roll_Up_Waiting_Period` (boolean, required)
    Roll Up Waiting Period can be defined here to apply to all claims for this group rather than on a claim by claim basis (acts as a default). Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `disability_Pay_Through_Day` (integer,null)
    The day of the week that Paid Through is calculated for Disability premiums.

  - `disable_COBRA_Auto_Select` (boolean, required)
    This flag indicates that the Group COBRA premium will not be automatically populated during member disenrollment. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `disenroll_Date` (string,null)
    Date when the Group expires/expired.

  - `distribution_Account_Key` (integer,null)
    For Premium Distribution processing, this notes the Account for the source of distributed funds.

  - `distribution_Payor_ID` (string,null)
    For Premium Distribution processing, this notes the Payor ID for the source of distributed funds.

  - `duplicate_Claim_Override` (boolean, required)
    Notes if this group allows Duplicate Claims to be overridden to be paid. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `election_Range` (integer,null)
    Used for determining Flex Election.

  - `election_Range_Type` (string,null)
    Used with Election_Range to determine the Flex Election.

  - `employer_Size` (string,null)
    Information field used in custom client reporting.

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

  - `ex_Code` (string,null)
    The Ex Code applied during claims adjudication if "Apply_Ex_Code" is enabled.

  - `fax` (string,null)
    Fax number of the Group.

  - `fax_Country_Code` (string,null)
    Country code of the Group's fax number.

  - `federal_ID` (string,null)
    Federal tax identifier of the Group.

  - `generate_Adjustments` (string,null)
    No longer in use. Replaced by Premium Billing module.

  - `generate_Invoices` (string,null)
    No longer in use. Replaced by Premium Billing module.

  - `group_Account` (integer,null)
    Holds the account reference for the Employer Account. Not used in processing.

  - `individual_Billing` (boolean, required)
    No longer in use. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `individual_Cycle` (boolean, required)
    No longer in use. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `individual_Dates` (boolean, required)
    No longer in use. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `inv_Grace_Period` (integer,null)
    The grace period value based on "Grace_Period_Type" for how long you have to process an invoice after the term date.

  - `inv_Grace_Period_Type` (string,null)
    Works with Grace_Period to determine how long after term date an invoice can be processed.

  - `invoice_Enrolled_By` (integer,null)
    Used to determine eligiblity during invoice generation for enrolled members.

  - `invoice_Enrolled_Thru` (integer,null)
    Used to determine eligiblity during invoice generation for enrolled members.

  - `issue_State` (string,null)
    Identifies the sate in which the Group is insured.

  - `name` (string,null)
    Name of the Group.

  - `notes` (string,null)
    No longer in use, replaced by Notes Service.

  - `open_Closed_Enrollment` (boolean, required)
    Information field used in custom client reporting. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `original_Date` (string,null)
    Date when the Group becomes/became active.

  - `paid_Through` (string,null)
    Date through which the Group premium has been paid.

  - `paperless` (boolean, required)
    Notes if this Group is Paperless (this overrides the individual member settings from VBAGateway). Used in process automation. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `pay_To_Account` (integer,null)
    The Pay To Account used for external payments.

  - `payor_ID` (string,null)
    Identifier of the Payor associated with the Group.

  - `phone` (string,null)
    Phone number of the Group.

  - `phone_Country_Code` (string,null)
    Country code of the Group's phone number.

  - `prepaid_Group` (boolean, required)
    Information field used in custom client reporting. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `primary_Contact` (string,null)
    Primary contact of the Group.

  - `producer` (string,null)
    Information field used in custom client reporting.

  - `prorate_Deduction` (boolean, required)
    Notes if the disability deductions should be prorated during adjudication. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `prorate_Deduction_Type` (string,null)
    For Disability, notes the Deduction Type to have prorate applied.

  - `rX_BIN` (string,null)
    Information field used in custom client reporting.

  - `rX_CS_Contact` (string,null)
    Information field used in custom client reporting.

  - `rX_CS_Phone` (string,null)
    Information field used in custom client reporting.

  - `rX_GRP` (string,null)
    Information field used in custom client reporting.

  - `rX_Name` (string,null)
    Information field used in custom client reporting.

  - `rX_PCN` (string,null)
    Information field used in custom client reporting.

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

  - `region_Code` (string,null)
    Region Code for this group (locality).

  - `renewal_Completion_Date` (string,null)
    Information field used in custom client reporting.

  - `renewal_Date` (string,null)
    The last renewal date for this Group. Used in custom reporting. Not used in processing.

  - `self_Admin` (boolean, required)
    Notes if this group has Self-Admin billing. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `set_Billing_Due_Date` (boolean, required)
    Indicates if the system should calculate the Due Date on an invoice based on Billing_Due_Date settings. By default the due date is the "Bill Thru" on an invoice, this gives the option to change that calculation. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `state` (string,null)
    State of the Group's address.

  - `subscriber_ID_Prefix` (string,null)
    The automatically applied Subscriber ID prefix when using auto generated IDs.

  - `subscriber_ID_Suffix` (string,null)
    The automatically applied Subscriber ID suffix when using auto generated IDs.

  - `total_Employees` (integer,null)
    Information field used in custom client reporting.

  - `uC_Percent` (string,null)
    Identifies the Usual and Customary percentage of the Group.

  - `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_Employer_State` (boolean,null)
    Notes if Employe State, not Subscriber State, should be used in invoice generation. Note: The database will apply a default value of False for this field if a value is not provided.

  - `zip_Code` (string,null)
    Zip code of the Group's address.

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