Skip to main content

Present Discount


Use Present Discount to add, update, or remove an appointment discount before submission of the Visit Took Place report.

The screen displays the appointment total and recalculates the amount after discount changes.


This screen includes:

#ElementDescription
1Discount typeSelects the discount type
2AmountSpecifies the discount amount
3TotalDisplays the net fee plus additional charges
4Include discountDisplays the total after the discount
5Discount actionsAdd, update, or remove the discount

Workflow

Add a Discount

  1. Open the appointment Visit Summary.
  2. Select Add Discount.
  3. Select a discount type.
  4. Enter the discount amount.
  5. Review the updated totals.
  6. Select Add discount.

Update a Discount

  1. Open the existing discount.
  2. Change the discount type or amount.
  3. Review the updated totals.
  4. Select Update.

Remove a Discount

  1. Open the existing discount.
  2. Select Remove.
  3. Apply the returned update set to the appointment summary.

Validations

ScenarioApp behaviorSDK output
Discount type is missingBlock submission and identify the required fieldValidation error
Amount is not numericBlock submission and identify the amount fieldValidation error
Amount falls outside the accepted rangeBlock submissionValidation error
Discount operation is not allowedBlock the actionError response
Request succeedsUpdate the discount and totalsPATCH update set
Request returns an application errorPreserve the current discount stateError response

Actions

ScenarioApp behaviorSDK output
Add discount selectedAdd the discount and update totalsPATCH update set
Discount value changesRefresh the affected discount fieldsPATCH update set
Update selectedUpdate the discount and totalsPATCH update set
Remove selectedRemove the discount and update totalsPATCH update set

Calculation

The screen displays these values:

ValueCalculation
TotalAppointment net fee + additional charges
Include discountTotal − discount

All amounts use the appointment currency.


Endpoint Resources

Present Discount

PUT 

v3/appointments/{appointment-id}/summary/discount

Displays the Manage Discounts screen for the specified appointment.

Path Parameters

ParameterTypeRequiredDescription
appointment-idIntegerYesIdentifies the appointment

UI Element Types

LevelReferenceTypeValuePlacement
1discount-typeComboType1
1discount-amountDoubleAmount1
1discount-total-titleRegularTotal
1discount-total-spacerSpacer~
1discount-total-amountRegularNet fee + additional charges~
1include-discount-titleRegularInclude discount
1include-discount-spacerSpacer~
1include-discount-amountRegularTotal − discount~
1createButtonAdd discount1
1updateButtonUpdate1

Add Discount

PATCH 

v3/appointments/{appointment-id}/summary/discount

Adds a discount to the appointment summary and returns an update set.

Update Discount

PATCH 

v3/appointments/{appointment-id}/summary/discount/update

Updates the discount values for the appointment and returns an update set.

Patch Discount

PATCH 

v3/appointments/{appointment-id}/summary/discount/patch

Returns an update set for discount fields on the active appointment summary.

Delete Discount

PATCH 

v3/appointments/{appointment-id}/summary/discount/delete

Removes the discount from the appointment summary and returns an update set.