Premium Invoices

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": {
    }
}
Create PremInvoice
Creates a new PremInvoice


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


 
Request Body schema: 
required
invoice_Key
required
integer <int32> 
Unique identifier for the Invoice Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
additional_Invoice_Level
string or null  <= 16 characters 
Specifies invoice level of additional invoices defined on the prem rate.


 
bill_Address
string or null  <= 128 characters 
Address of the group or individual the Invoice is for


 
bill_Address2
string or null  <= 128 characters 
Second line for the Address of the group or individual the Invoice is for


 
bill_City
string or null  <= 32 characters 
City of the group or individual the Invoice is for


 
bill_County_Code
string or null  <= 8 characters 
County of the group or individual the Invoice is for.


 
bill_Name
string or null  <= 256 characters 
Name of the group or individual the Invoice is for


 
bill_State
string or null  <= 2 characters 
State of the group or individual the Invoice is for


 
bill_Zip_Code
string or null  <= 32 characters 
Zip Code of the group or individual the Invoice is for


 
billing_Cycle_ID
string or null  <= 2 characters 
This is the Billing Cycle the invoice was gerenated for.


 
billing_From
string or null <date-time> 
First day of the Invoice period


 
billing_Thru
string or null <date-time> 
Last day of the Invoice period


 
due_Date
string or null <date-time> 
Due Date of the Invoice


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
finalized
required
boolean
Finalized invoices cannot be changed Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
finalized_Date
string or null <date-time> 
Date the Invoice was Finalized


 
finalized_User
string or null  <= 20 characters 
User that Finalized the Invoice


 
invoice_Date
string or null <date-time> 
Date of the Invoice


 
invoice_Level
string or null  <= 1 characters 
Level of the Invoice: Group, Division, or Subscriber


 
invoice_Number
string or null  <= 32 characters 
Number assigned to this Invoice


 
invoice_Status
string or null  <= 16 characters 
Status of the Invoice: Open or Closed


 
original_Invoice_Key
integer or null <int32> 
Identifies the Invoice that this Invoice was created from


 
pay_Period
integer or null <int32> 
This number represents sequence of the payroll from the beginning of the payroll year.


 
update_Date
string <date-time> 
Date the record was last updated in the system


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system


 
Responses 
200
Success


401
Unauthorized


post/premium-invoices
Request samples 
{
  • "invoice_Key": 0,
  • "additional_Invoice_Level": "string",
  • "bill_Address": "string",
  • "bill_Address2": "string",
  • "bill_City": "string",
  • "bill_County_Code": "string",
  • "bill_Name": "string",
  • "bill_State": "st",
  • "bill_Zip_Code": "string",
  • "billing_Cycle_ID": "st",
  • "billing_From": "2019-08-24T14:15:22Z",
  • "billing_Thru": "2019-08-24T14:15:22Z",
  • "due_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "finalized": true,
  • "finalized_Date": "2019-08-24T14:15:22Z",
  • "finalized_User": "string",
  • "invoice_Date": "2019-08-24T14:15:22Z",
  • "invoice_Level": "s",
  • "invoice_Number": "string",
  • "invoice_Status": "string",
  • "original_Invoice_Key": 0,
  • "pay_Period": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
List PremInvoice
Lists all PremInvoice.


SecurityapiKeyAuth and bearerAuth 
Request 
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
Request samples 
Response samples 
No sample
List PremInvoiceSlim
Gets a 'Slim' list of PremInvoices.  The Slim model has a limited subset of fields intended for quick loading.  You may provide the GroupID and/or Invoice Year to filter the list to include only those Invoices in which the Group/Invoice Year match an invoice with the same Group/Invoice Year wihtin the PremInvoiceSubscriber and PremInvoiceSelfAdmin tables.


SecurityapiKeyAuth and bearerAuth 
Request 
query Parameters
groupId
string
Group ID


 
invoiceYear
integer <int32> 
 Default:  -1
Invoice Year


 
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-slim
Request samples 
Response samples 
No sample
Get PremInvoice
Gets PremInvoice


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}
Request samples 
Response samples 
No sample
Update PremInvoice
Updates a specific PremInvoice.


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> 
Unique identifier for the Invoice Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
additional_Invoice_Level
string or null  <= 16 characters 
Specifies invoice level of additional invoices defined on the prem rate.


 
bill_Address
string or null  <= 128 characters 
Address of the group or individual the Invoice is for


 
bill_Address2
string or null  <= 128 characters 
Second line for the Address of the group or individual the Invoice is for


 
bill_City
string or null  <= 32 characters 
City of the group or individual the Invoice is for


 
bill_County_Code
string or null  <= 8 characters 
County of the group or individual the Invoice is for.


 
bill_Name
string or null  <= 256 characters 
Name of the group or individual the Invoice is for


 
bill_State
string or null  <= 2 characters 
State of the group or individual the Invoice is for


 
bill_Zip_Code
string or null  <= 32 characters 
Zip Code of the group or individual the Invoice is for


 
billing_Cycle_ID
string or null  <= 2 characters 
This is the Billing Cycle the invoice was gerenated for.


 
billing_From
string or null <date-time> 
First day of the Invoice period


 
billing_Thru
string or null <date-time> 
Last day of the Invoice period


 
due_Date
string or null <date-time> 
Due Date of the Invoice


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
finalized
required
boolean
Finalized invoices cannot be changed Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
finalized_Date
string or null <date-time> 
Date the Invoice was Finalized


 
finalized_User
string or null  <= 20 characters 
User that Finalized the Invoice


 
invoice_Date
string or null <date-time> 
Date of the Invoice


 
invoice_Level
string or null  <= 1 characters 
Level of the Invoice: Group, Division, or Subscriber


 
invoice_Number
string or null  <= 32 characters 
Number assigned to this Invoice


 
invoice_Status
string or null  <= 16 characters 
Status of the Invoice: Open or Closed


 
original_Invoice_Key
integer or null <int32> 
Identifies the Invoice that this Invoice was created from


 
pay_Period
integer or null <int32> 
This number represents sequence of the payroll from the beginning of the payroll year.


 
update_Date
string <date-time> 
Date the record was last updated in the system


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system


 
Responses 
200
Success


