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 payments
        • GETGet non-insurance payer payment
        • POSTCreate non-insurance payer payment
        • PATCHUpdate
        • DELDelete non-insurance payer payment
Contact Sales
LogoLogo
API ReferenceNon Insurance Payer PaymentsV1

Get non-insurance payer payments

Beta
GET
/api/non-insurance-payer-payments/v1
GET
/api/non-insurance-payer-payments/v1
$curl https://api.joincandidhealth.com/api/non-insurance-payer-payments/v1 \
>     -H "Authorization: Bearer <token>"
1{
2  "items": [
3    {
4      "non_insurance_payer_payment_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      "check_number": "check_number",
82      "payment_timestamp": "2024-01-15T09:30:00Z",
83      "payment_note": "payment_note",
84      "invoice_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
85    },
86    {
87      "non_insurance_payer_payment_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
88      "non_insurance_payer": {
89        "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
90        "name": "name",
91        "enabled": true,
92        "clinical_trials": [
93          {
94            "clinical_trial_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
95            "clinical_trial_number": "clinical_trial_number",
96            "is_active": true,
97            "name": "name",
98            "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
99            "clinical_trial_phase": "Phase 1"
100          },
101          {
102            "clinical_trial_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
103            "clinical_trial_number": "clinical_trial_number",
104            "is_active": true,
105            "name": "name",
106            "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
107            "clinical_trial_phase": "Phase 1"
108          }
109        ],
110        "description": "description",
111        "category": "category",
112        "address": {
113          "address1": "address1",
114          "city": "city",
115          "state": "AA",
116          "zip_code": "zip_code",
117          "address2": "address2",
118          "zip_plus_four_code": "zip_plus_four_code"
119        }
120      },
121      "amount_cents": 1,
122      "allocations": [
123        {
124          "amount_cents": 1,
125          "target": {
126            "type": "service_line",
127            "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
128            "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
129            "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
130          },
131          "allocation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
132          "earmark": {
133            "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
134            "target": {
135              "type": "date_of_service",
136              "value": "target"
137            },
138            "amount_earmarked_cents": 1,
139            "created_by_allocation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
140          },
141          "allocated_on": "2024-01-15T09:30:00Z"
142        },
143        {
144          "amount_cents": 1,
145          "target": {
146            "type": "service_line",
147            "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
148            "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
149            "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
150          },
151          "allocation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
152          "earmark": {
153            "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
154            "target": {
155              "type": "date_of_service",
156              "value": "target"
157            },
158            "amount_earmarked_cents": 1,
159            "created_by_allocation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
160          },
161          "allocated_on": "2024-01-15T09:30:00Z"
162        }
163      ],
164      "check_number": "check_number",
165      "payment_timestamp": "2024-01-15T09:30:00Z",
166      "payment_note": "payment_note",
167      "invoice_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
168    }
169  ],
170  "next_page_token": "next_page_token",
171  "prev_page_token": "prev_page_token"
172}

Returns all non-insurance payer payments

Was this page helpful?
Previous

Get non-insurance payer payment

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