Reinsurance Contracts

Create ReinsContract

Creates a new ReinsContract

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
reinsContract_Key
required
integer <int32>

Unique identifier for each Reinsurance Contract. This is system generated. Note: This field is marked as NOT NULL in the database and therefore required by the API.

adjudicate_Threshold
number or null <double>

Notes the threshold for when a member will have an ex code applied to their claim as they incur more claims against this contract.

adjudicate_Threshold_Ex_Code
string or null <= 6 characters

The ex code that is applied to claims for members who exceed the adjudication threshold.

adjudicate_Threshold_Pct
required
boolean

Notes if the "Adjudicate Threshold" is a percentage or flat value. Note: This field is marked as NOT NULL in the database and therefore required by the API.

aggregate_Max
number or null <double>

The aggregating Spec. Max for all members on this Reinsurance Contract.

aggregate_Specific_Deductible
number or null <double>

The aggregating Spec. Deductible for all members on this Reinsurance Contract.

attachment_Minimum
number or null <double>

The attachment point for reinsurance reporting.

attachment_Minimum_Term
string or null <= 1 characters

Notes if the attachment minimu is a monthly or annual value.

carrier_Key
integer or null <int32>

References the Carrier.Carrier_Key value on referenced table.

contract_Cycle
string or null <= 32 characters

User defined contract period from the ReinsContractCycle table.

contract_ID
string or null <= 64 characters

The contract ID assigned by the client to this Reinsurance Contract.

contract_Level
string or null <= 1 characters

Contract Level notes what level the members and claims on this contract are included. The level can be Group, Division or Subscriber.

contract_Status
string or null <= 32 characters

The status of the contract, Open or Closed.

contract_Type
string or null <= 32 characters

The type of contractly, typically a 12/12 or 12/24 contract.

description
string or null <= 512 characters

The description of this Reinsurance Contract.

disenrolled_By_Day
integer or null <int32>

Impacts how eligiblity is calculated when determining if a member applies to this contract.

division_ID
string or null <= 20 characters

When contract Level is Division, this is the Division (in combination with Group) that is applicable to this Reinsurance Contract.

domestic_Claim_Criteria_Key
integer or null <int32>
effective_Date
string or null <date-time>

The effective date of this Reinsurance Contract. Used in reporting and transaction processing.

enroll_Disenroll_By_On_Agg_Report
required
boolean

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

enrolled_By_Day
integer or null <int32>

Impacts how eligiblity is calculated when determining if a member applies to this contract.

enrollment_Baseline
integer or null <int32>

Used in custom reporting.

enrollment_Change_Threshold
number or null <double>

Used in custom reporting.

entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 20 characters

User that first added the record to the system

group_ID
string or null <= 20 characters

When contract Level is Group, this is the Group that is applicable to this Reinsurance Contract.

policy_Number
string or null <= 64 characters

The policy number associated with this Reinsurance Contract.

reimburse_Method
string or null <= 32 characters

Notes if this is "Spec. Advance Fund" where all claims are included or "Pay and Reimburse" where only paid claims are included in the calculation.

spec_Threshold_Notify
required
boolean

Indicates if an Event should be generated and user or group notified when the threshold has been exceeded. Note: This field is marked as NOT NULL in the database and therefore required by the API.

specific_Deductible
number or null <double>

The individual member Spec. Deductible for this Reinsurance Contract.

specific_Deductible_Family
required
boolean

The family Spec. Deductible for this Reinsurance Contract. Note: This field is marked as NOT NULL in the database and therefore required by the API.

specific_Max
number or null <double>

The Spec. Limit for this Reinsurance Contract.

specific_Reporting_Threshold
number or null <double>

Notes the threshold for when a member will be considered part of the Member Loss report.

specific_Reporting_Threshold_Pct
required
boolean

Notes if the Specific_Reporting_Threshold value is a percentage or set value. Note: This field is marked as NOT NULL in the database and therefore required by the API.

state_Minimum
number or null <double>

The individual state attachment minimum for reporting based on the state of the member.

subscriber_ID
string or null <= 9 characters

When contract Level is Subscriber, this is the Subscriber (in combination with Group and Division) that is applicable to this Reinsurance Contract.

template_Contract
required
boolean

Allows the user to create a template contract that can then be "copied" whenever new contracts are created. Note: This field is marked as NOT NULL in the database and therefore required by the API.

term_Date
string or null <date-time>

The term date of this Reinsurance Contract. Used in reporting and transaction processing.

update_Date
string <date-time>

Date 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_Reins_Level
required
boolean

Indicates if this contract uses "Reinsurance Levels" for Reinsurance Calculations. Note: This field is marked as NOT NULL in the database and therefore required by the API.

Responses
200

Success

401

Unauthorized