401
Unauthorized


put/premium-invoices/{invoiceKey}
Request samples 
{
  • "invoice_Key": 0,
  • "additional_Invoice_Level": "string",
  • "bill_Address": "string",
  • "bill_Address2": "string",
  • "bill_City": "string",
  • "bill_County_Code": "string",
  • "bill_Name": "string",
  • "bill_State": "st",
  • "bill_Zip_Code": "string",
  • "billing_Cycle_ID": "st",
  • "billing_From": "2019-08-24T14:15:22Z",
  • "billing_Thru": "2019-08-24T14:15:22Z",
  • "due_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "finalized": true,
  • "finalized_Date": "2019-08-24T14:15:22Z",
  • "finalized_User": "string",
  • "invoice_Date": "2019-08-24T14:15:22Z",
  • "invoice_Level": "s",
  • "invoice_Number": "string",
  • "invoice_Status": "string",
  • "original_Invoice_Key": 0,
  • "pay_Period": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete PremInvoice
Deletes an PremInvoice


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


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/premium-invoices/{invoiceKey}
Request samples 
Create or Update Batch PremInvoice
Create or Update multiple PremInvoice at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


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


 
Request Body schema: 
required
 Array 
invoice_Key
required
integer <int32> 
Unique identifier for the Invoice Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
additional_Invoice_Level
string or null  <= 16 characters 
Specifies invoice level of additional invoices defined on the prem rate.


 
bill_Address
string or null  <= 128 characters 
Address of the group or individual the Invoice is for


 
bill_Address2
string or null  <= 128 characters 
Second line for the Address of the group or individual the Invoice is for


 
bill_City
string or null  <= 32 characters 
City of the group or individual the Invoice is for


 
bill_County_Code
string or null  <= 8 characters 
County of the group or individual the Invoice is for.


 
bill_Name
string or null  <= 256 characters 
Name of the group or individual the Invoice is for


 
bill_State
string or null  <= 2 characters 
State of the group or individual the Invoice is for


 
bill_Zip_Code
string or null  <= 32 characters 
Zip Code of the group or individual the Invoice is for


 
billing_Cycle_ID
string or null  <= 2 characters 
This is the Billing Cycle the invoice was gerenated for.


 
billing_From
string or null <date-time> 
First day of the Invoice period


 
billing_Thru
string or null <date-time> 
Last day of the Invoice period


 
due_Date
string or null <date-time> 
Due Date of the Invoice


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
finalized
required
boolean
Finalized invoices cannot be changed Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
finalized_Date
string or null <date-time> 
Date the Invoice was Finalized


 
finalized_User
string or null  <= 20 characters 
User that Finalized the Invoice


 
invoice_Date
string or null <date-time> 
Date of the Invoice


 
invoice_Level
string or null  <= 1 characters 
Level of the Invoice: Group, Division, or Subscriber


 
invoice_Number
string or null  <= 32 characters 
Number assigned to this Invoice


 
invoice_Status
string or null  <= 16 characters 
Status of the Invoice: Open or Closed


 
original_Invoice_Key
integer or null <int32> 
Identifies the Invoice that this Invoice was created from


 
pay_Period
integer or null <int32> 
This number represents sequence of the payroll from the beginning of the payroll year.


 
update_Date
string <date-time> 
Date the record was last updated in the system


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system


 
Responses 
207
Success


401
Unauthorized


put/premium-invoices-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}
Get PremInvoice Summary
Gets PremInvoice Summary for the specified invoice.  First PremInvoiceSelfAdmin table is checked for the invoice key, if found the values are aggregated from come from PremInvoiceSelfAdmin; if the invoice key is not found in PremInvoiceSelfAdmin, the PremInvoiceSubscriber table is checked.  If not present in either table, an error is returned.


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}/summary
Request samples 
Response samples 
No sample
Get PremInvoice Group Summary
Gets PremInvoice Summary for the specified group id and invoice year.  First PremInvoiceSelfAdmin table is checked for the group id, if found the values are aggregated from come from PremInvoiceSelfAdmin; if the group is not found in PremInvoiceSelfAdmin, the PremInvoiceSubscriber table is checked for this group.  If not present in either table, an error is returned.


SecurityapiKeyAuth and bearerAuth 
Request 
query Parameters
groupId
required
string
Group ID


 
invoiceYear
required
integer <int32> 
Invoice Year


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/premium-invoices-group-summary
Request samples 
Response samples 
No sample
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