Manage Charges

---

Use Present Charges to add, update, or remove additional charge line items before submission of the Visit Took Place report.

Open this screen from the charges area in the visit summary. The screen displays charge values and recalculates totals when quantity or price changes.

This screen includes:

#	Element	Description
1	Charge for	Specifies the charge description
2	Quantity	Specifies the number of items
3	Price per item	Specifies the price for each item
4	Total	Displays quantity multiplied by price
5	Charge actions	Add, update, or remove a charge

---

Workflow

Add a Charge

1. Open the Visit Took Place screen.
2. Select Add charge.
3. Enter a value in Charge for.
4. Enter the quantity.
5. Enter the price per item.
6. Review the calculated total.
7. Select Add charge.
8. Apply the returned update set to the visit summary.

Update a Charge

1. Select an existing charge.
2. Change Charge for, Quantity, or Price per item.
3. Review the calculated total.
4. Select Update.
5. Apply the returned update set.

Remove a Charge

1. Select an existing charge.
2. Select Remove.
3. Apply the returned update set.

---

Validations

Scenario	App behavior	SDK output
Required charge value is missing	Block submission and identify the affected field	Validation error
Quantity is not numeric	Block submission and identify the quantity field	Validation error
Price per item is not numeric	Block submission and identify the price field	Validation error
Numeric value does not meet field rules	Block submission	Validation error
Add request succeeds	Add the charge to the visit summary	PATCH update set
Update request succeeds	Update the specified charge	PATCH update set
Delete request succeeds	Remove the specified charge	PATCH update set

Actions

Scenario	App behavior	SDK output
Charge for changes	Update the charge description	Form state update
Quantity changes	Recalculate the charge total	PATCH update set
Price per item changes	Recalculate the charge total	PATCH update set
Add charge selected	Add the charge line item	PATCH update set
Update selected	Save changes to the specified charge	PATCH update set
Remove selected	Remove the specified charge	PATCH update set

---

Endpoint Resources

Present Charge

PUT 

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

Displays the Manage Charges screen for the specified appointment.

The returned screen includes the charge description, quantity, price, calculated totals, and applicable charge actions.

Path Parameters

Parameter	Type	Required	Description
appointment-id	Integer	Yes	Identifies the appointment

UI Element Types

Level	Reference	Type	Value	Placement
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	New charge only
1	update	Button	Update	Existing charge only
1	remove	Ghost	Remove	Existing charge only

---

Add Charge

PATCH 

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

Adds a charge line item to the appointment summary and returns an update set.

Update Charge

PATCH 

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

Updates the specified charge line item and returns an update set.

Patch Charge

PATCH 

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

Refreshes calculated values in the active charge screen after quantity or price changes.

note

Patch Charge applies incremental updates to the active charge screen for quantity and price changes. Update Charge applies changes to an existing charge identified by extra-id.

Delete Charge

PATCH 

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

Removes the specified charge line item from the appointment summary and returns an update set.