PatientRefundsV1

Create patient refund

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.

post/api/patient-refunds/v1

Request

  • Base URL: https://api.taigabilling.com
  • URL: https://api.taigabilling.com/api/patient-refunds/v1
  • Auth: HTTP bearer

Request body

amount_centsinteger required
refund_timestampstring date-time nullable
refund_notestring nullable
patient_external_idstring required
invoicestring uuid
refund_reason'OVERCHARGED' | 'ENTERED_IN_ERROR' | 'TRANSFER'
raise_on_overdraftboolean nullable

If true, the refund will be rejected if it would cause any account to be overdrafted. Defaults to false.

Response

patient_refund_idstring uuid required
organization_idstring uuid required
source_internal_idstring nullable
refund_source'MANUAL_ENTRY' | 'CHARGEBEE' | 'SQUARE' | 'STRIPE' | 'ELATION' | 'CEDAR' | 'HEALTHIE' | 'REALLOCATION' | 'PHREESIA' | 'INSTAMED' | 'SHERPA_HEALTH' | 'LOCKBOX' required
amount_centsinteger required
patient_external_idstring required
refund_timestampstring date-time nullable
refund_notestring nullable
invoicestring uuid
refund_reason'OVERCHARGED' | 'ENTERED_IN_ERROR' | 'TRANSFER'

Changes

No recorded changes to this operation across all 1 revision of this API.