Group Divisions

Create GroupDivision

Creates a new GroupDivision

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
group_ID
required
string [ 1 .. 20 ] characters

References Groups.Group_ID value on parent record.

division_ID
required
string [ 1 .. 20 ] characters

Unique Division identifier assigned inside this Group. This ID must be unique within the Group ID.

acH_Account_Key
integer or null <int32>

References the FundingAccount.Account_Key that holds the ACH information for this Division for any ACH processing.

account_Key
integer or null <int32>

References the PayorAccount.Account_Key value in parent table.

address
string or null <= 255 characters

Address associated with the Division.

address2
string or null <= 128 characters

Address 2 associated with the Division.

adult_Age
integer or null <int32>

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.

agri_Tax_Return
string or null <= 3 characters

Information field for custom client reporting.

auth_Not_Reqd_Override
required
boolean

This flag tells adjudication to not error if no authorization is found on claims that require authorization. Note: This field is marked as NOT NULL in the database and therefore required by the API.

brokerage
string or null <= 256 characters

Information field for custom client reporting.

cobrA_Auto_Term_Adj_Reason
integer or null <int32>

When utilizing the Auto-Term process, notes the adjustment reason applied to premiums impacted by a retro term.

cobrA_Auto_Term_Reason
integer or null <int32>

When utilizing the Auto-Term process, indicates the Term Reason to apply if COBRA is being enrolled.

cobrA_Division
required
boolean

Points to the Division ID that is the COBRA Division for this Division. Note: This field is marked as NOT NULL in the database and therefore required by the API.

coE_Network
required
boolean

Information field for custom client reporting. Note: This field is marked as NOT NULL in the database and therefore required by the API.

caseRate
number or null <double>

Information field for custom client reporting.

city
string or null <= 25 characters

City of the Division address.

claim_Days_Allowed
integer or null <int32>

No longer in use.

class_Description
string or null <= 128 characters

No longer in use, replaced by GroupClass table.

class_ID
string or null <= 20 characters

No longer in use, replaced by GroupClass table.

contact_Country_Code
string or null <= 8 characters

Country Code for the Contact Phone Number.

contact_Email_Address
string or null <= 128 characters

The division contact email address.

contact_Extension
string or null <= 6 characters

The contacts extension for their phone number.

contact_Phone
string or null <= 20 characters

The Contact Phone number for this Divisions Contact.

contact_Title
string or null <= 20 characters

Title of the Division's primary contact.

country_ID
string or null <= 8 characters

Country ID associated with the Division.

county_Code
string or null <= 8 characters

County code of the Division address.

cutoff_Age
integer or null <int32>

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_COBRA_Reason
integer or null <int32>

When disenrolling a member and reenrolling into COBRA, this indicates the default reason attached to the disenroll.

default_Invoice_ReportDefinition_Key
integer or null <int32>

For reports in the "INV" Report_Category, this provides the user with the list of invoice reports they can set as the default report using for automated invoice generation.

disability_Pay_Through_Day
integer or null <int32>

Indicates the day of the week the paid through is set when using automatic paid through dates.

disenroll_Date
string or null <date-time>

This notes that the Division has been terminated and what date. An active Division has a NULL value here.

distribution_Account_Key
integer or null <int32>

References the PayorAccount.Account_Key value in parent table.

distribution_Payor_ID
string or null <= 20 characters

References the PayorAccount.Payor_ID value in parent table.

duplicate_Claim_Override
required
boolean

This flag tells adjudication to ignore Duplicate Claims Processing logic if enabled. Note: This field is marked as NOT NULL in the database and therefore required by the API.

entry_Date
string <date-time>

Date when the record was first added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

exempt_Federal
required
boolean

For Disability tax calculations, this indicates if the Division is exempt from taking Federal taxes on the claim payments. Note: This field is marked as NOT NULL in the database and therefore required by the API.

exempt_Medicare
required
boolean

For Disability tax calculations, this indicates if the Division is exempt from taking Medicare taxes on the claim payments. Note: This field is marked as NOT NULL in the database and therefore required by the API.

exempt_SocSec
required
boolean

For Disability tax calculations, this indicates if the Division is exempt from taking Social Security taxes on the claim payments. Note: This field is marked as NOT NULL in the database and therefore required by the API.

exempt_State
required
boolean

For Disability tax calculations, this indicates if the Division is exempt from taking State taxes on the claim payments. Note: This field is marked as NOT NULL in the database and therefore required by the API.

ficA_Employer_Match
required
boolean

Notes if the employer matches FICA (lowers that tax to 0) during claims adjudication. Note: This field is marked as NOT NULL in the database and therefore required by the API.

fax
string or null <= 20 characters

The fax number for this Division.

fax_Country_Code
string or null <= 8 characters

Country Code for the Division Fax Number.

federal_ID
string or null <= 20 characters

This Division Tax ID.

federal_Tax_Day_Limit
integer or null <int32>

Limit of days for the federal tax exemption.

federal_Wage_Limit
number or null <double>

Wage limit for the federal tax exemption.

generate_W2
required
boolean

Notes if this Division is part of tax reporting and should have its data sent for W2 generation. Note: This field is marked as NOT NULL in the database and therefore required by the API.

groupDivisionCaptive
string or null <= 256 characters

Information field for custom client reporting.

invoice_Grace_Period
integer or null <int32>

Indicates the grace period for invoice generation for this Division. This value works with "Invoice_Grace_Period_Type" to determine duration.

invoice_Grace_Period_Ex_Code
string or null <= 6 characters

When a grace period is applied to an invoice that impacts "Paid Through", the affected claims will apply this Ex Code.

invoice_Grace_Period_Type
string or null <= 16 characters

