Create patient refund

1 import datetime 2 import uuid 3 4 from candid import CandidApiClient 5 from candid.resources.financials import ( 6 AllocationCreate, 7 AllocationTargetCreate_ServiceLineById, 8 RefundReason, 9 ) 10 11 client = CandidApiClient( 12 client_id="YOUR_CLIENT_ID", 13 client_secret="YOUR_CLIENT_SECRET", 14 ) 15 client.patient_refunds.v_1.create( 16 amount_cents=1, 17 refund_timestamp=datetime.datetime.fromisoformat( 18 "2024-01-15 09:30:00+00:00", 19 ), 20 refund_note="string", 21 patient_external_id="string", 22 allocations=[ 23 AllocationCreate( 24 amount_cents=1, 25 target=AllocationTargetCreate_ServiceLineById( 26 value=uuid.UUID( 27 "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 28 ) 29 ), 30 ) 31 ], 32 invoice=uuid.UUID( 33 "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 34 ), 35 refund_reason=RefundReason.OVERCHARGED, 36 )

1 { 2 "patient_refund_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 3 "organization_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 4 "refund_source": "MANUAL_ENTRY", 5 "amount_cents": 0, 6 "patient_external_id": "string", 7 "allocations": [ 8 { 9 "amount_cents": 0, 10 "target": { 11 "type": "service_line", 12 "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 13 "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 14 "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" 15 } 16 } 17 ], 18 "source_internal_id": "string", 19 "refund_timestamp": "2023-01-01T00:00:00Z", 20 "refund_note": "string", 21 "invoice": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 22 "refund_reason": "OVERCHARGED" 23 }

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_reasonenumOptional

Allowed values:

Response

This endpoint returns an object.

patient_refund_idUUID

organization_idUUID

refund_sourceenum

amount_centsinteger

patient_external_idstring

allocationslist of objects

source_internal_idstringOptional