Beta

Update

PATCH

/api/insurance-refunds/v1/:insurance_refund_id

PATCH

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

Play

200Updated

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 }

Updates the patient refund record matching the provided insurance_refund_id. If updating the refund amount, then the allocations must be appropriately updated as well.

Path parameters

insurance_refund_idUUIDRequired

Request

This endpoint expects an object.

refund_timestampdatetimeOptional

refund_noteobjectOptional

refund_reasonobjectOptional

Response

This endpoint returns an object.

insurance_refund_idUUID

payerobject

amount_centsinteger

allocationslist of objects

refund_timestampdatetimeOptional

refund_notestringOptional

refund_reasonenumOptional

Allowed values:

Update

Path parameters

Headers

Request

Response

Errors