Based on "Invoice_Grace_Period", this is the Days, Weeks, Months or Years that grace period extends.

invoice_Level
string or null <= 1 characters

Indiciates the level of invoicing done by premium billing. There are 3 levels you can configure: S - Subscriber level invoicing (meaning an invoice per enrolled Subscriber), D - Division level invoicing (meaning an invoice per Division with all enrolled Subscribers in that Division on that Invoice), and G - Group level invoicing (meaning an invoice for the whole group with all enrolled Subscribers on the same invoice).

invoice_Remit_Address1
string or null <= 128 characters

When generating Division level invoices through premium biling, this is the Address on that invoice.

invoice_Remit_Address2
string or null <= 128 characters

When generating Division level invoices through premium biling, this is the Address 2 on that invoice.

invoice_Remit_City
string or null <= 32 characters

When generating Division level invoices through premium biling, this is the City on that invoice.

invoice_Remit_Country_Code
string or null <= 8 characters

When generating Division level invoices through premium biling, this is the Phone Number Country Code on that invoice.

invoice_Remit_Country_ID
string or null <= 8 characters

When generating Division level invoices through premium biling, this is the Country ID on that invoice.

invoice_Remit_Name
string or null <= 128 characters

When generating Division level invoices through premium biling, this is the Name on that invoice.

invoice_Remit_Phone_Number
string or null <= 32 characters

When generating Division level invoices through premium biling, this is the Phone Number on that invoice.

invoice_Remit_State
string or null <= 2 characters

When generating Division level invoices through premium biling, this is the State on that invoice.

invoice_Remit_Zip_Code
string or null <= 32 characters

When generating Division level invoices through premium biling, this is the Zip Code on that invoice.

issue_State
string or null <= 2 characters

For Life & Disability clients, this holds the issue state for processing taxes and reporting.

mail_To_Default
required
boolean

For Life & Disability clients, this is the default Mail To setting applied to claims created through the advisor wizards. Note: This field is marked as NOT NULL in the database and therefore required by the API.

medicare_Tax_Day_Limit
integer or null <int32>

Limit of days for the medicare tax exemption.

medicare_Wage_Limit
number or null <double>

Wage liimit for the medicare tax exemption.

name
string or null <= 50 characters

Name of the Group Division.

notes
string or null

No longer in use. Replaced by the Notes module.

numberLives
integer or null <int32>

Information field for custom client reporting.

original_Date
string or null <date-time>

This is the first start date (original effective date) of the Division inside this group. This date should be equal to or earlier than the first GroupContact.Coverage_Start date attached to this Division.

other_Insurance_ExCode
string or null <= 6 characters

This is the Ex Code applied if COB is identified during adjudciation and Other Insurance information is used during processing.

paid_Through
string or null <date-time>

This is the paid through date for any Division level invoices through premium billing. This can be manually set or updated by the system.

participationIncentive_ID
string or null <= 32 characters

Information field for custom client reporting.

pay_To_Account
integer or null <int32>

For processing that uses the Pay To Account, this referneces the FundingAccount.Account_Key for that process.

payor_ID
string or null <= 20 characters

References the PayorAccount.Payor_ID value in parent table.

pend_Ex_Code
string or null <= 6 characters

The Ex Code applied during claims adjudication if "Pend_Flag" is enabled.

pend_Flag
string or null <= 1 characters

Notes that this Division should have a pend code (Ex Code) applied during claims processing for any claims for this Division.

phone
string or null <= 20 characters

The phone number for this Division.

phone_Country_Code
string or null <= 8 characters

Country Code for the Division Phone Number.

premium_Location
string or null <= 50 characters

No longer in use.

primary_Contact
string or null <= 25 characters

Primary contact of the Division.

prorate_Deduction
required
boolean

Notes if this division should have disability deductions pro-rated during claims processing. Note: This field is marked as NOT NULL in the database and therefore required by the API.

prorate_Deduction_Type
string or null <= 10 characters

Indicates the type of prorating to calculate against. If calculating against flat deduction types only, set to F, to apply prorating to Percentage based deductions, set to P, if applying prorating on all deduction types, set to B.

reference_Based_Pricing
string or null <= 1 characters

Information field for custom client reporting.

region_Code
string or null <= 32 characters

Information field for noting the region for this Division.

reinsurance_Option
string or null <= 256 characters

No longer in use. Replaces by the full reinsurance module.

seerData
integer or null <int32>

Information field for custom client reporting.

set_Paid_Through
required
boolean

Notes if this division should have the paid through set as part of satisfying a premium bill. Note: This field is marked as NOT NULL in the database and therefore required by the API.

socSec_Tax_Day_Limit
integer or null <int32>

Limit of days for the social security tax exemption.

socSec_Wage_Limit
number or null <double>

Wage limite for Social Security tax exemption.

spec_Deductible
string or null <= 256 characters

No longer in use. Replaces by the full reinsurance module.

state
string or null <= 2 characters

State of the Division address.

state_Tax_Day_Limit
integer or null <int32>

Limit of days for the state tax exemption.

state_Wage_Limit
number or null <double>

Wage limit for the state tax exemption.

tax_Day_Limit_Type
required
integer <int32>

Indicates if the tax day limitations are by day or calendar months. Note: This field is marked as NOT NULL in the database and therefore required by the API.

transplantElite
string or null <= 256 characters

Information field for custom client reporting.

update_Date
string <date-time>

Date when the record was last updated in the system.

update_User
string or null <= 20 characters

User that last updated the record in the system.

use_Restricted_Deductions
required
boolean

Limits the deduction types that can be selected on disability claims to use the GroupDivisionDeductionType list. Note: This field is marked as NOT NULL in the database and therefore required by the API.

zip_Code
string or null <= 32 characters

