Update | Candid | API Reference

1 curl -X PATCH https://api.joincandidhealth.com/api/non-insurance-payer-payments/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32 \ 2 -H "Authorization: Bearer <token>" \ 3 -H "Content-Type: application/json" \ 4 -d '{}'

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": "name", 6 "enabled": true, 7 "clinical_trials": [ 8 { 9 "clinical_trial_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 10 "clinical_trial_number": "clinical_trial_number", 11 "is_active": true, 12 "name": "name", 13 "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 14 "clinical_trial_phase": "Phase 1" 15 }, 16 { 17 "clinical_trial_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 18 "clinical_trial_number": "clinical_trial_number", 19 "is_active": true, 20 "name": "name", 21 "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 22 "clinical_trial_phase": "Phase 1" 23 } 24 ], 25 "description": "description", 26 "category": "category", 27 "address": { 28 "address1": "address1", 29 "city": "city", 30 "state": "AA", 31 "zip_code": "zip_code", 32 "address2": "address2", 33 "zip_plus_four_code": "zip_plus_four_code" 34 } 35 }, 36 "amount_cents": 1, 37 "allocations": [ 38 { 39 "amount_cents": 1, 40 "target": { 41 "type": "service_line", 42 "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 43 "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 44 "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" 45 } 46 }, 47 { 48 "amount_cents": 1, 49 "target": { 50 "type": "service_line", 51 "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 52 "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 53 "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" 54 } 55 } 56 ], 57 "check_number": "check_number", 58 "payment_timestamp": "2024-01-15T09:30:00Z", 59 "payment_note": "payment_note", 60 "invoice_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" 61 }

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path Parameters

non_insurance_payer_payment_idUUIDRequired

Request

This endpoint expects an object.

payment_timestampdatetimeOptional

payment_noteobjectOptional

invoice_idobjectOptional

Response

This endpoint returns an object.

non_insurance_payer_payment_idUUID

non_insurance_payerobject

amount_centsinteger

allocationslist of objects

check_numberstring or null

payment_timestampdatetime or null

payment_notestring or null

invoice_idUUID or null

Authentication

Path Parameters

Request

Response

Errors