See API Specification

See Discount Plans for more information.

DiscountPlans GET (single)

Version Added: 22.4.19

Gets a single Discount Plan.

Parameters:

DiscountPlanNum: Required in URL.

Example Request:
GET /discountplans/2

Example Response:
{
"DiscountPlanNum": 2,
"Description": "Happy Smiles Basic",
"FeeSchedNum": 54,
"DefNum": 336,
"adjustmentType": "Discount Plan",
"IsHidden": "false",
"PlanNote": "50% services when paid cash at time of service.",
"ExamFreqLimit": 1,
"XrayFreqLimit": 1,
"ProphyFreqLimit": 1,
"FluorideFreqLimit": 0,
"PerioFreqLimit": 1,
"LimitedExamFreqLimit": 0,
"PAFreqLimit": 1,
"AnnualMax": 1000.0
}

200 OK
400 BadRequest (with explanation)
404 NotFound (with explanation)

DiscountPlans GET (multiple)

Version Added: 22.4.19

Gets a list of Discount Plans.

Example Request:
GET /discountplans

Example Response:
[
{
"DiscountPlanNum": 1,
"Description": "Happy Smiles Plus",
"FeeSchedNum": 54,
"DefNum": 336,
"adjustmentType": "Discount Plan",
"IsHidden": "true",
"PlanNote": "75% services when paid cash at time of service.",
"ExamFreqLimit": 1,
"XrayFreqLimit": 0,
"ProphyFreqLimit": 0,
"FluorideFreqLimit": 0,
"PerioFreqLimit": 1,
"LimitedExamFreqLimit": 1,
"PAFreqLimit": 1,
"AnnualMax": 500.0
},
{
"DiscountPlanNum": 2,
"Description": "Happy Smiles Basic",
"FeeSchedNum": 54,
"DefNum": 336,
"adjustmentType": "Discount Plan",
"IsHidden": "false",
"PlanNote": "50% services when paid cash at time of service.",
"ExamFreqLimit": 1,
"XrayFreqLimit": 1,
"ProphyFreqLimit": 1,
"FluorideFreqLimit": 0,
"PerioFreqLimit": 1,
"LimitedExamFreqLimit": 0,
"PAFreqLimit": 1,
"AnnualMax": 1000.0
},
etc...
]

200 OK
400 BadRequest (with explanation)
404 NotFound (with explanation)

DiscountPlans POST

Version Added: In development.

Creates a DiscountPlan.

Description: Required. Description of this Discount Plan.
FeeSchedNum: Required. FK to Feesched.FeeSchedNum.
DefNum: Required. FK to definition.DefNum where definition.Category=1 and definition.ItemValue="dp".
IsHidden: Optional. Hides a Discount Plan. Either "true" or "false".
PlanNote: Optional. Note on a Discount Plan.
ExamFreqLimit: Optional. Number of Procedures allowed for a discount plans Exam category. -1 indicates blank.
XrayFreqLimit: Optional. Number of Procedures allowed for a discount plans X-Ray category. -1 indicates blank.
ProphyFreqLimit: Optional. Number of Procedures allowed for a discount plans Prophylaxis category. -1 indicates blank.
FluorideFreqLimit: Optional. Number of Procedures allowed for a discount plans Fluoride category. -1 indicates blank.
PerioFreqLimit: Optional. Number of Procedures allowed for a discount plans Periodontal category. -1 indicates blank.
LimitedExamFreqLimit: Optional. Number of Procedures allowed for a discount plans Limited Exam category. -1 indicates blank.
PAFreqLimit: Optional. Number of Procedures allowed for a discount plans Periapical X-Ray category. -1 indicates blank.
AnnualMax: Optional. Annual discount maximum for frequency limitations. -1.0 indicates blank or no annual max limitation.

Example Request:
POST /discountplans

{
"Description": "Happy Smiles Ultra",
"FeeSchedNum": 54,
"DefNum": 336
}

Example Response:
{
"DiscountPlanNum": 3,
"Description": "Happy Smiles Ultra",
"FeeSchedNum": 54,
"DefNum": 336,
"adjustmentType": "Discount Plan",
"IsHidden": "false",
"PlanNote": "",
"ExamFreqLimit": -1,
"XrayFreqLimit": -1,
"ProphyFreqLimit": -1,
"FluorideFreqLimit": -1,
"PerioFreqLimit": -1,
"LimitedExamFreqLimit": -1,
"PAFreqLimit": -1,
"AnnualMax": -1.0
}

201 Created
400 BadRequest (with explanation)
404 NotFound (with explanation)

DiscountPlans PUT

Version Added: In development.

Updates an existing DiscountPlan. Updating Description or PlanNote will overwrite existing note.

DiscountPlanNum: Required in URL.

Description: Optional. Description of this Discount Plan.
FeeSchedNum: Optional. FK to Feesched.FeeSchedNum.
DefNum: Optional. FK to definition.DefNum where definition.Category=1 and definition.ItemValue="dp".
IsHidden: Optional. Hides a Discount Plan. Either "true" or "false".
PlanNote: Optional. Note on a Discount Plan.
ExamFreqLimit: Optional. Number of Procedures allowed for a discount plans Exam category. -1 indicates blank.
XrayFreqLimit: Optional. Number of Procedures allowed for a discount plans X-Ray category. -1 indicates blank.
ProphyFreqLimit: Optional. Number of Procedures allowed for a discount plans Prophylaxis category. -1 indicates blank.
FluorideFreqLimit: Optional. Number of Procedures allowed for a discount plans Fluoride category. -1 indicates blank.
PerioFreqLimit: Optional. Number of Procedures allowed for a discount plans Periodontal category. -1 indicates blank.
LimitedExamFreqLimit: Optional. Number of Procedures allowed for a discount plans Limited Exam category. -1 indicates blank.
PAFreqLimit: Optional. Number of Procedures allowed for a discount plans Periapical X-Ray category. -1 indicates blank.
AnnualMax: Optional. Annual discount maximum for frequency limitations. -1.0 indicates blank or no annual max limitation.

Example Request:
PUT /discountplans/1

{
"Description": "Happy Smiles Basic Plus",
"IsHidden": "false"
}

Example Response:
{
"DiscountPlanNum": 1,
"Description": "Happy Smiles Basic Plus",
"FeeSchedNum": 54,
"DefNum": 336,
"adjustmentType": "Discount Plan",
"IsHidden": "false",
"PlanNote": "75% services when paid cash at time of service.",
"ExamFreqLimit": 1,
"XrayFreqLimit": 0,
"ProphyFreqLimit": 0,
"FluorideFreqLimit": 0,
"PerioFreqLimit": 1,
"LimitedExamFreqLimit": 1,
"PAFreqLimit": 1,
"AnnualMax": 500.0
}

200 OK
400 BadRequest (with explanation)
404 NotFound (with explanation)