The Zip Code for this Division address.

Responses
200

Success

401

Unauthorized

post/groups/{groupID}/divisions
Request samples
{
  • "group_ID": "string",
  • "division_ID": "string",
  • "acH_Account_Key": 0,
  • "account_Key": 0,
  • "address": "string",
  • "address2": "string",
  • "adult_Age": 0,
  • "agri_Tax_Return": "str",
  • "auth_Not_Reqd_Override": true,
  • "brokerage": "string",
  • "cobrA_Auto_Term_Adj_Reason": 0,
  • "cobrA_Auto_Term_Reason": 0,
  • "cobrA_Division": true,
  • "coE_Network": true,
  • "caseRate": 0.1,
  • "city": "string",
  • "claim_Days_Allowed": 0,
  • "class_Description": "string",
  • "class_ID": "string",
  • "contact_Country_Code": "string",
  • "contact_Email_Address": "string",
  • "contact_Extension": "string",
  • "contact_Phone": "string",
  • "contact_Title": "string",
  • "country_ID": "string",
  • "county_Code": "string",
  • "cutoff_Age": 0,
  • "default_COBRA_Reason": 0,
  • "default_Invoice_ReportDefinition_Key": 0,
  • "disability_Pay_Through_Day": 0,
  • "disenroll_Date": "2019-08-24T14:15:22Z",
  • "distribution_Account_Key": 0,
  • "distribution_Payor_ID": "string",
  • "duplicate_Claim_Override": true,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "exempt_Federal": true,
  • "exempt_Medicare": true,
  • "exempt_SocSec": true,
  • "exempt_State": true,
  • "ficA_Employer_Match": true,
  • "fax": "string",
  • "fax_Country_Code": "string",
  • "federal_ID": "string",
  • "federal_Tax_Day_Limit": 0,
  • "federal_Wage_Limit": 0.1,
  • "generate_W2": true,
  • "groupDivisionCaptive": "string",
  • "invoice_Grace_Period": 0,
  • "invoice_Grace_Period_Ex_Code": "string",
  • "invoice_Grace_Period_Type": "string",
  • "invoice_Level": "s",
  • "invoice_Remit_Address1": "string",
  • "invoice_Remit_Address2": "string",
  • "invoice_Remit_City": "string",
  • "invoice_Remit_Country_Code": "string",
  • "invoice_Remit_Country_ID": "string",
  • "invoice_Remit_Name": "string",
  • "invoice_Remit_Phone_Number": "string",
  • "invoice_Remit_State": "st",
  • "invoice_Remit_Zip_Code": "string",
  • "issue_State": "st",
  • "mail_To_Default": true,
  • "medicare_Tax_Day_Limit": 0,
  • "medicare_Wage_Limit": 0.1,
  • "name": "string",
  • "notes": "string",
  • "numberLives": 0,
  • "original_Date": "2019-08-24T14:15:22Z",
  • "other_Insurance_ExCode": "string",
  • "paid_Through": "2019-08-24T14:15:22Z",
  • "participationIncentive_ID": "string",
  • "pay_To_Account": 0,
  • "payor_ID": "string",
  • "pend_Ex_Code": "string",
  • "pend_Flag": "s",
  • "phone": "string",
  • "phone_Country_Code": "string",
  • "premium_Location": "string",
  • "primary_Contact": "string",
  • "prorate_Deduction": true,
  • "prorate_Deduction_Type": "string",
  • "reference_Based_Pricing": "s",
  • "region_Code": "string",
  • "reinsurance_Option": "string",
  • "seerData": 0,
  • "set_Paid_Through": true,
  • "socSec_Tax_Day_Limit": 0,
  • "socSec_Wage_Limit": 0.1,
  • "spec_Deductible": "string",
  • "state": "st",
  • "state_Tax_Day_Limit": 0,
  • "state_Wage_Limit": 0.1,
  • "tax_Day_Limit_Type": 0,
  • "transplantElite": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "use_Restricted_Deductions": true,
  • "zip_Code": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List GroupDivision

Lists all GroupDivision for the given groupID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

query Parameters
page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

sortBy
string

Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., 'Property1:desc,Property2:asc,Property3:asc' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/groups/{groupID}/divisions
Request samples
Response samples
No sample

Get GroupDivision

Gets GroupDivision

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

divisionID
required
string

Division ID

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/groups/{groupID}/divisions/{divisionID}
Request samples
Response samples
No sample

Update GroupDivision

Updates a specific GroupDivision.

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

divisionID
required
string

Division ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
group_ID
required
string [ 1 .. 20 ] characters

References Groups.Group_ID value on parent record.

division_ID
required
string [ 1 .. 20 ] characters

Unique Division identifier assigned inside this Group. This ID must be unique within the Group ID.

acH_Account_Key
integer or null <int32>

References the FundingAccount.Account_Key that holds the ACH information for this Division for any ACH processing.

account_Key
integer or null <int32>

References the PayorAccount.Account_Key value in parent table.

address
string or null <= 255 characters

Address associated with the Division.

address2
string or null <= 128 characters

Address 2 associated with the Division.

adult_Age
integer or null <int32>

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.

agri_Tax_Return
string or null <= 3 characters

Information field for custom client reporting.

auth_Not_Reqd_Override
required
boolean

This flag tells adjudication to not error if no authorization is found on claims that require authorization. Note: This field is marked as NOT NULL in the database and therefore required by the API.

brokerage
string or null <= 256 characters

Information field for custom client reporting.

cobrA_Auto_Term_Adj_Reason
integer or null <int32>

When utilizing the Auto-Term process, notes the adjustment reason applied to premiums impacted by a retro term.

cobrA_Auto_Term_Reason
integer or null <int32>

When utilizing the Auto-Term process, indicates the Term Reason to apply if COBRA is being enrolled.

cobrA_Division
required
boolean

Points to the Division ID that is the COBRA Division for this Division. Note: This field is marked as NOT NULL in the database and therefore required by the API.

coE_Network
required
boolean

Information field for custom client reporting. Note: This field is marked as NOT NULL in the database and therefore required by the API.

caseRate
number or null <double>

Information field for custom client reporting.

city
string or null <= 25 characters

City of the Division address.

claim_Days_Allowed
integer or null <int32>

No longer in use.

class_Description
string or null <= 128 characters

No longer in use, replaced by GroupClass table.

class_ID
string or null <= 20 characters

No longer in use, replaced by GroupClass table.

contact_Country_Code
string or null <= 8 characters

Country Code for the Contact Phone Number.

contact_Email_Address
string or null <= 128 characters

The division contact email address.

contact_Extension
string or null <= 6 characters

The contacts extension for their phone number.

contact_Phone
string or null <= 20 characters

The Contact Phone number for this Divisions Contact.

contact_Title
string or null <= 20 characters

Title of the Division's primary contact.

country_ID
string or null <= 8 characters

Country ID associated with the Division.

county_Code
string or null <= 8 characters

County code of the Division address.

cutoff_Age
integer or null <int32>

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_COBRA_Reason
integer or null <int32>

When disenrolling a member and reenrolling into COBRA, this indicates the default reason attached to the disenroll.

default_Invoice_ReportDefinition_Key
integer or null <int32>

For reports in the "INV" Report_Category, this provides the user with the list of invoice reports they can set as the default report using for automated invoice generation.

disability_Pay_Through_Day
integer or null <int32>

Indicates the day of the week the paid through is set when using automatic paid through dates.

disenroll_Date
string or null <date-time>

This notes that the Division has been terminated and what date. An active Division has a NULL value here.

distribution_Account_Key
integer or null <int32>

References the PayorAccount.Account_Key value in parent table.

distribution_Payor_ID
string or null <= 20 characters

References the PayorAccount.Payor_ID value in parent table.

duplicate_Claim_Override
required
boolean

This flag tells adjudication to ignore Duplicate Claims Processing logic if enabled. Note: This field is marked as NOT NULL in the database and therefore required by the API.

entry_Date
string <date-time>

Date when the record was first added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

exempt_Federal
required
boolean

For Disability tax calculations, this indicates if the Division is exempt from taking Federal taxes on the claim payments. Note: This field is marked as NOT NULL in the database and therefore required by the API.

exempt_Medicare
required
boolean

For Disability tax calculations, this indicates if the Division is exempt from taking Medicare taxes on the claim payments. Note: This field is marked as NOT NULL in the database and therefore required by the API.

exempt_SocSec
required
boolean

For Disability tax calculations, this indicates if the Division is exempt from taking Social Security taxes on the claim payments. Note: This field is marked as NOT NULL in the database and therefore required by the API.

exempt_State
required
boolean

For Disability tax calculations, this indicates if the Division is exempt from taking State taxes on the claim payments. Note: This field is marked as NOT NULL in the database and therefore required by the API.

ficA_Employer_Match
required
boolean

Notes if the employer matches FICA (lowers that tax to 0) during claims adjudication. Note: This field is marked as NOT NULL in the database and therefore required by the API.

fax
string or null <= 20 characters

The fax number for this Division.

fax_Country_Code
string or null <= 8 characters

Country Code for the Division Fax Number.

federal_ID
string or null <= 20 characters

This Division Tax ID.

federal_Tax_Day_Limit
integer or null <int32>

Limit of days for the federal tax exemption.

federal_Wage_Limit
number or null <double>

Wage limit for the federal tax exemption.

generate_W2
required
boolean

Notes if this Division is part of tax reporting and should have its data sent for W2 generation. Note: This field is marked as NOT NULL in the database and therefore required by the API.

groupDivisionCaptive
string or null <= 256 characters

Information field for custom client reporting.

invoice_Grace_Period
integer or null <int32>

Indicates the grace period for invoice generation for this Division. This value works with "Invoice_Grace_Period_Type" to determine duration.

invoice_Grace_Period_Ex_Code
string or null <= 6 characters

When a grace period is applied to an invoice that impacts "Paid Through", the affected claims will apply this Ex Code.

invoice_Grace_Period_Type
string or null <= 16 characters

Based on "Invoice_Grace_Period", this is the Days, Weeks, Months or Years that grace period extends.

invoice_Level
string or null <= 1 characters

Indiciates the level of invoicing done by premium billing. There are 3 levels you can configure: S - Subscriber level invoicing (meaning an invoice per enrolled Subscriber), D - Division level invoicing (meaning an invoice per Division with all enrolled Subscribers in that Division on that Invoice), and G - Group level invoicing (meaning an invoice for the whole group with all enrolled Subscribers on the same invoice).

invoice_Remit_Address1
string or null <= 128 characters

When generating Division level invoices through premium biling, this is the Address on that invoice.

invoice_Remit_Address2
string or null <= 128 characters

When generating Division level invoices through premium biling, this is the Address 2 on that invoice.

invoice_Remit_City
string or null <= 32 characters

When generating Division level invoices through premium biling, this is the City on that invoice.

invoice_Remit_Country_Code
string or null <= 8 characters

When generating Division level invoices through premium biling, this is the Phone Number Country Code on that invoice.

invoice_Remit_Country_ID
string or null <= 8 characters

When generating Division level invoices through premium biling, this is the Country ID on that invoice.

invoice_Remit_Name
string or null <= 128 characters

When generating Division level invoices through premium biling, this is the Name on that invoice.

invoice_Remit_Phone_Number
string or null <= 32 characters

When generating Division level invoices through premium biling, this is the Phone Number on that invoice.

invoice_Remit_State
string or null <= 2 characters

When generating Division level invoices through premium biling, this is the State on that invoice.

invoice_Remit_Zip_Code
string or null <= 32 characters

When generating Division level invoices through premium biling, this is the Zip Code on that invoice.

issue_State
string or null <= 2 characters

For Life & Disability clients, this holds the issue state for processing taxes and reporting.

mail_To_Default
required
boolean

For Life & Disability clients, this is the default Mail To setting applied to claims created through the advisor wizards. Note: This field is marked as NOT NULL in the database and therefore required by the API.

medicare_Tax_Day_Limit
integer or null <int32>

Limit of days for the medicare tax exemption.

medicare_Wage_Limit
number or null <double>

Wage liimit for the medicare tax exemption.

name
string or null <= 50 characters

Name of the Group Division.

notes
string or null

No longer in use. Replaced by the Notes module.

numberLives
integer or null <int32>

Information field for custom client reporting.

original_Date
string or null <date-time>

This is the first start date (original effective date) of the Division inside this group. This date should be equal to or earlier than the first GroupContact.Coverage_Start date attached to this Division.

other_Insurance_ExCode
string or null <= 6 characters

This is the Ex Code applied if COB is identified during adjudciation and Other Insurance information is used during processing.

paid_Through
string or null <date-time>

This is the paid through date for any Division level invoices through premium billing. This can be manually set or updated by the system.

participationIncentive_ID
string or null <= 32 characters

Information field for custom client reporting.

pay_To_Account
integer or null <int32>

For processing that uses the Pay To Account, this referneces the FundingAccount.Account_Key for that process.

payor_ID
string or null <= 20 characters

References the PayorAccount.Payor_ID value in parent table.

pend_Ex_Code
string or null <= 6 characters

The Ex Code applied during claims adjudication if "Pend_Flag" is enabled.

pend_Flag
string or null <= 1 characters

Notes that this Division should have a pend code (Ex Code) applied during claims processing for any claims for this Division.

phone
string or null <= 20 characters

The phone number for this Division.

phone_Country_Code
string or null <= 8 characters

Country Code for the Division Phone Number.

premium_Location
string or null <= 50 characters

No longer in use.

primary_Contact
string or null <= 25 characters

Primary contact of the Division.

prorate_Deduction
required
boolean

Notes if this division should have disability deductions pro-rated during claims processing. Note: This field is marked as NOT NULL in the database and therefore required by the API.

prorate_Deduction_Type
string or null <= 10 characters

Indicates the type of prorating to calculate against. If calculating against flat deduction types only, set to F, to apply prorating to Percentage based deductions, set to P, if applying prorating on all deduction types, set to B.

reference_Based_Pricing
string or null <= 1 characters

Information field for custom client reporting.

region_Code
string or null <= 32 characters

Information field for noting the region for this Division.

reinsurance_Option
string or null <= 256 characters

No longer in use. Replaces by the full reinsurance module.

seerData
integer or null <int32>

Information field for custom client reporting.

set_Paid_Through
required
boolean

Notes if this division should have the paid through set as part of satisfying a premium bill. Note: This field is marked as NOT NULL in the database and therefore required by the API.

socSec_Tax_Day_Limit
integer or null <int32>

Limit of days for the social security tax exemption.

socSec_Wage_Limit
number or null <double>

Wage limite for Social Security tax exemption.

spec_Deductible
string or null <= 256 characters

No longer in use. Replaces by the full reinsurance module.

state
string or null <= 2 characters

State of the Division address.

state_Tax_Day_Limit
integer or null <int32>

Limit of days for the state tax exemption.

state_Wage_Limit
number or null <double>

Wage limit for the state tax exemption.

tax_Day_Limit_Type
required
integer <int32>

Indicates if the tax day limitations are by day or calendar months. Note: This field is marked as NOT NULL in the database and therefore required by the API.

transplantElite
string or null <= 256 characters

Information field for custom client reporting.

update_Date
string <date-time>

Date when the record was last updated in the system.

update_User
string or null <= 20 characters

User that last updated the record in the system.

use_Restricted_Deductions
required
boolean

Limits the deduction types that can be selected on disability claims to use the GroupDivisionDeductionType list. Note: This field is marked as NOT NULL in the database and therefore required by the API.

zip_Code
string or null <= 32 characters

The Zip Code for this Division address.

Responses
200

Success

401

Unauthorized

put/groups/{groupID}/divisions/{divisionID}
Request samples
{
  • "group_ID": "string",
  • "division_ID": "string",
  • "acH_Account_Key": 0,
  • "account_Key": 0,
  • "address": "string",
  • "address2": "string",
  • "adult_Age": 0,
  • "agri_Tax_Return": "str",
  • "auth_Not_Reqd_Override": true,
  • "brokerage": "string",
  • "cobrA_Auto_Term_Adj_Reason": 0,
  • "cobrA_Auto_Term_Reason": 0,
  • "cobrA_Division": true,
  • "coE_Network": true,
  • "caseRate": 0.1,
  • "city": "string",
  • "claim_Days_Allowed": 0,
  • "class_Description": "string",
  • "class_ID": "string",
  • "contact_Country_Code": "string",
  • "contact_Email_Address": "string",
  • "contact_Extension": "string",
  • "contact_Phone": "string",
  • "contact_Title": "string",
  • "country_ID": "string",
  • "county_Code": "string",
  • "cutoff_Age": 0,
  • "default_COBRA_Reason": 0,
  • "default_Invoice_ReportDefinition_Key": 0,
  • "disability_Pay_Through_Day": 0,
  • "disenroll_Date": "2019-08-24T14:15:22Z",
  • "distribution_Account_Key": 0,
  • "distribution_Payor_ID": "string",
  • "duplicate_Claim_Override": true,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "exempt_Federal": true,
  • "exempt_Medicare": true,
  • "exempt_SocSec": true,
  • "exempt_State": true,
  • "ficA_Employer_Match": true,
  • "fax": "string",
  • "fax_Country_Code": "string",
  • "federal_ID": "string",
  • "federal_Tax_Day_Limit": 0,
  • "federal_Wage_Limit": 0.1,
  • "generate_W2": true,
  • "groupDivisionCaptive": "string",
  • "invoice_Grace_Period": 0,
  • "invoice_Grace_Period_Ex_Code": "string",
  • "invoice_Grace_Period_Type": "string",
  • "invoice_Level": "s",
  • "invoice_Remit_Address1": "string",
  • "invoice_Remit_Address2": "string",
  • "invoice_Remit_City": "string",
  • "invoice_Remit_Country_Code": "string",
  • "invoice_Remit_Country_ID": "string",
  • "invoice_Remit_Name": "string",
  • "invoice_Remit_Phone_Number": "string",
  • "invoice_Remit_State": "st",
  • "invoice_Remit_Zip_Code": "string",
  • "issue_State": "st",
  • "mail_To_Default": true,
  • "medicare_Tax_Day_Limit": 0,
  • "medicare_Wage_Limit": 0.1,
  • "name": "string",
  • "notes": "string",
  • "numberLives": 0,
  • "original_Date": "2019-08-24T14:15:22Z",
  • "other_Insurance_ExCode": "string",
  • "paid_Through": "2019-08-24T14:15:22Z",
  • "participationIncentive_ID": "string",
  • "pay_To_Account": 0,
  • "payor_ID": "string",
  • "pend_Ex_Code": "string",
  • "pend_Flag": "s",
  • "phone": "string",
  • "phone_Country_Code": "string",
  • "premium_Location": "string",
  • "primary_Contact": "string",
  • "prorate_Deduction": true,
  • "prorate_Deduction_Type": "string",
  • "reference_Based_Pricing": "s",
  • "region_Code": "string",
  • "reinsurance_Option": "string",
  • "seerData": 0,
  • "set_Paid_Through": true,
  • "socSec_Tax_Day_Limit": 0,
  • "socSec_Wage_Limit": 0.1,
  • "spec_Deductible": "string",
  • "state": "st",
  • "state_Tax_Day_Limit": 0,
  • "state_Wage_Limit": 0.1,
  • "tax_Day_Limit_Type": 0,
  • "transplantElite": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "use_Restricted_Deductions": true,
  • "zip_Code": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Delete GroupDivision

Deletes an GroupDivision

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

divisionID
required
string

Division ID

header Parameters
vbasoftware-database
required
string

Target database

Responses
204

Success

401

Unauthorized

delete/groups/{groupID}/divisions/{divisionID}
Request samples

Create or Update Batch GroupDivision

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

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
Array
group_ID
required
string [ 1 .. 20 ] characters

References Groups.Group_ID value on parent record.

division_ID
required
string [ 1 .. 20 ] characters

Unique Division identifier assigned inside this Group. This ID must be unique within the Group ID.

acH_Account_Key
integer or null <int32>

References the FundingAccount.Account_Key that holds the ACH information for this Division for any ACH processing.

account_Key
integer or null <int32>

References the PayorAccount.Account_Key value in parent table.

address
string or null <= 255 characters

Address associated with the Division.

address2
string or null <= 128 characters

Address 2 associated with the Division.

adult_Age
integer or null <int32>

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.

agri_Tax_Return
string or null <= 3 characters

Information field for custom client reporting.

auth_Not_Reqd_Override
required
boolean

This flag tells adjudication to not error if no authorization is found on claims that require authorization. Note: This field is marked as NOT NULL in the database and therefore required by the API.

brokerage
string or null <= 256 characters

Information field for custom client reporting.

cobrA_Auto_Term_Adj_Reason
integer or null <int32>

When utilizing the Auto-Term process, notes the adjustment reason applied to premiums impacted by a retro term.

cobrA_Auto_Term_Reason
integer or null <int32>

When utilizing the Auto-Term process, indicates the Term Reason to apply if COBRA is being enrolled.

cobrA_Division
required
boolean

Points to the Division ID that is the COBRA Division for this Division. Note: This field is marked as NOT NULL in the database and therefore required by the API.

coE_Network
required
boolean

Information field for custom client reporting. Note: This field is marked as NOT NULL in the database and therefore required by the API.

caseRate
number or null <double>

Information field for custom client reporting.

city
string or null <= 25 characters

City of the Division address.

claim_Days_Allowed
integer or null <int32>

No longer in use.

class_Description
string or null <= 128 characters

No longer in use, replaced by GroupClass table.

class_ID
string or null <= 20 characters

No longer in use, replaced by GroupClass table.

contact_Country_Code
string or null <= 8 characters

Country Code for the Contact Phone Number.

contact_Email_Address
string or null <= 128 characters

The division contact email address.

contact_Extension
string or null <= 6 characters

The contacts extension for their phone number.

contact_Phone
string or null <= 20 characters

The Contact Phone number for this Divisions Contact.

contact_Title
string or null <= 20 characters

Title of the Division's primary contact.

country_ID
string or null <= 8 characters

Country ID associated with the Division.

county_Code
string or null <= 8 characters

County code of the Division address.

cutoff_Age
integer or null <int32>

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_COBRA_Reason
integer or null <int32>

When disenrolling a member and reenrolling into COBRA, this indicates the default reason attached to the disenroll.

default_Invoice_ReportDefinition_Key
integer or null <int32>

For reports in the "INV" Report_Category, this provides the user with the list of invoice reports they can set as the default report using for automated invoice generation.

disability_Pay_Through_Day
integer or null <int32>

Indicates the day of the week the paid through is set when using automatic paid through dates.

disenroll_Date
string or null <date-time>

This notes that the Division has been terminated and what date. An active Division has a NULL value here.

distribution_Account_Key
integer or null <int32>

References the PayorAccount.Account_Key value in parent table.

distribution_Payor_ID
string or null <= 20 characters

References the PayorAccount.Payor_ID value in parent table.

duplicate_Claim_Override
required
boolean

This flag tells adjudication to ignore Duplicate Claims Processing logic if enabled. Note: This field is marked as NOT NULL in the database and therefore required by the API.

entry_Date
string <date-time>

Date when the record was first added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

exempt_Federal
required
boolean

For Disability tax calculations, this indicates if the Division is exempt from taking Federal taxes on the claim payments. Note: This field is marked as NOT NULL in the database and therefore required by the API.

exempt_Medicare
required
boolean

For Disability tax calculations, this indicates if the Division is exempt from taking Medicare taxes on the claim payments. Note: This field is marked as NOT NULL in the database and therefore required by the API.

exempt_SocSec
required
boolean

For Disability tax calculations, this indicates if the Division is exempt from taking Social Security taxes on the claim payments. Note: This field is marked as NOT NULL in the database and therefore required by the API.

exempt_State
required
boolean

For Disability tax calculations, this indicates if the Division is exempt from taking State taxes on the claim payments. Note: This field is marked as NOT NULL in the database and therefore required by the API.

ficA_Employer_Match
required
boolean

Notes if the employer matches FICA (lowers that tax to 0) during claims adjudication. Note: This field is marked as NOT NULL in the database and therefore required by the API.

fax
string or null <= 20 characters

The fax number for this Division.

fax_Country_Code
string or null <= 8 characters

Country Code for the Division Fax Number.

federal_ID
string or null <= 20 characters

This Division Tax ID.

federal_Tax_Day_Limit
integer or null <int32>

Limit of days for the federal tax exemption.

federal_Wage_Limit
number or null <double>

Wage limit for the federal tax exemption.

generate_W2
required
boolean

Notes if this Division is part of tax reporting and should have its data sent for W2 generation. Note: This field is marked as NOT NULL in the database and therefore required by the API.

groupDivisionCaptive
string or null <= 256 characters

Information field for custom client reporting.

invoice_Grace_Period
integer or null <int32>

Indicates the grace period for invoice generation for this Division. This value works with "Invoice_Grace_Period_Type" to determine duration.

invoice_Grace_Period_Ex_Code
string or null <= 6 characters

When a grace period is applied to an invoice that impacts "Paid Through", the affected claims will apply this Ex Code.

invoice_Grace_Period_Type
string or null <= 16 characters

Based on "Invoice_Grace_Period", this is the Days, Weeks, Months or Years that grace period extends.

invoice_Level
string or null <= 1 characters

Indiciates the level of invoicing done by premium billing. There are 3 levels you can configure: S - Subscriber level invoicing (meaning an invoice per enrolled Subscriber), D - Division level invoicing (meaning an invoice per Division with all enrolled Subscribers in that Division on that Invoice), and G - Group level invoicing (meaning an invoice for the whole group with all enrolled Subscribers on the same invoice).

invoice_Remit_Address1
string or null <= 128 characters

When generating Division level invoices through premium biling, this is the Address on that invoice.

invoice_Remit_Address2
string or null <= 128 characters

When generating Division level invoices through premium biling, this is the Address 2 on that invoice.

invoice_Remit_City
string or null <= 32 characters

When generating Division level invoices through premium biling, this is the City on that invoice.

invoice_Remit_Country_Code
string or null <= 8 characters

When generating Division level invoices through premium biling, this is the Phone Number Country Code on that invoice.

invoice_Remit_Country_ID
string or null <= 8 characters

When generating Division level invoices through premium biling, this is the Country ID on that invoice.

invoice_Remit_Name
string or null <= 128 characters

When generating Division level invoices through premium biling, this is the Name on that invoice.

invoice_Remit_Phone_Number
string or null <= 32 characters

When generating Division level invoices through premium biling, this is the Phone Number on that invoice.

invoice_Remit_State
string or null <= 2 characters

When generating Division level invoices through premium biling, this is the State on that invoice.

invoice_Remit_Zip_Code
string or null <= 32 characters

When generating Division level invoices through premium biling, this is the Zip Code on that invoice.

issue_State
string or null <= 2 characters

For Life & Disability clients, this holds the issue state for processing taxes and reporting.

mail_To_Default
required
boolean

For Life & Disability clients, this is the default Mail To setting applied to claims created through the advisor wizards. Note: This field is marked as NOT NULL in the database and therefore required by the API.

medicare_Tax_Day_Limit
integer or null <int32>

Limit of days for the medicare tax exemption.

medicare_Wage_Limit
number or null <double>

Wage liimit for the medicare tax exemption.

name
string or null <= 50 characters

Name of the Group Division.

notes
string or null

No longer in use. Replaced by the Notes module.

numberLives
integer or null <int32>

Information field for custom client reporting.

original_Date
string or null <date-time>

This is the first start date (original effective date) of the Division inside this group. This date should be equal to or earlier than the first GroupContact.Coverage_Start date attached to this Division.

other_Insurance_ExCode
string or null <= 6 characters

This is the Ex Code applied if COB is identified during adjudciation and Other Insurance information is used during processing.

paid_Through
string or null <date-time>

This is the paid through date for any Division level invoices through premium billing. This can be manually set or updated by the system.

participationIncentive_ID
string or null <= 32 characters

Information field for custom client reporting.

pay_To_Account
integer or null <int32>

For processing that uses the Pay To Account, this referneces the FundingAccount.Account_Key for that process.

payor_ID
string or null <= 20 characters

References the PayorAccount.Payor_ID value in parent table.

pend_Ex_Code
string or null <= 6 characters

The Ex Code applied during claims adjudication if "Pend_Flag" is enabled.

pend_Flag
string or null <= 1 characters

Notes that this Division should have a pend code (Ex Code) applied during claims processing for any claims for this Division.

phone
string or null <= 20 characters

The phone number for this Division.

phone_Country_Code
string or null <= 8 characters

Country Code for the Division Phone Number.

premium_Location
string or null <= 50 characters

No longer in use.

primary_Contact
string or null <= 25 characters

Primary contact of the Division.

prorate_Deduction
required
boolean

Notes if this division should have disability deductions pro-rated during claims processing. Note: This field is marked as NOT NULL in the database and therefore required by the API.

prorate_Deduction_Type
string or null <= 10 characters

Indicates the type of prorating to calculate against. If calculating against flat deduction types only, set to F, to apply prorating to Percentage based deductions, set to P, if applying prorating on all deduction types, set to B.

reference_Based_Pricing
string or null <= 1 characters

Information field for custom client reporting.

region_Code
string or null <= 32 characters

Information field for noting the region for this Division.

reinsurance_Option
string or null <= 256 characters

No longer in use. Replaces by the full reinsurance module.

seerData
integer or null <int32>

Information field for custom client reporting.

set_Paid_Through
required
boolean

Notes if this division should have the paid through set as part of satisfying a premium bill. Note: This field is marked as NOT NULL in the database and therefore required by the API.

socSec_Tax_Day_Limit
integer or null <int32>

Limit of days for the social security tax exemption.

socSec_Wage_Limit
number or null <double>

Wage limite for Social Security tax exemption.

spec_Deductible
string or null <= 256 characters

No longer in use. Replaces by the full reinsurance module.

state
string or null <= 2 characters

State of the Division address.

state_Tax_Day_Limit
integer or null <int32>

Limit of days for the state tax exemption.

state_Wage_Limit
number or null <double>

Wage limit for the state tax exemption.

tax_Day_Limit_Type
required
integer <int32>

Indicates if the tax day limitations are by day or calendar months. Note: This field is marked as NOT NULL in the database and therefore required by the API.

transplantElite
string or null <= 256 characters

Information field for custom client reporting.

update_Date
string <date-time>

Date when the record was last updated in the system.

update_User
string or null <= 20 characters

User that last updated the record in the system.

use_Restricted_Deductions
required
boolean

Limits the deduction types that can be selected on disability claims to use the GroupDivisionDeductionType list. Note: This field is marked as NOT NULL in the database and therefore required by the API.

zip_Code
string or null <= 32 characters

The Zip Code for this Division address.

Responses
207

Success

401

Unauthorized

put/groups/{groupID}/divisions-batch
Request samples
[
  • {
    }
]
Response samples
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}

Copy a GroupDivision Advanced API

Copy a specific GroupDivision to a new GroupDivision

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

divisionID
required
string

Division ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
groupID
required
string non-empty

The owning Group

sourceDivisionID
required
string non-empty

The division from which values will be copied.

destinationGroupID
required
string non-empty

The Destination Group ID

destinationDivisionID
required
string non-empty

Name of the new divion

copyContracts
string or null

Flag indicating to copy this field or not. Default is false.

copyPlans
string or null

Flag indicating to copy this field or not. Default is false.

copyRiders
string or null

Flag indicating to copy this field or not. Default is false.

copyAdditional
string or null

Flag indicating to copy this field or not. Default is false.

copyClassOptions
string or null

Flag indicating to copy this field or not. Default is false.

copyCommissions
string or null

Flag indicating to copy this field or not. Default is false.

copyDisabilityOptions
string or null

Flag indicating to copy this field or not. Default is false.

copyNetworksTiers
string or null

Flag indicating to copy this field or not. Default is false.

copyPlanYears
string or null

Flag indicating to copy this field or not. Default is false.

copyPremiums
string or null

Flag indicating to copy this field or not. Default is false.

copySelfAdmin
string or null

Flag indicating to copy this field or not. Default is false.

copyStudentAge
string or null

Flag indicating to copy this field or not. Default is false.

copyVolumeDetails
string or null

Flag indicating to copy this field or not. Default is false.

copyIDCodes
string or null

Flag indicating to copy this field or not. Default is false.

Responses
200

Success

401

Unauthorized

post/groups/{groupID}/divisions/{divisionID}/copy
Request samples
{
  • "groupID": "string",
  • "sourceDivisionID": "string",
  • "destinationGroupID": "string",
  • "destinationDivisionID": "string",
  • "copyContracts": "string",
  • "copyPlans": "string",
  • "copyRiders": "string",
  • "copyAdditional": "string",
  • "copyClassOptions": "string",
  • "copyCommissions": "string",
  • "copyDisabilityOptions": "string",
  • "copyNetworksTiers": "string",
  • "copyPlanYears": "string",
  • "copyPremiums": "string",
  • "copySelfAdmin": "string",
  • "copyStudentAge": "string",
  • "copyVolumeDetails": "string",
  • "copyIDCodes": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Get Group enrollment summary information Advanced API

Gets enrollment summary for the given group id and division id.

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

divisionID
required
string

Division ID

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/groups/{groupID}/divisions/{divisionID}/enrollment-summary
Request samples
Response samples
No sample