Reinsurance Contract Transactions

Create ReinsContractTrans

Creates a new ReinsContractTrans

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

ReinsContract Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
reinsContractTrans_Key
required
integer <int32>

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

description
string or null <= 512 characters

The description of this transaction.

entry_Date
string <date-time>

User that first added the record to the system

entry_User
string or null <= 20 characters

Date record was first added to the system

member_Seq
string or null <= 2 characters

The member on this transaction.

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.

submitted_Date
string or null <date-time>

The date the reinsurance claims (transaction) was submitted to the reinsurance carrier.

subscriber_ID
string or null <= 9 characters

The member on this transaction.

transaction_Amount
number or null <double>

The total amount of the claims attached to this transaction.

transaction_Claim_Number
string or null <= 64 characters

The transaction ID associated with this reinsurance claim.

transaction_Date
string or null <date-time>

The date the transaction was generated.

transaction_Status
string or null <= 32 characters

The status of this transaction as it is in the process of being reimbursed.

transaction_Type
string or null <= 32 characters

The type of transaction being created. This is a spec transaction or agg transaction.

update_Date
string <date-time>

User that last updated the record in the system

update_User
string or null <= 20 characters

Date the record was last updated in the system

Responses
200

Success

401

Unauthorized

post/reinsurance-contracts/{reinsContractKey}/transactions
Request samples
{
  • "reinsContractTrans_Key": 0,
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "member_Seq": "st",
  • "reinsContract_Key": 0,
  • "submitted_Date": "2019-08-24T14:15:22Z",
  • "subscriber_ID": "string",
  • "transaction_Amount": 0.1,
  • "transaction_Claim_Number": "string",
  • "transaction_Date": "2019-08-24T14:15:22Z",
  • "transaction_Status": "string",
  • "transaction_Type": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ReinsContractTrans

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

List ReinsContractTrans

Lists all ReinsContractTransactions in a Summary for the given reinsContractKey

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}/transactions-summary
Request samples
Response samples
No sample

List ReinsContractTransClaim Info

List all Claims attached to this Reinsurance Transaction along with some associated claim information and amount summaries.

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

ReinsContract Key

reinsContractTransKey
required
integer <int32>

ReinsContractTrans Key

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/reinsurance-contracts/{reinsContractKey}/transactions/{reinsContractTransKey}/claim-info
Request samples
Response samples
No sample

List Calculated ReinsContractTransClaim

List all Reimbursements attached to this Reinsurance Transaction along with some associated funding information and amount summaries.

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

ReinsContract Key

reinsContractTransKey
required
integer <int32>

ReinsContractTrans Key

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/reinsurance-contracts/{reinsContractKey}/transactions/{reinsContractTransKey}/reimburse-info
Request samples
Response samples
No sample

Get ReinsContractTrans

Gets ReinsContractTrans

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

ReinsContract Key

reinsContractTransKey
required
integer <int32>

ReinsContractTrans Key

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/reinsurance-contracts/{reinsContractKey}/transactions/{reinsContractTransKey}
Request samples
Response samples
No sample

Update ReinsContractTrans

Updates a specific ReinsContractTrans.

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

ReinsContract Key

reinsContractTransKey
required
integer <int32>

ReinsContractTrans Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
reinsContractTrans_Key
required
integer <int32>

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

description
string or null <= 512 characters

The description of this transaction.

entry_Date
string <date-time>

User that first added the record to the system

entry_User
string or null <= 20 characters

Date record was first added to the system

member_Seq
string or null <= 2 characters

The member on this transaction.

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.

submitted_Date
string or null <date-time>

The date the reinsurance claims (transaction) was submitted to the reinsurance carrier.

subscriber_ID
string or null <= 9 characters

The member on this transaction.

transaction_Amount
number or null <double>

The total amount of the claims attached to this transaction.

transaction_Claim_Number
string or null <= 64 characters

The transaction ID associated with this reinsurance claim.

transaction_Date
string or null <date-time>

The date the transaction was generated.

transaction_Status
string or null <= 32 characters

The status of this transaction as it is in the process of being reimbursed.

transaction_Type
string or null <= 32 characters

The type of transaction being created. This is a spec transaction or agg transaction.

update_Date
string <date-time>

User that last updated the record in the system

update_User
string or null <= 20 characters

Date the record was last updated in the system

Responses
200

Success

401

Unauthorized

