Reinsurance Contract Factors

Create ReinsContractFactor

Creates a new ReinsContractFactor

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

ReinsContract Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
reinsContractFactor_Key
required
integer <int32>

Unique identifier for each contract factor configuration. Note: This field is marked as NOT NULL in the database and therefore required by the API.

age_From
integer or null <int32>

The reinsurance contract factor configuration value used to determine if a member falls into this factor calculation.

age_Thru
integer or null <int32>

The reinsurance contract factor configuration value used to determine if a member falls into this factor calculation.

effective_Date
required
string <date-time>

The effective date of this factor within the reinsurance contract. Note: This field is marked as NOT NULL in the database and therefore required by the API.

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

factor
number or null <double>

The calculated factor for each eligiblity member that falls into this configuration.

plan_ID
string or null <= 20 characters

The reinsurance contract factor configuration value used to determine if a member falls into this factor calculation.

reinsContract_Key
required
integer <int32>

References the ReinsContract.ReinsContract_Key on the parent record. 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 factor within the reinsurance contract.

tier
required
string [ 1 .. 2 ] characters

The reinsurance contract factor configuration value used to determine if a member falls into this factor calculation.

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

zip_From
string or null <= 32 characters

The reinsurance contract factor configuration value used to determine if a member falls into this factor calculation.

zip_Thru
string or null <= 32 characters

The reinsurance contract factor configuration value used to determine if a member falls into this factor calculation.

Responses
200

Success

401

Unauthorized

post/reinsurance-contracts/{reinsContractKey}/factors
Request samples
{
  • "reinsContractFactor_Key": 0,
  • "age_From": 0,
  • "age_Thru": 0,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "factor": 0.1,
  • "plan_ID": "string",
  • "reinsContract_Key": 0,
  • "term_Date": "2019-08-24T14:15:22Z",
  • "tier": "st",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "zip_From": "string",
  • "zip_Thru": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ReinsContractFactor

Lists all ReinsContractFactor for the given reinsContractKey

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

ReinsContract Key

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/{reinsContractKey}/factors
Request samples
Response samples
No sample

Get ReinsContractFactor

Gets ReinsContractFactor

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

ReinsContract Key

reinsContractFactorKey
required
integer <int32>

ReinsContractFactor Key

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/reinsurance-contracts/{reinsContractKey}/factors/{reinsContractFactorKey}
Request samples
Response samples
No sample

Update ReinsContractFactor

Updates a specific ReinsContractFactor.

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

ReinsContract Key

reinsContractFactorKey
required
integer <int32>

ReinsContractFactor Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
reinsContractFactor_Key
required
integer <int32>

Unique identifier for each contract factor configuration. Note: This field is marked as NOT NULL in the database and therefore required by the API.

age_From
integer or null <int32>

The reinsurance contract factor configuration value used to determine if a member falls into this factor calculation.

age_Thru
integer or null <int32>

The reinsurance contract factor configuration value used to determine if a member falls into this factor calculation.

effective_Date
required
string <date-time>

The effective date of this factor within the reinsurance contract. Note: This field is marked as NOT NULL in the database and therefore required by the API.

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

factor
number or null <double>

The calculated factor for each eligiblity member that falls into this configuration.

plan_ID
string or null <= 20 characters

The reinsurance contract factor configuration value used to determine if a member falls into this factor calculation.

reinsContract_Key
required
integer <int32>

References the ReinsContract.ReinsContract_Key on the parent record. 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 factor within the reinsurance contract.

tier
required
string [ 1 .. 2 ] characters

The reinsurance contract factor configuration value used to determine if a member falls into this factor calculation.

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

zip_From
string or null <= 32 characters

The reinsurance contract factor configuration value used to determine if a member falls into this factor calculation.

zip_Thru
string or null <= 32 characters

The reinsurance contract factor configuration value used to determine if a member falls into this factor calculation.

Responses
200

Success

401

Unauthorized

put/reinsurance-contracts/{reinsContractKey}/factors/{reinsContractFactorKey}
Request samples
{
  • "reinsContractFactor_Key": 0,
  • "age_From": 0,
  • "age_Thru": 0,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "factor": 0.1,
  • "plan_ID": "string",
  • "reinsContract_Key": 0,
  • "term_Date": "2019-08-24T14:15:22Z",
  • "tier": "st",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "zip_From": "string",
  • "zip_Thru": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Delete ReinsContractFactor

Deletes an ReinsContractFactor

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

ReinsContract Key

reinsContractFactorKey
required
integer <int32>

ReinsContractFactor Key

header Parameters
vbasoftware-database
required
string

Target database

Responses
204

Success

401

Unauthorized

delete/reinsurance-contracts/{reinsContractKey}/factors/{reinsContractFactorKey}
Request samples

Create or Update Batch ReinsContractFactor

Create or Update multiple ReinsContractFactor 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
reinsContractKey
required
integer <int32>

ReinsContract Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
Array
reinsContractFactor_Key
required
integer <int32>

Unique identifier for each contract factor configuration. Note: This field is marked as NOT NULL in the database and therefore required by the API.

age_From
integer or null <int32>

The reinsurance contract factor configuration value used to determine if a member falls into this factor calculation.

age_Thru
integer or null <int32>

The reinsurance contract factor configuration value used to determine if a member falls into this factor calculation.

effective_Date
required
string <date-time>

The effective date of this factor within the reinsurance contract. Note: This field is marked as NOT NULL in the database and therefore required by the API.

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

factor
number or null <double>

The calculated factor for each eligiblity member that falls into this configuration.

plan_ID
string or null <= 20 characters

The reinsurance contract factor configuration value used to determine if a member falls into this factor calculation.

reinsContract_Key
required
integer <int32>

References the ReinsContract.ReinsContract_Key on the parent record. 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 factor within the reinsurance contract.

tier
required
string [ 1 .. 2 ] characters

The reinsurance contract factor configuration value used to determine if a member falls into this factor calculation.

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

zip_From
string or null <= 32 characters

The reinsurance contract factor configuration value used to determine if a member falls into this factor calculation.

zip_Thru
string or null <= 32 characters

The reinsurance contract factor configuration value used to determine if a member falls into this factor calculation.

Responses
207

Success

401

Unauthorized

put/reinsurance-contracts/{reinsContractKey}/factors-batch
Request samples
[
  • {
    }
]
Response samples
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}