Beta

Create patient payment

POST

/api/patient-payments/v4

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 
10 client = CandidApiClient(
11     client_id="YOUR_CLIENT_ID",
12     client_secret="YOUR_CLIENT_SECRET",
13 )
14 client.patient_payments.v_4.create(
15     amount_cents=1,
16     payment_timestamp=datetime.datetime.fromisoformat(
17         "2024-01-15 09:30:00+00:00",
18     ),
19     payment_note="string",
20     patient_external_id="string",
21     allocations=[
22         AllocationCreate(
23             amount_cents=1,
24             target=AllocationTargetCreate_ServiceLineById(
25                 value=uuid.UUID(
26                     "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
27                 )
28             ),
29         )
30     ],
31     invoice=uuid.UUID(
32         "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
33     ),
34 )

Play

200Successful

1 {
2   "patient_payment_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
3   "organization_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
4   "payment_source": "MANUAL_ENTRY",
5   "amount_cents": 0,
6   "patient_external_id": "string",
7   "allocations": [
8     {
9       "amount_cents": 0,
10       "target": {
11         "type": "service_line",
12         "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
13         "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
14         "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
15       }
16     }
17   ],
18   "source_internal_id": "string",
19   "payment_timestamp": "2023-01-01T00:00:00Z",
20   "payment_note": "string",
21   "invoice": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
22 }

Creates a new patient payment record and returns the newly created PatientPayment object. The allocations can describe whether the payment is being applied toward a specific service line, claim, or billing provider.

Request

This endpoint expects an object.

amount_centsintegerRequired

patient_external_idstringRequired

allocationslist of objectsRequired

payment_timestampdatetimeOptional

payment_notestringOptional

invoiceUUIDOptional

Response

This endpoint returns an object.

patient_payment_idUUID

organization_idUUID

payment_sourceenum

amount_centsinteger

patient_external_idstring

allocationslist of objects

source_internal_idstringOptional