Reinsurance Contract Criterias

Create ReinsContractCriteria

Creates a new ReinsContractCriteria

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

ReinsContract Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
reinsContractCriteria_Key
required
integer <int32>

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

criteria_Type
required
string [ 1 .. 16 ] characters

Indicates if this is a Spec or Agg criteria.

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

incurred_From
string or null <date-time>

The incurred (service date) from.

incurred_Thru
string or null <date-time>

The incurred (service date) thru.

paid_From
string or null <date-time>

The paid (check run date) from.

paid_Thru
string or null <date-time>

The paid (check run date) thru.

reinsContract_Key
required
integer <int32>

References the ReinsContract.ReinsContract_Key on parent table. This holds the Spec or Agg Inccurred/Paid ranges that create the basis for claims being attached to transactions. Note: This field is marked as NOT NULL in the database and therefore required by the API.

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}/criterias
Request samples
{
  • "reinsContractCriteria_Key": 0,
  • "criteria_Type": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "incurred_From": "2019-08-24T14:15:22Z",
  • "incurred_Thru": "2019-08-24T14:15:22Z",
  • "paid_From": "2019-08-24T14:15:22Z",
  • "paid_Thru": "2019-08-24T14:15:22Z",
  • "reinsContract_Key": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ReinsContractCriteria

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

Get ReinsContractCriteria

Gets ReinsContractCriteria

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

ReinsContract Key

reinsContractCriteriaKey
required
integer <int32>

ReinsContractCriteria Key

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/reinsurance-contracts/{reinsContractKey}/criterias/{reinsContractCriteriaKey}
Request samples
Response samples
No sample

Update ReinsContractCriteria

Updates a specific ReinsContractCriteria.

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

ReinsContract Key

reinsContractCriteriaKey
required
integer <int32>

ReinsContractCriteria Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
reinsContractCriteria_Key
required
integer <int32>

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

criteria_Type
required
string [ 1 .. 16 ] characters

Indicates if this is a Spec or Agg criteria.

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

incurred_From
string or null <date-time>

The incurred (service date) from.

incurred_Thru
string or null <date-time>

The incurred (service date) thru.

paid_From
string or null <date-time>

The paid (check run date) from.

paid_Thru
string or null <date-time>

The paid (check run date) thru.

reinsContract_Key
required
integer <int32>

References the ReinsContract.ReinsContract_Key on parent table. This holds the Spec or Agg Inccurred/Paid ranges that create the basis for claims being attached to transactions. Note: This field is marked as NOT NULL in the database and therefore required by the API.

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}/criterias/{reinsContractCriteriaKey}
Request samples
{
  • "reinsContractCriteria_Key": 0,
  • "criteria_Type": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "incurred_From": "2019-08-24T14:15:22Z",
  • "incurred_Thru": "2019-08-24T14:15:22Z",
  • "paid_From": "2019-08-24T14:15:22Z",
  • "paid_Thru": "2019-08-24T14:15:22Z",
  • "reinsContract_Key": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Delete ReinsContractCriteria

Deletes an ReinsContractCriteria

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

ReinsContract Key

reinsContractCriteriaKey
required
integer <int32>

ReinsContractCriteria Key

header Parameters
vbasoftware-database
required
string

Target database

Responses
204

Success

401

Unauthorized

delete/reinsurance-contracts/{reinsContractKey}/criterias/{reinsContractCriteriaKey}
Request samples

Create or Update Batch ReinsContractCriteria

Create or Update multiple ReinsContractCriteria 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
reinsContractCriteria_Key
required
integer <int32>

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

criteria_Type
required
string [ 1 .. 16 ] characters

Indicates if this is a Spec or Agg criteria.

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

incurred_From
string or null <date-time>

The incurred (service date) from.

incurred_Thru
string or null <date-time>

The incurred (service date) thru.

paid_From
string or null <date-time>

The paid (check run date) from.

paid_Thru
string or null <date-time>

The paid (check run date) thru.

reinsContract_Key
required
integer <int32>

References the ReinsContract.ReinsContract_Key on parent table. This holds the Spec or Agg Inccurred/Paid ranges that create the basis for claims being attached to transactions. Note: This field is marked as NOT NULL in the database and therefore required by the API.

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}/criterias-batch
Request samples
[
  • {
    }
]
Response samples
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}