Manage Charges

---

Use the Manage Charges screen to add, edit, or remove charge line items for an appointment before you submit the Visit Took Place report.
The Doctor App opens this screen from the charges area in the visit summary.
The screen enforces charge rules, recalculates totals, and returns control to the visit summary after you confirm changes.

This page includes:

• A header with title and close button.
• Instruction text for additional treatments.
• A charges table with these columns:
  • Item.
  • Doctor fee
  • Doctor’s total
  • Air Doctor total
• Controls to add, update, and remove charge line items.
• Validation that blocks confirmation when required values contain errors.
• Totals that reflect charge values and markup rules.

---

Workflow

Add a Charge

1. On the Visit Took Place screen, select Add charge.
   
2. In Charge for, enter an item label.
3. In Quantity, enter a numeric value.
4. In Price per item, enter a numeric value in the appointment currency.
5. Review values in the popup:
   • Total shows quantity multiplied by price.
   • With Air Doctor fee shows the amount with markup when markup applies.
6. Select Add.
7. Review the charges table.
   

Edit or Remove a Charge

1. In the charges table, select Edit charge for a line item.
2. Update Charge for, Quantity, or Price per item.
3. Select Update.
4. Select Remove to delete the line item.
   

---

Validations

These scenarios describe how the app validates the Manage Charges screen and what the integrator can expect.

Scenario	App Behavior	SDK Output	Example
The doctor selects Add with a required field empty.	The app blocks submission and highlights the field.	The SDK returns a validation error in the update set, and the charge list remains unchanged.	—
The doctor enters a non-numeric value in Quantity or Price per item.	The app blocks submission and shows inline feedback for the field.	The SDK returns a validation error that targets the numeric field.	—
The doctor enters a numeric value that violates field rules.	The app blocks submission and keeps the popup open.	The SDK returns a validation error in the update set, and totals remain unchanged.	—
Authorization denies the charge operation.	The app blocks the action and displays an error message.	The SDK returns an error in the update set or a server error response, and charge data remains unchanged.	—

Actions

These scenarios describe how the app responds to actions on the Manage Charges screen and what the SDK returns.

Scenario	App Behavior	SDK Output	Example
The doctor enters valid values and selects Add.	The app adds a line item and recalculates totals.	The SDK returns an update set that adds a charge entry to the page object.
The doctor edits a charge and selects Update.	The app updates the line item and recalculates totals.	The SDK returns an update set that modifies the selected charge entry in the page object.
The doctor selects Remove for a charge.	The app removes the line item and recalculates totals.	The SDK returns an update set that deletes the selected charge entry from the page object.
The doctor edits Quantity or Price per item in the popup without confirmation.	The app refreshes computed totals in the popup.	The SDK returns an update set that patches computed fields for display.

---

Endpoint Resources

Present Charge

PUT 

/profile/appointments/{appointment-id}/summary/charge

Produces the Manage Charges popup for the specified appointment.
The response body includes:

• Item label input.
• Quantity input.
• Price input.
• Computed total fields.
• Action buttons for add, update, and remove.

UI Element Types

Level	Reference	Type	Value	Placement
1	—	Edit	The header text and close button are part of the cover
1	charge-info	Edit	Charge for
1	charge-quantity	Integer	Quantity
1	charge-price	Double	Price per item
1	charge-total-title	Regular	Total:
1	charge-total-spacer	Spacer	—	~
1	charge-total-amount	Regular	Quantity × Price in appointment currency	~
1	create	Button	Add charge	Visible in new charge popup only
1	update	Button	Update	Visible in edit charge popup only
1	remove	Ghost	Remove	Visible in edit charge popup only

---

Add Charge

PATCH 

/profile/appointments/{appointment-id}/summary/charge

Returns an update set that adds a charge line item to the appointment summary.

Update Charge

PATCH 

/profile/appointments/{appointment-id}/summary/charge/{extra-id}/update

Returns an update set that updates the specified charge line item.

Patch Charge

PATCH 

/profile/appointments/{appointment-id}/summary/charge/patch

Returns an update set that refreshes computed totals in the charge popup.

Delete Charge

PATCH 

/profile/appointments/{appointment-id}/summary/charge/{extra-id}/delete

Returns an update set that removes the specified charge line item from the appointment summary.