Premium Payments On Accounts

Create PremPaymentOnAccount

Creates a new PremPaymentOnAccount

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

PremPayment Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
premPaymentOnAccount_Key
required
integer <int32>
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
group_ID
string or null <= 20 characters
payment_Amount
number or null <double>
payment_Posted
number or null <double>
payor_ID
string or null <= 20 characters
plan_Type
string or null <= 6 characters
premPayment_Key
required
integer <int32>
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/{premPaymentKey}/account-payments
Request samples
{
  • "premPaymentOnAccount_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "payment_Amount": 0.1,
  • "payment_Posted": 0.1,
  • "payor_ID": "string",
  • "plan_Type": "string",
  • "premPayment_Key": 0,
  • "subscriber_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List PremPaymentOnAccount

Lists all PremPaymentOnAccount for the given premPaymentKey

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

PremPayment 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-payments/{premPaymentKey}/account-payments
Request samples 
Response samples 
No sample
Get PremPaymentOnAccount
Gets PremPaymentOnAccount


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


 
premPaymentOnAccountKey
required
integer <int32> 
PremPaymentOnAccount Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


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


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


 
premPaymentOnAccountKey
required
integer <int32> 
PremPaymentOnAccount Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
premPaymentOnAccount_Key
required
integer <int32> 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
group_ID
string or null  <= 20 characters 
 
payment_Amount
number or null <double> 
 
payment_Posted
number or null <double> 
 
payor_ID
string or null  <= 20 characters 
 
plan_Type
string or null  <= 6 characters 
 
premPayment_Key
required
integer <int32> 
 
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}/account-payments/{premPaymentOnAccountKey}
Request samples 
{
  • "premPaymentOnAccount_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "payment_Amount": 0.1,
  • "payment_Posted": 0.1,
  • "payor_ID": "string",
  • "plan_Type": "string",
  • "premPayment_Key": 0,
  • "subscriber_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete PremPaymentOnAccount
Deletes an PremPaymentOnAccount


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


 
premPaymentOnAccountKey
required
integer <int32> 
PremPaymentOnAccount Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/premium-payments/{premPaymentKey}/account-payments/{premPaymentOnAccountKey}
Request samples 
Create or Update Batch PremPaymentOnAccount
Create or Update multiple PremPaymentOnAccount 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
premPaymentKey
required
integer <int32> 
PremPayment Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
premPaymentOnAccount_Key
required
integer <int32> 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
group_ID
string or null  <= 20 characters 
 
payment_Amount
number or null <double> 
 
payment_Posted
number or null <double> 
 
payor_ID
string or null  <= 20 characters 
 
plan_Type
string or null  <= 6 characters 
 
premPayment_Key
required
integer <int32> 
 
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/{premPaymentKey}/account-payments-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}