Premium Distributions

Create PremDistribution

Creates a new PremDistribution

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
premDistribution_Key
required
integer <int32>
account_Key
integer or null <int32>
amount
number or null <double>
amount_Received
number or null <double>
benefit_Code
string or null <= 10 characters
calculated_Distribution_Amount
number or null <double>
check_ID
integer or null <int32>
dist_Setting_Amount
number or null <double>
dist_Setting_Amount_Max
number or null <double>
dist_Setting_Amount_Pct
required
boolean
dist_Setting_Dist_Type
string or null <= 8 characters
dist_Setting_Priority
integer or null <int32>
dist_Setting_Rate
number or null <double>
dist_Setting_Rate_Max
number or null <double>
dist_Setting_Rate_Min
number or null <double>
dist_Setting_Rate_Round_Precision
integer or null <int32>
dist_Setting_Rate_Round_Type
string or null <= 16 characters
dist_Setting_Rate_Var1
number or null <double>
dist_Setting_Rate_Var2
number or null <double>
dist_Setting_Rate_Var3
number or null <double>
dist_Volume
number or null <double>
distribution_Amount
number or null <double>
division_ID
string or null <= 20 characters
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
expense_Type
string or null <= 16 characters
groupSelfAdmin_Key
integer or null <int32>
group_ID
string or null <= 20 characters
invoiceAdjustment_Key
integer or null <int32>
invoice_Key
integer or null <int32>
override_Distribution_Amount
number or null <double>
payee_ID
string or null <= 20 characters
payor_ID
string or null <= 20 characters
plan_ID
string or null <= 20 characters
policy_Number
string or null <= 25 characters
premRate_Key
integer or null <int32>
previous_Distribution_Amount
number or null <double>
reference_ID
string or null <= 256 characters
reinsurable_Volume
number or null <double>
subscriber_ID
string or null <= 9 characters
update_Date
string <date-time>
update_User
string or null <= 20 characters
void_PremDistribution_Key
integer or null <int32>
volume
number or null <double>
Responses
200

Success

401

Unauthorized

