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 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
 
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",
  • "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
 
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",
  • "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
 
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",
  • "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
 
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",
  • "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
 
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",
  • "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
 
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",
  • "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"
}
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
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 
 
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"
}
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
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 
 
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"
}
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
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 
 
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"
}
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
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 
 
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"
}
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 
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> 
Subscriber ID


 
groupID
required
string
Subscriber ID


 
divisionID
required
string
Subscriber ID


 
premRateType
required
string
Subscriber ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


post/premium-rates/{premRateKey}/add-from-template/{groupID}/{divisionID}/{premRateType}
Request samples 
Response samples 
No sample