Create insurance 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 from candid.resources.insurance_refunds.resources.v_1 import ( 11 InsuranceRefundCreate, 12 ) 13 from candid.resources.payers.resources.v_3 import PayerIdentifier_PayerInfo 14 15 client = CandidApiClient( 16 client_id="YOUR_CLIENT_ID", 17 client_secret="YOUR_CLIENT_SECRET", 18 ) 19 client.insurance_refunds.v_1.create( 20 request=InsuranceRefundCreate( 21 payer_identifier=PayerIdentifier_PayerInfo(), 22 amount_cents=1, 23 refund_timestamp=datetime.datetime.fromisoformat( 24 "2024-01-15 09:30:00+00:00", 25 ), 26 refund_note="string", 27 allocations=[ 28 AllocationCreate( 29 amount_cents=1, 30 target=AllocationTargetCreate_ServiceLineById( 31 value=uuid.UUID( 32 "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 33 ) 34 ), 35 ) 36 ], 37 refund_reason=RefundReason.OVERCHARGED, 38 ), 39 )

1 { 2 "insurance_refund_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 3 "payer": { 4 "payer_uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 5 "payer_id": "string", 6 "payer_name": "string", 7 "availity_payer_name": "string", 8 "availity_claims_payer_id": "string", 9 "availity_eligibility_id": "string", 10 "availity_remittance_payer_id": "string", 11 "street_address": { 12 "address1": "string", 13 "city": "string", 14 "state": "AA", 15 "zip_code": "string", 16 "zip_plus_four_code": "string", 17 "address2": "string" 18 } 19 }, 20 "amount_cents": 0, 21 "allocations": [ 22 { 23 "amount_cents": 0, 24 "target": { 25 "type": "service_line", 26 "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 27 "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 28 "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" 29 } 30 } 31 ], 32 "refund_timestamp": "2023-01-01T00:00:00Z", 33 "refund_note": "string", 34 "refund_reason": "OVERCHARGED" 35 }

Creates a new insurance refund record and returns the newly created InsuranceRefund 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.

payer_identifierobjectRequired

amount_centsintegerRequired

allocationslist of objectsRequired

refund_timestampdatetimeOptional

refund_notestringOptional

refund_reasonenumOptional

Allowed values:

Response

This endpoint returns an object.

insurance_refund_idUUID

payerobject

amount_centsinteger

allocationslist of objects