Patient PaymentsV4

Update

Beta
PATCH

Updates the patient payment record matching the provided patient_payment_id.

Path parameters

patient_payment_idUUIDRequired

Request

This endpoint expects an object.
payment_timestamp
datetimeOptional
payment_note
unionOptional
invoice
unionOptional

Response

This endpoint returns an object
patient_payment_id
UUID
organization_id
UUID
payment_source
enum
amount_cents
integer
patient_external_id
string
allocations
list of objects
source_internal_id
stringOptional
payment_timestamp
datetimeOptional
payment_note
stringOptional
invoice
UUIDOptional

Errors

PATCH
1curl -X PATCH https://api.joincandidhealth.com/api/patient-payments/v4/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32 \
2 -H "Authorization: Bearer <token>" \
3 -H "Content-Type: application/json" \
4 -d '{}'
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}