post/reinsurance-contracts
Request samples
{
  • "reinsContract_Key": 0,
  • "adjudicate_Threshold": 0.1,
  • "adjudicate_Threshold_Ex_Code": "string",
  • "adjudicate_Threshold_Pct": true,
  • "aggregate_Max": 0.1,
  • "aggregate_Specific_Deductible": 0.1,
  • "attachment_Minimum": 0.1,
  • "attachment_Minimum_Term": "s",
  • "carrier_Key": 0,
  • "contract_Cycle": "string",
  • "contract_ID": "string",
  • "contract_Level": "s",
  • "contract_Status": "string",
  • "contract_Type": "string",
  • "description": "string",
  • "disenrolled_By_Day": 0,
  • "division_ID": "string",
  • "domestic_Claim_Criteria_Key": 0,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "enroll_Disenroll_By_On_Agg_Report": true,
  • "enrolled_By_Day": 0,
  • "enrollment_Baseline": 0,
  • "enrollment_Change_Threshold": 0.1,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "policy_Number": "string",
  • "reimburse_Method": "string",
  • "spec_Threshold_Notify": true,
  • "specific_Deductible": 0.1,
  • "specific_Deductible_Family": true,
  • "specific_Max": 0.1,
  • "specific_Reporting_Threshold": 0.1,
  • "specific_Reporting_Threshold_Pct": true,
  • "state_Minimum": 0.1,
  • "subscriber_ID": "string",
  • "template_Contract": true,
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "use_Reins_Level": true
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ReinsContract

Lists all ReinsContract

SecurityapiKeyAuth and bearerAuth
Request
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/reinsurance-contracts
Request samples 
Response samples 
No sample
Add ReinsContract from a Template ReinsContract
Take the information from a template and apply it to one or more new contracts based on that template contract.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
template_ReinsContract_Key
integer <int32> 
 
user_ID
string or null
 
Array of objects or null (TemplateGroupConfig) 
 
Responses 
200
Success


401
Unauthorized


post/reinsurance-contract-add-from-template
Request samples 
{
  • "template_ReinsContract_Key": 0,
  • "user_ID": "string",
  • "templateGroupConfigs": [
    ]
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Copy and existing ReinsContract to a new ReinsContract
Copy everything from an existing contract to a new Contract.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
reinsContract_Key
integer <int32> 
 
user_ID
string or null
 
description
string or null
 
contract_ID
string or null
 
effective_Date
string or null <date-time> 
 
term_Date
string or null <date-time> 
 
Responses 
200
Success


401
Unauthorized


post/reinsurance-contract-copy
Request samples 
{
  • "reinsContract_Key": 0,
  • "user_ID": "string",
  • "description": "string",
  • "contract_ID": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "term_Date": "2019-08-24T14:15:22Z"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Get ReinsContract
Gets ReinsContract


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
reinsContractKey
required
integer <int32> 
ReinsContract Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/reinsurance-contracts/{reinsContractKey}
Request samples 
Response samples 
No sample
Update ReinsContract
Updates a specific ReinsContract.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
reinsContractKey
required
integer <int32> 
ReinsContract Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
reinsContract_Key
required
integer <int32> 
Unique identifier for each Reinsurance Contract. This is system generated. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
adjudicate_Threshold
number or null <double> 
Notes the threshold for when a member will have an ex code applied to their claim as they incur more claims against this contract.


 
adjudicate_Threshold_Ex_Code
string or null  <= 6 characters 
The ex code that is applied to claims for members who exceed the adjudication threshold.


 
adjudicate_Threshold_Pct
required
boolean
Notes if the "Adjudicate Threshold" is a percentage or flat value. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
aggregate_Max
number or null <double> 
The aggregating Spec. Max for all members on this Reinsurance Contract.


 
aggregate_Specific_Deductible
number or null <double> 
The aggregating Spec. Deductible for all members on this Reinsurance Contract.


 
attachment_Minimum
number or null <double> 
The attachment point for reinsurance reporting.


 
attachment_Minimum_Term
string or null  <= 1 characters 
Notes if the attachment minimu is a monthly or annual value.


 
carrier_Key
integer or null <int32> 
References the Carrier.Carrier_Key value on referenced table.


 
contract_Cycle
string or null  <= 32 characters 
User defined contract period from the ReinsContractCycle table.


 
contract_ID
string or null  <= 64 characters 
The contract ID assigned by the client to this Reinsurance Contract.


 
contract_Level
string or null  <= 1 characters 
Contract Level notes what level the members and claims on this contract are included. The level can be Group, Division or Subscriber.


 
contract_Status
string or null  <= 32 characters 
The status of the contract, Open or Closed.


 
contract_Type
string or null  <= 32 characters 
The type of contractly, typically a 12/12 or 12/24 contract.


 
description
string or null  <= 512 characters 
The description of this Reinsurance Contract.


 
disenrolled_By_Day
integer or null <int32> 
Impacts how eligiblity is calculated when determining if a member applies to this contract.


 
division_ID
string or null  <= 20 characters 
When contract Level is Division, this is the Division (in combination with Group) that is applicable to this Reinsurance Contract.


 
domestic_Claim_Criteria_Key
integer or null <int32> 
 
effective_Date
string or null <date-time> 
The effective date of this Reinsurance Contract. Used in reporting and transaction processing.


 
enroll_Disenroll_By_On_Agg_Report
required
boolean
Used in custom reporting. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
enrolled_By_Day
integer or null <int32> 
Impacts how eligiblity is calculated when determining if a member applies to this contract.


 
enrollment_Baseline
integer or null <int32> 
Used in custom reporting.


 
enrollment_Change_Threshold
number or null <double> 
Used in custom reporting.


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
group_ID
string or null  <= 20 characters 
When contract Level is Group, this is the Group that is applicable to this Reinsurance Contract.


 
policy_Number
string or null  <= 64 characters 
The policy number associated with this Reinsurance Contract.


 
reimburse_Method
string or null  <= 32 characters 
Notes if this is "Spec. Advance Fund" where all claims are included or "Pay and Reimburse" where only paid claims are included in the calculation.


 
spec_Threshold_Notify
required
boolean
Indicates if an Event should be generated and user or group notified when the threshold has been exceeded. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
specific_Deductible
number or null <double> 
The individual member Spec. Deductible for this Reinsurance Contract.


 
specific_Deductible_Family
required
boolean
The family Spec. Deductible for this Reinsurance Contract. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
specific_Max
number or null <double> 
The Spec. Limit for this Reinsurance Contract.


 
specific_Reporting_Threshold
number or null <double> 
Notes the threshold for when a member will be considered part of the Member Loss report.


 
specific_Reporting_Threshold_Pct
required
boolean
Notes if the Specific_Reporting_Threshold value is a percentage or set value. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
state_Minimum
number or null <double> 
The individual state attachment minimum for reporting based on the state of the member.


 
subscriber_ID
string or null  <= 9 characters 
When contract Level is Subscriber, this is the Subscriber (in combination with Group and Division) that is applicable to this Reinsurance Contract.


 
template_Contract
required
boolean
Allows the user to create a template contract that can then be "copied" whenever new contracts are created. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
term_Date
string or null <date-time> 
The term date of this Reinsurance Contract. Used in reporting and transaction processing.


 
update_Date
string <date-time> 
Date 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_Reins_Level
required
boolean
Indicates if this contract uses "Reinsurance Levels" for Reinsurance Calculations. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
Responses 
200
Success


401
Unauthorized


put/reinsurance-contracts/{reinsContractKey}
Request samples 
{
  • "reinsContract_Key": 0,
  • "adjudicate_Threshold": 0.1,
  • "adjudicate_Threshold_Ex_Code": "string",
  • "adjudicate_Threshold_Pct": true,
  • "aggregate_Max": 0.1,
  • "aggregate_Specific_Deductible": 0.1,
  • "attachment_Minimum": 0.1,
  • "attachment_Minimum_Term": "s",
  • "carrier_Key": 0,
  • "contract_Cycle": "string",
  • "contract_ID": "string",
  • "contract_Level": "s",
  • "contract_Status": "string",
  • "contract_Type": "string",
  • "description": "string",
  • "disenrolled_By_Day": 0,
  • "division_ID": "string",
  • "domestic_Claim_Criteria_Key": 0,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "enroll_Disenroll_By_On_Agg_Report": true,
  • "enrolled_By_Day": 0,
  • "enrollment_Baseline": 0,
  • "enrollment_Change_Threshold": 0.1,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "policy_Number": "string",
  • "reimburse_Method": "string",
  • "spec_Threshold_Notify": true,
  • "specific_Deductible": 0.1,
  • "specific_Deductible_Family": true,
  • "specific_Max": 0.1,
  • "specific_Reporting_Threshold": 0.1,
  • "specific_Reporting_Threshold_Pct": true,
  • "state_Minimum": 0.1,
  • "subscriber_ID": "string",
  • "template_Contract": true,
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "use_Reins_Level": true
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ReinsContract
Deletes an ReinsContract


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
reinsContractKey
required
integer <int32> 
ReinsContract Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/reinsurance-contracts/{reinsContractKey}
Request samples 
Create or Update Batch ReinsContract
Create or Update multiple ReinsContract at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
reinsContract_Key
required
integer <int32> 
Unique identifier for each Reinsurance Contract. This is system generated. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
adjudicate_Threshold
number or null <double> 
Notes the threshold for when a member will have an ex code applied to their claim as they incur more claims against this contract.


 
adjudicate_Threshold_Ex_Code
string or null  <= 6 characters 
The ex code that is applied to claims for members who exceed the adjudication threshold.


 
adjudicate_Threshold_Pct
required
boolean
Notes if the "Adjudicate Threshold" is a percentage or flat value. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
aggregate_Max
number or null <double> 
The aggregating Spec. Max for all members on this Reinsurance Contract.


 
aggregate_Specific_Deductible
number or null <double> 
The aggregating Spec. Deductible for all members on this Reinsurance Contract.


 
attachment_Minimum
number or null <double> 
The attachment point for reinsurance reporting.


 
attachment_Minimum_Term
string or null  <= 1 characters 
Notes if the attachment minimu is a monthly or annual value.


 
carrier_Key
integer or null <int32> 
References the Carrier.Carrier_Key value on referenced table.


 
contract_Cycle
string or null  <= 32 characters 
User defined contract period from the ReinsContractCycle table.


 
contract_ID
string or null  <= 64 characters 
The contract ID assigned by the client to this Reinsurance Contract.


 
contract_Level
string or null  <= 1 characters 
Contract Level notes what level the members and claims on this contract are included. The level can be Group, Division or Subscriber.


 
contract_Status
string or null  <= 32 characters 
The status of the contract, Open or Closed.


 
contract_Type
string or null  <= 32 characters 
The type of contractly, typically a 12/12 or 12/24 contract.


 
description
string or null  <= 512 characters 
The description of this Reinsurance Contract.


 
disenrolled_By_Day
integer or null <int32> 
Impacts how eligiblity is calculated when determining if a member applies to this contract.


 
division_ID
string or null  <= 20 characters 
When contract Level is Division, this is the Division (in combination with Group) that is applicable to this Reinsurance Contract.


 
domestic_Claim_Criteria_Key
integer or null <int32> 
 
effective_Date
string or null <date-time> 
The effective date of this Reinsurance Contract. Used in reporting and transaction processing.


 
enroll_Disenroll_By_On_Agg_Report
required
boolean
Used in custom reporting. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
enrolled_By_Day
integer or null <int32> 
Impacts how eligiblity is calculated when determining if a member applies to this contract.


 
enrollment_Baseline
integer or null <int32> 
Used in custom reporting.


 
enrollment_Change_Threshold
number or null <double> 
Used in custom reporting.


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
group_ID
string or null  <= 20 characters 
When contract Level is Group, this is the Group that is applicable to this Reinsurance Contract.


 
policy_Number
string or null  <= 64 characters 
The policy number associated with this Reinsurance Contract.


 
reimburse_Method
string or null  <= 32 characters 
Notes if this is "Spec. Advance Fund" where all claims are included or "Pay and Reimburse" where only paid claims are included in the calculation.


 
spec_Threshold_Notify
required
boolean
Indicates if an Event should be generated and user or group notified when the threshold has been exceeded. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
specific_Deductible
number or null <double> 
The individual member Spec. Deductible for this Reinsurance Contract.


 
specific_Deductible_Family
required
boolean
The family Spec. Deductible for this Reinsurance Contract. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
specific_Max
number or null <double> 
The Spec. Limit for this Reinsurance Contract.


 
specific_Reporting_Threshold
number or null <double> 
Notes the threshold for when a member will be considered part of the Member Loss report.


 
specific_Reporting_Threshold_Pct
required
boolean
Notes if the Specific_Reporting_Threshold value is a percentage or set value. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
state_Minimum
number or null <double> 
The individual state attachment minimum for reporting based on the state of the member.


 
subscriber_ID
string or null  <= 9 characters 
When contract Level is Subscriber, this is the Subscriber (in combination with Group and Division) that is applicable to this Reinsurance Contract.


 
template_Contract
required
boolean
Allows the user to create a template contract that can then be "copied" whenever new contracts are created. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
term_Date
string or null <date-time> 
The term date of this Reinsurance Contract. Used in reporting and transaction processing.


 
update_Date
string <date-time> 
Date 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_Reins_Level
required
boolean
Indicates if this contract uses "Reinsurance Levels" for Reinsurance Calculations. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
Responses 
207
Success


401
Unauthorized


put/reinsurance-contracts-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}
Generate Transactions for this Contract
Based on submitted information, generate reinsurance transactions for this contract.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
reinsContractKey
required
integer <int32> 
ReinsContract Key


 
query Parameters
autoApplyDeductible
required
boolean
Auto Apply Deductible


 
subscriberId
string
Subscriber ID


 
memberSeq
string
Member Sequence


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


post/reinsurance-contracts/{reinsContractKey}/generate-transaction
Request samples 
Response samples 
No sample
Generate Level Transactions for this Contract
Based on submitted information, generate reinsurance level transactions for this contract.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
reinsContractKey
required
integer <int32> 
ReinsContract Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


post/reinsurance-contracts/{reinsContractKey}/generate-level-transaction
Request samples 
Response samples 
No sample