Beta

Get non-insurance payer payments

GET

/api/non-insurance-payer-payments/v1

GET

1 import uuid
2 
3 from candid import CandidApiClient
4 from candid.resources.commons import SortDirection
5 from candid.resources.non_insurance_payer_payments.resources.v_1 import (
6     NonInsurancePayerPaymentSortField,
7 )
8 
9 client = CandidApiClient(
10     client_id="YOUR_CLIENT_ID",
11     client_secret="YOUR_CLIENT_SECRET",
12 )
13 client.non_insurance_payer_payments.v_1.get_multi(
14     limit=1,
15     non_insurance_payer_id=uuid.UUID(
16         "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
17     ),
18     check_number="string",
19     invoice_id=uuid.UUID(
20         "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
21     ),
22     sort=NonInsurancePayerPaymentSortField.AMOUNT_CENTS,
23     sort_direction=SortDirection.ASC,
24     page_token="eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9",
25 )

Play

200Retrieved

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": "string",
8         "enabled": true,
9         "clinical_trials": [
10           {
11             "clinical_trial_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
12             "clinical_trial_number": "string",
13             "is_active": true,
14             "name": "string",
15             "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
16             "clinical_trial_phase": "Phase 1"
17           }
18         ],
19         "description": "string",
20         "category": "string",
21         "address": {
22           "address1": "string",
23           "city": "string",
24           "state": "AA",
25           "zip_code": "string",
26           "address2": "string",
27           "zip_plus_four_code": "string"
28         }
29       },
30       "amount_cents": 0,
31       "allocations": [
32         {
33           "amount_cents": 0,
34           "target": {
35             "type": "service_line",
36             "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
37             "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
38             "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
39           }
40         }
41       ],
42       "check_number": "string",
43       "payment_timestamp": "2023-01-01T00:00:00Z",
44       "payment_note": "string",
45       "invoice_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
46     }
47   ],
48   "next_page_token": "string",
49   "prev_page_token": "string"
50 }

Returns all non-insurance payer payments

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_tokenstringOptional

prev_page_tokenstringOptional

Get non-insurance payer payments

Headers

Query parameters

Response

Errors