Insurance RefundsV1

Update

Beta

PATCH

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_timestamp

datetimeOptional

refund_note

unionOptional

refund_reason

unionOptional

Response

This endpoint returns an object

insurance_refund_id

UUID

payer

object

amount_cents

integer

allocations

list of objects

refund_timestamp

datetimeOptional

refund_note

stringOptional

refund_reason

enumOptional

Allowed values: OVERCHARGED

Errors

PATCH

1 curl -X PATCH https://api.joincandidhealth.com/api/insurance-refunds/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32 \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{}'

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   },
8   "amount_cents": 0,
9   "allocations": [
10     {
11       "amount_cents": 0,
12       "target": {
13         "type": "service_line",
14         "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
15         "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
16         "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
17       }
18     }
19   ],
20   "refund_timestamp": "2023-01-01T00:00:00Z",
21   "refund_note": "string",
22   "refund_reason": "OVERCHARGED"
23 }

Built with

1	curl -X PATCH https://api.joincandidhealth.com/api/insurance-refunds/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32 \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{}'

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	},
8	"amount_cents": 0,
9	"allocations": [
10	{
11	"amount_cents": 0,
12	"target": {
13	"type": "service_line",
14	"claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
15	"encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
16	"service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
17	}
18	}
19	],
20	"refund_timestamp": "2023-01-01T00:00:00Z",
21	"refund_note": "string",
22	"refund_reason": "OVERCHARGED"
23	}