Premium Invoice Subscribers

Create PremInvoiceSubscriber

Creates a new PremInvoiceSubscriber

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

Invoice Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
invoice_Key
required
integer <int32>
group_ID
required
string [ 1 .. 20 ] characters
division_ID
required
string [ 1 .. 20 ] characters
subscriber_ID
required
string [ 1 .. 9 ] characters
dependent_Count
integer or null <int32>
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
member_Count
integer or null <int32>
premium_Waived
required
boolean
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

post/premium-invoices/{invoiceKey}/subscribers
Request samples
{
  • "invoice_Key": 0,
  • "group_ID": "string",
  • "division_ID": "string",
  • "subscriber_ID": "string",
  • "dependent_Count": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "member_Count": 0,
  • "premium_Waived": true,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List PremInvoiceSubscriber

Lists all PremInvoiceSubscriber for the given invoiceKey

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

Invoice 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/premium-invoices/{invoiceKey}/subscribers
Request samples 
Response samples 
No sample
Get PremInvoiceSubscriber
Gets PremInvoiceSubscriber


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


 
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
subscriberID
required
string
Subscriber ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/premium-invoices/{invoiceKey}/subscribers/{groupID}/{divisionID}/{subscriberID}
Request samples 
Response samples 
No sample
Update PremInvoiceSubscriber
Updates a specific PremInvoiceSubscriber.


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


 
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
subscriberID
required
string
Subscriber ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
invoice_Key
required
integer <int32> 
 
group_ID
required
string  [ 1 .. 20 ] characters 
 
division_ID
required
string  [ 1 .. 20 ] characters 
 
subscriber_ID
required
string  [ 1 .. 9 ] characters 
 
dependent_Count
integer or null <int32> 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
member_Count
integer or null <int32> 
 
premium_Waived
required
boolean
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
200
Success


401
Unauthorized


put/premium-invoices/{invoiceKey}/subscribers/{groupID}/{divisionID}/{subscriberID}
Request samples 
{
  • "invoice_Key": 0,
  • "group_ID": "string",
  • "division_ID": "string",
  • "subscriber_ID": "string",
  • "dependent_Count": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "member_Count": 0,
  • "premium_Waived": true,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete PremInvoiceSubscriber
Deletes an PremInvoiceSubscriber


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


 
groupID
required
string
Group ID


 
divisionID
required
string
Division ID


 
subscriberID
required
string
Subscriber ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/premium-invoices/{invoiceKey}/subscribers/{groupID}/{divisionID}/{subscriberID}
Request samples 
Create or Update Batch PremInvoiceSubscriber
Create or Update multiple PremInvoiceSubscriber 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
invoiceKey
required
integer <int32> 
Invoice Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
invoice_Key
required
integer <int32> 
 
group_ID
required
string  [ 1 .. 20 ] characters 
 
division_ID
required
string  [ 1 .. 20 ] characters 
 
subscriber_ID
required
string  [ 1 .. 9 ] characters 
 
dependent_Count
integer or null <int32> 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
member_Count
integer or null <int32> 
 
premium_Waived
required
boolean
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
207
Success


401
Unauthorized


put/premium-invoices/{invoiceKey}/subscribers-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}
List PremInvoiceSubscriberHistory
Lists all PremInvoiceSubscriber History for the given invoiceKey and Subscriber ID


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


 
subscriberID
required
string
Subscriber ID


 
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/premium-invoices/{invoiceKey}/subscribers/{subscriberID}/history
Request samples 
Response samples 
No sample
List of Premium Invoice Calculations by Subscriber Advanced API 
Retrieves detailed calculations and metrics for subscribers associated with a specific invoice key, including financial summaries, premium adjustments, and waiver statuses.


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


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/premium-invoices/{invoiceKey}/subscriber-calculations
Request samples 
Response samples 
No sample
List of Premium Invoice Details for Subscribers
Retrieves detailed calculations and metrics for subscribers associated with a specific invoice key, including financial summaries, premium adjustments, and waiver statuses.


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


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/premium-invoices/{invoiceKey}/subscriber-details
Request samples 
Response samples 
No sample
List of Premium Invoice Adjustment Details for Subscribers
Retrieves detailed invoice adjustments for subscribers associated with a specific invoice key, including financial summaries, & premium adjustments.


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


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/premium-invoices/{invoiceKey}/subscriber-detail-adjustments
Request samples 
Response samples 
No sample