For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Contact Sales
DocsAPI reference
DocsAPI reference
  • API Reference
        • GETGet non-insurance payer refunds refunds
        • GETGet non-insurance payer refund
        • POSTCreate non-insurance payer refund
        • PATCHUpdate
        • DELDelete non-insurance payer refund
Contact Sales
LogoLogo
API ReferenceNon Insurance Payer RefundsV1

Get non-insurance payer refunds refunds

Beta
GET
/api/non-insurance-payer-refunds/v1
GET
/api/non-insurance-payer-refunds/v1
$curl https://api.joincandidhealth.com/api/non-insurance-payer-refunds/v1 \
>     -H "Authorization: Bearer <token>"
1{
2  "items": [
3    {
4      "non_insurance_payer_refund_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
5      "non_insurance_payer": {
6        "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
7        "name": "name",
8        "enabled": true,
9        "clinical_trials": [
10          {
11            "clinical_trial_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
12            "clinical_trial_number": "clinical_trial_number",
13            "is_active": true,
14            "name": "name",
15            "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
16            "clinical_trial_phase": "Phase 1"
17          },
18          {
19            "clinical_trial_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
20            "clinical_trial_number": "clinical_trial_number",
21            "is_active": true,
22            "name": "name",
23            "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
24            "clinical_trial_phase": "Phase 1"
25          }
26        ],
27        "description": "description",
28        "category": "category",
29        "address": {
30          "address1": "address1",
31          "city": "city",
32          "state": "AA",
33          "zip_code": "zip_code",
34          "address2": "address2",
35          "zip_plus_four_code": "zip_plus_four_code"
36        }
37      },
38      "amount_cents": 1,
39      "allocations": [
40        {
41          "amount_cents": 1,
42          "target": {
43            "type": "service_line",
44            "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
45            "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
46            "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
47          },
48          "allocation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
49          "earmark": {
50            "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
51            "target": {
52              "type": "date_of_service",
53              "value": "target"
54            },
55            "amount_earmarked_cents": 1,
56            "created_by_allocation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
57          },
58          "allocated_on": "2024-01-15T09:30:00Z"
59        },
60        {
61          "amount_cents": 1,
62          "target": {
63            "type": "service_line",
64            "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
65            "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
66            "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
67          },
68          "allocation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
69          "earmark": {
70            "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
71            "target": {
72              "type": "date_of_service",
73              "value": "target"
74            },
75            "amount_earmarked_cents": 1,
76            "created_by_allocation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
77          },
78          "allocated_on": "2024-01-15T09:30:00Z"
79        }
80      ],
81      "refund_timestamp": "2024-01-15T09:30:00Z",
82      "refund_note": "refund_note",
83      "check_number": "check_number",
84      "refund_reason": "OVERCHARGED",
85      "invoice_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
86    },
87    {
88      "non_insurance_payer_refund_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
89      "non_insurance_payer": {
90        "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
91        "name": "name",
92        "enabled": true,
93        "clinical_trials": [
94          {
95            "clinical_trial_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
96            "clinical_trial_number": "clinical_trial_number",
97            "is_active": true,
98            "name": "name",
99            "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
100            "clinical_trial_phase": "Phase 1"
101          },
102          {
103            "clinical_trial_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
104            "clinical_trial_number": "clinical_trial_number",
105            "is_active": true,
106            "name": "name",
107            "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
108            "clinical_trial_phase": "Phase 1"
109          }
110        ],
111        "description": "description",
112        "category": "category",
113        "address": {
114          "address1": "address1",
115          "city": "city",
116          "state": "AA",
117          "zip_code": "zip_code",
118          "address2": "address2",
119          "zip_plus_four_code": "zip_plus_four_code"
120        }
121      },
122      "amount_cents": 1,
123      "allocations": [
124        {
125          "amount_cents": 1,
126          "target": {
127            "type": "service_line",
128            "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
129            "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
130            "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
131          },
132          "allocation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
133          "earmark": {
134            "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
135            "target": {
136              "type": "date_of_service",
137              "value": "target"
138            },
139            "amount_earmarked_cents": 1,
140            "created_by_allocation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
141          },
142          "allocated_on": "2024-01-15T09:30:00Z"
143        },
144        {
145          "amount_cents": 1,
146          "target": {
147            "type": "service_line",
148            "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
149            "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
150            "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
151          },
152          "allocation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
153          "earmark": {
154            "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
155            "target": {
156              "type": "date_of_service",
157              "value": "target"
158            },
159            "amount_earmarked_cents": 1,
160            "created_by_allocation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
161          },
162          "allocated_on": "2024-01-15T09:30:00Z"
163        }
164      ],
165      "refund_timestamp": "2024-01-15T09:30:00Z",
166      "refund_note": "refund_note",
167      "check_number": "check_number",
168      "refund_reason": "OVERCHARGED",
169      "invoice_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
170    }
171  ],
172  "next_page_token": "next_page_token",
173  "prev_page_token": "prev_page_token"
174}

Returns all non-insurance payer refunds satisfying the search criteria

Was this page helpful?
Previous

Get non-insurance payer refund

Next
Built with

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Query parameters

limitintegerOptional
Defaults to 100. The value must be greater than 0 and less than 1000.
non_insurance_payer_idUUIDOptional
check_numberstringOptional
invoice_idUUIDOptional
sortenumOptional

Defaults to refund_timestamp

Allowed values:
sort_directionenumOptional
Sort direction. Defaults to descending order if not provided.
Allowed values:
page_tokenstringOptional

Response

This endpoint returns an object.
itemslist of objects
next_page_tokenstring
prev_page_tokenstring

Errors

422
Unprocessable Entity Error