post/premium-distributions
Request samples
{
  • "premDistribution_Key": 0,
  • "account_Key": 0,
  • "amount": 0.1,
  • "amount_Received": 0.1,
  • "benefit_Code": "string",
  • "calculated_Distribution_Amount": 0.1,
  • "check_ID": 0,
  • "dist_Setting_Amount": 0.1,
  • "dist_Setting_Amount_Max": 0.1,
  • "dist_Setting_Amount_Pct": true,
  • "dist_Setting_Dist_Type": "string",
  • "dist_Setting_Priority": 0,
  • "dist_Setting_Rate": 0.1,
  • "dist_Setting_Rate_Max": 0.1,
  • "dist_Setting_Rate_Min": 0.1,
  • "dist_Setting_Rate_Round_Precision": 0,
  • "dist_Setting_Rate_Round_Type": "string",
  • "dist_Setting_Rate_Var1": 0.1,
  • "dist_Setting_Rate_Var2": 0.1,
  • "dist_Setting_Rate_Var3": 0.1,
  • "dist_Volume": 0.1,
  • "distribution_Amount": 0.1,
  • "division_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "expense_Type": "string",
  • "groupSelfAdmin_Key": 0,
  • "group_ID": "string",
  • "invoiceAdjustment_Key": 0,
  • "invoice_Key": 0,
  • "override_Distribution_Amount": 0.1,
  • "payee_ID": "string",
  • "payor_ID": "string",
  • "plan_ID": "string",
  • "policy_Number": "string",
  • "premRate_Key": 0,
  • "previous_Distribution_Amount": 0.1,
  • "reference_ID": "string",
  • "reinsurable_Volume": 0.1,
  • "subscriber_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "void_PremDistribution_Key": 0,
  • "volume": 0.1
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List PremDistribution

Lists all PremDistribution

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-distributions
Request samples 
Response samples 
No sample
Get PremDistribution
Gets PremDistribution


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
premDistributionKey
required
integer <int32> 
PremDistribution Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/premium-distributions/{premDistributionKey}
Request samples 
Response samples 
No sample
Update PremDistribution
Updates a specific PremDistribution.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
premDistributionKey
required
integer <int32> 
PremDistribution Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
premDistribution_Key
required
integer <int32> 
 
account_Key
integer or null <int32> 
 
amount
number or null <double> 
 
amount_Received
number or null <double> 
 
benefit_Code
string or null  <= 10 characters 
 
calculated_Distribution_Amount
number or null <double> 
 
check_ID
integer or null <int32> 
 
dist_Setting_Amount
number or null <double> 
 
dist_Setting_Amount_Max
number or null <double> 
 
dist_Setting_Amount_Pct
required
boolean
 
dist_Setting_Dist_Type
string or null  <= 8 characters 
 
dist_Setting_Priority
integer or null <int32> 
 
dist_Setting_Rate
number or null <double> 
 
dist_Setting_Rate_Max
number or null <double> 
 
dist_Setting_Rate_Min
number or null <double> 
 
dist_Setting_Rate_Round_Precision
integer or null <int32> 
 
dist_Setting_Rate_Round_Type
string or null  <= 16 characters 
 
dist_Setting_Rate_Var1
number or null <double> 
 
dist_Setting_Rate_Var2
number or null <double> 
 
dist_Setting_Rate_Var3
number or null <double> 
 
dist_Volume
number or null <double> 
 
distribution_Amount
number or null <double> 
 
division_ID
string or null  <= 20 characters 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
expense_Type
string or null  <= 16 characters 
 
groupSelfAdmin_Key
integer or null <int32> 
 
group_ID
string or null  <= 20 characters 
 
invoiceAdjustment_Key
integer or null <int32> 
 
invoice_Key
integer or null <int32> 
 
override_Distribution_Amount
number or null <double> 
 
payee_ID
string or null  <= 20 characters 
 
payor_ID
string or null  <= 20 characters 
 
plan_ID
string or null  <= 20 characters 
 
policy_Number
string or null  <= 25 characters 
 
premRate_Key
integer or null <int32> 
 
previous_Distribution_Amount
number or null <double> 
 
reference_ID
string or null  <= 256 characters 
 
reinsurable_Volume
number or null <double> 
 
subscriber_ID
string or null  <= 9 characters 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
void_PremDistribution_Key
integer or null <int32> 
 
volume
number or null <double> 
 
Responses 
200
Success


401
Unauthorized


put/premium-distributions/{premDistributionKey}
Request samples 
{
  • "premDistribution_Key": 0,
  • "account_Key": 0,
  • "amount": 0.1,
  • "amount_Received": 0.1,
  • "benefit_Code": "string",
  • "calculated_Distribution_Amount": 0.1,
  • "check_ID": 0,
  • "dist_Setting_Amount": 0.1,
  • "dist_Setting_Amount_Max": 0.1,
  • "dist_Setting_Amount_Pct": true,
  • "dist_Setting_Dist_Type": "string",
  • "dist_Setting_Priority": 0,
  • "dist_Setting_Rate": 0.1,
  • "dist_Setting_Rate_Max": 0.1,
  • "dist_Setting_Rate_Min": 0.1,
  • "dist_Setting_Rate_Round_Precision": 0,
  • "dist_Setting_Rate_Round_Type": "string",
  • "dist_Setting_Rate_Var1": 0.1,
  • "dist_Setting_Rate_Var2": 0.1,
  • "dist_Setting_Rate_Var3": 0.1,
  • "dist_Volume": 0.1,
  • "distribution_Amount": 0.1,
  • "division_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "expense_Type": "string",
  • "groupSelfAdmin_Key": 0,
  • "group_ID": "string",
  • "invoiceAdjustment_Key": 0,
  • "invoice_Key": 0,
  • "override_Distribution_Amount": 0.1,
  • "payee_ID": "string",
  • "payor_ID": "string",
  • "plan_ID": "string",
  • "policy_Number": "string",
  • "premRate_Key": 0,
  • "previous_Distribution_Amount": 0.1,
  • "reference_ID": "string",
  • "reinsurable_Volume": 0.1,
  • "subscriber_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "void_PremDistribution_Key": 0,
  • "volume": 0.1
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete PremDistribution
Deletes an PremDistribution


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
premDistributionKey
required
integer <int32> 
PremDistribution Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/premium-distributions/{premDistributionKey}
Request samples 
Create or Update Batch PremDistribution
Create or Update multiple PremDistribution 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 
premDistribution_Key
required
integer <int32> 
 
account_Key
integer or null <int32> 
 
amount
number or null <double> 
 
amount_Received
number or null <double> 
 
benefit_Code
string or null  <= 10 characters 
 
calculated_Distribution_Amount
number or null <double> 
 
check_ID
integer or null <int32> 
 
dist_Setting_Amount
number or null <double> 
 
dist_Setting_Amount_Max
number or null <double> 
 
dist_Setting_Amount_Pct
required
boolean
 
dist_Setting_Dist_Type
string or null  <= 8 characters 
 
dist_Setting_Priority
integer or null <int32> 
 
dist_Setting_Rate
number or null <double> 
 
dist_Setting_Rate_Max
number or null <double> 
 
dist_Setting_Rate_Min
number or null <double> 
 
dist_Setting_Rate_Round_Precision
integer or null <int32> 
 
dist_Setting_Rate_Round_Type
string or null  <= 16 characters 
 
dist_Setting_Rate_Var1
number or null <double> 
 
dist_Setting_Rate_Var2
number or null <double> 
 
dist_Setting_Rate_Var3
number or null <double> 
 
dist_Volume
number or null <double> 
 
distribution_Amount
number or null <double> 
 
division_ID
string or null  <= 20 characters 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
expense_Type
string or null  <= 16 characters 
 
groupSelfAdmin_Key
integer or null <int32> 
 
group_ID
string or null  <= 20 characters 
 
invoiceAdjustment_Key
integer or null <int32> 
 
invoice_Key
integer or null <int32> 
 
override_Distribution_Amount
number or null <double> 
 
payee_ID
string or null  <= 20 characters 
 
payor_ID
string or null  <= 20 characters 
 
plan_ID
string or null  <= 20 characters 
 
policy_Number
string or null  <= 25 characters 
 
premRate_Key
integer or null <int32> 
 
previous_Distribution_Amount
number or null <double> 
 
reference_ID
string or null  <= 256 characters 
 
reinsurable_Volume
number or null <double> 
 
subscriber_ID
string or null  <= 9 characters 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
void_PremDistribution_Key
integer or null <int32> 
 
volume
number or null <double> 
 
Responses 
207
Success


401
Unauthorized


put/premium-distributions-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}
Create Premium Distributions Advanced API 
Generate the Premium Distributions for the selected Group and As of Date.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupId
required
string
Group ID


 
asOfDate
required
string <date-time> 
As of Date


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
202
Accepted for processing


401
Unauthorized


post/premium-distributions-generate/{groupId}/{asOfDate}
Request samples 
Create Premium Distributions Checks Advanced API 
Generate the Premium Distribution Checks for the selected Payor and Payee.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
payeeId
required
string
Payee ID


 
payorId
required
string
Payor ID


 
accountKey
required
integer <int32> 
Account Key


 
checkNumber
required
string
Check Number


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
202
Accepted for processing


401
Unauthorized


post/premium-distributions-generate-check/{payeeId}/{payorId}/{accountKey}/{checkNumber}
Request samples 
List of Distribution by Group that have not been distributed. Advanced API 
List of Distribution by Group that have not been distributed.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
asOfDate
required
string <date-time> 
As of Date


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/premium-distributions-available/{asOfDate}
Request samples 
Response samples 
No sample