APIs for VBASoftware
- Change Premium Rates
List Invoices to be Generated
List Retro Adjustments
List Subscriber Disenroll Adjustments
List Self-Admin Invoices to be Generated
Generate Subscriber Invoice
Generate Group Invoice
Generate Division Invoice
Generate GroupDivisionCaptive Invoice
Generate Group and Division Invoice
Generate Self-Admin Group Invoice
Generate Self-Admin Division Invoice
Billing Refund
Copy Premium Rates
Billing Auto-Apply
Billing Apply Payment Category
Billing Apply Payment On Account Category
Reset Self-Admin Invoice
Clear Applied on Invoice
Delete an Invoice with additional options
Regenerate Invoice
Finalize Invoice
Process Payment File
PremInvoice Apply Payments for Self-Admin
Process or Check Invoice Tolerance
Undo an Applied Premium Payment
Set Paid Through by Invoice
Check Past Due settings and trigger Process Automation
When a negative Payment is attached to an Invoice, trigger Process Automation.
Generate Invoice Process Automation
List Billing Adjustments for Disenroll
Create Premium Distributions
Create Premium Distributions Checks
Create Premium Distributions Check Batch
PremInvoice Apply Payments by Subscriber
PremInvoice Apply Payments by Header Adjustment
PremInvoice Apply Payments by Subscriber and Plan Type
PremInvoice Apply Payments by Subscriber and Payor ID
PremInvoice Auto-Apply
PremInvoice Auto-Apply for Self-Admin
List Premium for Payment Application
Add Rate from Template
Generate Invoice Process Automation
Change Premium Rates
VBASoftware (v1)
Download OpenAPI description
Languages
Servers
VBAPI VBASoftware
https://vbapi.vbasoftware.com/vbasoftware/
Body
- application/json
- text/json
- application/*+json
Used in both Rate Copy and Rate Change 1 - Use Existing; 2 - Update Existing; 3 - Create New;
Used in both Rate Copy and Rate Change 1 - Use Existing Rates; 2 - Create New Rates; 3 - Add;
- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/billing-rate-copy
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://vbapi.vbasoftware.com/vbasoftware/billing-rate-copy \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-d '{
"rate_Basis": "string",
"keep_Rate_Basis": true,
"rate_Category": "string",
"keep_Rate_Category": true,
"plan_ID": "string",
"keep_Plan_ID": true,
"group_ID": "string",
"keep_Group_ID": true,
"division_ID": "string",
"keep_Division_ID": true,
"premRate_Type": "string",
"rate_Option": 0,
"payee_Option": 0,
"existing_Rate_Term_Date": "2019-08-24T14:15:22Z",
"new_Rate_Effective_Date": "2019-08-24T14:15:22Z",
"new_Rate_Term_Date": "2019-08-24T14:15:22Z",
"user_ID": "string",
"premRates": [
{
"premRate_Key": 0,
"add_On_Grouping_ID": "string",
"additional_Invoice_Address": "stri",
"additional_Invoice_Frequency": "st",
"additional_Invoice_Level": "string",
"address_Type": "string",
"adjustment_Reason": 0,
"adult": true,
"age_From": 0,
"age_Thru": 0,
"age_Type": "string",
"age_Type_Month": "st",
"assign_To_New_Division": true,
"assign_To_New_Group": true,
"assign_To_New_Member": true,
"auto_Adjust": true,
"auto_Adjust_Reason": 0,
"avoid_Retro": true,
"benefit_Code": "string",
"billing_Cycle_ID": "st",
"child": true,
"city": "string",
"class_Code": "string",
"country_ID": "string",
"county_Code": "string",
"description": "string",
"division_ID": "string",
"effective_Date": "2019-08-24T14:15:22Z",
"effective_Date_Type": "string",
"employee_Employer_Contribution": "st",
"employer_Contribution": 0.1,
"employer_Contribution_Pct": true,
"employer_Rate": 0.1,
"employer_Rate_Max": 0.1,
"employer_Rate_Minimum": 0.1,
"employer_Rate_Type": "string",
"employer_Rate_Variable1": 0.1,
"employer_Rate_Variable2": 0.1,
"employer_Rate_Variable3": 0.1,
"employer_Round_Precision": 0,
"employer_Round_Type": "string",
"enrolled_Count_From": 0,
"enrolled_Count_Thru": 0,
"enrolled_Count_Type": "string",
"enrolled_Duration_From": 0,
"enrolled_Duration_Min": 0,
"enrolled_Duration_Option": "string",
"enrolled_Duration_Thru": 0,
"enrolled_Duration_Type": "string",
"entry_Date": "2019-08-24T14:15:22Z",
"entry_User": "string",
"group_Division_Offering": true,
"group_ID": "string",
"member_Seq": "st",
"network_ID": "string",
"network_Type": "string",
"new_Hire_Age": true,
"override_Enrolled_Dates": true,
"parent_PremRate_Key": 0,
"payment_Method": "string",
"plan_ID": "string",
"plan_Type": "string",
"premRate_Basis": "string",
"premRate_Category": "string",
"premRate_ID": "string",
"premRate_Type": "string",
"premium_Proration": true,
"rate": 0.1,
"rate_Max": 0.1,
"rate_Minimum": 0.1,
"rate_Pace": "string",
"rate_Pace_Type": "string",
"rate_Round_Precision": 0,
"rate_Round_Type": "string",
"rate_Type": "string",
"rate_Variable1": 0.1,
"rate_Variable2": 0.1,
"rate_Variable3": 0.1,
"region_Code": "string",
"relationship": "string",
"sex": "s",
"smoker": "s",
"state": "st",
"subscriber_ID": "string",
"term_Date": "2019-08-24T14:15:22Z",
"term_Date_type": "string",
"tier": "st",
"update_Date": "2019-08-24T14:15:22Z",
"update_User": "string",
"zip_Code_From": "string",
"zip_Code_Thru": "string"
}
],
"premRatePayees": [
{
"premRate_Key": 0,
"payee_ID": "string",
"account_Key": 0,
"amount": 0.1,
"amount_Max": 0.1,
"amount_Pct": true,
"dist_Type": "string",
"entry_Date": "2019-08-24T14:15:22Z",
"entry_User": "string",
"payor_ID": "string",
"policy_Number": "string",
"premRate_Category": "string",
"priority": 0,
"rate": 0.1,
"rate_Max": 0.1,
"rate_Min": 0.1,
"rate_Round_Precision": 0,
"rate_Round_Type": "string",
"rate_Var1": 0.1,
"rate_Var2": 0.1,
"rate_Var3": 0.1,
"update_Date": "2019-08-24T14:15:22Z",
"update_User": "string"
}
]
}'Body
- application/json
- text/json
- application/*+json
Used in both Rate Copy and Rate Change 1 - Use Existing; 2 - Update Existing; 3 - Create New;
Used in both Rate Copy and Rate Change 1 - Use Existing Rates; 2 - Create New Rates; 3 - Add;
- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/billing-rate-change
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://vbapi.vbasoftware.com/vbasoftware/billing-rate-change \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-d '{
"rate_Basis": "string",
"keep_Rate_Basis": true,
"rate_Category": "string",
"keep_Rate_Category": true,
"plan_ID": "string",
"keep_Plan_ID": true,
"group_ID": "string",
"keep_Group_ID": true,
"division_ID": "string",
"keep_Division_ID": true,
"premRate_Type": "string",
"rate_Option": 0,
"payee_Option": 0,
"existing_Rate_Term_Date": "2019-08-24T14:15:22Z",
"new_Rate_Effective_Date": "2019-08-24T14:15:22Z",
"new_Rate_Term_Date": "2019-08-24T14:15:22Z",
"user_ID": "string",
"premRates": [
{
"premRate_Key": 0,
"add_On_Grouping_ID": "string",
"additional_Invoice_Address": "stri",
"additional_Invoice_Frequency": "st",
"additional_Invoice_Level": "string",
"address_Type": "string",
"adjustment_Reason": 0,
"adult": true,
"age_From": 0,
"age_Thru": 0,
"age_Type": "string",
"age_Type_Month": "st",
"assign_To_New_Division": true,
"assign_To_New_Group": true,
"assign_To_New_Member": true,
"auto_Adjust": true,
"auto_Adjust_Reason": 0,
"avoid_Retro": true,
"benefit_Code": "string",
"billing_Cycle_ID": "st",
"child": true,
"city": "string",
"class_Code": "string",
"country_ID": "string",
"county_Code": "string",
"description": "string",
"division_ID": "string",
"effective_Date": "2019-08-24T14:15:22Z",
"effective_Date_Type": "string",
"employee_Employer_Contribution": "st",
"employer_Contribution": 0.1,
"employer_Contribution_Pct": true,
"employer_Rate": 0.1,
"employer_Rate_Max": 0.1,
"employer_Rate_Minimum": 0.1,
"employer_Rate_Type": "string",
"employer_Rate_Variable1": 0.1,
"employer_Rate_Variable2": 0.1,
"employer_Rate_Variable3": 0.1,
"employer_Round_Precision": 0,
"employer_Round_Type": "string",
"enrolled_Count_From": 0,
"enrolled_Count_Thru": 0,
"enrolled_Count_Type": "string",
"enrolled_Duration_From": 0,
"enrolled_Duration_Min": 0,
"enrolled_Duration_Option": "string",
"enrolled_Duration_Thru": 0,
"enrolled_Duration_Type": "string",
"entry_Date": "2019-08-24T14:15:22Z",
"entry_User": "string",
"group_Division_Offering": true,
"group_ID": "string",
"member_Seq": "st",
"network_ID": "string",
"network_Type": "string",
"new_Hire_Age": true,
"override_Enrolled_Dates": true,
"parent_PremRate_Key": 0,
"payment_Method": "string",
"plan_ID": "string",
"plan_Type": "string",
"premRate_Basis": "string",
"premRate_Category": "string",
"premRate_ID": "string",
"premRate_Type": "string",
"premium_Proration": true,
"rate": 0.1,
"rate_Max": 0.1,
"rate_Minimum": 0.1,
"rate_Pace": "string",
"rate_Pace_Type": "string",
"rate_Round_Precision": 0,
"rate_Round_Type": "string",
"rate_Type": "string",
"rate_Variable1": 0.1,
"rate_Variable2": 0.1,
"rate_Variable3": 0.1,
"region_Code": "string",
"relationship": "string",
"sex": "s",
"smoker": "s",
"state": "st",
"subscriber_ID": "string",
"term_Date": "2019-08-24T14:15:22Z",
"term_Date_type": "string",
"tier": "st",
"update_Date": "2019-08-24T14:15:22Z",
"update_User": "string",
"zip_Code_From": "string",
"zip_Code_Thru": "string"
}
],
"premRatePayees": [
{
"premRate_Key": 0,
"payee_ID": "string",
"account_Key": 0,
"amount": 0.1,
"amount_Max": 0.1,
"amount_Pct": true,
"dist_Type": "string",
"entry_Date": "2019-08-24T14:15:22Z",
"entry_User": "string",
"payor_ID": "string",
"policy_Number": "string",
"premRate_Category": "string",
"priority": 0,
"rate": 0.1,
"rate_Max": 0.1,
"rate_Min": 0.1,
"rate_Round_Precision": 0,
"rate_Round_Type": "string",
"rate_Var1": 0.1,
"rate_Var2": 0.1,
"rate_Var3": 0.1,
"update_Date": "2019-08-24T14:15:22Z",
"update_User": "string"
}
]
}'- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/billing-auto-apply
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://vbapi.vbasoftware.com/vbasoftware/billing-auto-apply \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-d '{
"invoice_Key": 0,
"premPayment_Key": 0,
"payment_Posted": 0.1,
"payment_Posted_Date": "2019-08-24T14:15:22Z",
"payment_ID": "string",
"received_Date": "2019-08-24T14:15:22Z",
"autoApplyOption": 0,
"autoApplyAdjustmentOption": 0,
"autoApplyCategories": [
"string"
],
"autoApplySubscribers": [
"string"
]
}'