Get non-insurance payer refund

Beta

GET

/api/non-insurance-payer-refunds/v1/:non_insurance_payer_refund_id

GET

/api/non-insurance-payer-refunds/v1/:non_insurance_payer_refund_id

$ curl https://api.joincandidhealth.com/api/non-insurance-payer-refunds/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32 \
>      -H "Authorization: Bearer <token>"

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": "name",
6     "enabled": true,
7     "clinical_trials": [
8       {
9         "clinical_trial_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
10         "clinical_trial_number": "clinical_trial_number",
11         "is_active": true,
12         "name": "name",
13         "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
14         "clinical_trial_phase": "Phase 1"
15       },
16       {
17         "clinical_trial_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
18         "clinical_trial_number": "clinical_trial_number",
19         "is_active": true,
20         "name": "name",
21         "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
22         "clinical_trial_phase": "Phase 1"
23       }
24     ],
25     "description": "description",
26     "category": "category",
27     "address": {
28       "address1": "address1",
29       "city": "city",
30       "state": "AA",
31       "zip_code": "zip_code",
32       "address2": "address2",
33       "zip_plus_four_code": "zip_plus_four_code"
34     }
35   },
36   "amount_cents": 1,
37   "allocations": [
38     {
39       "amount_cents": 1,
40       "target": {
41         "type": "service_line",
42         "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
43         "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
44         "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
45       },
46       "allocation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
47       "earmark": {
48         "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
49         "target": {
50           "type": "date_of_service",
51           "value": "target"
52         },
53         "amount_earmarked_cents": 1,
54         "created_by_allocation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
55       },
56       "allocated_on": "2024-01-15T09:30:00Z"
57     },
58     {
59       "amount_cents": 1,
60       "target": {
61         "type": "service_line",
62         "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
63         "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
64         "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
65       },
66       "allocation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
67       "earmark": {
68         "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
69         "target": {
70           "type": "date_of_service",
71           "value": "target"
72         },
73         "amount_earmarked_cents": 1,
74         "created_by_allocation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
75       },
76       "allocated_on": "2024-01-15T09:30:00Z"
77     }
78   ],
79   "refund_timestamp": "2024-01-15T09:30:00Z",
80   "refund_note": "refund_note",
81   "check_number": "check_number",
82   "refund_reason": "OVERCHARGED",
83   "invoice_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
84 }

Retrieves a previously created non-insurance payer refund by its non_insurance_payer_refund_id.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

non_insurance_payer_refund_idUUIDRequired

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

invoice_idUUIDOptional

Errors

404

Entity Not Found Error