Beta

Create non-insurance payer refund

POST

/api/non-insurance-payer-refunds/v1

POST

1 curl -X POST https://api.joincandidhealth.com/api/non-insurance-payer-refunds/v1 \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
6   "amount_cents": 0,
7   "allocations": [
8     {
9       "amount_cents": 0,
10       "target": {
11         "type": "service_line_by_id",
12         "value": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
13       }
14     }
15   ]
16 }'

Play

200Successful

1 {
2   "non_insurance_payer_refund_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
3   "non_insurance_payer": {
4     "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
5     "name": "string",
6     "enabled": true,
7     "clinical_trials": [
8       {
9         "clinical_trial_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
10         "clinical_trial_number": "string",
11         "is_active": true,
12         "name": "string",
13         "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
14         "clinical_trial_phase": "Phase 1"
15       }
16     ],
17     "description": "string",
18     "category": "string",
19     "address": {
20       "address1": "string",
21       "city": "string",
22       "state": "AA",
23       "zip_code": "string",
24       "address2": "string",
25       "zip_plus_four_code": "string"
26     }
27   },
28   "amount_cents": 0,
29   "allocations": [
30     {
31       "amount_cents": 0,
32       "target": {
33         "type": "service_line",
34         "claim_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
35         "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
36         "service_line_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
37       }
38     }
39   ],
40   "refund_timestamp": "2023-01-01T00:00:00Z",
41   "refund_note": "string",
42   "check_number": "string",
43   "refund_reason": "OVERCHARGED",
44   "invoice_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
45 }

Creates a new non-insurance payer refund record and returns the newly created NonInsurancePayerRefund object. The allocations can describe whether the refund is being applied toward a specific service line, claim, or billing provider.

Request

This endpoint expects an object.

non_insurance_payer_idUUIDRequired

amount_centsintegerRequired

allocationslist of objectsRequired

invoice_idUUIDOptional

refund_timestampdatetimeOptional

refund_notestringOptional

check_numberstringOptional

refund_reasonenumOptional

Allowed values:

Response

This endpoint returns an object.

non_insurance_payer_refund_idUUID

non_insurance_payerobject

amount_centsinteger

allocationslist of objects