Update

Beta

PATCH

Updates the patient refund record matching the provided patient_refund_id.

Path parameters

patient_refund_idUUIDRequired

Request

This endpoint expects an object.

refund_timestampdatetimeOptional

refund_noteobjectOptional

invoiceobjectOptional

refund_reasonobjectOptional

Response

This endpoint returns an object.

patient_refund_idUUID

organization_idUUID

refund_sourceenum

amount_centsinteger

patient_external_idstring

allocationslist of objects

source_internal_idstringOptional

refund_timestampdatetimeOptional

refund_notestringOptional

invoiceUUIDOptional

refund_reason"OVERCHARGED"Optional

Allowed values: OVERCHARGED

Errors

PATCH

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

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

Built with

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

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