put/reinsurance-contracts/{reinsContractKey}/transactions/{reinsContractTransKey}
Request samples
{
  • "reinsContractTrans_Key": 0,
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "member_Seq": "st",
  • "reinsContract_Key": 0,
  • "submitted_Date": "2019-08-24T14:15:22Z",
  • "subscriber_ID": "string",
  • "transaction_Amount": 0.1,
  • "transaction_Claim_Number": "string",
  • "transaction_Date": "2019-08-24T14:15:22Z",
  • "transaction_Status": "string",
  • "transaction_Type": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Delete ReinsContractTrans

Deletes an ReinsContractTrans

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

ReinsContract Key

reinsContractTransKey
required
integer <int32>

ReinsContractTrans Key

header Parameters
vbasoftware-database
required
string

Target database

Responses
204

Success

401

Unauthorized

delete/reinsurance-contracts/{reinsContractKey}/transactions/{reinsContractTransKey}
Request samples

Create or Update Batch ReinsContractTrans

Create or Update multiple ReinsContractTrans 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
reinsContractTrans_Key
required
integer <int32>

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

description
string or null <= 512 characters

The description of this transaction.

entry_Date
string <date-time>

User that first added the record to the system

entry_User
string or null <= 20 characters

Date record was first added to the system

member_Seq
string or null <= 2 characters

The member on this transaction.

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.

submitted_Date
string or null <date-time>

The date the reinsurance claims (transaction) was submitted to the reinsurance carrier.

subscriber_ID
string or null <= 9 characters

The member on this transaction.

transaction_Amount
number or null <double>

The total amount of the claims attached to this transaction.

transaction_Claim_Number
string or null <= 64 characters

The transaction ID associated with this reinsurance claim.

transaction_Date
string or null <date-time>

The date the transaction was generated.

transaction_Status
string or null <= 32 characters

The status of this transaction as it is in the process of being reimbursed.

transaction_Type
string or null <= 32 characters

The type of transaction being created. This is a spec transaction or agg transaction.

update_Date
string <date-time>

User that last updated the record in the system

update_User
string or null <= 20 characters

Date the record was last updated in the system

Responses
207

Success

401

Unauthorized

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

Calculate ReinsContractTrans Advanced API

Based on information existing in the ReinsTrans records and the attached ReinsTransClaim records, calculate the header information and return result.

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

ReinsContract Key

reinsContractTransKey
required
integer <int32>

ReinsContractTrans Key

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

post/reinsurance-contracts/{reinsContractKey}/transactions/{reinsContractTransKey}/calculate
Request samples
Response samples
No sample

Reset ReinsContractTrans Advanced API

For all claims attached to this Reinsurance Transaction, reset the various applied amounts (Reimbursed, Not Covered, etc.).

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

ReinsContract Key

reinsContractTransKey
required
integer <int32>

ReinsContractTrans Key

header Parameters
vbasoftware-database
required
string

Target database

Responses
202

Accepted for processing

401

Unauthorized

post/reinsurance-contracts/{reinsContractKey}/transactions/{reinsContractTransKey}/reset
Request samples

Apply Deductible ReinsContractTrans Advanced API

This option will reset all deductible applied amounts for claims on this transaction. Specific or Lasered Deductible amount is then applied to claims in service date order until deductible is met.

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

ReinsContract Key

reinsContractTransKey
required
integer <int32>

ReinsContractTrans Key

header Parameters
vbasoftware-database
required
string

Target database

Responses
202

Accepted for processing

401

Unauthorized

post/reinsurance-contracts/{reinsContractKey}/transactions/{reinsContractTransKey}/apply-deductible
Request samples

Apply Agg. Spec. Deductible ReinsContractTrans Advanced API

Using this option will reset all aggregate deductible applied amounts for claims on this transaction. Aggregate Deductible amount is then applied to claims in service date order until Aggregate Specific Deductible is met.

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

ReinsContract Key

reinsContractTransKey
required
integer <int32>

ReinsContractTrans Key

header Parameters
vbasoftware-database
required
string

Target database

Responses
202

Accepted for processing

401

Unauthorized

post/reinsurance-contracts/{reinsContractKey}/transactions/{reinsContractTransKey}/apply-agg-spec-deductible
Request samples

Apply Reimbursement ReinsContractTrans Advanced API

Using this option will reset all reimbursement applied amounts for claims on this transaction. Received Reimbursement amount is then applied to claims in service date order until reimbursement amount is used.

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

ReinsContract Key

reinsContractTransKey
required
integer <int32>

ReinsContractTrans Key

header Parameters
vbasoftware-database
required
string

Target database

Responses
202

Accepted for processing

401

Unauthorized

post/reinsurance-contracts/{reinsContractKey}/transactions/{reinsContractTransKey}/apply-reimbursement
Request samples