Plan Auth Penalties

Create PlanAuthPenalty

Creates a new PlanAuthPenalty

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
planID
required
string

Plan ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
planAuthPenalty_Key
required
integer <int32>

Unique identifier assigned to the Plan Auth Penalty. Note: This field is marked as NOT NULL in the database and therefore required by the API.

effective_Date
string or null <date-time>

Date when the penalty becomes effective.

entry_Date
string <date-time>

Date when the record was added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

penalty
number or null <double>

Amount of the penalty that will applied.

penalty_Max
number or null <double>

Maximum penalty that can be applied.

penalty_Pct
required
boolean

Indicates whether the penalty will be a percentage or fixed amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.

penalty_Type
string or null <= 16 characters

Identifies the type of penalty: By Visit - adjudication will consider per Provider per day. By Occurrence - adjudication will consider the occurrence date of the claim.

plan_ID
string or null <= 20 characters

References the Plans.Plan_ID value in parent table.

term_Date
string or null <date-time>

Date when the penalty is terminated.

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/plans/{planID}/auth-penalties
Request samples
{
  • "planAuthPenalty_Key": 0,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "penalty": 0.1,
  • "penalty_Max": 0.1,
  • "penalty_Pct": true,
  • "penalty_Type": "string",
  • "plan_ID": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List PlanAuthPenalty

Lists all PlanAuthPenalty planID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
planID
required
string

Plan ID

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/plans/{planID}/auth-penalties
Request samples 
Response samples 
No sample
Get PlanAuthPenalty
Gets PlanAuthPenalty


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
planAuthPenaltyKey
required
integer <int32> 
PlanAuthPenalty Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/plans/{planID}/auth-penalties/{planAuthPenaltyKey}
Request samples 
Response samples 
No sample
Update PlanAuthPenalty
Updates a specific PlanAuthPenalty.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
planAuthPenaltyKey
required
integer <int32> 
PlanAuthPenalty Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
planAuthPenalty_Key
required
integer <int32> 
Unique identifier assigned to the Plan Auth Penalty. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
effective_Date
string or null <date-time> 
Date when the penalty becomes effective.


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


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


 
penalty
number or null <double> 
Amount of the penalty that will applied.


 
penalty_Max
number or null <double> 
Maximum penalty that can be applied.


 
penalty_Pct
required
boolean
Indicates whether the penalty will be a percentage or fixed amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
penalty_Type
string or null  <= 16 characters 
Identifies the type of penalty: By Visit - adjudication will consider per Provider per day. By Occurrence - adjudication will consider the occurrence date of the claim.


 
plan_ID
string or null  <= 20 characters 
References the Plans.Plan_ID value in parent table.


 
term_Date
string or null <date-time> 
Date when the penalty is terminated.


 
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/plans/{planID}/auth-penalties/{planAuthPenaltyKey}
Request samples 
{
  • "planAuthPenalty_Key": 0,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "penalty": 0.1,
  • "penalty_Max": 0.1,
  • "penalty_Pct": true,
  • "penalty_Type": "string",
  • "plan_ID": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete PlanAuthPenalty
Deletes an PlanAuthPenalty


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
planAuthPenaltyKey
required
integer <int32> 
PlanAuthPenalty Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/plans/{planID}/auth-penalties/{planAuthPenaltyKey}
Request samples 
Create or Update Batch PlanAuthPenalty
Create or Update multiple PlanAuthPenalty 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
planID
required
string
Plan ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
planAuthPenalty_Key
required
integer <int32> 
Unique identifier assigned to the Plan Auth Penalty. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
effective_Date
string or null <date-time> 
Date when the penalty becomes effective.


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


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


 
penalty
number or null <double> 
Amount of the penalty that will applied.


 
penalty_Max
number or null <double> 
Maximum penalty that can be applied.


 
penalty_Pct
required
boolean
Indicates whether the penalty will be a percentage or fixed amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
penalty_Type
string or null  <= 16 characters 
Identifies the type of penalty: By Visit - adjudication will consider per Provider per day. By Occurrence - adjudication will consider the occurrence date of the claim.


 
plan_ID
string or null  <= 20 characters 
References the Plans.Plan_ID value in parent table.


 
term_Date
string or null <date-time> 
Date when the penalty is terminated.


 
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 
207
Success


401
Unauthorized


put/plans/{planID}/auth-penalties-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}