Create patient refund

Beta
POST
/api/patient-refunds/v1

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_centsintegerRequired
patient_external_idstringRequired
allocationslist of objectsRequired
refund_timestampdatetimeOptional
refund_notestringOptional
invoiceUUIDOptional
refund_reason"OVERCHARGED"Optional
Allowed values: OVERCHARGED

Response

This endpoint returns an object.
patient_refund_idUUID
organization_idUUID
refund_sourceenum
amount_centsinteger
patient_external_idstring
allocationslist of objects
source_internal_idstringOptional
refund_timestampdatetimeOptional
refund_notestringOptional
invoiceUUIDOptional
refund_reason"OVERCHARGED"Optional
Allowed values: OVERCHARGED

Errors