Reinsurance Contract Levels

Create ReinsLevel

Creates a new ReinsLevel

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>

References the ReinsContract.ReinsContract_Key on parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.

reinsLevel_Seq
required
integer <int32>

The unique sequence for this reinsurance level on this contract. Note: This field is marked as NOT NULL in the database and therefore required by the API.

benefit_Code
string or null <= 10 characters

The benefit code assigned to this reinsurance level.

deductible_Pct
number or null <double>

The reinsurance level deductible percent to be applied during transaction creation.

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

reins_Level_From
number or null <double>

The reinsurance level range.

reins_Level_Thru
number or null <double>

The reinsurance level range.

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

Responses
200

Success

401

Unauthorized

post/reinsurance-contracts/{reinsContractKey}/levels
Request samples
{
  • "reinsContract_Key": 0,
  • "reinsLevel_Seq": 0,
  • "benefit_Code": "string",
  • "deductible_Pct": 0.1,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "reins_Level_From": 0.1,
  • "reins_Level_Thru": 0.1,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ReinsLevel

Lists all ReinsLevel 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}/levels
Request samples
Response samples
No sample

Generate ReinsLevel Transactions

Creates new Reinsurance Transactions based on Reinsurance Level configurations.

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-reins-level
Request samples
Response samples
No sample

Get ReinsLevel

Gets ReinsLevel

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

ReinsContract Key

reinsLevelSeq
required
integer <int32>

ReinsLevel Seq

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/reinsurance-contracts/{reinsContractKey}/levels/{reinsLevelSeq}
Request samples
Response samples
No sample

Update ReinsLevel

Updates a specific ReinsLevel.

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

ReinsContract Key

reinsLevelSeq
required
integer <int32>

ReinsLevel Seq

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
reinsContract_Key
required
integer <int32>

References the ReinsContract.ReinsContract_Key on parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.

reinsLevel_Seq
required
integer <int32>

The unique sequence for this reinsurance level on this contract. Note: This field is marked as NOT NULL in the database and therefore required by the API.

benefit_Code
string or null <= 10 characters

The benefit code assigned to this reinsurance level.

deductible_Pct
number or null <double>

The reinsurance level deductible percent to be applied during transaction creation.

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

reins_Level_From
number or null <double>

The reinsurance level range.

reins_Level_Thru
number or null <double>

The reinsurance level range.

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

Responses
200

Success

401

Unauthorized

put/reinsurance-contracts/{reinsContractKey}/levels/{reinsLevelSeq}
Request samples
{
  • "reinsContract_Key": 0,
  • "reinsLevel_Seq": 0,
  • "benefit_Code": "string",
  • "deductible_Pct": 0.1,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "reins_Level_From": 0.1,
  • "reins_Level_Thru": 0.1,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Delete ReinsLevel

Deletes an ReinsLevel

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

ReinsContract Key

reinsLevelSeq
required
integer <int32>

ReinsLevel Seq

header Parameters
vbasoftware-database
required
string

Target database

Responses
204

Success

401

Unauthorized

delete/reinsurance-contracts/{reinsContractKey}/levels/{reinsLevelSeq}
Request samples

Create or Update Batch ReinsLevel

Create or Update multiple ReinsLevel 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
reinsContract_Key
required
integer <int32>

References the ReinsContract.ReinsContract_Key on parent record. Note: This field is marked as NOT NULL in the database and therefore required by the API.

reinsLevel_Seq
required
integer <int32>

The unique sequence for this reinsurance level on this contract. Note: This field is marked as NOT NULL in the database and therefore required by the API.

benefit_Code
string or null <= 10 characters

The benefit code assigned to this reinsurance level.

deductible_Pct
number or null <double>

The reinsurance level deductible percent to be applied during transaction creation.

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

reins_Level_From
number or null <double>

The reinsurance level range.

reins_Level_Thru
number or null <double>

The reinsurance level range.

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

Responses
207

Success

401

Unauthorized

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