Subscriber Plan Policy Forfeitures

Subscriber Policy Forfeiture

Forfeits a Policy for a given Subscriber ID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

planID
required
string

Plan ID

benefitCode
required
string

Benefit Code

policyNumber
required
string

Policy Number

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
plan_ID
string or null
benefit_Code
string or null
subscriber_ID
string or null
policy_Number
string or null
cash_Value
number or null <double>
rpu
number or null <double>
current_Policy_Status
string or null
current_Forfeiture_Status
string or null
current_Status_End
string or null <date-time>
suggested_Policy_Status
string or null
suggested_Policy_Status_Date
string or null <date-time>
maturity_Date
string or null <date-time>
policy_Duration
integer or null <int32>
subscriber_Age
integer or null <int32>
invoice_Key
integer or null <int32>
Responses
204

Success

401

Unauthorized

post/subscribers/{subscriberID}/plans/{planID}/benefits/{benefitCode}/policies/{policyNumber}/forfeiture
Request samples
{
  • "plan_ID": "string",
  • "benefit_Code": "string",
  • "subscriber_ID": "string",
  • "policy_Number": "string",
  • "cash_Value": 0.1,
  • "rpu": 0.1,
  • "current_Policy_Status": "string",
  • "current_Forfeiture_Status": "string",
  • "current_Status_End": "2019-08-24T14:15:22Z",
  • "suggested_Policy_Status": "string",
  • "suggested_Policy_Status_Date": "2019-08-24T14:15:22Z",
  • "maturity_Date": "2019-08-24T14:15:22Z",
  • "policy_Duration": 0,
  • "subscriber_Age": 0,
  • "invoice_Key": 0
}

Create SubscriberForfeitureStatus

Creates a new SubscriberForfeitureStatus

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
subscriber_ID
required
string [ 1 .. 9 ] characters

References Subscribers.Subscriber_ID value on the parent record.

plan_ID
required
string [ 1 .. 20 ] characters

Unique identifier assigned to the plan.

benefit_Code
required
string [ 1 .. 10 ] characters

Benefit Code associated with the forfeiture.

policy_Number
required
string [ 1 .. 64 ] characters

Policy number of the policy being forfeited.

forfeiture_Status
required
string [ 1 .. 32 ] characters

Identifies the status of the policy forfeiture.

effective_Date
required
string <date-time>

Date when the forfeiture becomes/became effective.

entry_Date
string <date-time>

Date when the record was first added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

term_Date
string or null <date-time>

Date when the forfeiture expires/expired.

update_Date
string <date-time>

Date when 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/subscriber-forfeiture-status
Request samples
{
  • "subscriber_ID": "string",
  • "plan_ID": "string",
  • "benefit_Code": "string",
  • "policy_Number": "string",
  • "forfeiture_Status": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List SubscriberForfeitureStatus

Lists all SubscriberForfeitureStatus for the given filters: subscriberID and planID and benefitCode and policyNumber and forfeitureStatus and effectiveDate

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
subscriberID
string

Subscriber ID

planID
string

Plan ID

benefitCode
string

Benefit Code

policyNumber
string

Policy Number

forfeitureStatus
string

Forfeiture Status

effectiveDate
string <date-time>

Effective Date

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/subscriber-forfeiture-status
Request samples 
Response samples 
No sample
Get SubscriberForfeitureStatus
Gets SubscriberForfeitureStatus


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
planID
required
string
Plan ID


 
benefitCode
required
string
Benefit Code


 
policyNumber
required
string
Policy Number


 
forfeitureStatus
required
string
Forfeiture Status


 
effectiveDate
required
string <date-time> 
Effective Date


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/subscriber-forfeiture-status/{subscriberID}/{planID}/{benefitCode}/{policyNumber}/{forfeitureStatus}/{effectiveDate}
Request samples 
Response samples 
No sample
Update SubscriberForfeitureStatus
Updates a specific SubscriberForfeitureStatus.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
planID
required
string
Plan ID


 
benefitCode
required
string
Benefit Code


 
policyNumber
required
string
Policy Number


 
forfeitureStatus
required
string
Forfeiture Status


 
effectiveDate
required
string <date-time> 
Effective Date


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
subscriber_ID
required
string  [ 1 .. 9 ] characters 
References Subscribers.Subscriber_ID value on the parent record.


 
plan_ID
required
string  [ 1 .. 20 ] characters 
Unique identifier assigned to the plan.


 
benefit_Code
required
string  [ 1 .. 10 ] characters 
Benefit Code associated with the forfeiture.


 
policy_Number
required
string  [ 1 .. 64 ] characters 
Policy number of the policy being forfeited.


 
forfeiture_Status
required
string  [ 1 .. 32 ] characters 
Identifies the status of the policy forfeiture.


 
effective_Date
required
string <date-time> 
Date when the forfeiture becomes/became effective.


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


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


 
term_Date
string or null <date-time> 
Date when the forfeiture expires/expired.


 
update_Date
string <date-time> 
Date when 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/subscriber-forfeiture-status/{subscriberID}/{planID}/{benefitCode}/{policyNumber}/{forfeitureStatus}/{effectiveDate}
Request samples 
{
  • "subscriber_ID": "string",
  • "plan_ID": "string",
  • "benefit_Code": "string",
  • "policy_Number": "string",
  • "forfeiture_Status": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete SubscriberForfeitureStatus
Deletes an SubscriberForfeitureStatus


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
planID
required
string
Plan ID


 
benefitCode
required
string
Benefit Code


 
policyNumber
required
string
Policy Number


 
forfeitureStatus
required
string
Forfeiture Status


 
effectiveDate
required
string <date-time> 
Effective Date


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/subscriber-forfeiture-status/{subscriberID}/{planID}/{benefitCode}/{policyNumber}/{forfeitureStatus}/{effectiveDate}
Request samples