Premium Invoices Self-Admin

Create PremInvoiceSelfAdmin

Creates a new PremInvoiceSelfAdmin

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

Invoice Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
premInvoiceSelfAdmin_Key
required
integer <int32>
age
integer or null <int32>
benefit_Code
string or null <= 10 characters
dependents
integer or null <int32>
dist_Volume
number or null <double>
division_ID
string or null <= 20 characters
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
groupSelfAdmin_Age
integer or null <int32>
groupSelfAdmin_Dependents
integer or null <int32>
groupSelfAdmin_Dist_Volume
number or null <double>
groupSelfAdmin_Key
integer or null <int32>
groupSelfAdmin_Members
integer or null <int32>
groupSelfAdmin_Premium
number or null <double>
groupSelfAdmin_Sex
string or null <= 1 characters
groupSelfAdmin_Subscribers
integer or null <int32>
groupSelfAdmin_Volume
number or null <double>
group_ID
string or null <= 20 characters
invoice_Key
required
integer <int32>
members
integer or null <int32>
plan_ID
string or null <= 20 characters
premRate_Key
integer or null <int32>
premium
number or null <double>
premium_Received
number or null <double>
sex
string or null <= 1 characters
subscribers
integer or null <int32>
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}/self-admin
Request samples
{
  • "premInvoiceSelfAdmin_Key": 0,
  • "age": 0,
  • "benefit_Code": "string",
  • "dependents": 0,
  • "dist_Volume": 0.1,
  • "division_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "groupSelfAdmin_Age": 0,
  • "groupSelfAdmin_Dependents": 0,
  • "groupSelfAdmin_Dist_Volume": 0.1,
  • "groupSelfAdmin_Key": 0,
  • "groupSelfAdmin_Members": 0,
  • "groupSelfAdmin_Premium": 0.1,
  • "groupSelfAdmin_Sex": "s",
  • "groupSelfAdmin_Subscribers": 0,
  • "groupSelfAdmin_Volume": 0.1,
  • "group_ID": "string",
  • "invoice_Key": 0,
  • "members": 0,
  • "plan_ID": "string",
  • "premRate_Key": 0,
  • "premium": 0.1,
  • "premium_Received": 0.1,
  • "sex": "s",
  • "subscribers": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "volume": 0.1
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List PremInvoiceSelfAdmin

Lists all PremInvoiceSelfAdmin 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}/self-admin
Request samples 
Response samples 
No sample
Get PremInvoiceSelfAdmin
Gets PremInvoiceSelfAdmin


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


 
premInvoiceSelfAdminKey
required
integer <int32> 
PremInvoiceSelfAdmin Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/premium-invoices/{invoiceKey}/self-admin/{premInvoiceSelfAdminKey}
Request samples 
Response samples 
No sample
Update PremInvoiceSelfAdmin
Updates a specific PremInvoiceSelfAdmin.


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


 
premInvoiceSelfAdminKey
required
integer <int32> 
PremInvoiceSelfAdmin Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
premInvoiceSelfAdmin_Key
required
integer <int32> 
 
age
integer or null <int32> 
 
benefit_Code
string or null  <= 10 characters 
 
dependents
integer or null <int32> 
 
dist_Volume
number or null <double> 
 
division_ID
string or null  <= 20 characters 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
groupSelfAdmin_Age
integer or null <int32> 
 
groupSelfAdmin_Dependents
integer or null <int32> 
 
groupSelfAdmin_Dist_Volume
number or null <double> 
 
groupSelfAdmin_Key
integer or null <int32> 
 
groupSelfAdmin_Members
integer or null <int32> 
 
groupSelfAdmin_Premium
number or null <double> 
 
groupSelfAdmin_Sex
string or null  <= 1 characters 
 
groupSelfAdmin_Subscribers
integer or null <int32> 
 
groupSelfAdmin_Volume
number or null <double> 
 
group_ID
string or null  <= 20 characters 
 
invoice_Key
required
integer <int32> 
 
members
integer or null <int32> 
 
plan_ID
string or null  <= 20 characters 
 
premRate_Key
integer or null <int32> 
 
premium
number or null <double> 
 
premium_Received
number or null <double> 
 
sex
string or null  <= 1 characters 
 
subscribers
integer or null <int32> 
 
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}/self-admin/{premInvoiceSelfAdminKey}
Request samples 
{
  • "premInvoiceSelfAdmin_Key": 0,
  • "age": 0,
  • "benefit_Code": "string",
  • "dependents": 0,
  • "dist_Volume": 0.1,
  • "division_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "groupSelfAdmin_Age": 0,
  • "groupSelfAdmin_Dependents": 0,
  • "groupSelfAdmin_Dist_Volume": 0.1,
  • "groupSelfAdmin_Key": 0,
  • "groupSelfAdmin_Members": 0,
  • "groupSelfAdmin_Premium": 0.1,
  • "groupSelfAdmin_Sex": "s",
  • "groupSelfAdmin_Subscribers": 0,
  • "groupSelfAdmin_Volume": 0.1,
  • "group_ID": "string",
  • "invoice_Key": 0,
  • "members": 0,
  • "plan_ID": "string",
  • "premRate_Key": 0,
  • "premium": 0.1,
  • "premium_Received": 0.1,
  • "sex": "s",
  • "subscribers": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "volume": 0.1
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete PremInvoiceSelfAdmin
Deletes an PremInvoiceSelfAdmin


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


 
premInvoiceSelfAdminKey
required
integer <int32> 
PremInvoiceSelfAdmin Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/premium-invoices/{invoiceKey}/self-admin/{premInvoiceSelfAdminKey}
Request samples 
Create or Update Batch PremInvoiceSelfAdmin
Create or Update multiple PremInvoiceSelfAdmin 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 
premInvoiceSelfAdmin_Key
required
integer <int32> 
 
age
integer or null <int32> 
 
benefit_Code
string or null  <= 10 characters 
 
dependents
integer or null <int32> 
 
dist_Volume
number or null <double> 
 
division_ID
string or null  <= 20 characters 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
groupSelfAdmin_Age
integer or null <int32> 
 
groupSelfAdmin_Dependents
integer or null <int32> 
 
groupSelfAdmin_Dist_Volume
number or null <double> 
 
groupSelfAdmin_Key
integer or null <int32> 
 
groupSelfAdmin_Members
integer or null <int32> 
 
groupSelfAdmin_Premium
number or null <double> 
 
groupSelfAdmin_Sex
string or null  <= 1 characters 
 
groupSelfAdmin_Subscribers
integer or null <int32> 
 
groupSelfAdmin_Volume
number or null <double> 
 
group_ID
string or null  <= 20 characters 
 
invoice_Key
required
integer <int32> 
 
members
integer or null <int32> 
 
plan_ID
string or null  <= 20 characters 
 
premRate_Key
integer or null <int32> 
 
premium
number or null <double> 
 
premium_Received
number or null <double> 
 
sex
string or null  <= 1 characters 
 
subscribers
integer or null <int32> 
 
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}/self-admin-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}