Premium Invoices Received

Create PremInvoiceReceived

Creates a new PremInvoiceReceived

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
premInvoiceReceived_Key
required
integer <int32>
division_ID
required
string [ 1 .. 20 ] characters
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
group_ID
required
string [ 1 .. 20 ] characters
invoice_Key
required
integer <int32>
premPayment_Key
required
integer <int32>
premRate_Key
required
integer <int32>
premium_Received
number or null <double>
premium_Received_Date
string or null <date-time>
subscriber_ID
required
string [ 1 .. 20 ] characters
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

post/premium-invoices-received
Request samples
{
  • "premInvoiceReceived_Key": 0,
  • "division_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "invoice_Key": 0,
  • "premPayment_Key": 0,
  • "premRate_Key": 0,
  • "premium_Received": 0.1,
  • "premium_Received_Date": "2019-08-24T14:15:22Z",
  • "subscriber_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List PremInvoiceReceived

Lists all PremInvoiceReceived for the given invoiceKey and groupID and divisionID and subscriberID and premRateKey

SecurityapiKeyAuth and bearerAuth
Request
query 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

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-received
Request samples 
Response samples 
No sample
Get PremInvoiceReceived
Gets PremInvoiceReceived


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
premInvoiceReceivedKey
required
integer <int32> 
PremInvoiceReceived Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/premium-invoices-received/{premInvoiceReceivedKey}
Request samples 
Response samples 
No sample
Update PremInvoiceReceived
Updates a specific PremInvoiceReceived.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
premInvoiceReceivedKey
required
integer <int32> 
PremInvoiceReceived Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
premInvoiceReceived_Key
required
integer <int32> 
 
division_ID
required
string  [ 1 .. 20 ] characters 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
group_ID
required
string  [ 1 .. 20 ] characters 
 
invoice_Key
required
integer <int32> 
 
premPayment_Key
required
integer <int32> 
 
premRate_Key
required
integer <int32> 
 
premium_Received
number or null <double> 
 
premium_Received_Date
string or null <date-time> 
 
subscriber_ID
required
string  [ 1 .. 20 ] characters 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
200
Success


401
Unauthorized


put/premium-invoices-received/{premInvoiceReceivedKey}
Request samples 
{
  • "premInvoiceReceived_Key": 0,
  • "division_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "invoice_Key": 0,
  • "premPayment_Key": 0,
  • "premRate_Key": 0,
  • "premium_Received": 0.1,
  • "premium_Received_Date": "2019-08-24T14:15:22Z",
  • "subscriber_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete PremInvoiceReceived
Deletes an PremInvoiceReceived


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
premInvoiceReceivedKey
required
integer <int32> 
PremInvoiceReceived Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/premium-invoices-received/{premInvoiceReceivedKey}
Request samples 
Create or Update Batch PremInvoiceReceived
Create or Update multiple PremInvoiceReceived 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 
premInvoiceReceived_Key
required
integer <int32> 
 
division_ID
required
string  [ 1 .. 20 ] characters 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
group_ID
required
string  [ 1 .. 20 ] characters 
 
invoice_Key
required
integer <int32> 
 
premPayment_Key
required
integer <int32> 
 
premRate_Key
required
integer <int32> 
 
premium_Received
number or null <double> 
 
premium_Received_Date
string or null <date-time> 
 
subscriber_ID
required
string  [ 1 .. 20 ] characters 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
207
Success


401
Unauthorized


put/premium-invoices-received-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}