Insurance PaymentsV1

Update

Beta
PATCH
https://api.joincandidhealth.com/api/insurance-payments/v1/:insurance_payment_id
Updates the patient payment record matching the provided insurance_payment_id. If updating the payment amount, then the allocations must be appropriately updated as well.

Path parameters

insurance_payment_id
UUID

Request

This endpoint expects an object.
payment_timestamp
optional datetime
payment_note
optional union

Response

This endpoint return an object.
insurance_payment_id
UUID
payer
object
amount_cents
integer
allocations
list of objects
payment_timestamp
optional datetime
payment_note
optional string

Errors

PATCH
/api/insurance-payments/v1/:insurance_payment_id
curl -X PATCH https://api.joincandidhealth.com/api/insurance-payments/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32 \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{}'
Response
{
"insurance_payment_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
"payer": {
"payer_uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
"payer_id": "string",
"payer_name": "string"
},
"amount_cents": 0,
"allocations": [
{
"amount_cents": 0,
"target": {
"type": "service_line",
"claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
"encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
"service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
}
}
],
"payment_timestamp": "2023-01-01T00:00:00Z",
"payment_note": "string"
}