Adv. Billing

List Invoices to be Generated Advanced API

List of Invoices to be generated based on the selected Invoice Date.

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
invoiceDate
required
string <date-time>

Invoice Date

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/list-generate-bill/{invoiceDate}
Request samples 
Response samples 
No sample
List Retro Adjustments Advanced API 
List Retro Adjustments based on a provided Group, Division, Subscriber, and Eff Date.


SecurityapiKeyAuth and bearerAuth 
Request 
query Parameters
groupId
required
string
Group ID


 
divisionId
required
string
Division ID


 
subscriberId
required
string
Subscriber ID


 
effDate
required
string <date-time> 
Effective Date


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/list-retro-adjustment
Request samples 
Response samples 
No sample
List Subscriber Disenroll Adjustments Advanced API 
List Disenroll Adjustments based on a provided Subscriber ID and As of Date (Disenroll Date).


SecurityapiKeyAuth and bearerAuth 
Request 
query Parameters
subscriberId
required
string
Subscriber ID


 
effDate
required
string <date-time> 
Effective Date


 
showClosed
required
boolean
Show Closed


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/list-subscriber-disenroll-adjustment
Request samples 
Response samples 
No sample
List Self-Admin Invoices to be Generated Advanced API 
List of Self-Admin Invoices to be generated based on the selected Invoice Date.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
invoiceDate
required
string <date-time> 
Invoice Date


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/list-generate-self-admin/{invoiceDate}
Request samples 
Response samples 
No sample
Generate Subscriber Invoice Advanced API 
Creates a new Premium Billing Invoice for the selected Subscriber.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
invoice_Key
integer or null <int32> 
 
group_ID
string or null
 
division_ID
string or null
 
subscriber_ID
string or null
 
groupDivisionCaptive
string or null
 
bill_From
string or null <date-time> 
 
bill_Thru
string or null <date-time> 
 
invoice_Date
string or null <date-time> 
 
due_Date
string or null <date-time> 
 
user_ID
string or null
 
regenerate
boolean
 
input_Date
string or null <date-time> 
 
Responses 
200
Success


401
Unauthorized


