Beta

Create non-insurance payer payment

POST

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

POST

1 import datetime
2 import uuid
3 
4 from candid import CandidApiClient
5 from candid.resources.financials import (
6     AllocationCreate,
7     AllocationTargetCreate_ServiceLineById,
8 )
9 from candid.resources.non_insurance_payer_payments.resources.v_1 import (
10     NonInsurancePayerPaymentCreate,
11 )
12 
13 client = CandidApiClient(
14     client_id="YOUR_CLIENT_ID",
15     client_secret="YOUR_CLIENT_SECRET",
16 )
17 client.non_insurance_payer_payments.v_1.create(
18     request=NonInsurancePayerPaymentCreate(
19         non_insurance_payer_id=uuid.UUID(
20             "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
21         ),
22         amount_cents=1,
23         payment_timestamp=datetime.datetime.fromisoformat(
24             "2024-01-15 09:30:00+00:00",
25         ),
26         payment_note="string",
27         check_number="string",
28         allocations=[
29             AllocationCreate(
30                 amount_cents=1,
31                 target=AllocationTargetCreate_ServiceLineById(
32                     value=uuid.UUID(
33                         "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
34                     )
35                 ),
36             )
37         ],
38         invoice_id=uuid.UUID(
39             "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
40         ),
41     ),
42 )

Play

200Successful

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 }

Request

This endpoint expects an object.

non_insurance_payer_idUUIDRequired

amount_centsintegerRequired

allocationslist of objectsRequired

payment_timestampdatetimeOptional

payment_notestringOptional

check_numberstringOptional

invoice_idUUIDOptional

Response

This endpoint returns an object.

non_insurance_payer_payment_idUUID

non_insurance_payerobject

amount_centsinteger

allocationslist of objects