Insurance PaymentsV1

Update

Beta
PATCH

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_idUUIDRequired

Request

This endpoint expects an object.
payment_timestamp
datetimeOptional
payment_note
unionOptional

Response

This endpoint returns an object
insurance_payment_id
UUID
payer
object
amount_cents
integer
allocations
list of objects
payment_timestamp
datetimeOptional
payment_note
stringOptional

Errors

PATCH
1curl -X PATCH https://api.joincandidhealth.com/api/insurance-payments/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32 \
2     -H "Authorization: Bearer <token>" \
3     -H "Content-Type: application/json" \
4     -d '{}'
1{
2  "insurance_payment_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
3  "payer": {
4    "payer_uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
5    "payer_id": "string",
6    "payer_name": "string"
7  },
8  "amount_cents": 0,
9  "allocations": [
10    {
11      "amount_cents": 0,
12      "target": {
13        "type": "service_line",
14        "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
15        "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
16        "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
17      }
18    }
19  ],
20  "payment_timestamp": "2023-01-01T00:00:00Z",
21  "payment_note": "string"
22}
Built with