post/generate-subscriber-invoice
Request samples 
{
  • "invoice_Key": 0,
  • "group_ID": "string",
  • "division_ID": "string",
  • "subscriber_ID": "string",
  • "groupDivisionCaptive": "string",
  • "bill_From": "2019-08-24T14:15:22Z",
  • "bill_Thru": "2019-08-24T14:15:22Z",
  • "invoice_Date": "2019-08-24T14:15:22Z",
  • "due_Date": "2019-08-24T14:15:22Z",
  • "user_ID": "string",
  • "regenerate": true,
  • "input_Date": "2019-08-24T14:15:22Z"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Generate Group Invoice Advanced API 
Creates a new Premium Billing Invoice for the selected Group.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
invoice_Key
integer or null <int32> 
 
group_ID
string or null
 
division_ID
string or null
 
subscriber_ID
string or null
 
groupDivisionCaptive
string or null
 
bill_From
string or null <date-time> 
 
bill_Thru
string or null <date-time> 
 
invoice_Date
string or null <date-time> 
 
due_Date
string or null <date-time> 
 
user_ID
string or null
 
regenerate
boolean
 
input_Date
string or null <date-time> 
 
Responses 
200
Success


401
Unauthorized


post/generate-group-invoice
Request samples 
{
  • "invoice_Key": 0,
  • "group_ID": "string",
  • "division_ID": "string",
  • "subscriber_ID": "string",
  • "groupDivisionCaptive": "string",
  • "bill_From": "2019-08-24T14:15:22Z",
  • "bill_Thru": "2019-08-24T14:15:22Z",
  • "invoice_Date": "2019-08-24T14:15:22Z",
  • "due_Date": "2019-08-24T14:15:22Z",
  • "user_ID": "string",
  • "regenerate": true,
  • "input_Date": "2019-08-24T14:15:22Z"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Generate Division Invoice Advanced API 
Creates a new Premium Billing Invoice for the selected Group/Division.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
invoice_Key
integer or null <int32> 
 
group_ID
string or null
 
division_ID
string or null
 
subscriber_ID
string or null
 
groupDivisionCaptive
string or null
 
bill_From
string or null <date-time> 
 
bill_Thru
string or null <date-time> 
 
invoice_Date
string or null <date-time> 
 
due_Date
string or null <date-time> 
 
user_ID
string or null
 
regenerate
boolean
 
input_Date
string or null <date-time> 
 
Responses 
200
Success


401
Unauthorized


post/generate-division-invoice
Request samples 
{
  • "invoice_Key": 0,
  • "group_ID": "string",
  • "division_ID": "string",
  • "subscriber_ID": "string",
  • "groupDivisionCaptive": "string",
  • "bill_From": "2019-08-24T14:15:22Z",
  • "bill_Thru": "2019-08-24T14:15:22Z",
  • "invoice_Date": "2019-08-24T14:15:22Z",
  • "due_Date": "2019-08-24T14:15:22Z",
  • "user_ID": "string",
  • "regenerate": true,
  • "input_Date": "2019-08-24T14:15:22Z"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Generate GroupDivisionCaptive Invoice Advanced API 
Creates a new Premium Billing Invoice for the selected GroupDivisionCaptive.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
invoice_Key
integer or null <int32> 
 
group_ID
string or null
 
division_ID
string or null
 
subscriber_ID
string or null
 
groupDivisionCaptive
string or null
 
bill_From
string or null <date-time> 
 
bill_Thru
string or null <date-time> 
 
invoice_Date
string or null <date-time> 
 
due_Date
string or null <date-time> 
 
user_ID
string or null
 
regenerate
boolean
 
input_Date
string or null <date-time> 
 
Responses 
200
Success


401
Unauthorized


post/generate-group-division-captive-invoice
Request samples 
{
  • "invoice_Key": 0,
  • "group_ID": "string",
  • "division_ID": "string",
  • "subscriber_ID": "string",
  • "groupDivisionCaptive": "string",
  • "bill_From": "2019-08-24T14:15:22Z",
  • "bill_Thru": "2019-08-24T14:15:22Z",
  • "invoice_Date": "2019-08-24T14:15:22Z",
  • "due_Date": "2019-08-24T14:15:22Z",
  • "user_ID": "string",
  • "regenerate": true,
  • "input_Date": "2019-08-24T14:15:22Z"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Generate Group and Division Invoice Advanced API 
Creates a new Premium Billing Invoice the selected Group for any Division with the Group Invoice Level AND a separate Invoice for each Division flagged as Division Invoice Level.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
invoice_Key
integer or null <int32> 
 
group_ID
string or null
 
division_ID
string or null
 
subscriber_ID
string or null
 
groupDivisionCaptive
string or null
 
bill_From
string or null <date-time> 
 
bill_Thru
string or null <date-time> 
 
invoice_Date
string or null <date-time> 
 
due_Date
string or null <date-time> 
 
user_ID
string or null
 
regenerate
boolean
 
input_Date
string or null <date-time> 
 
Responses 
202
Accepted for processing


401
Unauthorized


post/generate-group-division-invoice
Request samples 
{
  • "invoice_Key": 0,
  • "group_ID": "string",
  • "division_ID": "string",
  • "subscriber_ID": "string",
  • "groupDivisionCaptive": "string",
  • "bill_From": "2019-08-24T14:15:22Z",
  • "bill_Thru": "2019-08-24T14:15:22Z",
  • "invoice_Date": "2019-08-24T14:15:22Z",
  • "due_Date": "2019-08-24T14:15:22Z",
  • "user_ID": "string",
  • "regenerate": true,
  • "input_Date": "2019-08-24T14:15:22Z"
}
Generate Self-Admin Group Invoice Advanced API 
Creates a new Self-Admin Invoice for the selected Group.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
invoice_Key
integer or null <int32> 
 
group_ID
string or null
 
division_ID
string or null
 
subscriber_ID
string or null
 
groupDivisionCaptive
string or null
 
bill_From
string or null <date-time> 
 
bill_Thru
string or null <date-time> 
 
invoice_Date
string or null <date-time> 
 
due_Date
string or null <date-time> 
 
user_ID
string or null
 
regenerate
boolean
 
input_Date
string or null <date-time> 
 
Responses 
200
Success


401
Unauthorized


post/generate-self-admin-group-invoice
Request samples 
{
  • "invoice_Key": 0,
  • "group_ID": "string",
  • "division_ID": "string",
  • "subscriber_ID": "string",
  • "groupDivisionCaptive": "string",
  • "bill_From": "2019-08-24T14:15:22Z",
  • "bill_Thru": "2019-08-24T14:15:22Z",
  • "invoice_Date": "2019-08-24T14:15:22Z",
  • "due_Date": "2019-08-24T14:15:22Z",
  • "user_ID": "string",
  • "regenerate": true,
  • "input_Date": "2019-08-24T14:15:22Z"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Generate Self-Admin Division Invoice Advanced API 
Creates a new Self-Admin Invoice for the selected Group/Division.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
invoice_Key
integer or null <int32> 
 
group_ID
string or null
 
division_ID
string or null
 
subscriber_ID
string or null
 
groupDivisionCaptive
string or null
 
bill_From
string or null <date-time> 
 
bill_Thru
string or null <date-time> 
 
invoice_Date
string or null <date-time> 
 
due_Date
string or null <date-time> 
 
user_ID
string or null
 
regenerate
boolean
 
input_Date
string or null <date-time> 
 
Responses 
200
Success


401
Unauthorized


post/generate-self-admin-division-invoice
Request samples 
{
  • "invoice_Key": 0,
  • "group_ID": "string",
  • "division_ID": "string",
  • "subscriber_ID": "string",
  • "groupDivisionCaptive": "string",
  • "bill_From": "2019-08-24T14:15:22Z",
  • "bill_Thru": "2019-08-24T14:15:22Z",
  • "invoice_Date": "2019-08-24T14:15:22Z",
  • "due_Date": "2019-08-24T14:15:22Z",
  • "user_ID": "string",
  • "regenerate": true,
  • "input_Date": "2019-08-24T14:15:22Z"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Billing Refund Advanced API 
Generate the necessary Billing adjustments for an Invoice refund and create a Distribution if needed.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
invoice_Key
integer or null <int32> 
 
group_ID
string or null
 
division_ID
string or null
 
subscriber_ID
string or null
 
premRate_Key
integer or null <int32> 
 
amount
number or null <double> 
 
amount_Received
number or null <double> 
 
volume
number or null <double> 
 
payee_Level
string or null
 
payor_ID
string or null
 
account_Key
integer or null <int32> 
 
premPayment_Key
integer or null <int32> 
 
refund_Amount
number or null <double> 
 
payment_ID
string or null
 
payment_Name
string or null
 
invoice_Level
string or null
 
user_ID
string or null
 
Responses 
202
Accepted for processing


401
Unauthorized


post/billing-refund
Request samples 
{
  • "invoice_Key": 0,
  • "group_ID": "string",
  • "division_ID": "string",
  • "subscriber_ID": "string",
  • "premRate_Key": 0,
  • "amount": 0.1,
  • "amount_Received": 0.1,
  • "volume": 0.1,
  • "payee_Level": "string",
  • "payor_ID": "string",
  • "account_Key": 0,
  • "premPayment_Key": 0,
  • "refund_Amount": 0.1,
  • "payment_ID": "string",
  • "payment_Name": "string",
  • "invoice_Level": "string",
  • "user_ID": "string"
}
Copy Premium Rates Advanced API 
Take a list of Rates and a set of configuration options and copy those rates.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
rate_Basis
string or null
Used in both Rate Copy and Rate Change


 
keep_Rate_Basis
boolean
Used in both Rate Copy and Rate Change


 
rate_Category
string or null
Used in both Rate Copy and Rate Change


 
keep_Rate_Category
boolean
Used in both Rate Copy and Rate Change


 
plan_ID
string or null
Used in both Rate Copy and Rate Change


 
keep_Plan_ID
boolean
Used in both Rate Copy and Rate Change


 
group_ID
string or null
Used in both Rate Copy and Rate Change


 
keep_Group_ID
boolean
Used in both Rate Copy and Rate Change


 
division_ID
string or null
Used in both Rate Copy and Rate Change


 
keep_Division_ID
boolean
Used in both Rate Copy and Rate Change


 
premRate_Type
string or null
Used in both Rate Copy and Rate Change


 
rate_Option
integer <int32> 
Used in both Rate Copy and Rate Change
1 - Use Existing;
2 - Update Existing;
3 - Create New;


 
payee_Option
integer <int32> 
Used in both Rate Copy and Rate Change
1 - Use Existing Rates;
2 - Create New Rates;
3 - Add;


 
existing_Rate_Term_Date
string or null <date-time> 
Used only with Rate Change


 
new_Rate_Effective_Date
string or null <date-time> 
Used only with Rate Change


 
new_Rate_Term_Date
string or null <date-time> 
Used only with Rate Change


 
user_ID
string or null
Used in both Rate Copy and Rate Change


 
Array of objects or null (PremRate) 
Used in both Rate Copy and Rate Change


 
Array of objects or null (PremRatePayee) 
Used in both Rate Copy and Rate Change


 
Responses 
202
Accepted for processing


401
Unauthorized


post/billing-rate-copy
Request samples 
{
  • "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": [
    ],
  • "premRatePayees": [
    ]
}
Change Premium Rates Advanced API 
Take a list of Rates and a set of configuration options and change those rates.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
rate_Basis
string or null
Used in both Rate Copy and Rate Change


 
keep_Rate_Basis
boolean
Used in both Rate Copy and Rate Change


 
rate_Category
string or null
Used in both Rate Copy and Rate Change


 
keep_Rate_Category
boolean
Used in both Rate Copy and Rate Change


 
plan_ID
string or null
Used in both Rate Copy and Rate Change


 
keep_Plan_ID
boolean
Used in both Rate Copy and Rate Change


 
group_ID
string or null
Used in both Rate Copy and Rate Change


 
keep_Group_ID
boolean
Used in both Rate Copy and Rate Change


 
division_ID
string or null
Used in both Rate Copy and Rate Change


 
keep_Division_ID
boolean
Used in both Rate Copy and Rate Change


 
premRate_Type
string or null
Used in both Rate Copy and Rate Change


 
rate_Option
integer <int32> 
Used in both Rate Copy and Rate Change
1 - Use Existing;
2 - Update Existing;
3 - Create New;


 
payee_Option
integer <int32> 
Used in both Rate Copy and Rate Change
1 - Use Existing Rates;
2 - Create New Rates;
3 - Add;


 
existing_Rate_Term_Date
string or null <date-time> 
Used only with Rate Change


 
new_Rate_Effective_Date
string or null <date-time> 
Used only with Rate Change


 
new_Rate_Term_Date
string or null <date-time> 
Used only with Rate Change


 
user_ID
string or null
Used in both Rate Copy and Rate Change


 
Array of objects or null (PremRate) 
Used in both Rate Copy and Rate Change


 
Array of objects or null (PremRatePayee) 
Used in both Rate Copy and Rate Change


 
Responses 
202
Accepted for processing


401
Unauthorized


post/billing-rate-change
Request samples 
{
  • "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": [
    ],
  • "premRatePayees": [
    ]
}
Billing Auto-Apply Advanced API 
Auto Apply Payment based on specified configuration options.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
invoice_Key
integer <int32> 
 
premPayment_Key
integer <int32> 
 
payment_Posted
number or null <double> 
 
payment_Posted_Date
string or null <date-time> 
 
payment_ID
string or null
 
received_Date
string <date-time> 
 
autoApplyOption
integer <int32> 
 
autoApplyAdjustmentOption
integer <int32> 
 
autoApplyCategories
Array of strings or null
 
autoApplySubscribers
Array of strings or null
 
Responses 
202
Accepted for processing


401
Unauthorized


post/billing-auto-apply
Request samples 
{
  • "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": [
    ],
  • "autoApplySubscribers": [
    ]
}
Billing Apply Payment Category Advanced API 
Using the ListPremApplyPaymentCategory Operation to get a list of payments and additional configuration, have On Accout and PremPayment information updated.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
file_Type
string or null
 
posted_Date
string <date-time> 
 
received_Date
string <date-time> 
 
posted_Amount
number <double> 
 
user_ID
string or null
 
write_Off_When_In_Tolerance_Range
boolean
 
object (PremPayment) 
 
Array of objects or null (PremApplyPaymentCategoryResult) 
 
Responses 
202
Accepted for processing


401
Unauthorized


post/billing-apply-payment-category
Request samples 
{
  • "file_Type": "string",
  • "posted_Date": "2019-08-24T14:15:22Z",
  • "received_Date": "2019-08-24T14:15:22Z",
  • "posted_Amount": 0.1,
  • "user_ID": "string",
  • "write_Off_When_In_Tolerance_Range": true,
  • "payment": {
    },
  • "applyPayments": [
    ]
}
Billing Apply Payment On Account Category Advanced API 
Using the PremPaymentOnAccount List as a basis for configuration, have On Accout and PremPayment information updated.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
user_ID
string or null
 
object (PremPayment) 
 
Array of objects or null (PremPaymentOnAccount) 
 
Responses 
202
Accepted for processing


401
Unauthorized


post/billing-apply-payment-on-account-category
Request samples 
{
  • "user_ID": "string",
  • "payment": {
    },
  • "onAccountPayments": [
    ]
}
Reset Self-Admin Invoice Advanced API 
Reset a Self-Admin Invoice removing received amounts, adjustments applied, etc.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
invoiceKey
required
integer <int32> 
Invoice Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
202
Accepted for processing


401
Unauthorized


post/reset-self-admin-invoice/{invoiceKey}
Request samples 
Clear Applied on Invoice Advanced API 
Clear Applied data on invoice.  Delete received records.  Update Received Amounts.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
invoiceKey
required
integer <int32> 
Invoice Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
202
Accepted for processing


401
Unauthorized


post/invoice-clear-applied/{invoiceKey}
Request samples 
Delete an Invoice with additional options Advanced API 
This process will delete an invoice and remove attached records, update or delete adjustments based on selected options.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
invoiceKey
required
integer <int32> 
Invoice Key


 
query Parameters
deleteAdditionalInvoices
required
boolean
Delete Additional Invoices


 
keepManualAdjustments
required
boolean
Keep Manual Adjustments


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
202
Accepted for processing


401
Unauthorized


post/invoice-full-delete/{invoiceKey}
Request samples 
Regenerate Invoice Advanced API 
This will delete the invoice, remove attached adjustments, payments, etc. Then Regenerate the Invoice using the same Invoice Key.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
invoiceKey
required
integer <int32> 
Invoice Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
202
Accepted for processing


401
Unauthorized


post/invoice-regenerate/{invoiceKey}
Request samples 
Finalize Invoice Advanced API 
This will finalize the selected Invoice.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
invoiceKey
required
integer <int32> 
Invoice Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
202
Accepted for processing


401
Unauthorized


post/invoice-finalize/{invoiceKey}
Request samples 
Process Payment File Advanced API 
Import a defined Payment File in .csv format to then have payments created and, optionally, attached to invoices.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
payment_File_Format_Key
integer <int32> 
Used in both Rate Copy and Rate Change


 
payment_File
string or null <byte> 
This MUST be a .csv file with the following columns (Include Headers with field name):        



Payment_Type - Use a value from the PremPaymentType table (can be null)
Payment_Batch - Source system indicator for the payment batch (can be null)
Payment_Batch_Seq - Source system indicator for the payment batch sequence (can be null)
Payment_Account - The name of the account that the payment is being made from - required
Payment_ID - The unique identifier for the payment - required
Payment_Date - The date the payment was made in YYYY-MM-DD format - required
Payment_Amount - The amount of the payment - required
Payment_Name - The name of the person or entity making the payment - required
Group_ID - If this payment is for the entire group, this should be the Group_ID - can be null
Division_ID - If this payment is for the entire division, this should be the Division_ID - can be null
Subscriber_ID - If this payment is for a specific subscriber, this should be the Subscriber_ID - can be null
Payor_ID - The Payor_ID to be set on the created payments - required
Account_Key - The Account_Key to be set on the created payments - required
Invoice_Key - If this payment is to be applied to a specific invoice, this should be the Invoice_Key - can be null
PremRate_Key - If this payment is to be applied to a specific rate, this should be the PremRate_Key - can be null
PremPayment_Key - If this payment is to be applied to a specific payment, this should be the PremPayment_Key - can be null
 
payor_ID
string or null
The Payor to be set on the created payments


 
account_Key
integer <int32> 
The Account to be set on the created payments


 
create_Invoice_Payments
boolean
Indicates that payments should be created from the payment file


 
apply_Payments
boolean
Indicates that payments should be applied to invoices


 
close_Invoices
boolean
Indicates that invoices should be closed after payment is applied


 
only_Close_Satisfied_Invoices
boolean
Indicates that only fully satisfied invoices should be closed


 
user_ID
string or null
User ID performing the Payment File import


 
Responses 
200
Success


401
Unauthorized


post/process-payment-file
Request samples 
{
  • "payment_File_Format_Key": 0,
  • "payment_File": "string",
  • "payor_ID": "string",
  • "account_Key": 0,
  • "create_Invoice_Payments": true,
  • "apply_Payments": true,
  • "close_Invoices": true,
  • "only_Close_Satisfied_Invoices": true,
  • "user_ID": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
PremInvoice Apply Payments for Self-Admin Advanced API 
PremInvoice Apply Payments for Self-Admin


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
invoice_Key
required
integer <int32> 
 
subscriber_ID
string or null
Required for:
    ApplyPaymentSubscriber
    ApplyPaymentSubscriberPayorID
    ApplyPaymentSubscriberPlanType
    ApplyPaymentSelfAdmin
Not used for:
    ApplyPaymentHeaderAdjustment


 
plan_Type
string or null
Required for:
    ApplyPaymentSubscriberPlanType
Not used for:
    ApplyPaymentSubscriber
    ApplyPaymentSubscriberPayorID
    ApplyPaymentHeaderAdjustment


 
payor_ID
string or null
Required for:
    ApplyPaymentSubscriberPayorID
Not used for:
    ApplyPaymentSubscriber
    ApplyPaymentSubscriberPlanType
    ApplyPaymentHeaderAdjustment


 
premPayment_Key
required
integer <int32> 
 
adjustment_Reason
integer or null <int32> 
Required for:
    ApplyPaymentHeaderAdjustment
Not used for:
    ApplyPaymentSubscriber
    ApplyPaymentSubscriberPayorID
    ApplyPaymentSubscriberPlanType


 
payment_Posted
required
number <double> 
 
payment_Posted_Date
required
string <date-time> 
 
user_ID
required
string  non-empty 
 
Array of objects or null (PremInvoiceSelfAdmin) 
If using the ApplyPaymentSelfAdmin process, you pass in the PremInvoiceSelfAdmins to apply the payment to.  For non-self-admin invoices leave this empty


 
Responses 
202
Accepted for processing


401
Unauthorized


post/premium-invoice-apply-payment-self-admin
Request samples 
{
  • "invoice_Key": 0,
  • "subscriber_ID": "string",
  • "plan_Type": "string",
  • "payor_ID": "string",
  • "premPayment_Key": 0,
  • "adjustment_Reason": 0,
  • "payment_Posted": 0.1,
  • "payment_Posted_Date": "2019-08-24T14:15:22Z",
  • "user_ID": "string",
  • "premInvoiceSelfAdmins": [
    ]
}
Process or Check Invoice Tolerance Advanced API 
Given an Invoice and amount due, either check if an Invoice falls withing Tolerance range to performan a write-off, or go ahead and perform the write-off.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
invoiceKey
required
integer <int32> 
Invoice Key


 
query Parameters
amountDue
required
number <double> 
Amount Due


 
verifyOnly
required
boolean
Verify Only


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


post/process-invoice-tolerance/{invoiceKey}
Request samples 
Response samples 
No sample
Undo an Applied Premium Payment Advanced API 
Based on the supplied PremPayment_Key, remove this payment from any invoice it is attached, and then recalc the received on each affected invoice.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
premPaymentKey
required
integer <int32> 
PremPayment Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
202
Accepted for processing


401
Unauthorized


post/undo-premium-payment/{premPaymentKey}
Request samples 
List Billing Adjustments for Disenroll Advanced API 
List of Billing Adjustments that would be created based on a Subscriber being disenrolled on the As of Date.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
asOfDate
required
string <date-time> 
As of Date


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/subscribers/{subscriberID}/as-of-date/{asOfDate}/disenroll-adjustments
Request samples 
Response samples 
No sample
Create Premium Distributions Advanced API 
Generate the Premium Distributions for the selected Group and As of Date.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupId
required
string
Group ID


 
asOfDate
required
string <date-time> 
As of Date


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
202
Accepted for processing


401
Unauthorized


post/premium-distributions-generate/{groupId}/{asOfDate}
Request samples 
Create Premium Distributions Checks Advanced API 
Generate the Premium Distribution Checks for the selected Payor and Payee.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
payeeId
required
string
Payee ID


 
payorId
required
string
Payor ID


 
accountKey
required
integer <int32> 
Account Key


 
checkNumber
required
string
Check Number


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
202
Accepted for processing


401
Unauthorized


post/premium-distributions-generate-check/{payeeId}/{payorId}/{accountKey}/{checkNumber}
Request samples 
PremInvoice Apply Payments by Subscriber Advanced API 
PremInvoice Apply Payments by Subscriber


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
invoice_Key
required
integer <int32> 
 
subscriber_ID
string or null
Required for:
    ApplyPaymentSubscriber
    ApplyPaymentSubscriberPayorID
    ApplyPaymentSubscriberPlanType
    ApplyPaymentSelfAdmin
Not used for:
    ApplyPaymentHeaderAdjustment


 
plan_Type
string or null
Required for:
    ApplyPaymentSubscriberPlanType
Not used for:
    ApplyPaymentSubscriber
    ApplyPaymentSubscriberPayorID
    ApplyPaymentHeaderAdjustment


 
payor_ID
string or null
Required for:
    ApplyPaymentSubscriberPayorID
Not used for:
    ApplyPaymentSubscriber
    ApplyPaymentSubscriberPlanType
    ApplyPaymentHeaderAdjustment


 
premPayment_Key
required
integer <int32> 
 
adjustment_Reason
integer or null <int32> 
Required for:
    ApplyPaymentHeaderAdjustment
Not used for:
    ApplyPaymentSubscriber
    ApplyPaymentSubscriberPayorID
    ApplyPaymentSubscriberPlanType


 
payment_Posted
required
number <double> 
 
payment_Posted_Date
required
string <date-time> 
 
user_ID
required
string  non-empty 
 
Array of objects or null (PremInvoiceSelfAdmin) 
If using the ApplyPaymentSelfAdmin process, you pass in the PremInvoiceSelfAdmins to apply the payment to.  For non-self-admin invoices leave this empty


 
Responses 
202
Accepted for processing


401
Unauthorized


post/premium-invoice-apply-payment-sub
Request samples 
{
  • "invoice_Key": 0,
  • "subscriber_ID": "string",
  • "plan_Type": "string",
  • "payor_ID": "string",
  • "premPayment_Key": 0,
  • "adjustment_Reason": 0,
  • "payment_Posted": 0.1,
  • "payment_Posted_Date": "2019-08-24T14:15:22Z",
  • "user_ID": "string",
  • "premInvoiceSelfAdmins": [
    ]
}
PremInvoice Apply Payments by Header Adjustment Advanced API 
PremInvoice Apply Payments by Header Adjustment


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
invoice_Key
required
integer <int32> 
 
subscriber_ID
string or null
Required for:
    ApplyPaymentSubscriber
    ApplyPaymentSubscriberPayorID
    ApplyPaymentSubscriberPlanType
    ApplyPaymentSelfAdmin
Not used for:
    ApplyPaymentHeaderAdjustment


 
plan_Type
string or null
Required for:
    ApplyPaymentSubscriberPlanType
Not used for:
    ApplyPaymentSubscriber
    ApplyPaymentSubscriberPayorID
    ApplyPaymentHeaderAdjustment


 
payor_ID
string or null
Required for:
    ApplyPaymentSubscriberPayorID
Not used for:
    ApplyPaymentSubscriber
    ApplyPaymentSubscriberPlanType
    ApplyPaymentHeaderAdjustment


 
premPayment_Key
required
integer <int32> 
 
adjustment_Reason
integer or null <int32> 
Required for:
    ApplyPaymentHeaderAdjustment
Not used for:
    ApplyPaymentSubscriber
    ApplyPaymentSubscriberPayorID
    ApplyPaymentSubscriberPlanType


 
payment_Posted
required
number <double> 
 
payment_Posted_Date
required
string <date-time> 
 
user_ID
required
string  non-empty 
 
Array of objects or null (PremInvoiceSelfAdmin) 
If using the ApplyPaymentSelfAdmin process, you pass in the PremInvoiceSelfAdmins to apply the payment to.  For non-self-admin invoices leave this empty


 
Responses 
202
Accepted for processing


401
Unauthorized


post/premium-invoice-apply-payment-adj
Request samples 
{
  • "invoice_Key": 0,
  • "subscriber_ID": "string",
  • "plan_Type": "string",
  • "payor_ID": "string",
  • "premPayment_Key": 0,
  • "adjustment_Reason": 0,
  • "payment_Posted": 0.1,
  • "payment_Posted_Date": "2019-08-24T14:15:22Z",
  • "user_ID": "string",
  • "premInvoiceSelfAdmins": [
    ]
}
PremInvoice Apply Payments by Subscriber and Plan Type Advanced API 
PremInvoice Apply Payments by Subscriber and Plan Type


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
invoice_Key
required
integer <int32> 
 
subscriber_ID
string or null
Required for:
    ApplyPaymentSubscriber
    ApplyPaymentSubscriberPayorID
    ApplyPaymentSubscriberPlanType
    ApplyPaymentSelfAdmin
Not used for:
    ApplyPaymentHeaderAdjustment


 
plan_Type
string or null
Required for:
    ApplyPaymentSubscriberPlanType
Not used for:
    ApplyPaymentSubscriber
    ApplyPaymentSubscriberPayorID
    ApplyPaymentHeaderAdjustment


 
payor_ID
string or null
Required for:
    ApplyPaymentSubscriberPayorID
Not used for:
    ApplyPaymentSubscriber
    ApplyPaymentSubscriberPlanType
    ApplyPaymentHeaderAdjustment


 
premPayment_Key
required
integer <int32> 
 
adjustment_Reason
integer or null <int32> 
Required for:
    ApplyPaymentHeaderAdjustment
Not used for:
    ApplyPaymentSubscriber
    ApplyPaymentSubscriberPayorID
    ApplyPaymentSubscriberPlanType


 
payment_Posted
required
number <double> 
 
payment_Posted_Date
required
string <date-time> 
 
user_ID
required
string  non-empty 
 
Array of objects or null (PremInvoiceSelfAdmin) 
If using the ApplyPaymentSelfAdmin process, you pass in the PremInvoiceSelfAdmins to apply the payment to.  For non-self-admin invoices leave this empty


 
Responses 
202
Accepted for processing


401
Unauthorized


post/premium-invoice-apply-payment-sub-plan-type
Request samples 
{
  • "invoice_Key": 0,
  • "subscriber_ID": "string",
  • "plan_Type": "string",
  • "payor_ID": "string",
  • "premPayment_Key": 0,
  • "adjustment_Reason": 0,
  • "payment_Posted": 0.1,
  • "payment_Posted_Date": "2019-08-24T14:15:22Z",
  • "user_ID": "string",
  • "premInvoiceSelfAdmins": [
    ]
}
PremInvoice Apply Payments by Subscriber and Payor ID Advanced API 
PremInvoice Apply Payments by Subscriber and Payor ID


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
invoice_Key
required
integer <int32> 
 
subscriber_ID
string or null
Required for:
    ApplyPaymentSubscriber
    ApplyPaymentSubscriberPayorID
    ApplyPaymentSubscriberPlanType
    ApplyPaymentSelfAdmin
Not used for:
    ApplyPaymentHeaderAdjustment


 
plan_Type
string or null
Required for:
    ApplyPaymentSubscriberPlanType
Not used for:
    ApplyPaymentSubscriber
    ApplyPaymentSubscriberPayorID
    ApplyPaymentHeaderAdjustment


 
payor_ID
string or null
Required for:
    ApplyPaymentSubscriberPayorID
Not used for:
    ApplyPaymentSubscriber
    ApplyPaymentSubscriberPlanType
    ApplyPaymentHeaderAdjustment


 
premPayment_Key
required
integer <int32> 
 
adjustment_Reason
integer or null <int32> 
Required for:
    ApplyPaymentHeaderAdjustment
Not used for:
    ApplyPaymentSubscriber
    ApplyPaymentSubscriberPayorID
    ApplyPaymentSubscriberPlanType


 
payment_Posted
required
number <double> 
 
payment_Posted_Date
required
string <date-time> 
 
user_ID
required
string  non-empty 
 
Array of objects or null (PremInvoiceSelfAdmin) 
If using the ApplyPaymentSelfAdmin process, you pass in the PremInvoiceSelfAdmins to apply the payment to.  For non-self-admin invoices leave this empty


 
Responses 
202
Accepted for processing


401
Unauthorized


post/premium-invoice-apply-payment-sub-payor_id
Request samples 
{
  • "invoice_Key": 0,
  • "subscriber_ID": "string",
  • "plan_Type": "string",
  • "payor_ID": "string",
  • "premPayment_Key": 0,
  • "adjustment_Reason": 0,
  • "payment_Posted": 0.1,
  • "payment_Posted_Date": "2019-08-24T14:15:22Z",
  • "user_ID": "string",
  • "premInvoiceSelfAdmins": [
    ]
}
PremInvoice Auto-Apply Advanced API 
Auto-Apply all payements to the selected invoice.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
invoiceKey
required
integer <int32> 
Invoice Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
202
Accepted for processing


401
Unauthorized


post/premium-invoices/{invoiceKey}/auto-apply
Request samples 
PremInvoice Auto-Apply for Self-Admin Advanced API 
Auto-Apply all payements to the selected Self-Admin invoice.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
invoiceKey
required
integer <int32> 
Invoice Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
202
Accepted for processing


401
Unauthorized


post/premium-invoices/{invoiceKey}/auto-apply-self-admin
Request samples 
List Premium for Payment Application Advanced API 
List Invoice Detail that can have premimum applied based on payment information and applied payment category.


SecurityapiKeyAuth and bearerAuth 
Request 
query Parameters
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
subscriberID
required
string
Subscriber ID


 
invoiceLevel
required
string
Invoice Level


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/list-apply-payment-category
Request samples 
Response samples 
No sample
Add Rate from Template Advanced API 
Create a new Premium Rate based on the selected Template Rate.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
premRateKey
required
integer <int32> 
PremRate Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
group_ID
string or null
Populate the Group ID that will be set on the newly created rate.  This is required.


 
division_ID
string or null
Populate the Division ID that will be set on the newly created rate.  This is optional.


 
premRate_Type
string or null
Popluate the Rate Type on the new rate if different than the Template Rate.  This is optional.


 
Responses 
200
Success


401
Unauthorized


post/premium-rates/{premRateKey}/add-from-template
Request samples 
{
  • "group_ID": "string",
  • "division_ID": "string",
  • "premRate_Type": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Generate Invoice Process Automation Advanced API 
This will trigger Generate Invoice Process Automation.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
invoiceKey
required
integer <int32> 
Invoice Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
202
Accepted for processing


401
Unauthorized


post/report-series-process-generate-invoice/{invoiceKey}
Request samples