See API Specification

InsPlans GET

Version Added: 22.3.30

Gets a list of InsPlans.

Example Request:
GET /insplans

Example Response:
[
{
"PlanNum": 6,
"GroupName": "United States Post Office",
"GroupNum": "PB181863",
"PlanNote": "Mostly covered.",
"FeeSched": 54,
"PlanType": "p",
"EmployerNum": 23,
"CarrierNum": 10,
"CodeSubstNone": "true",
"IsHidden": "false",
"MonthRenew": 0,
"IsBlueBookEnabled": "false"
},
{
"PlanNum": 14,
"GroupName": "REI",
"GroupNum": "G189614",
"PlanNote": "",
"FeeSched": 0,
"PlanType": "c",
"EmployerNum": 23,
"CarrierNum": 10,
"CodeSubstNone": "false",
"IsHidden": "true",
"MonthRenew": 6,
"IsBlueBookEnabled": "false"
},
etc...
]

200 OK

InsPlans POST

Version Added: 22.4.24

Creates a new InsPlan.

CarrierNum: Required. FK to carrier.CarrierNum.

GroupName: Optional. Typically the same as the employer. Used to identify difference in plans.
GroupNum: Optional. The Plan Number in Canada.
PlanNote: Optional. Note for this plan. Same for all subscribers.
FeeSched: Optional. FK to feesched.FeeSchedNum. Default is 0.
PlanType: Optional. Must be one of the following: "" (Percentage), "p" (PPO Percentage), "f" (Flat Copay), or "c" (Capitation). Default is "" (Percentage).
EmployerNum: Optional. FK to employer.EmployerNum. Default is 0.
CodeSubstNone: (Added in version 22.4.31) Optional. Either "true" or "false". Set "true" if this Insurance Plan should ignore any Substitution Codes. Default is "false".
IsHidden: (Added in version 22.4.31) Optional. Either "true" or "false". Default is "false".
MonthRenew: Optional. The month, 1-12, when the insurance plan renews. It will renew on the first of the month. Default is 0 to indicate calendar year.
IsBlueBookEnabled:Optional. Determines if the plan utilizes BlueBook or not. Cannot be set to true if PlanType is set to anything other than "" (Percentage). Defaults to true if AllowedFeeSchedsAutomate is set to BlueBook, otherwise defaults to false.

Example Requests:
POST /insplans

{
"CarrierNum": 10
}

or

{
"GroupName": "Walmart",
"GroupNum": "W4875",
"PlanNote": "Copayments",
"FeeSched": 56,
"PlanType": "f",
"EmployerNum": 23,
"CarrierNum": 10,
"CodeSubstNone": "false",
"IsHidden": "false",
"MonthRenew": 12,
"IsBlueBookEnabled": "false"
}

Example Response:
{
"PlanNum": 16,
"GroupName": "Walmart",
"GroupNum": "W4875",
"PlanNote": "Copayments",
"FeeSched": 56,
"PlanType": "f",
"EmployerNum": 23,
"CarrierNum": 10,
"CodeSubstNone": "false",
"IsHidden": "false",
"MonthRenew": 12,
"IsBlueBookEnabled": "false"
}

200 OK
400 BadRequest (Invalid fields)
404 NotFound ("CarrierNum not found" or "FeeSched not found")

InsPlans PUT

Version Added: 22.3.30

Updates an InsPlan.

PlanNum: Required in the URL.

GroupName: Optional. Typically the same as the employer. Used to identify difference in plans.
GroupNum: Optional. The Plan Number in Canada.
PlanNote: Optional. Note for this plan. Same for all subscribers.
FeeSched: Optional. FK to feesched.FeeSchedNum.
PlanType: Optional. Must be one of the following: "" (Percentage), "p" (PPO Percentage), "f" (Flat Copay), or "c" (Capitation).
EmployerNum: (Added in version 22.4.24) Optional. FK to employer.EmployerNum.
CarrierNum: (Added in version 22.4.24) Optional. FK to carrier.CarrierNum.
CodeSubstNone: (Added in version 22.4.31) Optional. Either "true" or "false". Set "true" if this Insurance Plan should ignore any Substitution Codes.
IsHidden: (Added in version 22.4.31) Optional. Either "true" or "false".
MonthRenew: Optional. The month, 1-12, when the insurance plan renews. It will renew on the first of the month. Use 0 to indicate calendar year.
IsBlueBookEnabled:(Added in version 22.4.24) Optional. Determines if the plan utilizes BlueBook or not. Cannot be set to true if PlanType is set it anything other than "" (Percentage).

Example Requests:
PUT /insplans/15

{
"FeeSched": 0,
"PlanType": "",
"MonthRenew": 0
}

or

{
"GroupName": "Pixar",
"GroupNum": "Y4845",
"PlanNote": "Copayments",
"FeeSched": 56,
"PlanType": "f",
"EmployerNum": 12,
"CarrierNum": 8,
"CodeSubstNone": "false",
"IsHidden": "false",
"MonthRenew": 12
"IsBlueBookEnabled": "false"
}

Example Response:
{
"PlanNum": 15,
"GroupName": "Pixar",
"GroupNum": "Y4845",
"PlanNote": "Copayments",
"FeeSched": 56,
"PlanType": "f",
"EmployerNum": 12,
"CarrierNum": 8,
"CodeSubstNone": "false",
"IsHidden": "false",
"MonthRenew": 12
"IsBlueBookEnabled": "false"
}

200 OK
400 BadRequest (Invalid fields)
404 NotFound ("InsPlan not found" or "FeeSched not found")