Premium Payments

Create PremPayment

Creates a new PremPayment

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
premPayment_Key
required
integer <int32>
account_Key
integer or null <int32>
division_ID
string or null <= 20 characters
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
funding_Key
integer or null <int32>
group_ID
string or null <= 20 characters
payment_Amount
number or null <double>
payment_Date
string or null <date-time>
payment_ID
string or null <= 64 characters
payment_Name
string or null <= 256 characters
payment_Type
string or null <= 32 characters
payor_ID
string or null <= 20 characters
subscriber_ID
string or null <= 9 characters
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

post/premium-payments
Request samples
{
  • "premPayment_Key": 0,
  • "account_Key": 0,
  • "division_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "funding_Key": 0,
  • "group_ID": "string",
  • "payment_Amount": 0.1,
  • "payment_Date": "2019-08-24T14:15:22Z",
  • "payment_ID": "string",
  • "payment_Name": "string",
  • "payment_Type": "string",
  • "payor_ID": "string",
  • "subscriber_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List PremPayment

Lists all PremPayment

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-payments
Request samples 
Response samples 
No sample
Get PremPayment
Gets PremPayment


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
premPaymentKey
required
integer <int32> 
PremPayment Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/premium-payments/{premPaymentKey}
Request samples 
Response samples 
No sample
Update PremPayment
Updates a specific PremPayment.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
premPaymentKey
required
integer <int32> 
PremPayment Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
premPayment_Key
required
integer <int32> 
 
account_Key
integer or null <int32> 
 
division_ID
string or null  <= 20 characters 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
funding_Key
integer or null <int32> 
 
group_ID
string or null  <= 20 characters 
 
payment_Amount
number or null <double> 
 
payment_Date
string or null <date-time> 
 
payment_ID
string or null  <= 64 characters 
 
payment_Name
string or null  <= 256 characters 
 
payment_Type
string or null  <= 32 characters 
 
payor_ID
string or null  <= 20 characters 
 
subscriber_ID
string or null  <= 9 characters 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
200
Success


401
Unauthorized


put/premium-payments/{premPaymentKey}
Request samples 
{
  • "premPayment_Key": 0,
  • "account_Key": 0,
  • "division_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "funding_Key": 0,
  • "group_ID": "string",
  • "payment_Amount": 0.1,
  • "payment_Date": "2019-08-24T14:15:22Z",
  • "payment_ID": "string",
  • "payment_Name": "string",
  • "payment_Type": "string",
  • "payor_ID": "string",
  • "subscriber_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete PremPayment
Deletes an PremPayment


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
premPaymentKey
required
integer <int32> 
PremPayment Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/premium-payments/{premPaymentKey}
Request samples 
Create or Update Batch PremPayment
Create or Update multiple PremPayment 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 
premPayment_Key
required
integer <int32> 
 
account_Key
integer or null <int32> 
 
division_ID
string or null  <= 20 characters 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
funding_Key
integer or null <int32> 
 
group_ID
string or null  <= 20 characters 
 
payment_Amount
number or null <double> 
 
payment_Date
string or null <date-time> 
 
payment_ID
string or null  <= 64 characters 
 
payment_Name
string or null  <= 256 characters 
 
payment_Type
string or null  <= 32 characters 
 
payor_ID
string or null  <= 20 characters 
 
subscriber_ID
string or null  <= 9 characters 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
207
Success


401
Unauthorized


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