APIs for VBASoftware
- Delete ReinsContract
Create ReinsContract
List ReinsContract
Add ReinsContract from a Template ReinsContract
Copy and existing ReinsContract to a new ReinsContract
Get ReinsContract
Update ReinsContract
Create or Update Batch ReinsContract
Generate Transactions for this Contract
Generate Aggregate Transaction for this Contract
Generate Level Transactions for this Contract
Delete ReinsContract
VBASoftware (v1)
Download OpenAPI description
Languages
Servers
VBAPI VBASoftware
https://vbapi.vbasoftware.com/vbasoftware/
Bodyrequired
- application/json
- text/json
- application/*+json
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.
Notes the threshold for when a member will have an ex code applied to their claim as they incur more claims against this contract.
The ex code that is applied to claims for members who exceed the adjudication threshold.
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.
The aggregating Spec. Max for all members on this Reinsurance Contract.
The aggregating Spec. Deductible for all members on this Reinsurance Contract.
Notes if the attachment minimu is a monthly or annual value.
User defined contract period from the ReinsContractCycle table.
The contract ID assigned by the client to this Reinsurance Contract.
Contract Level notes what level the members and claims on this contract are included. The level can be Group, Division or Subscriber.
The type of contractly, typically a 12/12 or 12/24 contract.
Impacts how eligiblity is calculated when determining if a member applies to this contract.
When contract Level is Division, this is the Division (in combination with Group) that is applicable to this Reinsurance Contract.
The effective date of this Reinsurance Contract. Used in reporting and transaction processing.
Used in custom reporting. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Impacts how eligiblity is calculated when determining if a member applies to this contract.
When contract Level is Group, this is the Group that is applicable to this Reinsurance Contract.
The policy number associated with this Reinsurance Contract.
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. IMPORTANT: While you may enter any value here via API, Reports that use this data will will look for the value of "S" for "Spec. Advance Fund" or "P" for "Pay and Reimburse".
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.
The individual member Spec. Deductible for this Reinsurance Contract.
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.
Notes the threshold for when a member will be considered part of the Member Loss report.
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.
The individual state attachment minimum for reporting based on the state of the member.
When contract Level is Subscriber, this is the Subscriber (in combination with Group and Division) that is applicable to this Reinsurance Contract.
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.
The term date of this Reinsurance Contract. Used in reporting and transaction processing.
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.
- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/reinsurance-contracts/{reinsContractKey}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://vbapi.vbasoftware.com/vbasoftware/reinsurance-contracts/{reinsContractKey}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-d '{
"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,
"advanced_Funding_Minimum": 0.1
}'Response
No response example- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/reinsurance-contracts/{reinsContractKey}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://vbapi.vbasoftware.com/vbasoftware/reinsurance-contracts/{reinsContractKey}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE'Body
- application/json
- text/json
- application/*+json
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.
Notes the threshold for when a member will have an ex code applied to their claim as they incur more claims against this contract.
The ex code that is applied to claims for members who exceed the adjudication threshold.
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.
The aggregating Spec. Max for all members on this Reinsurance Contract.
The aggregating Spec. Deductible for all members on this Reinsurance Contract.
Notes if the attachment minimu is a monthly or annual value.
User defined contract period from the ReinsContractCycle table.
The contract ID assigned by the client to this Reinsurance Contract.
Contract Level notes what level the members and claims on this contract are included. The level can be Group, Division or Subscriber.
The type of contractly, typically a 12/12 or 12/24 contract.
Impacts how eligiblity is calculated when determining if a member applies to this contract.
When contract Level is Division, this is the Division (in combination with Group) that is applicable to this Reinsurance Contract.
The effective date of this Reinsurance Contract. Used in reporting and transaction processing.
Used in custom reporting. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Impacts how eligiblity is calculated when determining if a member applies to this contract.
When contract Level is Group, this is the Group that is applicable to this Reinsurance Contract.
The policy number associated with this Reinsurance Contract.
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. IMPORTANT: While you may enter any value here via API, Reports that use this data will will look for the value of "S" for "Spec. Advance Fund" or "P" for "Pay and Reimburse".
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.
The individual member Spec. Deductible for this Reinsurance Contract.
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.
Notes the threshold for when a member will be considered part of the Member Loss report.
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.
The individual state attachment minimum for reporting based on the state of the member.
When contract Level is Subscriber, this is the Subscriber (in combination with Group and Division) that is applicable to this Reinsurance Contract.
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.
The term date of this Reinsurance Contract. Used in reporting and transaction processing.
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.
- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/reinsurance-contracts-batch
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
https://vbapi.vbasoftware.com/vbasoftware/reinsurance-contracts-batch \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-d '[
{
"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,
"advanced_Funding_Minimum": 0.1
}
]'Response
No response example