Beta

Get non-insurance payer payment

GET

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

GET

1 import uuid
2 
3 from candid import CandidApiClient
4 
5 client = CandidApiClient(
6     client_id="YOUR_CLIENT_ID",
7     client_secret="YOUR_CLIENT_SECRET",
8 )
9 client.non_insurance_payer_payments.v_1.get(
10     non_insurance_payer_payment_id=uuid.UUID(
11         "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
12     ),
13 )

Play

200Retrieved

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

Retrieves a previously created non-insurance payer payment by its non_insurance_payer_payment_id.

Path parameters

non_insurance_payer_payment_idUUIDRequired

Response

This endpoint returns an object.

non_insurance_payer_payment_idUUID

non_insurance_payerobject

amount_centsinteger

allocationslist of objects

check_numberstringOptional

payment_timestampdatetimeOptional

payment_notestringOptional

invoice_idUUIDOptional

Get non-insurance payer payment

Path parameters

Headers

Response

Errors