Patient RefundsV1

Create patient refund

Beta
POST
Creates a new patient refund record and returns the newly created PatientRefund object. The allocations can describe whether the refund is being applied toward a specific service line, claim, or billing provider.

Request

This endpoint expects an object.
amount_cents
integerRequired
patient_external_id
stringRequired
allocations
list of objectsRequired
Allocations are portions of payments that are applied to specific resources, known as targets. Each allocation has and amount, defined in cents, and a target.
refund_timestamp
datetimeOptional
refund_note
stringOptional
invoice
UUIDOptional
refund_reason
enumOptional
Allowed values: OVERCHARGED

Response

This endpoint returns an object
patient_refund_id
UUID
organization_id
UUID
refund_source
enum
amount_cents
integer
patient_external_id
string
allocations
list of objects
source_internal_id
stringOptional
refund_timestamp
datetimeOptional
refund_note
stringOptional
invoice
UUIDOptional
refund_reason
enumOptional
Allowed values: OVERCHARGED

Errors