Premium Invoice Subscriber Details

Create PremInvoiceSubscriberDetail

Creates a new PremInvoiceSubscriberDetail

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 .. 20 ] characters
premRate_Key
required
integer <int32>
dist_Volume
number or null <double>
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
payee_ID
string or null <= 20 characters
premium
number or null <double>
premium_Received
number or null <double>
premium_Waived
required
boolean
update_Date
string <date-time>
update_User
string or null <= 20 characters
volume
number or null <double>
Responses
200

Success

401

Unauthorized

post/premium-invoices/{invoiceKey}/subscribers/{groupID}/{divisionID}/{subscriberID}/details
Request samples
{
  • "invoice_Key": 0,
  • "group_ID": "string",
  • "division_ID": "string",
  • "subscriber_ID": "string",
  • "premRate_Key": 0,
  • "dist_Volume": 0.1,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "payee_ID": "string",
  • "premium": 0.1,
  • "premium_Received": 0.1,
  • "premium_Waived": true,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "volume": 0.1
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List PremInvoiceSubscriberDetail

Lists all PremInvoiceSubscriberDetail for the given invoiceKey and groupID and divisionID and subscriberID

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

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/{groupID}/{divisionID}/{subscriberID}/details
Request samples 
Response samples 
No sample
Get PremInvoiceSubscriberDetail
Gets PremInvoiceSubscriberDetail


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


 
premRateKey
required
integer <int32> 
PremRate Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


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


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


 
premRateKey
required
integer <int32> 
PremRate 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 .. 20 ] characters 
 
premRate_Key
required
integer <int32> 
 
dist_Volume
number or null <double> 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
payee_ID
string or null  <= 20 characters 
 
premium
number or null <double> 
 
premium_Received
number or null <double> 
 
premium_Waived
required
boolean
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
volume
number or null <double> 
 
Responses 
200
Success


401
Unauthorized


put/premium-invoices/{invoiceKey}/subscribers/{groupID}/{divisionID}/{subscriberID}/details/{premRateKey}
Request samples 
{
  • "invoice_Key": 0,
  • "group_ID": "string",
  • "division_ID": "string",
  • "subscriber_ID": "string",
  • "premRate_Key": 0,
  • "dist_Volume": 0.1,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "payee_ID": "string",
  • "premium": 0.1,
  • "premium_Received": 0.1,
  • "premium_Waived": true,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "volume": 0.1
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete PremInvoiceSubscriberDetail
Deletes an PremInvoiceSubscriberDetail


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


 
premRateKey
required
integer <int32> 
PremRate Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/premium-invoices/{invoiceKey}/subscribers/{groupID}/{divisionID}/{subscriberID}/details/{premRateKey}
Request samples 
Create or Update Batch PremInvoiceSubscriberDetail
Create or Update multiple PremInvoiceSubscriberDetail 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


 
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
 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 .. 20 ] characters 
 
premRate_Key
required
integer <int32> 
 
dist_Volume
number or null <double> 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
payee_ID
string or null  <= 20 characters 
 
premium
number or null <double> 
 
premium_Received
number or null <double> 
 
premium_Waived
required
boolean
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
volume
number or null <double> 
 
Responses 
207
Success


401
Unauthorized


put/premium-invoices/{invoiceKey}/subscribers/{groupID}/{divisionID}/{subscriberID}/details-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}