Update

1 import datetime 2 import uuid 3 4 from candid import CandidApiClient 5 from candid.resources.financials import ( 6 InvoiceUpdate_Set, 7 NoteUpdate_Set, 8 RefundReason, 9 RefundReasonUpdate_Set, 10 ) 11 12 client = CandidApiClient( 13 client_id="YOUR_CLIENT_ID", 14 client_secret="YOUR_CLIENT_SECRET", 15 ) 16 client.non_insurance_payer_refunds.v_1.update( 17 non_insurance_payer_refund_id=uuid.UUID( 18 "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 19 ), 20 refund_timestamp=datetime.datetime.fromisoformat( 21 "2024-01-15 09:30:00+00:00", 22 ), 23 refund_note=NoteUpdate_Set(value="string"), 24 refund_reason=RefundReasonUpdate_Set(value=RefundReason.OVERCHARGED), 25 invoice_id=InvoiceUpdate_Set( 26 value=uuid.UUID( 27 "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 28 ) 29 ), 30 )

1 { 2 "non_insurance_payer_refund_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 3 "non_insurance_payer": { 4 "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 5 "name": "string", 6 "enabled": true, 7 "clinical_trials": [ 8 { 9 "clinical_trial_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 10 "clinical_trial_number": "string", 11 "is_active": true, 12 "name": "string", 13 "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 14 "clinical_trial_phase": "Phase 1" 15 } 16 ], 17 "description": "string", 18 "category": "string", 19 "address": { 20 "address1": "string", 21 "city": "string", 22 "state": "AA", 23 "zip_code": "string", 24 "address2": "string", 25 "zip_plus_four_code": "string" 26 } 27 }, 28 "amount_cents": 0, 29 "allocations": [ 30 { 31 "amount_cents": 0, 32 "target": { 33 "type": "service_line", 34 "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 35 "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 36 "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" 37 } 38 } 39 ], 40 "refund_timestamp": "2023-01-01T00:00:00Z", 41 "refund_note": "string", 42 "check_number": "string", 43 "refund_reason": "OVERCHARGED", 44 "invoice_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" 45 }

Updates the non-insurance payer refund record matching the provided non_insurance_payer_refund_id. If updating the refund amount, then the allocations must be appropriately updated as well.

Path parameters

non_insurance_payer_refund_idUUIDRequired

Request

This endpoint expects an object.

refund_timestampdatetimeOptional

refund_noteobjectOptional

refund_reasonobjectOptional

invoice_idobjectOptional

Response

This endpoint returns an object.

non_insurance_payer_refund_idUUID

non_insurance_payerobject

amount_centsinteger

allocationslist of objects

refund_timestampdatetimeOptional

refund_notestringOptional

check_numberstringOptional

refund_reasonenumOptional

Allowed values:

invoice_idUUIDOptional

Update

Path parameters

Headers

Request

Response

Errors